frequenz-core 1.1.0__tar.gz → 1.2.0__tar.gz

{frequenz_core-1.1.0/src/frequenz_core.egg-info → frequenz_core-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-core
-Version: 1.1.0
+Version: 1.2.0
 Summary: Core utilities to complement Python's standard library
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -25,7 +25,7 @@ Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
 Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.6.6; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.6.11; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
 Requires-Dist: black==25.1.0; extra == "dev-formatting"
@@ -36,14 +36,14 @@ Requires-Dist: black==25.1.0; extra == "dev-mkdocs"
 Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.6.16; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.3.9; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.18; extra == "dev-mkdocs"
 Requires-Dist: mkdocstrings[python]==0.30.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.17.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
 Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
 Requires-Dist: mypy==1.17.1; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.8.0.20250708; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.8.0.20250809; extra == "dev-mypy"
 Requires-Dist: frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
 Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
@@ -52,12 +52,12 @@ Provides-Extra: dev-pylint
 Requires-Dist: frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
 Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: pylint==3.3.7; extra == "dev-pytest"
+Requires-Dist: pylint==3.3.8; extra == "dev-pytest"
 Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
 Requires-Dist: pytest-mock==3.14.1; extra == "dev-pytest"
 Requires-Dist: pytest-asyncio==1.1.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
-Requires-Dist: hypothesis==6.138.2; extra == "dev-pytest"
+Requires-Dist: hypothesis==6.138.11; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-core[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 Dynamic: license-file

frequenz_core-1.2.0/RELEASE_NOTES.md

@@ -0,0 +1,41 @@
+# Frequenz Core Library Release Notes
+
+## Summary
+
+## New Features
+
+* `frequenz.core.enum` now provides a `@unique` decorator that is aware of deprecations, and will only check for uniqueness among non-deprecated enum members.
+
+    For example this works:
+
+    ```py
+    >>> from frequenz.core.enum import DeprecatedMember, Enum, unique
+    >>> 
+    >>> @unique
+    ... class Status(Enum):
+    ...     ACTIVE = 1
+    ...     INACTIVE = 2
+    ...     PENDING = DeprecatedMember(1, "PENDING is deprecated, use ACTIVE instead")
+    ... 
+    >>> 
+    ```
+
+    While using the standard library's `enum.unique` decorator raises a `ValueError`:
+
+    ```py
+    >>> from enum import unique
+    >>> from frequenz.core.enum import DeprecatedMember, Enum
+    >>> 
+    >>> @unique
+    ... class Status(Enum):
+    ...     ACTIVE = 1
+    ...     INACTIVE = 2
+    ...     PENDING = DeprecatedMember(1, "PENDING is deprecated, use ACTIVE instead")
+    ... 
+    Traceback (most recent call last):
+      File "<stdin>", line 1, in <module>
+      File "/usr/lib/python3.12/enum.py", line 1617, in unique
+        raise ValueError('duplicate values found in %r: %s' %
+    ValueError: duplicate values found in <enum 'Status'>: PENDING -> ACTIVE
+    >>> 
+    ```

{frequenz_core-1.1.0 → frequenz_core-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@
 [build-system]
 requires = [
   "setuptools == 80.9.0",
-  "setuptools_scm[toml] == 8.3.1",
+  "setuptools_scm[toml] == 9.2.0",
   "frequenz-repo-config[lib] == 0.13.5",
 ]
 build-backend = "setuptools.build_meta"
@@ -49,7 +49,7 @@ dev-flake8 = [
   "flake8 == 7.3.0",
   "flake8-docstrings == 1.7.0",
   "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.6.6",
+  "pydoclint == 0.6.11",
   "pydocstyle == 6.3.0",
 ]
 dev-formatting = ["black == 25.1.0", "isort == 6.0.1"]
@@ -59,15 +59,15 @@ dev-mkdocs = [
   "mike == 2.1.3",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.2",
-  "mkdocs-macros-plugin == 1.3.7",
-  "mkdocs-material == 9.6.16",
+  "mkdocs-macros-plugin == 1.3.9",
+  "mkdocs-material == 9.6.18",
   "mkdocstrings[python] == 0.30.0",
-  "mkdocstrings-python == 1.17.0",
+  "mkdocstrings-python == 1.18.2",
   "frequenz-repo-config[lib] == 0.13.5",
 ]
 dev-mypy = [
   "mypy == 1.17.1",
-  "types-Markdown == 3.8.0.20250708",
+  "types-Markdown == 3.8.0.20250809",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
@@ -79,12 +79,12 @@ dev-pylint = [
 ]
 dev-pytest = [
   "pytest == 8.4.1",
-  "pylint == 3.3.7", # We need this to check for the examples
+  "pylint == 3.3.8", # We need this to check for the examples
   "frequenz-repo-config[extra-lint-examples] == 0.13.5",
   "pytest-mock == 3.14.1",
   "pytest-asyncio == 1.1.0",
   "async-solipsism == 0.8",
-  "hypothesis == 6.138.2",
+  "hypothesis == 6.138.11",
 ]
 dev = [
   "frequenz-core[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

{frequenz_core-1.1.0 → frequenz_core-1.2.0}/src/frequenz/core/enum.py

@@ -205,3 +205,61 @@ else:
 
         __deprecated_names__: ClassVar[Mapping[str, str]]
         __deprecated_value_map__: ClassVar[Mapping[Self, str]]
+
+
+def unique(enumeration: type[EnumT]) -> type[EnumT]:
+    """Class decorator for enums that ensures unique non-deprecated values.
+
+    This works similarly to [`@enum.unique`][enum.unique], but it only enforces
+    uniqueness for members that are not deprecated. This allows deprecated members to
+    be aliases for non-deprecated members without causing a `ValueError`.
+
+    If you need strict uniqueness for all deprecated and non-deprecated members, use
+    [`@enum.unique`][enum.unique] instead.
+
+    Example:
+        ```python
+        from frequenz.core.enum import Enum, DeprecatedMember, unique
+
+        @unique
+        class TaskStatus(Enum):
+            OPEN = 1
+            IN_PROGRESS = 2
+            # This is okay, as PENDING is a deprecated alias.
+            PENDING = DeprecatedMember(1, "Use OPEN instead")
+        ```
+
+    Args:
+        enumeration: The enum class to decorate.
+
+    Returns:
+        The decorated enum class.
+
+    Raises:
+        ValueError: If duplicate values are found among non-deprecated members.
+    """
+    # Retrieve the map of deprecated names created by the metaclass.
+    deprecated_names = enumeration.__dict__.get("__deprecated_names__", {})
+
+    duplicates = []
+    seen_values: dict[Any, str] = {}
+    for member_name, member in enumeration.__members__.items():
+        # Ignore members that are marked as deprecated.
+        if member_name in deprecated_names:
+            continue
+
+        value = member.value
+        if value in seen_values:
+            duplicates.append((member_name, seen_values[value]))
+        else:
+            seen_values[value] = member_name
+
+    if duplicates:
+        alias_details = ", ".join(
+            f"{name!r} -> {alias!r}" for name, alias in duplicates
+        )
+        raise ValueError(
+            f"duplicate values found in {enumeration.__name__}: {alias_details}"
+        )
+
+    return enumeration

{frequenz_core-1.1.0 → frequenz_core-1.2.0/src/frequenz_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-core
-Version: 1.1.0
+Version: 1.2.0
 Summary: Core utilities to complement Python's standard library
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -25,7 +25,7 @@ Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
 Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.6.6; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.6.11; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
 Requires-Dist: black==25.1.0; extra == "dev-formatting"
@@ -36,14 +36,14 @@ Requires-Dist: black==25.1.0; extra == "dev-mkdocs"
 Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.6.16; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.3.9; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.18; extra == "dev-mkdocs"
 Requires-Dist: mkdocstrings[python]==0.30.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.17.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
 Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
 Requires-Dist: mypy==1.17.1; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.8.0.20250708; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.8.0.20250809; extra == "dev-mypy"
 Requires-Dist: frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
 Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
@@ -52,12 +52,12 @@ Provides-Extra: dev-pylint
 Requires-Dist: frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
 Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: pylint==3.3.7; extra == "dev-pytest"
+Requires-Dist: pylint==3.3.8; extra == "dev-pytest"
 Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
 Requires-Dist: pytest-mock==3.14.1; extra == "dev-pytest"
 Requires-Dist: pytest-asyncio==1.1.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
-Requires-Dist: hypothesis==6.138.2; extra == "dev-pytest"
+Requires-Dist: hypothesis==6.138.11; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-core[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 Dynamic: license-file

{frequenz_core-1.1.0 → frequenz_core-1.2.0}/src/frequenz_core.egg-info/requires.txt

@@ -7,7 +7,7 @@ frequenz-core[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pyli
 flake8==7.3.0
 flake8-docstrings==1.7.0
 flake8-pyproject==1.2.3
-pydoclint==0.6.6
+pydoclint==0.6.11
 pydocstyle==6.3.0
 
 [dev-formatting]
@@ -20,15 +20,15 @@ black==25.1.0
 mike==2.1.3
 mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.2
-mkdocs-macros-plugin==1.3.7
-mkdocs-material==9.6.16
+mkdocs-macros-plugin==1.3.9
+mkdocs-material==9.6.18
 mkdocstrings[python]==0.30.0
-mkdocstrings-python==1.17.0
+mkdocstrings-python==1.18.2
 frequenz-repo-config[lib]==0.13.5
 
 [dev-mypy]
 mypy==1.17.1
-types-Markdown==3.8.0.20250708
+types-Markdown==3.8.0.20250809
 frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
@@ -40,9 +40,9 @@ frequenz-core[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
 pytest==8.4.1
-pylint==3.3.7
+pylint==3.3.8
 frequenz-repo-config[extra-lint-examples]==0.13.5
 pytest-mock==3.14.1
 pytest-asyncio==1.1.0
 async-solipsism==0.8
-hypothesis==6.138.2
+hypothesis==6.138.11

frequenz_core-1.1.0/RELEASE_NOTES.md

@@ -1,21 +0,0 @@
-# Frequenz Core Library Release Notes
-
-## New Features
-
-- A new `frequenz.core.enum` module was added, providing a drop-in replacement `Enum` that supports deprecating members.
-
-   Example:
-
-   ```python
-   from frequenz.core.enum import Enum, DeprecatedMember
-
-   class TaskStatus(Enum):
-       OPEN = 1
-       IN_PROGRESS = 2
-       PENDING = DeprecatedMember(1, "PENDING is deprecated, use OPEN instead")
-       DONE = DeprecatedMember(3, "DONE is deprecated, use FINISHED instead")
-       FINISHED = 4
-
-   status1 = TaskStatus.PENDING  # Warns: "PENDING is deprecated, use OPEN instead"
-   assert status1 is TaskStatus.OPEN
-   ```