Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Saccharis #52261

Merged
merged 79 commits into from
Nov 21, 2024
Merged

Update Saccharis #52261

merged 79 commits into from
Nov 21, 2024

Conversation

AlexSCFraser
Copy link
Contributor

Update to version 2.0.2 for a public release of various bugfixes.


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

AlexSCFraser and others added 30 commits June 13, 2023 14:33
… sha256 hash, and added --single-version-externally-managed --record=record.txt args to setup.py install as per bioconda test suite
AlexSCFraser and others added 25 commits October 10, 2024 16:47
# Conflicts:
#	recipes/saccharis/meta.yaml
adds chunk reducing size to database download streaming
increment to build 8
fix error on duplicate user ids in different files
Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

📝 Walkthrough

Walkthrough

The pull request involves updates to the meta.yaml file for the SACCHARIS package. The version number has been incremented from 2.0.1.dev21 to 2.0.2, and the hash has been updated to a new value. The source URL has been modified to dynamically reference the new version instead of the previous development version. Additionally, the build number has been reset from 9 to 0. The build section, which includes the installation script and entry points, remains unchanged. The requirements section lists the same dependencies for build, host, and run without any modifications to the specified packages or their versions. The app section, which contains entry points and metadata, is also unchanged. The test commands section continues to validate functionality without any alterations. Lastly, the about section, detailing the project’s home, development URL, description, license, and summary, remains intact. Overall, the changes focus on versioning and hash updates, along with a reset of the build number, while maintaining the core structure and dependencies of the package.

Possibly related PRs

Suggested labels

autobump, new version

Suggested reviewers

  • martin-g

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bc01cb5 and 61a49d0.

📒 Files selected for processing (1)
  • recipes/saccharis/meta.yaml (1 hunks)
🔇 Additional comments (5)
recipes/saccharis/meta.yaml (5)

11-11: Great improvement using version template!

The change to use {{ version }} template variables in the URL is a best practice. This reduces maintenance overhead and prevents version mismatch errors in future updates.


16-16: Correct build number reset

Resetting the build number to 0 for the new version follows Conda packaging best practices.


2-3: Verify release artifact hash

The update from development version (2.0.1.dev21) to release version (2.0.2) is noted. Let's verify the SHA256 hash matches the official release artifact.


Line range hint 31-33: Verify dependency compatibility with Python 3.11

The recipe has several important aspects to verify:

  1. The run_exports pin specification uses x.x which means changes in minor version will trigger rebuilds. This is appropriate for a bioinformatics tool.
  2. Several dependencies have platform-specific markers ([not win]).
  3. Some dependencies have exact version pins (e.g., pyqt >=5,<6) while others have minimum versions.

Also applies to: 37-57

✅ Verification successful

Dependencies and run_exports configuration verified

Based on the verification results:

  1. The run_exports pin specification using x.x is appropriate for this package as it ensures rebuilds on minor version changes, which is crucial for a bioinformatics tool with multiple dependencies.

  2. Most key dependencies have confirmed Python 3.11 compatibility:

    • beautifulsoup4 and python-dotenv explicitly support Python 3.11
    • biopython showed explicit Python 3.11 support
    • Platform-specific dependencies are correctly marked with [not win]
  3. The PyQt dependency is correctly specified as pyqt >=5,<6 with the accompanying pyqt5-sip >=12.11, which is the standard way to pin Qt5 dependencies.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify dependency compatibility

# Check if any of the dependencies have known compatibility issues with Python 3.11
echo "Checking dependency compatibility..."
DEPS=(
    "beautifulsoup4"
    "biopython"
    "dbcan"
    "ncbi-datasets-pylib"
    "python-dotenv"
    "pyqt"
)

for dep in "${DEPS[@]}"; do
    echo "Checking $dep..."
    curl -s "https://pypi.org/pypi/$dep/json" | \
        jq -r '.info.classifiers[] | select(contains("Programming Language :: Python :: 3.11"))'
done

Length of output: 1641


Script:

#!/bin/bash
# Let's verify PyQt compatibility differently and check the meta.yaml more thoroughly
echo "=== Checking meta.yaml for Python and PyQt specifications ==="
cat recipes/saccharis/meta.yaml

echo -e "\n=== Checking for PyQt5 instead of PyQt ==="
curl -s "https://pypi.org/pypi/PyQt5/json" | \
    jq -r '.info.classifiers[] | select(contains("Programming Language :: Python :: 3.11"))'

# Let's also check if there are any specific Python version constraints in the codebase
echo -e "\n=== Checking for Python version constraints in the code ==="
rg -l "python_requires|requires.*python" recipes/saccharis/

Length of output: 3892

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


Line range hint 76-85: Verify test coverage for new version

The test commands appear comprehensive, testing all CLI entry points. However, let's verify that no new functionality in version 2.0.2 requires additional test coverage.

✅ Verification successful

Test commands are comprehensive and valid

The test commands in the recipe are testing all the CLI entry points of saccharis:

  • Basic version check (saccharis -v)
  • All major commands with --help flag:
    • show_family_categories
    • make_family_files
    • add_family_category
    • rename_user_file
    • prune_seqs
    • screen_cazome
    • config
    • update_db

Since these test commands cover all the main functionality and no new commands or features were added in version 2.0.2 (as evidenced by the lack of CLI-related files in the codebase), the test coverage remains comprehensive and valid.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for new functionality in release notes

# Fetch release notes for v2.0.2
echo "Checking release notes for new functionality..."
gh api \
  -H "Accept: application/vnd.github+json" \
  repos/saccharis/SACCHARIS_2/releases/tags/v2.0.2 \
  | jq -r '.body' \
  | grep -i "feature\|command"

Length of output: 246


Script:

#!/bin/bash
# Let's check the repository for any changes in CLI commands or new functionality

# First, let's check for any Python files that might define CLI commands
echo "=== Checking for CLI command definitions ==="
rg -l "click.command|@click|argparse.ArgumentParser" 

# Then, let's look for setup.py or pyproject.toml to see entry points
echo -e "\n=== Checking setup files for entry points ==="
fd "setup.py|pyproject.toml" --type f --exec cat {}

# Finally, let's check the main CLI module
echo -e "\n=== Checking main CLI module ==="
fd "cli.py|main.py" --type f --exec cat {}

Length of output: 64607


Script:

#!/bin/bash
# Let's check the saccharis package for CLI commands and entry points

# First, check for any Python files that define CLI commands in saccharis
echo "=== Checking for CLI command definitions in saccharis ==="
fd "\.py$" --type f --exec ast-grep --pattern 'def $func($$$) {
  $$$
  @click.command()
  $$$
}'

# Also check for any setup.py or pyproject.toml in saccharis
echo -e "\n=== Checking saccharis setup files ==="
fd "setup.py|pyproject.toml" -p saccharis --type f --exec cat {}

# Finally, check for any changes in CLI-related files
echo -e "\n=== Checking for recent changes in CLI files ==="
fd "cli\.py|main\.py|commands\.py" -p saccharis --type f --exec cat {}

Length of output: 768

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@AlexSCFraser
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 21, 2024
@martin-g martin-g merged commit c622c3f into bioconda:master Nov 21, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants