datedict 0.1.1__tar.gz

datedict-0.1.1/.gitignore

@@ -0,0 +1,45 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*.so
+
+# Environments
+.venv/
+venv/
+.env
+.env.*
+
+# Build / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+pip-wheel-metadata/
+.wheelhouse/
+
+# Test / coverage
+.coverage
+.coverage.*
+.cache/
+pytest.cache/
+htmlcov/
+.tox/
+.nox/
+
+# IDE / tooling
+.vscode/
+.idea/
+*.iml
+*.swp
+*.swo
+
+# Logs
+*.log
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project
+.github/
+*.local

datedict-0.1.1/.gitlab-ci.yml

@@ -0,0 +1,51 @@
+stages: [build, test-release, release]
+
+variables:
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+
+build:
+  stage: build
+  image: python:3.11-bookworm
+  script:
+    - python -m pip install -U pip build
+    - python -m build
+  artifacts:
+    paths: [dist/]
+    expire_in: 1 hour
+
+# Publish to TestPyPI on any tag vX.Y.Z
+publish_testpypi:
+  stage: test-release
+  image: python:3.11-bookworm
+  needs: 
+    - job: build
+      artifacts: true
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/'
+  id_tokens:
+    TESTPYPI_ID_TOKEN:
+      aud: testpypi
+  script:
+    - python -m pip install -U twine
+    - twine upload --repository testpypi dist/*
+  environment:
+    name: test-release
+
+# Manual promotion to PyPI
+publish_pypi:
+  stage: release
+  image: python:3.11-bookworm
+  needs: 
+    - job: build
+      artifacts: true
+    - job: publish_testpypi
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/'
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  script:
+    - python -m pip install -U twine
+    - twine upload dist/*
+  environment:
+    name: release

datedict-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lorenzo Guideri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

datedict-0.1.1/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: datedict
+Version: 0.1.1
+Summary: DateDict and YearDict: date-aware dictionary structures
+Project-URL: Homepage, https://github.com/you/datedict
+Project-URL: Issues, https://github.com/you/datedict/issues
+Author-email: Lorenzo Guideri <lorenzo.guideri@dec-energy.ch>
+License: MIT License
+        
+        Copyright (c) 2025 Lorenzo Guideri
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# datedict
+
+`datedict` bundles two data structures: `DateDict` and `YearDict`.
+
+## Install
+```bash
+pip install datedict
+```
+
+## Usage
+
+```python
+from datedict import DateDict, YearDict
+```

datedict-0.1.1/README.md

@@ -0,0 +1,14 @@
+# datedict
+
+`datedict` bundles two data structures: `DateDict` and `YearDict`.
+
+## Install
+```bash
+pip install datedict
+```
+
+## Usage
+
+```python
+from datedict import DateDict, YearDict
+```

datedict-0.1.1/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "datedict"
+version = "0.1.1"
+description = "DateDict and YearDict: date-aware dictionary structures"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "Lorenzo Guideri", email = "lorenzo.guideri@dec-energy.ch" }]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Typing :: Typed"
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/you/datedict"
+Issues = "https://github.com/you/datedict/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/datedict"]
+
+[tool.hatch.build]
+exclude = ["tests", ".github", ".gitignore"]

datedict-0.1.1/src/datedict/DateDict.py

@@ -0,0 +1,137 @@
+from datetime import date
+from decimal import Decimal
+
+from datetime import timedelta
+
+from .common import _to_decimal, _Z
+
+
+class DateDict:
+    def __init__(self, data=dict()):
+        self.data: dict[str, Decimal | None] = data
+
+    def create(self, start_date, end_date, value: Decimal) -> "DateDict":
+        """
+        Create a new graph with a specified range and value.
+        The range is defined by start_date and end_date.
+        If the value is None, it will not be included in the graph.
+        """
+        start = (
+            date.fromisoformat(start_date)
+            if isinstance(start_date, str)
+            else start_date
+        )
+        end = date.fromisoformat(end_date) if isinstance(end_date, str) else end_date
+        self.data = {
+            date.strftime("%Y-%m-%d"): (value if value is not None else None)
+            for date in (
+                start + timedelta(days=i) for i in range((end - start).days + 1)
+            )
+        }
+        return self
+
+    def get(self, key: str, default: Decimal) -> Decimal:
+        """
+        Get the value for a specific date. If the date does not exist, return the default value.
+        The date should be in the format yyyy-mm-dd.
+        If the value is None, return the default value.
+        """
+        return self.data.get(key) or default
+
+    def __getitem__(self, key) -> Decimal | None:
+        return self.data.get(key, None)
+
+    def __setitem__(self, key: str, value) -> None:
+        self.data[key] = value
+
+    def crop(self, start: str | None = None, end: str | None = None) -> "DateDict":
+        """
+        Crop the graph data to a specific range defined by start and end.
+        If any of the parameters is None, it will not filter by that parameter.
+        """
+        if start is None and end is None:
+            return self
+        return DateDict(
+            {
+                k: v
+                for k, v in self.data.items()
+                if (start is None or k >= start) and (end is None or k <= end)
+            }
+        )
+
+    def sum(self: "DateDict") -> Decimal:
+        """
+        Calculate the sum of all values in the graph.
+        If a value is None, it is treated as zero.
+        """
+        return Decimal(
+            sum(value if value is not None else _Z for value in self.data.values())
+        )
+
+    def __add__(self, other: "Decimal | DateDict") -> "DateDict":
+        if isinstance(other, Decimal):
+            return DateDict(
+                {
+                    k: (v + other if v is not None else None)
+                    for k, v in self.data.items()
+                }
+            )
+        else:
+            return DateDict(
+                {
+                    k: ((v + (other.data.get(k) or _Z) if v is not None else None))
+                    for k, v in self.data.items()
+                }
+            )
+
+    def __mul__(self, other: "Decimal | DateDict") -> "DateDict":
+        if isinstance(other, Decimal):
+            return DateDict(
+                {
+                    k: (v * other if v is not None else None)
+                    for k, v in self.data.items()
+                }
+            )
+        elif isinstance(other, DateDict):
+            return DateDict(
+                {
+                    k: ((v * (other.data.get(k) or _Z) if v is not None else None))
+                    for k, v in self.data.items()
+                }
+            )
+
+    def __sub__(self, other: "Decimal | DateDict") -> "DateDict":
+        return self + (other * Decimal(-1))
+
+    def __truediv__(self, other: "Decimal | DateDict") -> "DateDict":
+        if isinstance(other, Decimal):
+            return DateDict(
+                {
+                    k: (v / other if v is not None else None)
+                    for k, v in self.data.items()
+                }
+            )
+        elif isinstance(other, DateDict):
+            return DateDict(
+                {
+                    k: ((v / (other.data.get(k) or _Z) if v is not None else None))
+                    for k, v in self.data.items()
+                }
+            )
+
+    def to_dict(self) -> dict[str, Decimal | None]:
+        """
+        Convert the graph data to a dictionary.
+        This is useful for serialization or returning as a response.
+        """
+        return self.data.copy()
+
+    def average(self) -> Decimal:
+        """
+        Calculate the average of all values in the graph.
+        If there are no valid values, return Decimal(0).
+        """
+        valid_values = [v for v in self.data.values() if v is not None]
+        if not valid_values:
+            return _Z
+        return Decimal(sum(valid_values)) / len(valid_values)

datedict-0.1.1/src/datedict/YearDict.py

@@ -0,0 +1,103 @@
+from decimal import Decimal
+
+from .common import _to_decimal, _Z
+
+
+class YearDict:
+    def __init__(self, start_year=2025, end_year=2025, initial_value: Decimal | int | float = _Z):
+        self.start_year: int = start_year
+        self.end_year: int = end_year
+        iv: Decimal = _to_decimal(initial_value)
+        self.data: dict[int, Decimal] = {y: iv for y in range(self.start_year, self.end_year + 1)}
+
+    def __getitem__(self, year: int) -> Decimal:
+        return self.data[year]
+
+    def __setitem__(self, year: int, value):
+        self.data[int(year)] = _to_decimal(value)
+
+    def override(self, data: dict[int, Decimal | float | int | str]) -> "YearDict":
+        if not data:
+            raise ValueError("Data cannot be empty.")
+        ys = sorted(data.keys())
+        # enforce contiguous coverage
+        if ys != list(range(ys[0], ys[-1] + 1)):
+            raise ValueError("Data must cover all years in the contiguous range.")
+        self.start_year, self.end_year = ys[0], ys[-1]  # inclusive
+        self.data = {
+            y: _to_decimal(data[y]) for y in range(self.start_year, self.end_year + 1)
+        }
+        return self
+
+    def fit(self, start_year: int, end_year: int, initial_value: Decimal = _Z):
+        self.start_year, self.end_year = int(start_year), int(end_year)
+        iv = _to_decimal(initial_value)
+        self.data = {
+            y: _to_decimal(self.data[y]) if y in self.data else iv
+            for y in range(self.start_year, self.end_year + 1)
+        }
+        return self
+
+    def non_negative(self) -> "YearDict":
+        out = YearDict(self.start_year, self.end_year)
+        out.data = {y: (v if v >= _Z else _Z) for y, v in self.data.items()}
+        return out
+
+    def sum(
+        self, start_year: int | None = None, end_year: int | None = None
+    ) -> Decimal:
+        sy = self.start_year if start_year is None else int(start_year)
+        ey = self.end_year if end_year is None else int(end_year)
+        return sum((self.data[y] for y in range(sy, ey + 1) if y in self.data), _Z)
+
+    def __mul__(self, other):
+        result = YearDict(self.start_year, self.end_year)
+        if isinstance(other, (int, float, Decimal)):
+            result.data = {
+                year: Decimal(value) * Decimal(str(other))
+                for year, value in self.data.items()
+            }
+        elif isinstance(other, YearDict):
+            result.data = {
+                year: Decimal(self.data[year]) * Decimal(other.data[year])
+                for year in self.data.keys() & other.data.keys()
+            }
+        else:
+            return NotImplemented
+        return result
+
+    def __rmul__(self, other):
+        return self.__mul__(other)
+
+    def __add__(self, other):
+        result = YearDict(self.start_year, self.end_year)
+        if isinstance(other, (int, float, Decimal)):
+            result.data = {
+                year: value + Decimal(str(other)) for year, value in self.data.items()
+            }
+        elif isinstance(other, YearDict):
+            result.data = {
+                year: Decimal(self.data[year]) + Decimal(other.data[year])
+                for year in self.data.keys() & other.data.keys()
+            }
+        else:
+            return NotImplemented
+        return result
+
+    def __radd__(self, other):
+        return self.__add__(other)
+
+    def __sub__(self, other):
+        return self.__add__(-1 * other)
+
+    def __str__(self):
+        return "\n".join(f"{y}: {v}" for y, v in sorted(self.data.items()))
+
+    def __repr__(self):
+        return f"{self.data!r}"
+
+    def to_array(self):
+        return [self.data[y] for y in range(self.start_year, self.end_year + 1)]
+
+    def to_dict(self):
+        return dict(self.data)

datedict-0.1.1/src/datedict/__init__.py

@@ -0,0 +1,5 @@
+from .DateDict import DateDict
+from .YearDict import YearDict
+
+__all__ = ["DateDict", "YearDict"]
+__version__ = "0.1.1"

datedict-0.1.1/src/datedict/common.py

@@ -0,0 +1,14 @@
+from decimal import Decimal
+
+
+_Z = Decimal("0")
+
+
+def _to_decimal(x) -> Decimal:
+    if isinstance(x, Decimal):
+        return x
+    if isinstance(x, (int, str)):
+        return Decimal(x)
+    if isinstance(x, float):
+        return Decimal(str(x))
+    raise TypeError(f"Unsupported type for Decimal: {type(x)}")