timevec 0.3.2__tar.gz → 0.4.0__tar.gz

timevec-0.4.0/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+branch = True

{timevec-0.3.2 → timevec-0.4.0}/.github/workflows/gitignore-in.yml

@@ -1,16 +1,11 @@
 name: Update gitignore file
-
 on:
   schedule:
     # daily at 00:00
     - cron: '0 0 * * *'
-
 permissions:
   contents: write
   pull-requests: write
-
 jobs:
   update-gitignore:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: gitignore-in/gh-action@v0.2.3
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/gitignore-in.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc

timevec-0.4.0/.github/workflows/happy.yml

@@ -0,0 +1,10 @@
+name: happy-commit
+on:
+  - pull_request
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+jobs:
+  happy:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/happy-commit.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc

{timevec-0.3.2 → timevec-0.4.0}/.github/workflows/octocov.yml

@@ -5,6 +5,10 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
 permissions:
   contents: read
   pull-requests: write
@@ -20,16 +24,19 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Set up Python
         id: setup-python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
         with:
           python-version: "${{ matrix.python }}"
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
 
       - name: Install dependencies
         run: |
@@ -44,7 +51,7 @@ jobs:
 
       # See also: https://github.com/k1LoW/octocov-action
       - name: Report coverage with octocov
-        uses: k1LoW/octocov-action@v1
+        uses: k1LoW/octocov-action@b3b6ee60482a667950f87553abf1df63217235d9 # v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           config: .octocov.yml

timevec-0.4.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,59 @@
+name: Packaging
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  release:
+    # "released" events are emitted either when directly be released or be edited from pre-released.
+    types: [prereleased, released]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.event.release.id || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      attestations: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build
+        run: uv build
+
+      - name: Attest build provenance
+        if: github.event_name == 'release' && !github.event.release.prerelease
+        uses: actions/attest-build-provenance@a2bbfa25375fe432b6a289bc6b6cd05ecd0c4c32 # v4.1.0
+        with:
+          subject-path: dist/*
+
+      - name: Publish distribution to Test PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # release/v1
+        if: github.event_name == 'release' && github.event.release.prerelease
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+      - name: Publish distribution to PyPI
+        if: github.event_name == 'release' && !github.event.release.prerelease
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # release/v1

{timevec-0.3.2 → timevec-0.4.0}/.github/workflows/python-test.yml

@@ -8,21 +8,16 @@ on:
     branches:
       - main
 
-jobs:
-  actionlint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
-      - name: Set up Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: stable
-
-      - name: Run actionlint
-        run: go run github.com/rhysd/actionlint/cmd/actionlint@v1.7.12
+permissions:
+  contents: read
 
+jobs:
+  actionlint:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/actionlint.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc # main
   test:
     runs-on: ubuntu-latest
     strategy:
@@ -31,16 +26,19 @@ jobs:
         python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Set up Python
         id: setup-python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
         with:
           python-version: "${{ matrix.python }}"
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
 
       - name: Install dependencies
         run: |

timevec-0.4.0/.github/workflows/spellcheck.yml

@@ -0,0 +1,8 @@
+name: Spellcheck
+on:
+  - pull_request
+permissions:
+  contents: read
+jobs:
+  check:
+    uses: kitsuyui/gh-actions-workflows/.github/workflows/spellcheck.yml@3717c78af3a5e594b7a81b063276e15fac7e08fc # main

timevec-0.4.0/CHANGELOG.md

@@ -0,0 +1,94 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.2] - 2026-05-03
+
+### Changed
+- Add workflow concurrency groups to CI
+
+## [0.3.1] - 2025-02-01
+
+### Changed
+- Migrate package manager from Poetry to uv
+- Set minimal permissions in CI publish workflow
+- Add actionlint check to CI
+
+### Fixed
+- Fix decade range near datetime minimum
+
+## [0.3.0] - 2024-10-16
+
+### Added
+- Add Python 3.13 support
+
+## [0.2.0] - 2023-10-06
+
+### Added
+- Add Python 3.12 support
+
+## [0.1.7] - 2023-07-17
+
+### Changed
+- Minor refactor: convert comments to docstrings
+
+## [0.1.6] - 2023-02-18
+
+### Added
+- Add `py.typed` marker for PEP 561 compliance
+
+## [0.1.5] - 2023-02-08
+
+### Changed
+- Rewrite vector ↔ time conversion logic
+- Add additional tests for time/vector round-trips
+
+## [0.1.4] - 2023-01-26
+
+### Added
+- Reverse conversion: create datetime from time vector
+- Add tests for many dates
+
+## [0.1.3] - 2023-01-24
+
+### Added
+- Add `numpy.datetime64` vector support
+- Unify date conversion between `builtin_math` and `numpy` submodules
+
+## [0.1.2] - 2023-01-23
+
+### Fixed
+- Fix boundary value bug in edge cases
+
+## [0.1.1] - 2023-01-23
+
+### Changed
+- Abstract common logic across `year_vec`, `month_vec`, `day_vec`, `week_vec`
+- Add figure to README illustrating vector representation
+
+## [0.1.0] - 2023-01-21
+
+### Added
+- Initial release
+- Time vector representation using cos/sin for periodicity
+- `builtin_math` submodule (no NumPy dependency)
+- `numpy` submodule (optional NumPy support)
+
+[Unreleased]: https://github.com/kitsuyui/python-timevec/compare/v0.3.2...HEAD
+[0.3.2]: https://github.com/kitsuyui/python-timevec/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/kitsuyui/python-timevec/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/kitsuyui/python-timevec/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/kitsuyui/python-timevec/compare/v0.1.7...v0.2.0
+[0.1.7]: https://github.com/kitsuyui/python-timevec/compare/v0.1.6...v0.1.7
+[0.1.6]: https://github.com/kitsuyui/python-timevec/compare/v0.1.5...v0.1.6
+[0.1.5]: https://github.com/kitsuyui/python-timevec/compare/v0.1.4...v0.1.5
+[0.1.4]: https://github.com/kitsuyui/python-timevec/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/kitsuyui/python-timevec/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/kitsuyui/python-timevec/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/kitsuyui/python-timevec/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/kitsuyui/python-timevec/releases/tag/v0.1.0

{timevec-0.3.2/timevec.egg-info → timevec-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: timevec
-Version: 0.3.2
+Version: 0.4.0
 Summary: Get some usable vector representations of datetime.
 Author-email: Yui KITSU <kitsuyui+github@kitsuyui.com>
 License: Copyright 2023-2025 Kitsu Yui
@@ -56,15 +56,39 @@ This is called a time vector.
 
 # Installation
 
+The base package has no NumPy dependency and supports
+`timevec.builtin_math`:
+
 ```sh
 pip install timevec
 ```
 
+Install the `numpy` extra when you use `timevec.numpy` or
+`timevec.numpy_datetime64`:
+
+```sh
+pip install "timevec[numpy]"
+```
+
 # Usage
 
+With the base install:
+
+```python
+import datetime
+import timevec.builtin_math as tv
+
+dt = datetime.datetime(2020, 1, 1, 0, 0, 0)
+vec = tv.year_vec(dt)
+# (1.0, 0.0)
+```
+
+With the `numpy` extra:
+
 ```python
-import timevec.numpy as tv
 import datetime
+import timevec.numpy as tv
+
 dt = datetime.datetime(2020, 1, 1, 0, 0, 0)
 vec = tv.year_vec(dt)
 # array([1., 0.])
@@ -130,11 +154,39 @@ You can express periodicity such as morning, noon, and night.
 
 ## Others
 
-- `long_time_vec` ... 1 to 5001 years period
+- `long_time_vec` ... `datetime.min` to `datetime.max` period
 - `millennium_vec` ... one millennium (1000 years) period
 - `century_vec` ... one century (100 years) period
 - `decade_vec` ... one decade (10 years) period
 
+## Development
+
+This repository uses [lefthook](https://lefthook.dev/) to run the same checks as CI
+locally, so problems surface before they reach CI.
+
+```sh
+# Install dependencies
+uv sync
+
+# Install the Git hooks (once; requires lefthook on your PATH)
+lefthook install
+```
+
+Once installed, the hooks run automatically:
+
+- **pre-commit**: `uv run poe check`
+- **pre-push**: `uv run poe check` and `uv run poe test`
+
+You can also run the checks manually:
+
+```sh
+uv run poe check
+uv run poe test
+```
+
+CI still runs the full matrix (see `.github/workflows/`); the hooks only bring that
+feedback earlier on your machine.
+
 # License
 
 BSD 3-Clause License

{timevec-0.3.2 → timevec-0.4.0}/README.md

@@ -22,15 +22,39 @@ This is called a time vector.
 
 # Installation
 
+The base package has no NumPy dependency and supports
+`timevec.builtin_math`:
+
 ```sh
 pip install timevec
 ```
 
+Install the `numpy` extra when you use `timevec.numpy` or
+`timevec.numpy_datetime64`:
+
+```sh
+pip install "timevec[numpy]"
+```
+
 # Usage
 
+With the base install:
+
+```python
+import datetime
+import timevec.builtin_math as tv
+
+dt = datetime.datetime(2020, 1, 1, 0, 0, 0)
+vec = tv.year_vec(dt)
+# (1.0, 0.0)
+```
+
+With the `numpy` extra:
+
 ```python
-import timevec.numpy as tv
 import datetime
+import timevec.numpy as tv
+
 dt = datetime.datetime(2020, 1, 1, 0, 0, 0)
 vec = tv.year_vec(dt)
 # array([1., 0.])
@@ -96,11 +120,39 @@ You can express periodicity such as morning, noon, and night.
 
 ## Others
 
-- `long_time_vec` ... 1 to 5001 years period
+- `long_time_vec` ... `datetime.min` to `datetime.max` period
 - `millennium_vec` ... one millennium (1000 years) period
 - `century_vec` ... one century (100 years) period
 - `decade_vec` ... one decade (10 years) period
 
+## Development
+
+This repository uses [lefthook](https://lefthook.dev/) to run the same checks as CI
+locally, so problems surface before they reach CI.
+
+```sh
+# Install dependencies
+uv sync
+
+# Install the Git hooks (once; requires lefthook on your PATH)
+lefthook install
+```
+
+Once installed, the hooks run automatically:
+
+- **pre-commit**: `uv run poe check`
+- **pre-push**: `uv run poe check` and `uv run poe test`
+
+You can also run the checks manually:
+
+```sh
+uv run poe check
+uv run poe test
+```
+
+CI still runs the full matrix (see `.github/workflows/`); the hooks only bring that
+feedback earlier on your machine.
+
 # License
 
 BSD 3-Clause License

timevec-0.4.0/examples/plot.py

@@ -0,0 +1,58 @@
+# ja: 実際に year_vec がどのような値を返すかのグラフを描き、わかりやすくします。
+
+import datetime
+from collections.abc import Callable
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+import timevec.numpy as tv
+
+
+def plot_func_vec(
+    func: Callable[[datetime.datetime], np.ndarray],
+    dates: list[datetime.datetime],
+) -> None:
+    vecs = np.array([func(dt) for dt in dates])
+    _fig, _ax = plt.subplots()
+    plt.plot(vecs)
+    plt.savefig(f"examples/{func.__name__}.svg")
+
+
+def main() -> None:
+    plot_func_vec(
+        tv.year_vec,
+        dates=[
+            datetime.datetime(2023, 1, 1, 0, 0, 0)
+            + datetime.timedelta(days=day)
+            for day in range(365 * 2)
+        ],
+    )
+    plot_func_vec(
+        tv.month_vec,
+        dates=[
+            datetime.datetime(2023, 1, 1, 0, 0, 0)
+            + datetime.timedelta(days=day)
+            for day in range(31 * 2)
+        ],
+    )
+    plot_func_vec(
+        tv.week_vec,
+        dates=[
+            datetime.datetime(2023, 1, 1, 0, 0, 0)
+            + datetime.timedelta(hours=h)
+            for h in range(24 * 7 * 2)
+        ],
+    )
+    plot_func_vec(
+        tv.day_vec,
+        dates=[
+            datetime.datetime(2023, 1, 1, 0, 0, 0)
+            + datetime.timedelta(hours=h)
+            for h in range(24 * 2)
+        ],
+    )
+
+
+if __name__ == "__main__":
+    main()

timevec-0.4.0/lefthook.yml

@@ -0,0 +1,13 @@
+# Clear Git hook environment variables before running checks so nested or sibling
+# repositories are not affected: https://git-scm.com/docs/githooks
+pre-commit:
+  jobs:
+    - name: check
+      run: for name in $(env | sed -n 's/^\(GIT_[A-Za-z0-9_]*\)=.*/\1/p'); do unset "$name"; done; uv run poe check
+
+pre-push:
+  jobs:
+    - name: check
+      run: for name in $(env | sed -n 's/^\(GIT_[A-Za-z0-9_]*\)=.*/\1/p'); do unset "$name"; done; uv run poe check
+    - name: test
+      run: for name in $(env | sed -n 's/^\(GIT_[A-Za-z0-9_]*\)=.*/\1/p'); do unset "$name"; done; uv run poe test

{timevec-0.3.2 → timevec-0.4.0}/pyproject.toml

@@ -131,3 +131,21 @@ max-complexity = 4
 [tool.mypy]
 strict = true
 ignore_missing_imports = false
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+warn_return_any = false
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "numpy"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "scipy.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "sympy"
+ignore_missing_imports = true

{timevec-0.3.2 → timevec-0.4.0}/tests/test_builtin_math.py

@@ -48,8 +48,14 @@ def assert_range_vector_value(
 ) -> None:
     assert fn(range.begin) == pytest.approx((1.0, 0.0), abs=abs)
     assert fn(range.end_of_first_quarter) == pytest.approx((0.0, 1.0), abs=abs)
-    assert fn(range.end_of_second_quarter) == pytest.approx((-1.0, 0.0), abs=abs)
-    assert fn(range.end_of_third_quarter) == pytest.approx((0.0, -1.0), abs=abs)
+    assert fn(range.end_of_second_quarter) == pytest.approx(
+        (-1.0, 0.0),
+        abs=abs,
+    )
+    assert fn(range.end_of_third_quarter) == pytest.approx(
+        (0.0, -1.0),
+        abs=abs,
+    )
     assert fn(range.end) == pytest.approx((1.0, 0.0), abs=abs)
 
 
@@ -156,6 +162,15 @@ def test_day_vec() -> None:
     assert (x, y) == pytest.approx((1.0, 0.0), abs=1e-6)
 
 
