refactor: refactor find-dicom logic + docstring formatting, closes #149

[jjjermiah]

closes #149 #141

Summary by CodeRabbit

• Documentation

  • Improved docstring formatting for better readability in DICOM-related utility functions
  • Enhanced parameter descriptions in documentation

• Chores

  • Reformatted code for improved readability
  • Slight modifications to code structure without changing core functionality

[coderabbitai]

Walkthrough

The pull request involves modifications to two Python files in the imgtools/dicom module. The changes primarily focus on improving code readability and documentation formatting. In sorter_base.py, the docstring formatting was adjusted, and the control flow in the resolve_path function was slightly modified. In utils.py, the docstrings were reformatted, and the find_dicoms function's generator expression was reorganized. The ALL_DICOM_TAGS declaration was also reformatted for improved readability.

Changes

File	Changes
src/imgtools/dicom/sort/sorter_base.py	- Docstring parameter descriptions reformatted with consistent indentation - resolve_path function control flow modified with elif statement
src/imgtools/dicom/utils.py	- Docstring formatting improved for find_dicoms function - Generator expression condition order modified - ALL_DICOM_TAGS declaration reformatted

Assessment against linked issues

Objective	Addressed	Explanation
Fix find-dicoms utility to check valid DICOM after filtering [#149]	✅

Poem

🐰 A rabbit's code review delight,
Docstrings aligned, formatting just right!
Conditions shuffled with gentle care,
Readability blooming everywhere,
A code ballet, clean and bright! 🔍

---

📜 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 093eab0 and 22409d2.

📒 Files selected for processing (2)

• src/imgtools/dicom/sort/sorter_base.py (2 hunks)
• src/imgtools/dicom/utils.py (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Unit-Tests (macos-14, py312)
• GitHub Check: Unit-Tests (macos-14, py311)
• GitHub Check: Unit-Tests (macos-14, py310)
• GitHub Check: Unit-Tests (macos-latest, py311)
• GitHub Check: Unit-Tests (macos-latest, py310)
• GitHub Check: Unit-Tests (ubuntu-latest, py312)
• GitHub Check: Unit-Tests (ubuntu-latest, py311)
• GitHub Check: Unit-Tests (ubuntu-latest, py310)

🔇 Additional comments (5)

src/imgtools/dicom/utils.py (3)

54-77: Well-formatted docstring improvements!

The parameter descriptions are now properly aligned and formatted, improving readability while maintaining Python docstring conventions.

---

174-178: Good optimization in the generator expression!

Moving the search_input check before _is_valid_dicom is a performance improvement. It filters out non-matching files before performing the potentially expensive DICOM validation.

---

188-190: Clean formatting of ALL_DICOM_TAGS declaration!

Breaking the declaration across multiple lines improves readability while maintaining functionality.

src/imgtools/dicom/sort/sorter_base.py (2)

76-80: Consistent docstring formatting!

The parameter descriptions are now formatted consistently with the changes in utils.py, improving overall codebase documentation coherence.

---

91-94: Clearer control flow with explicit condition!

Using elif check_existing instead of else makes the condition more explicit and improves code clarity while maintaining the same functionality.

✨ 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

All modified and coverable lines are covered by tests ✅

Project coverage is 48.39%. Comparing base (093eab0) to head (22409d2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
+ Coverage   48.37%   48.39%   +0.01%     
==========================================
  Files          46       46              
  Lines        3603     3604       +1     
==========================================
+ Hits         1743     1744       +1     
  Misses       1860     1860              

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