Skip to content

Conversation

ericcurtin
Copy link
Member

@ericcurtin ericcurtin commented Apr 25, 2025

If installed with uv the correct directory wasn't being looked for

Summary by Sourcery

Bug Fixes:

  • Add the installation-specific data directory path to the list of locations searched for 'shortnames.conf'.

If installed with uv the correct directory wasn't being looked for

Signed-off-by: Eric Curtin <[email protected]>
Copy link
Contributor

sourcery-ai bot commented Apr 25, 2025

Reviewer's Guide by Sourcery

This pull request modifies the Shortnames class to correctly locate the shortnames.conf file when the package is installed using tools like uv. It adds logic to determine the data installation path using sysconfig.get_path("data") and includes this path in the list of directories checked for the configuration file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Add support for locating the configuration file in the data directory determined by sysconfig.
  • Get the data installation path using sysconfig.get_path("data").
  • Include the path derived from the data installation directory in the list of potential configuration file locations.
ramalama/shortnames.py

Possibly linked issues


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!

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
Contributor

@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 @ericcurtin - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider whether the share/ramalama/ subpath relative to the data directory is guaranteed across all installation methods.
  • The new path derived from sysconfig is checked first; confirm this is the desired precedence over system-wide configuration paths.
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.

@rhatdan
Copy link
Member

rhatdan commented Apr 26, 2025

LGTM

@rhatdan rhatdan merged commit 193ec04 into main Apr 26, 2025
15 checks passed
@ericcurtin ericcurtin deleted the fix-for-finding-correct-config-file branch April 26, 2025 12:09
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