+def test_ratio_to_vec_rejects_nan_and_inf() -> None:
+    with pytest.raises(ValueError, match="finite"):
+        tv.ratio_to_vec(float("nan"))
+    with pytest.raises(ValueError, match="finite"):
+        tv.ratio_to_vec(float("inf"))
+    with pytest.raises(ValueError, match="finite"):
+        tv.ratio_to_vec(float("-inf"))
+
+
 def test_edge_cases() -> None:
     # beginning of year
     dt = datetime.datetime(2023, 1, 1, 0, 0, 0)
@@ -178,3 +193,18 @@ def test_edge_cases() -> None:
     dt = datetime.datetime(2023, 12, 31, 23, 59, 59, 999999)
     x, y = tv.year_vec(dt)
     assert (x, y) == pytest.approx((1.0, 0.0), abs=1e-6)
+
+
+def test_vec_to_ratio_zero_vector_raises() -> None:
+    with pytest.raises(ValueError):
+        tv.vec_to_ratio(0.0, 0.0)
+
+
+def test_datetime_from_vecs_empty_raises() -> None:
+    with pytest.raises(ValueError, match="No recognized time targets"):
+        tv.datetime_from_vecs({})
+
+
+def test_datetime_from_vecs_unrecognized_keys_raises() -> None:
+    with pytest.raises(ValueError, match="No recognized time targets"):
+        tv.datetime_from_vecs({"unknown_key": (0.5, 0.5)})  # type: ignore[dict-item]

{timevec-0.3.2 → timevec-0.4.0}/tests/test_many_dates.py

@@ -23,7 +23,16 @@ def test_many_dates() -> None:
             "week",
             "day",
         ]
-    ] = ["long_time", "millennium", "century", "decade", "year", "month", "week", "day"]
+    ] = [
+        "long_time",
+        "millennium",
+        "century",
+        "decade",
+        "year",
+        "month",
+        "week",
+        "day",
+    ]
     minimal: Iterable[Literal["long_time", "century", "year", "day"]] = [
         "long_time",
         "century",
@@ -57,5 +66,5 @@ def test_many_dates() -> None:
         vecs7 = tv64.datetime64_to_vecs(np.datetime64(dt), minimal)
         tv64.datetime64_from_vecs(vecs7)
 
-    # tested up to 2100-01-01
+    # tested beyond 2400-01-01
     assert dt >= datetime.datetime(2400, 1, 1, 0, 0, 0)

{timevec-0.3.2 → timevec-0.4.0}/tests/test_numpy.py

@@ -11,7 +11,7 @@ def test_long_time_vec() -> None:
     vec = tvn.long_time_vec(dt)
     assert vec == pytest.approx(np.array([1.0, 0.0]), abs=1e-6)
 
-    dt = datetime.datetime(5001, 1, 1, 0, 0, 0)
+    dt = datetime.datetime.max
     vec = tvn.long_time_vec(dt)
     assert vec == pytest.approx(np.array([1.0, 0.0]), abs=1e-6)
 
@@ -139,3 +139,20 @@ def test_edge_cases() -> None:
     dt = datetime.datetime(2023, 1, 31, 23, 59, 59, 999999)
     vec = tvn.month_vec(dt)
     assert vec == pytest.approx(np.array([1.0, 0.0]), abs=1e-5)
+
+
+def test_vec_to_ratio_zero_vector_raises() -> None:
+    with pytest.raises(ValueError):
+        tvn.vec_to_ratio(np.array([0.0, 0.0]))
+
+
+def test_datetime_from_vecs_empty_raises() -> None:
+    with pytest.raises(ValueError, match="No recognized time targets"):
+        tvn.datetime_from_vecs({})
+
+
+def test_datetime_from_vecs_unrecognized_keys_raises() -> None:
+    with pytest.raises(ValueError, match="No recognized time targets"):
+        tvn.datetime_from_vecs(
+            {"unknown_key": np.array([0.5, 0.5])},  # type: ignore[dict-item]
+        )