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

MAINT: code tidy #197

Merged
merged 1 commit into from
Feb 27, 2025
Merged

MAINT: code tidy #197

merged 1 commit into from
Feb 27, 2025

Conversation

GavinHuttley
Copy link

@GavinHuttley GavinHuttley commented Feb 27, 2025

Summary by Sourcery

This PR performs minor code tidying, including removing unused code and standardising type annotations.

Copy link

sourcery-ai bot commented Feb 27, 2025

Reviewer's Guide by Sourcery

This pull request focuses on code tidying. It removes commented-out code, updates type hints for better clarity, and refactors an assertion in a test for improved readability.

Updated class diagram for TranscriptSpan

classDiagram
  class TranscriptSpan {
    transcript_spans: np.ndarray
    cds_spans: np.ndarray
    exon_spans: np.ndarray
    start() int
    stop() int
    to_record(columns: tuple[str, ...]) tuple
  }
Loading

File-Level Changes

Change Details Files
Removed commented-out code and unused attributes in location_attrs.
  • Removed commented-out coord_names attribute.
  • Removed commented-out meta attribute.
src/ensembl_tui/_mysql_core_attr.py
Updated the type hint for the columns parameter in the to_record method of the Transcript class to be a tuple of strings.
  • Changed columns: tuple[str] to columns: tuple[str, ...].
src/ensembl_tui/_mysql_core_attr.py
Refactored the assertion in test_check_one_cds_seq to directly compare the sequence instead of converting the slice to a string.
  • Replaced assert str(cds.get_slice()) == expect with assert str(seq) == expect.
tests/test_cli.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @GavinHuttley - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The change to to_record's columns argument should include a type annotation change in the function signature.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 13558106124

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.673%

Totals Coverage Status
Change from base Build 13556903411: 0.0%
Covered Lines: 2660
Relevant Lines: 3034

💛 - Coveralls

@GavinHuttley GavinHuttley merged commit 74d8b7a into cogent3:develop Feb 27, 2025
28 checks passed
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