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 ucsc-wigtobigwig to 472 #51702

Merged
merged 2 commits into from
Oct 28, 2024
Merged

Update ucsc-wigtobigwig to 472 #51702

merged 2 commits into from
Oct 28, 2024

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Oct 28, 2024

Describe your pull request here


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>.

Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

📝 Walkthrough

Walkthrough

This pull request includes several modifications across multiple files related to the ucsc-wigtobigwig package. The build.sh script has been updated to enhance compiler flag handling by adding the optimization flag -O3 to the CXXFLAGS variable. Additionally, the sequence for copying and changing permissions of the wigToBigWig binary has been altered to first set permissions before moving the binary to the target directory. In the htmshell.c file, a conditional check was simplified by removing the dependency on args, allowing output formatting to proceed if format is not NULL. The include.macos.patch file has updated include paths in makefiles and changed the shebang line of a Python script to support the default Python interpreter. The meta.yaml file reflects a version increment from "469" to "472", updates the SHA256 checksum, modifies the source URL, and adds a new macOS patch. It also removes the skip directive for macOS builds, adds clangdev as a host requirement, and adjusts run requirements by removing zlib.

Possibly related PRs

  • Update ucsc-twobittofa to 472 #51654: The changes in the main PR regarding the CXXFLAGS variable and the handling of the twoBitToFa binary are directly related to the modifications made in this PR, which also updates the CXXFLAGS and alters the final steps for handling the binary.

Suggested labels

please review & merge, new version

Suggested reviewers

  • mencian

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9a03cf0 and 226ec0a.

📒 Files selected for processing (4)
  • recipes/ucsc-wigtobigwig/build.sh (1 hunks)
  • recipes/ucsc-wigtobigwig/htmshell.patch (0 hunks)
  • recipes/ucsc-wigtobigwig/include.macos.patch (1 hunks)
  • recipes/ucsc-wigtobigwig/meta.yaml (3 hunks)
💤 Files with no reviewable changes (1)
  • recipes/ucsc-wigtobigwig/htmshell.patch
🔇 Additional comments (9)
recipes/ucsc-wigtobigwig/build.sh (2)

12-12: LGTM: Consistent optimization flags

Adding -O3 to CXXFLAGS brings C++ optimization in line with the C optimization level, ensuring consistent compiler optimization across the codebase.


20-21: LGTM: Improved binary installation

The change from cp + chmod to chmod + mv is a good improvement because:

  1. Setting permissions before moving is slightly safer
  2. Using mv is more atomic than cp
recipes/ucsc-wigtobigwig/include.macos.patch (3)

7-8: LGTM: Include path addition follows conda build best practices.

The addition of ${PREFIX}/include to HG_INC is the correct approach for conda builds, ensuring that the compiler can find headers installed by build dependencies.


15-16: LGTM: Consistent include path configuration.

The change to KENT_INC maintains consistency with the previous modification in common.mk, ensuring uniform header discovery across the build.


23-24: Verify Python version compatibility.

Removing the Python 2.7 requirement makes the script more flexible, but we should ensure it doesn't use Python 2.7-specific features that might break in Python 3.

✅ Verification successful

Let me analyze the results and generate a final response.

The search results show that the script expMatrixToBarchartBed is being modified from Python 2.7 to Python 3 compatibility. Looking at the results:

  1. The 2to3.patch file shows only one Python 2 to 3 compatibility change: replacing iteritems() with items() for dictionary iteration.

  2. No other Python 2.x specific patterns like print statements without parentheses, unicode(), basestring, or raw_input() were found in the script.

  3. The change is part of a larger set of Python 2 to 3 compatibility updates across many UCSC tools, suggesting this is a coordinated effort to modernize the codebase.

Python 2 to 3 compatibility verified - only minor dictionary iteration change needed.

The script appears to be Python 3 compatible with just the dictionary iteration method update, which is a safe and straightforward change. No other Python 2.x specific features were found that would cause compatibility issues.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for Python 2.7 specific syntax in the script
# Look for common Python 2.x patterns like print statements without parentheses,
# unicode literals, etc.

# Search for Python 2.x specific syntax
echo "Checking for Python 2.x specific patterns..."
rg -l "print [^(]" || true
rg "unicode\(" || true
rg "basestring" || true
rg "raw_input\(" || true

# Look for the actual script content to verify its Python compatibility
echo "Retrieving script content for manual review..."
rg -A 10 "expMatrixToBarchartBed" || true

Length of output: 204889

recipes/ucsc-wigtobigwig/meta.yaml (4)

45-49: LGTM! URL improvements and version-specific documentation.

The changes improve URL formatting and add version-specific documentation links. The use of version templating in doc_url is particularly good as it ensures documentation matches the package version.


31-31: ⚠️ Potential issue

Consider zlib runtime dependency.

The addition of clangdev for macOS builds is good. However, I notice that while zlib is a host requirement, it's not listed in run requirements. This might cause runtime issues if the compiled binary dynamically links against zlib.

#!/bin/bash
# Description: Check if zlib is used in the source code
# Expected: Find references to zlib usage that might indicate dynamic linking

rg -i 'zlib|compress' kent/src/utils/wigToBigWig/

Consider adding this diff if the binary requires zlib at runtime:

  run:
    - libpng
    - libuuid
    - mysql-connector-c
    - libopenssl-static
+   - zlib

14-15: Verify existence of include.macos.patch file.

The patch is correctly conditioned for macOS, but let's verify its existence.

✅ Verification successful

Both patch files exist and are properly configured

The verification confirms that both patch files are present in the recipe directory:

  • include.patch (1241 bytes) for Linux
  • include.macos.patch (1223 bytes) for macOS
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the macOS patch file exists
# Expected: File should exist in the recipe directory

fd --type f "include.macos.patch" recipes/ucsc-wigtobigwig/

Length of output: 213


Script:

#!/bin/bash
# Let's check if both patch files exist in the recipe directory
ls -la recipes/ucsc-wigtobigwig/include*patch

# Also check the contents of the recipe directory to understand the context better
ls -la recipes/ucsc-wigtobigwig/

Length of output: 823


3-4: Verify SHA256 checksum for version 472.

Let's verify that the SHA256 checksum matches the source archive.

Comment on lines +23 to +27
-#!/usr/bin/env python2.7
+#!/usr/bin/env python
# expMatrixToBarchartBed
"""
Generate a barChart bed6+5 file from a matrix, meta data, and coordinates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider adding explicit Python version compatibility handling.

Since this script is part of a bioinformatics tool, it's recommended to:

  1. Add explicit version checking at runtime
  2. Include compatibility imports if needed
  3. Document supported Python versions in the script's docstring

Example addition:

#!/usr/bin/env python
import sys

if sys.version_info[0] < 3:
    from __future__ import print_function, division

# Version check
min_python = (2, 7)
if sys.version_info[:2] < min_python:
    sys.exit("Python %s.%s or later is required." % min_python)

# expMatrixToBarchartBed
"""
Generate a barChart bed6+5 file from a matrix, meta data, and coordinates.
Supported Python versions: 2.7+, 3.x
"""

@bgruening bgruening merged commit fb974cc into master Oct 28, 2024
6 checks passed
@bgruening bgruening deleted the wigtobigwig branch October 28, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants