Skip to content

Log instead of warn when registering an ID prefix that already exists #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 23, 2025
Merged

Log instead of warn when registering an ID prefix that already exists #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

## Bug Fixes

* `BaseId` will now warn instead of raising an exception 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.
* `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.
11 changes: 6 additions & 5 deletions src/frequenz/core/id.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,10 @@ class CustomNameForId(BaseId, str_prefix="CST", allow_custom_name=True):
'''


import logging
from typing import Any, ClassVar, Self, cast
from warnings import warn

_logger = logging.getLogger(__name__)


class BaseId:
Expand Down Expand Up @@ -114,10 +116,9 @@ def __init_subclass__(
if str_prefix in BaseId._registered_prefixes:
# We want to raise an exception here, but currently can't due to
# https://github.com/frequenz-floss/frequenz-repo-config-python/issues/421
warn(
f"Prefix '{str_prefix}' is already registered. "
"ID prefixes must be unique.",
stacklevel=2,
_logger.warning(
"Prefix '%s' is already registered. ID prefixes must be unique.",
str_prefix,
)
BaseId._registered_prefixes.add(str_prefix)

Expand Down
10 changes: 0 additions & 10 deletions tests/test_id.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,6 @@ def test_use_a_subclass() -> None:
BaseId(42)


def test_warn_non_unique_prefix() -> None:
"""Test that using a non-unique prefix raises a warning."""
with pytest.warns(UserWarning, match="Prefix 'TEST_ID' is already registered"):

class _TestDuplicateId(BaseId, str_prefix="TEST_ID"):
"""A duplicate test ID class with the same prefix as _TestId."""

_TestDuplicateId(1)


def test_negative_raises() -> None:
"""Test that creating a negative ID raises ValueError."""
with pytest.raises(ValueError, match="_TestId can't be negative"):
Expand Down
Loading