feat: add error for when file output by CorrelationWriter already exists

[strixy16]

Makes it easier to catch times when file exists without resolving the path twice

Summary by CodeRabbit

• New Features

  • Added a new, more specific exception for handling file existence scenarios during correlation writing.

• Documentation

  • Updated method documentation to reflect new error handling behavior.

[coderabbitai]

Walkthrough

A new, more specific exception class CorrelationWriterFileExistsError has been introduced in the correlation writer module. This exception inherits from the existing CorrelationWriterIOError and is designed to provide more precise error handling when attempting to save a file that already exists and overwriting is not permitted. The save method has been updated to raise this new exception, improving the granularity of error reporting during file save operations.

Changes

File	Change Summary
src/readii/io/writers/correlation_writer.py	Added CorrelationWriterFileExistsError exception class Updated save method to raise the new specific exception when file exists

Poem

🐰 A writer's tale of files and care,
Where exceptions dance with flair!
No overwrite? A new error springs,
Precise as rabbit's whispered things.
Code clarity, our bunny's delight! 📝

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 1770187 and 7350bbc.

⛔ Files ignored due to path filters (1)

• pixi.lock is excluded by !**/*.lock

📒 Files selected for processing (1)

• src/readii/io/writers/correlation_writer.py (2 hunks)

🔇 Additional comments (2)

src/readii/io/writers/correlation_writer.py (2)

23-27: Well-structured exception class!

The new CorrelationWriterFileExistsError follows good practices by:

• Inheriting from the appropriate parent exception
• Having a clear, descriptive name
• Including a concise docstring

---

90-90: Good improvement in error specificity!

The change to raise CorrelationWriterFileExistsError provides better error handling granularity, making it easier for users to specifically catch and handle file existence cases.

Let's verify the error message format consistency across the codebase:

✅ Verification successful

Error message format is consistent across writer classes

The verification shows that the error message format is perfectly consistent across all writer classes (correlation_writer.py, plot_writer.py, and nifti_writer.py). They all:

• Use the same template: "File {out_path} already exists. \nSet {self.__class__.__name__}.overwrite to True to overwrite."
• Follow the same pattern for warning messages when overwriting: "File {out_path} already exists. Overwriting."

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check error message formatting consistency across the codebase
# Look for similar error messages in other writer classes for consistency

# Search for error messages with similar structure
rg "File .* already exists" --type py

# Search for other uses of the overwrite flag in error messages
rg "Set .*.overwrite to True" --type py

Length of output: 1368

---

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

All modified and coverable lines are covered by tests ✅

Project coverage is 47.73%. Comparing base (9baffe9) to head (7350bbc).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #106      +/-   ##
==========================================
+ Coverage   47.66%   47.73%   +0.06%     
==========================================
  Files          33       33              
  Lines        1502     1504       +2     
==========================================
+ Hits          716      718       +2     
  Misses        786      786              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.