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

Added more flexibility for expand shards, as well as reading dir as glob #81

Merged
merged 1 commit into from
Jul 28, 2024

Conversation

justin13601
Copy link
Owner

@justin13601 justin13601 commented Jul 28, 2024

Closes #77

Summary by CodeRabbit

  • New Features

    • Enhanced the expand_shards function to support expansion of both shard prefixes and directory paths, listing all files within the specified directory.
    • Updated documentation to clarify new functionality and provide examples for both shard specifications and directory usage.
  • Bug Fixes

    • Improved error handling for invalid shard formats, now raising appropriate ValueError.

Copy link
Contributor

coderabbitai bot commented Jul 28, 2024

Walkthrough

The changes to the expand_shards function in src/aces/expand_shards.py enhance its capability to process both shard specifications and directory paths. The updated function can now expand a directory into a list of files, alongside its original functionality of expanding shard prefixes. This dual functionality increases its versatility, making it suitable for a wider range of use cases.

Changes

File Change Summary
src/aces/expand_shards.py Enhanced expand_shards to support directory input in addition to shard specifications. Updated docstring and validation logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant expand_shards
    participant Directory
    participant ShardProcessor

    User->>expand_shards: Call with directory path
    expand_shards->>Directory: Check if path is a directory
    Directory-->>expand_shards: Return list of files
    expand_shards->>User: Return file list as string

    User->>expand_shards: Call with shard specification
    expand_shards->>ShardProcessor: Validate and expand shards
    ShardProcessor-->>expand_shards: Return expanded shards
    expand_shards->>User: Return expanded shards as string
Loading

Assessment against linked issues

Objective Addressed Explanation
Expand shards should accept a slightly more permissive string formatting language (#[77])
Support for capturing files in a directory directly (#[77])

🐇 "In fields of code, I leap and bound,
With shards and files, new options found.
From prefixes tight to directories wide,
My functions now dance, with joy and pride!
A hop, a click, let files unfold,
In the garden of code, new stories told!" 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

codecov bot commented Jul 28, 2024

Codecov Report

Attention: Patch coverage is 92.30769% with 1 line in your changes missing coverage. Please review.

Files Coverage Δ
src/aces/expand_shards.py 90.90% <92.30%> (-0.76%) ⬇️

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ff5efab and bf912bb.

Files selected for processing (1)
  • src/aces/expand_shards.py (1 hunks)
Additional context used
GitHub Check: codecov/patch
src/aces/expand_shards.py

[warning] 64-64: src/aces/expand_shards.py#L64
Added line #L64 was not covered by tests

Additional comments not posted (4)
src/aces/expand_shards.py (4)

3-4: LGTM! Imports are appropriate.

The new imports for glob and os are necessary for the enhanced functionality of the expand_shards function.


10-46: LGTM! Docstring is clear and informative.

The updated docstring accurately describes the enhanced functionality of the expand_shards function and provides useful examples.


51-54: LGTM! Directory handling is well-implemented.

The new functionality to handle directories using glob is well-implemented.


Line range hint 69-77:
LGTM! Main function is appropriate.

The main function is simple and appropriate for command-line execution.

Tools
GitHub Check: codecov/patch

[warning] 64-64: src/aces/expand_shards.py#L64
Added line #L64 was not covered by tests

Comment on lines +57 to +64
match = re.match(r"(.+)([/_])(\d+)$", arg)
if match:
prefix = match.group(1)
delimiter = match.group(2)
num = int(match.group(3))
result.extend(f"{prefix}{delimiter}{i}" for i in range(num))
else:
raise ValueError(f"Invalid shard format: {arg}")
Copy link
Contributor

Choose a reason for hiding this comment

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

Improve shard format validation and test coverage.

The shard format validation currently only handles / and _ as delimiters. Consider expanding this to handle more delimiters if needed. Additionally, the error handling line is not covered by tests.

-  match = re.match(r"(.+)([/_])(\d+)$", arg)
+  match = re.match(r"(.+)([/_.-])(\d+)$", arg)  # Added `.` and `-` as possible delimiters

Do you want me to generate the unit testing code to cover the error handling or open a GitHub issue to track this task?


<details>
<summary>Tools</summary>

<details>
<summary>GitHub Check: codecov/patch</summary><blockquote>

[warning] 64-64: src/aces/expand_shards.py#L64
Added line #L64 was not covered by tests

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit -->

@justin13601 justin13601 merged commit d4f66c5 into main Jul 28, 2024
4 checks passed
@justin13601 justin13601 deleted the expand-extract-shards branch July 28, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant