fix: limit inventory by prefix

[jakevc]

resolves #24

Summary by CodeRabbit

• Refactor
  • Streamlined the retrieval process for stored objects, enhancing clarity and consistency in cache updates while improving efficiency when interacting with storage.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the inventory method within the StorageObject class in the snakemake_storage_plugin_s3 package. The method retains the check for the S3 bucket's existence but simplifies the logic by unconditionally updating the cache for the inventory parent. It now filters objects using a prefix derived from the object's key, which changes the set of objects processed based on the directory structure. No changes were made to the public interface.

Changes

Files	Change Summary
snakemake_storage_plugin_s3/init.py	Modified the inventory method in the StorageObject class to streamline logic and filter objects using a prefix derived from the object's key.

Sequence Diagram(s)

sequenceDiagram
    participant SO as StorageObject
    participant SB as S3Bucket

    SO->>SB: Retrieve S3 bucket (s3bucket())
    SO->>SB: Call objects.filter(Prefix=os.path.dirname(self.key))
    SB-->>SO: Return filtered list of objects
    SO->>SO: Process returned objects in inventory method

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e659d2e and 9704976.

📒 Files selected for processing (2)

• snakemake_storage_plugin_s3/__init__.py (2 hunks)
• snakemake_storage_plugin_s3/__init__.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• snakemake_storage_plugin_s3/init.py
• snakemake_storage_plugin_s3/init.py

---

🪧 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 generate docstrings to generate docstrings for this 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c78fa78 and e659d2e.

📒 Files selected for processing (1)

• snakemake_storage_plugin_s3/__init__.py (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.py`: Do not try to improve formatting. Do not suggest ...

**/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

• snakemake_storage_plugin_s3/__init__.py

🔇 Additional comments (1)

snakemake_storage_plugin_s3/__init__.py (1)

7-7: Good addition of required import

Adding the os module import is necessary for the os.path.dirname() function used in the updated code.

[jakevc]

Okay this should be good to go