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

Add support for an additional pattern episode, season parsing #36

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

mhdzumair
Copy link
Contributor

@mhdzumair mhdzumair commented Dec 5, 2024

Summary by CodeRabbit

  • New Features

    • Introduced new handlers for recognizing season and episode patterns in filenames, enhancing parsing capabilities.
  • Bug Fixes

    • Improved the accuracy of episode and season number extraction from various filename formats.
  • Tests

    • Added parameterized test cases for episode and season detection, increasing test coverage for the parser's functionality.

Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes in this pull request enhance the add_defaults function in PTT/handlers.py by introducing new regex handlers for recognizing season and episode patterns in filenames. Specifically, handlers for "seasons" and "episodes" are added to improve the parser's capabilities. Additionally, new parameterized test cases are included in tests/test_episodes.py and tests/test_season.py to validate these enhancements using specific input strings. Minor formatting adjustments were also made for clarity.

Changes

File Change Summary
PTT/handlers.py - Updated add_defaults function.
- Added handler for "seasons" with regex for season numbers.
- Added handler for "episodes" with regex for episode numbers.
- Minor formatting adjustments.
tests/test_episodes.py - Added parameterized test case for input "Vikkatakavi 01E06.mkv" expecting output [6].
tests/test_season.py - Added parameterized test case for input "Vikkatakavi 01E06.mkv" expecting output [1].

Possibly related PRs

  • Improve title parse #10: The changes in PTT/handlers.py related to the add_defaults function include the addition of new handlers for episodes and seasons, which directly connects to the enhancements made in the episode and season parsing functionalities in the main PR.

Poem

🐇 In the land of code where patterns play,
New handlers hop in, brightening the day.
Seasons and episodes, now clear as can be,
Parsing with joy, as easy as three!
With tests that dance, ensuring all's right,
Code's a garden, blooming in light! 🌼


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>, 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 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.

Copy link

@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: 0

🧹 Outside diff range and nitpick comments (1)
PTT/handlers.py (1)

Line range hint 335-368: Consider adding test cases for edge cases.

While the current test coverage is good for the happy path, consider adding test cases for edge cases such as:

  • Invalid season numbers (00, 100)
  • Invalid episode numbers (0000)
  • Mixed case variations (e vs E)
  • Different separators (space, dot, underscore)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f4dec25 and d362ed7.

📒 Files selected for processing (3)
  • PTT/handlers.py (6 hunks)
  • tests/test_episodes.py (1 hunks)
  • tests/test_season.py (1 hunks)
🔇 Additional comments (6)
tests/test_season.py (1)

114-114: LGTM! Test case addition is appropriate.

The new test case "Vikkatakavi 01E06.mkv" with expected season [1] properly validates the parser's ability to extract season numbers from the "##E##" format.

tests/test_episodes.py (1)

193-193: LGTM! Test case addition is appropriate.

The new test case "Vikkatakavi 01E06.mkv" with expected episode [6] properly validates the parser's ability to extract episode numbers from the "##E##" format.

PTT/handlers.py (4)

335-335: LGTM! Season pattern handler is well-implemented.

The new season pattern handler correctly captures 1-2 digit season numbers in the format "##E##" with proper word boundaries.


368-368: LGTM! Episode pattern handler is well-implemented.

The new episode pattern handler correctly captures 1-3 digit episode numbers in the format "##E##" with proper word boundaries.


599-601: LGTM! Group handlers addition is appropriate.

The new group handlers for "INFLATE|DEFLATE" and "Erai-raws" follow the existing pattern for release group detection.


614-615: LGTM! Title cleanup handler addition is appropriate.

The new title cleanup handler for "100 years quest" follows the existing pattern for title cleanup.

Copy link
Owner

@dreulavelle dreulavelle left a comment

Choose a reason for hiding this comment

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

looks good!

@dreulavelle dreulavelle merged commit 877585b into dreulavelle:main Dec 6, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants