Skip to content

Improve ModelRegistry item assignment error #254

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

Open
russlan23 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve ModelRegistry item assignment error #254

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
4 changes: 4 additions & 0 deletions ccflow/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,10 @@ def __getitem__(self, item) -> ModelType:
else:
raise KeyError(f"No registered model found by the name '{item}' in registry '{self._debug_name}'")

def __setitem__(self, name: str, model: BaseModel) -> None:
"""Reject item assignment in favor of the registry's controlled API."""
raise TypeError("ModelRegistry does not support item assignment; use the 'add' method instead.")

def __iter__(self):
for key, model in self._models.items():
yield key
Expand Down
9 changes: 9 additions & 0 deletions ccflow/tests/test_base_registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,15 @@ def test_add_twice(self):
self.assertListEqual(m.get_registrations(), [(r, "foo"), (r, "bar"), (r2, "foo2"), (r2, "bar2")])
self.assertListEqual(m.get_registered_names(), ["/foo", "/bar"])

def test_setitem_directs_users_to_add(self):
registry = ModelRegistry(name="test")
model = MyTestModel(a="test", b=0.0)

with self.assertRaisesRegex(TypeError, "use the 'add' method"):
registry["foo"] = model

self.assertEqual(registry.models, {})

def test_add_two_places(self):
m = MyTestModel(a="test", b=0.0)
r1 = ModelRegistry(name="test")
Expand Down