Merge pull request #93 from jenskeiner/feature/prek

Feature/prek

Author: jenskeiner

.gitignore

@@ -20,6 +20,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -49,7 +50,6 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
-cover/
 
 # Translations
 *.mo
@@ -72,7 +72,6 @@ instance/
 docs/_build/
 
 # PyBuilder
-.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -83,9 +82,7 @@ profile_default/
 ipython_config.py
 
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -94,30 +91,7 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# UV
-#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#uv.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
 
 # Celery stuff
@@ -154,29 +128,12 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
-# PyPI configuration file
-.pypirc
-
-# Configuration file.
-lintr.yml
-
-support/docs/external/
-
-# VS Code
-.vscode
-
-# Windsurf
-scratchpad.md
+# Ruff linter cache
+.ruff_cache

.pre-commit-config.yaml

@@ -1,4 +1,16 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: end-of-file-fixer
+      - id: check-json
+      - id: check-toml
+      - id: check-symlinks
+      - id: check-executables-have-shebangs
+      - id: mixed-line-ending
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.21.2
     hooks:

README.md

@@ -1,12 +1,12 @@
 # exchange-calendars-extensions-api
-This package contains parts of the API of 
+This package contains parts of the API of
 [exchange-calendars-extensions](https://pypi.org/project/exchange-calendars-extensions/).
 
-To separate the API from the implementation, the API is defined in a separate distribution package 
-[exchange-calendars-extensions-api](https://pypi.org/project/exchange-calendars-extensions_api/), i.e. this package, 
+To separate the API from the implementation, the API is defined in a separate distribution package
+[exchange-calendars-extensions-api](https://pypi.org/project/exchange-calendars-extensions_api/), i.e. this package,
 that contains the sub-package `exchange_calendars_extensions.api`.
 
-The implementation has been moved to the sub-package `exchange_calendars_extensions.core` and is distributed via 
+The implementation has been moved to the sub-package `exchange_calendars_extensions.core` and is distributed via
 [exchange-calendars-extensions](https://pypi.org/project/exchange-calendars-extensions/).
 
 The package `exchange_calendars_extensions` is now a namespace package that wraps the sub-packages.

pyproject.toml

@@ -1,13 +1,19 @@
+[build-system]
+requires = ["hatchling>=1.21.1", "hatch-env-plus>=1.0.0"]
+build-backend = "hatchling.build"
+
 [project]
 name = "exchange-calendars-extensions-api"
 dynamic = ["version"]
 description = "A package that defines parts of the API of the exchange-calendars-extensions package."
+license = "Apache-2.0"
+license-files = ["LICENSE"]
 authors = [
     { name = "Jens Keiner", email = "jens.keiner@gmail.com" }
 ]
 readme = "README.md"
 requires-python = ">=3.10"
-license = { text = "Apache-2.0" }
+keywords = ["exchange", "calendar", "trading", "holidays"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python",
@@ -44,9 +50,9 @@ dev = [
     "pre-commit>=4,<5"
 ]
 
-[build-system]
-requires = ["hatchling>=1.21.1", "hatch-env-plus>=0.1.0"]
-build-backend = "hatchling.build"
+[tool.hatch.version]
+source = "env-plus"
+variable = "PACKAGE_VERSION"
 
 [tool.hatch.build.targets.sdist]
 include = [
@@ -62,10 +68,6 @@ exclude = [
 sources = ["src"]
 only-include = ["src/exchange_calendars_extensions"]
 
-[tool.hatch.version]
-source = "env-plus"
-variable = "PACKAGE_VERSION"
-
 [tool.pytest.ini_options]
-addopts = "--cov=exchange_calendars_extensions.api --cov-report=term-missing --cov-report=html"
+addopts = "--cov=exchange_calendars_extensions.api --cov-report=term-missing"
 testpaths = ["tests"]

src/exchange_calendars_extensions/api/changes.py

@@ -2,7 +2,8 @@
 import functools
 from collections import OrderedDict
 from enum import Enum, unique
-from typing import Union, Annotated, Callable
+from typing import Union, Annotated
+from collections.abc import Callable
 
 import pandas as pd
 from pydantic import (
@@ -18,13 +19,12 @@
     ConfigDict,
 )
 from typing_extensions import (
-    Literal,
     Any,
     Self,
-    Concatenate,
     ParamSpec,
     TypeVar,
 )
+from typing import Literal, Concatenate
 
 
 @unique
@@ -155,7 +155,7 @@ def __str__(self):
         return f'{{type={self.type.name}, name="{self.name}"}}'
 
 
-def _to_time(value: Union[dt.time, str]):
+def _to_time(value: dt.time | str):
     """
     Convert value to time.
 
@@ -230,7 +230,7 @@ class DayMeta(BaseModel, validate_assignment=True, extra="forbid"):
     tags: Tags = []
 
     # Free-form comment.
-    comment: Union[str, None] = Field(default=None, examples=["This is a comment."])
+    comment: str | None = Field(default=None, examples=["This is a comment."])
 
     @model_validator(mode="after")
     def _canonicalize(self) -> "DayMeta":
@@ -459,7 +459,7 @@ def set_tags(self, meta: DayMeta, tags: Tags) -> DayMeta:
 
     @_with_meta
     @validate_call
-    def set_comment(self, meta: DayMeta, comment: Union[str, None]) -> DayMeta:
+    def set_comment(self, meta: DayMeta, comment: str | None) -> DayMeta:
         """
         Set the comment for a given day.
 
@@ -482,7 +482,7 @@ def set_comment(self, meta: DayMeta, comment: Union[str, None]) -> DayMeta:
 
     @_with_meta
     @validate_call
-    def set_meta(self, meta: DayMeta, meta0: Union[DayMeta, None]) -> DayMeta:
+    def set_meta(self, meta: DayMeta, meta0: DayMeta | None) -> DayMeta:
         """
         Set the metadata for a given day.
 

tests/test_changes.py

@@ -293,7 +293,7 @@ def test_set_tags_to_none(self):
 
     @pytest.mark.parametrize(["date"], to_args(VALID_DATES))
     @pytest.mark.parametrize(["comment"], to_args(VALID_COMMENTS))
-    def test_set_comment(self, date: DateLike, comment: Union[str, None]):
+    def test_set_comment(self, date: DateLike, comment: str | None):
         cs = ChangeSet()
         cs.set_comment(date, comment)