Added warning if data path is a directory but ACES is not in shard mode

[justin13601]

Closes #163

Summary by CodeRabbit

• New Features
  • Enhanced the system’s data processing guidance by adding a warning when processing directory-based datasets. Users will now be informed if a performance-enhancing option is disabled, potentially improving efficiency and completeness for large-scale or sharded data workflows.

[coderabbitai]

Walkthrough

The changes update the get_predicates_df function in the src/aces/predicates.py file by adding a conditional check. Specifically, the function now verifies if the expand_shards option in data_config is enabled. If it is not enabled and the provided data_path is a directory, the code logs a warning to inform the user. No existing logic is removed or altered, with the new handling solely aimed at enhancing the function’s guidance on configuration.

Changes

File	Change Summary
src/.../predicates.py	Added a conditional check for the expand_shards option. If disabled and the data_path is a directory, a warning message is logged for user guidance.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant F as get_predicates_df
    participant L as Logger

    U->>F: Call get_predicates_df(data_config, data_path)
    F->>F: Check if expand_shards is enabled & data_path is a directory
    alt expand_shards is disabled
        F->>L: Log a warning message
    end
    F->>U: Return predicates dataframe

Loading

Poem

I'm a bouncy rabbit on the run,
Hopping through code in the bright morning sun.
A new check was added on my data trail,
Warning logs hopping in like a playful gale.
With each byte and log in our code delight,
I wink and hop deep into the night!
🐰🌟

---

📜 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 0c5f437 and 27443ab.

📒 Files selected for processing (1)

• src/aces/predicates.py (1 hunks)

🧰 Additional context used

🪛 GitHub Check: codecov/patch

src/aces/predicates.py

[warning] 688-688: src/aces/predicates.py#L688
Added line #L688 was not covered by tests

🔇 Additional comments (1)

src/aces/predicates.py (1)

686-693: LGTM! Consider adding test coverage for the shard mode warning.

The warning implementation is well-structured and provides clear guidance to users. However, the static analysis indicates that this code path is not covered by tests.

To ensure robustness, please add test cases for:

1. Directory path with shard mode disabled
2. Directory path with shard mode enabled
3. File path with shard mode in both states

Here's a suggested test case structure:

def test_get_predicates_df_shard_warning():
    # Test case 1: Directory path with shard mode disabled
    with tempfile.TemporaryDirectory() as d:
        data_path = Path(d)
        data_config = DictConfig({
            "path": str(data_path),
            "standard": "direct",
            "ts_format": "%m/%d/%Y %H:%M",
            "shard": False
        })
        # Assert warning is logged

    # Test case 2: Directory path with shard mode enabled
    with tempfile.TemporaryDirectory() as d:
        data_path = Path(d)
        data_config = DictConfig({
            "path": str(data_path),
            "standard": "direct",
            "ts_format": "%m/%d/%Y %H:%M",
            "shard": True
        })
        # Assert no warning is logged

    # Test case 3: File path with shard mode in both states
    with tempfile.NamedTemporaryFile(mode="w", suffix=".csv") as f:
        data_path = Path(f.name)
        for shard_mode in [True, False]:
            data_config = DictConfig({
                "path": str(data_path),
                "standard": "direct",
                "ts_format": "%m/%d/%Y %H:%M",
                "shard": shard_mode
            })
            # Assert no warning is logged

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 688-688: src/aces/predicates.py#L688
Added line #L688 was not covered by tests

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.

[codecov]

Codecov Report

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

Files with missing lines	Patch %	Lines
src/aces/predicates.py	66.66%	1 Missing ⚠️

Files with missing lines	Coverage Δ
src/aces/predicates.py	83.33% <66.66%> (-0.39%)	⬇️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.