Skip to content

Commit

Permalink
standardise aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
dbogunowicz committed Jan 18, 2024
1 parent b363dea commit d34ad2a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
12 changes: 12 additions & 0 deletions src/sparsezoo/utils/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,17 @@ def standardize_lookup_name(name: str) -> str:
return name.replace("_", "-").replace(" ", "-").lower()


def standardize_alias_name(
name: Union[None, str, List[str]]
) -> Union[None, str, List[str]]:
if name is None:
return None
elif isinstance(name, str):
return standardize_lookup_name(name)
else: # isinstance(name, list)
return [standardize_lookup_name(n) for n in name]


class RegistryMixin:
"""
Universal registry to support registration and loading of child classes and plugins
Expand Down Expand Up @@ -210,6 +221,7 @@ def register(
name = value.__name__

name = standardize_lookup_name(name)
alias = standardize_alias_name(alias)
register_alias(name=name, alias=alias, parent_class=parent_class)

if require_subclass:
Expand Down
4 changes: 2 additions & 2 deletions tests/sparsezoo/utils/test_registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class Foo1(foo):
pass

assert {"foo1"} == set(foo.registered_names())
assert {"name-3", "name_4"} == set(foo.registered_aliases())
assert {"name-3", "name-4"} == set(foo.registered_aliases())

def test_key_error_on_duplicate_alias(self, foo):
# once we register an object under one alias, we can't
Expand Down Expand Up @@ -111,7 +111,7 @@ class Foo1(foo):
pass

assert {"name-2"} == set(foo.registered_names())
assert {"name-3", "name_4"} == set(foo.registered_aliases())
assert {"name-3", "name-4"} == set(foo.registered_aliases())

def test_get_value_from_registry(self, foo):
@foo.register(alias=["name-3"])
Expand Down

0 comments on commit d34ad2a

Please sign in to comment.