Add support for site & add docs & refactors & cleanup

mhdzumair commented 4 months ago

Summary by CodeRabbit

New Features
- Added more non-English character support for title parsing.
Refactor
- Improved type hints and readability for various functions including extend_options, create_handler_from_regexp, clean_title, and Parser class methods.
Tests
- Updated and added test cases to ensure robustness and accuracy in title parsing, including new tests for site and size detection.

coderabbitai[bot] commented 4 months ago

Walkthrough

The updates enhance the parsett library by refining parsing functions, adding type hints, and improving code readability. New functions and additional non-English character support were integrated. Tests were updated to align with parsing changes, and .gitignore now excludes .idea/ files. Documentation has been improved for clarity.

Changes

File(s)	Change Summary
`.gitignore`	Excluded `.idea/` directory.
`PTT/__init__.py`	Added `parse_title` function and included it in `__all__` list.
`PTT/parse.py`	Refactored functions with type hints, added non-English characters, and improved code readability.
`PTT/transformers.py`	Updated functions with type hints and enhanced logic for better input handling.
`README.md`	Improved documentation and clarified function signatures and usage.
`tests/test_site.py`	Introduced `test_group_detection` for site detection via `PTT.parse_title`.
`tests/test_title.py`	Refactored tests to use `PTT.parse_title` instead of `parser.parse`.
`tests/test_audio.py`	Reformatted parameterization for better readability without changing logic.
`tests/test_size.py`	Added new tests for size detection using `PTT.parse_title`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PTT
    participant Parser
    participant Transformers

    User ->> PTT: Call `parse_title`
    PTT ->> Parser: Initialize and call `parse`
    Parser ->> Transformers: Apply transformers
    Transformers -->> Parser: Return transformed data
    Parser -->> PTT: Return parsed result
    PTT -->> User: Return parsed title as dictionary

Poem

A rabbit hops with code so bright,
Through fields of lines, both day and night.
It parses titles, non-English too,
With type hints guiding what to do.
Now tests align, the code refined,
In this update, improvements shine.
A leap ahead, with joy anew! 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

dreulavelle commented 4 months ago

I've changed so much stuff on my own, as I was also working on a large commit lol. I've taken a lot of stuff out as well from here as I had already started working on it before the PR.

How are things running for you currently though? I am currently adding more handlers as well

mhdzumair commented 4 months ago

Cool. I'm almost done with the changes and ready to release the changes for MediaFusion. Its working great. There are some slightly off case scenarios like typos in the naming conventions, ex:

"www,1TamilMV.phd - The Great Indian Suicide (2023) Tamil TRUE WEB-DL - 4K SDR - HEVC - (DD+5.1 - 384Kbps & AAC) - 3.2GB - ESub.mkv"
"ww.Tamilblasters.sbs - 8 Bit Christmas (2021) HQ HDRip - x264 - Telugu (Fan Dub) - 400MB].mkv"
"www.1TamilMV.pics - 777 Charlie (2022) Tamil HDRip - 720p - x264 - HQ Clean Aud - 1.4GB.mkv"

1, 2 having typos in the URL. But 3rd one, not sure what's wrong with. The title should be 777 Charlie however it's parsing as '777 Charlie Tamil - - - - .'

dreulavelle commented 4 months ago

Ah yes, I can work on these

dreulavelle commented 4 months ago

alright I've merged my changes and changes from this into main, so we should be roughly on the same page now

dreulavelle commented 4 months ago

If I missed something, just submit a new PR. I'll handle the next PR better lol. Apologies!

dreulavelle commented 4 months ago

I do have more stuff coming possibly as I'm trying to migrate some things from PTN over to this so that we can support everything. I've gotta work on RTN changes now, I have a large update coming for that as well.

dreulavelle / PTT