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

ENH: allow specifying the directory for creating tmpdir #180

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

GavinHuttley
Copy link

@GavinHuttley GavinHuttley commented Jan 20, 2025

Summary by Sourcery

Enhancements:

  • Add a working_dir parameter to the tempdir context manager to create the temporary directory in the specified location.

Copy link

sourcery-ai bot commented Jan 20, 2025

Reviewer's Guide by Sourcery

This pull request introduces a change to the tempdir context manager to allow specifying the directory where the temporary directory is created. It also modifies the tempdb function to use the current working directory as the base directory for the temporary directory.

Sequence diagram for temporary directory creation with custom working directory

sequenceDiagram
    participant C as Client Code
    participant T as tempdir()
    participant S as System temp

    C->>+T: Create temp dir(working_dir)
    alt working_dir specified
        T->>S: Create temp dir in working_dir
    else working_dir not specified
        T->>S: Create temp dir in system default
    end
    T-->>-C: Return Path object
    Note over C,T: Use temp dir
    C->>T: Exit context
    T->>S: Clean up temp dir
Loading

Class diagram showing tempdir function modification

classDiagram
    class tempdir{
        +__enter__(working_dir: Optional[Path|str]) Path
        +__exit__()
    }
    note for tempdir "Modified to accept working_dir parameter"

    class Path{
        +cwd() Path
    }

    tempdir ..> Path: uses
Loading

File-Level Changes

Change Details Files
Modified the tempdir context manager to accept an optional working_dir argument.
  • Added an optional working_dir parameter to the tempdir context manager.
  • Modified the tempfile.TemporaryDirectory call to use the provided working_dir if available.
  • Added a CWD constant to store the current working directory.
src/ensembl_tui/_util.py
Modified the tempdb function to use the current working directory as the base directory for the temporary directory.
  • Modified the tempdir call in tempdb to pass the CWD constant as the working_dir argument.
src/ensembl_tui/_ingest_annotation.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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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:

  • Consider making the temp directory location configurable rather than hardcoding CWD in _ingest_annotation.py
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 12859953874

Details

  • 4 of 4 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall first build on develop at 86.952%

Totals Coverage Status
Change from base Build 12821829351: 87.0%
Covered Lines: 2639
Relevant Lines: 3035

💛 - Coveralls

@GavinHuttley GavinHuttley merged commit fa552e2 into cogent3:develop Jan 20, 2025
22 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