search

dh-tech / undate-python

A Python library for working with fuzzy, partial, or otherwise uncertain dates
Apache License 2.0
8 stars 1 forks source link

preliminary str parse and format methods #90

Closed rlskoeser closed 2 weeks ago

rlskoeser commented 2 months ago

add undate parse and format methods (~ analogous to datetime.strptime and strftime) to allow parsing and formatting dates as strings using any defined formatter class (to be expanded later for more formatting options)

this resolves #87 and is something we can built out for more flexible formatting options later

Summary by CodeRabbit

rlskoeser commented 2 months ago

@coderabbitai full review

coderabbitai[bot] commented 2 months ago
Actions performed Full review triggered.
coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduced enhance the functionality of the date handling system by expanding type support and improving the parsing and formatting capabilities of the Undate and UndateInterval classes. New methods for parsing and formatting date strings have been added, allowing for greater flexibility in handling different date formats. Additionally, tests have been implemented to ensure the correctness of these new features.

Changes

Files Change Summary
src/undate/dateformat/base.py Updated import statements to include Union for enhanced type hinting.
src/undate/dateformat/edtf/formatter.py, src/undate/dateformat/iso8601.py Modified to_string methods to accept both Undate and UndateInterval, adding a new helper method for string conversion.
src/undate/undate.py Introduced parse and format methods for Undate and UndateInterval classes to handle date string conversion.
tests/test_undate.py Added new test cases for parsing and formatting functionalities in Undate and UndateInterval.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Undate
    participant Formatter

    User->>Undate: parse(date_string, format)
    Undate->>Formatter: get appropriate formatter
    Formatter-->>Undate: formatter found
    Undate->>Formatter: call parse method
    Formatter-->>Undate: return Undate/UndateInterval object
    Undate-->>User: return parsed object
sequenceDiagram
    participant User
    participant Undate
    participant Formatter

    User->>Undate: format(format)
    Undate->>Formatter: get appropriate formatter
    Formatter-->>Undate: formatter found
    Undate->>Formatter: call to_string method
    Formatter-->>Undate: return formatted string
    Undate-->>User: return formatted string

Assessment against linked issues

Objective Addressed Explanation
support using different formatters for input and output (#[87]) ✅

🐇 Hopping through the fields so bright,
With new formats to parse, oh what a delight!
From Undate to intervals, we dance with glee,
Formatting dates as easy as can be!
So let’s celebrate this change with cheer,
For a world of dates is finally here! 🌼✨

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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
rlskoeser commented 2 months ago

@coderabbitai full review

coderabbitai[bot] commented 2 months ago
Actions performed Full review triggered.
codecov[bot] commented 2 weeks ago

Codecov Report

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

Please upload report for BASE (feature/edtf-formatter@5668c52). Learn more about missing BASE report.

Files with missing lines Patch % Lines
src/undate/undate.py 93.75% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## feature/edtf-formatter #90 +/- ## ========================================================= Coverage ? 96.94% ========================================================= Files ? 10 Lines ? 458 Branches ? 0 ========================================================= Hits ? 444 Misses ? 14 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.