Use numpy datetime64 instead of datetime.date #77

rlskoeser commented 5 months ago

ref #77

new local date object that lets us interact with numpy.datetime64 like a python datetime.date

previous notes

I implemented this as spike to see how hard it would be to use numpy's datetime64 instead of python's builtin datetime.date. Using np.datetime64 gets us way past the year limitation of datetime.date ([2.5e16 BC, 2.5e16 AD] for day-precision dates).

We can make this an optional dependency so you would only install numpy if you need the expanded year range. Making it optional makes the code and the testing more complicated. Do you think numpy as a dependency would be a concern for folks doing e.g web-based projects?

(type check is failing because I haven't bothered updating the types yet)

Summary by CodeRabbit

New Features
- Added a DEVELOPER_NOTES.md file providing comprehensive contribution guidelines and setup instructions.
- Introduced Timedelta and Date classes for enhanced date and time handling.
- Expanded Python version support in testing workflows.
Documentation
- Updated DEVELOPER_NOTES.md with detailed setup and testing instructions.
- Added a new .pythonversion file for specifying the Python version.
Chores
- Transitioned the project configuration to use hatchling as the build system and updated dependency management.

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 encompass updates to several configuration files, workflow definitions, and documentation files for the undate project. Key modifications include updates to the unit test workflow to support new Python versions, the introduction of a .pythonversion file for version management, enhancements to the DEVELOPER_NOTES.md for contributor guidance, and a comprehensive restructuring of the pyproject.toml file to include project metadata and dependencies. Additionally, new classes for date handling have been introduced in the codebase.

Changes

File(s)	Change Summary
`.github/workflows/unit_tests.yml`	Updated Python version to 3.12, expanded job matrix to include 3.13, modified cache path, and changed testing commands from `tox` to `pytest`.
`.pythonversion`	New file created specifying Python version as `Python 3.12.7`.
`DEVELOPER_NOTES.md`	Added detailed instructions for setup, git flow, virtual environment, testing, and documentation building.
`pyproject.toml`	Restructured to use `hatchling`, added project metadata, dependencies, optional dependencies, and URLs.
`src/undate/date.py`	Introduced `Timedelta` and `Date` classes for enhanced date handling, along with a `DatePrecision` enum.
`src/undate/dateformat/base.py`	Replaced `lru_cache` with `cache` for the `import_formatters` method in `BaseDateFormat`.

Possibly related PRs

#88: The changes in the unit tests workflow in the main PR are directly related to the updates in the .github/workflows/unit_tests.yml file in PR #88, which also involves modifications to the testing framework and caching mechanisms.

Suggested reviewers

ColeDCrawford

🐰 In the garden of code, we hop and play,
With new contributors joining the fray.
Workflows updated, and docs refined,
A brighter future for all we find!
So let us celebrate, with joy and cheer,
For every change brings us closer, my dear! 🌼

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.

ColeDCrawford commented 2 months ago

Observations on coderabbit (will keep updating):

It used ruff even though we're using black / flake8. ruff is definitely worth moving too but worth noting that it didn't align with the project's conventions. I think this is going to be one of the negative externalities of gen AI code tools - they will work well on high profile languages / frameworks with lots of existing examples and much less well on those outside of that scope. In this case if you want to use a different formatter or linter that doesn't have support in their agent, then you are SOL.
Memaid sequence diagram generation is cool, if not particularly groundbreaking or even useful here.

rlskoeser commented 2 months ago

I'll update this and reconcile with the other merged PRs, address the flagged comments about type hints, and then do some testing and documentation of benchmarking as suggested before I merge this.

review-notebook-app[bot] commented 1 month ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

rlskoeser commented 1 month ago

@ColeDCrawford I was hoping I could just clean this PR up and merge without further review, but an error in the S&co example notebook caused me to find some problems with how I was handling duration logic in the new numpy-based implementation, which resulted in a bit more substantial change (and effort!) than I'd anticipated. I'm going to tag you for review on the updates.

I've resolved all the coderabbitai comments that I've either addressed or don't care about; one interesting/tricky one left open for now. It flagged a lot of things, which I have mixed feelings about - glad to have things cleaner and in better shape, but it felt like it resulted in more work for me.

FWIW I also went ahead and switched from black to ruff in the pre-commit hook. It doesn't seem to be correcting unused imports automatically, so if you have a set of options you prefer maybe you could open a PR to add them after this is merged.

dh-tech / undate-python