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

Stash output from container_manager #790

Merged
merged 1 commit into from
Feb 12, 2025
Merged

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Feb 11, 2025

Fixes: #788

Summary by Sourcery

Bug Fixes:

  • Fixes an issue where the container engine was not being cached, leading to unnecessary checks and potential inconsistencies across multiple calls.

Copy link
Contributor

sourcery-ai bot commented Feb 11, 2025

Reviewer's Guide by Sourcery

This pull request primarily introduces caching behavior to avoid repeated container engine selection in the 'container_manager' function, alongside various formatting and style improvements across multiple files. The changes are implemented by adding a global variable to stash the engine value and by tweaking code style details in configuration and device setup routines.

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

File-Level Changes

Change Details Files
Cache container engine retrieval in common.py
  • Introduced a global variable (_engine) to store the container engine value.
  • Modified the container_manager() function to check and update the cached _engine value.
  • Ensured that environment variable checks and available() function invocations update the global cache.
ramalama/common.py
Improve code formatting in ollama.py
  • Standardized whitespace usage in the definition of the default_ollama_caches list.
  • Fixed minor formatting issues in the if condition checking os.path.exists by adding consistent spacing around colons.
ramalama/ollama.py
Adjust formatting and whitespace in model.py
  • Reformatted variable assignment for device_override to use consistent spacing.
  • Updated the if block for adding GPU device configuration to improve readability and style.
ramalama/model.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
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 @rhatdan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using functools.cache instead of manually implementing caching for container_manager.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

Comment on lines 33 to 39
global _engine
if _engine != "":
if _engine != "None":
return None
return _engine

_engine = "None"
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): Revisit the caching logic in container_manager.

The current logic checks if _engine is not an empty string and then, if it's not 'None', it returns None even when a valid engine value (e.g. 'podman' or 'docker') was stored. This inverted condition seems unintended. Consider revising the conditional so that a valid cached engine is returned rather than defaulting to None.

global _engine
if _engine != "":
if _engine == "None":
return None
Copy link
Collaborator

Choose a reason for hiding this comment

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

Empty string, "None" and None... Python is frustrating with all the various kinds of null :'(

@ericcurtin ericcurtin merged commit c02cc6f into containers:main Feb 12, 2025
15 of 16 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.

Optimization: check if container capable only once
2 participants