frequenz-core 1.0.0__tar.gz → 1.0.2__tar.gz

{frequenz_core-1.0.0/src/frequenz_core.egg-info → frequenz_core-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-core
-Version: 1.0.0
+Version: 1.0.2
 Summary: Core utilities to complement Python's standard library
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

frequenz_core-1.0.2/RELEASE_NOTES.md

@@ -0,0 +1,17 @@
+# Frequenz Core Library Release Notes
+
+## Summary
+
+<!-- Here goes a general summary of what this release is about -->
+
+## Upgrading
+
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+
+## New Features
+
+<!-- Here goes the main new features and examples or instructions on how to use them -->
+
+## Bug Fixes
+
+* `BaseId` will now log instead of raising a warning when a duplicate prefix is detected. This is to fix [a problem with code examples](https://github.com/frequenz-floss/frequenz-repo-config-python/issues/421) being tested using sybil and the class being imported multiple times, which caused the exception to be raised. We first tried to use `warn()` but that complicated the building process for all downstream projects, requiring them to add an exception for exactly this warning.

{frequenz_core-1.0.0 → frequenz_core-1.0.2}/src/frequenz/core/id.py

@@ -62,8 +62,11 @@ Example: Creating an ID type with a non-standard name
 '''
 
 
+import logging
 from typing import Any, ClassVar, Self, cast
 
+_logger = logging.getLogger(__name__)
+
 
 class BaseId:
     """A base class for unique identifiers.
@@ -105,17 +108,17 @@ class BaseId:
             **kwargs: Forwarded to the parent's __init_subclass__.
 
         Raises:
-            ValueError: If the `str_prefix` is already registered by another
-                ID type.
             TypeError: If `allow_custom_name` is False and the class name
                 does not end with "Id".
         """
         super().__init_subclass__(**kwargs)
 
         if str_prefix in BaseId._registered_prefixes:
-            raise ValueError(
-                f"Prefix '{str_prefix}' is already registered. "
-                "ID prefixes must be unique."
+            # We want to raise an exception here, but currently can't due to
+            # https://github.com/frequenz-floss/frequenz-repo-config-python/issues/421
+            _logger.warning(
+                "Prefix '%s' is already registered. ID prefixes must be unique.",
+                str_prefix,
             )
         BaseId._registered_prefixes.add(str_prefix)
 

{frequenz_core-1.0.0 → frequenz_core-1.0.2/src/frequenz_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-core
-Version: 1.0.0
+Version: 1.0.2
 Summary: Core utilities to complement Python's standard library
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

frequenz_core-1.0.0/RELEASE_NOTES.md

@@ -1,14 +0,0 @@
-# Frequenz Core Library Release Notes
-
-## Summary
-
-This is the initial release of the Frequenz Core Library, which provides a set of fundamental tools and utilities for Python.
-
-The library currently includes:
-
-- `datetime`: For utilities related to dates and times.
-* `id`: For creating unique system-wide ID types.
-* `math`: For utilities related to math.
-* `typing`: For type annotations and type-checking utilities.
-
-But more tools will be added in the future.