Fix pylance type errors

also remove class attrs of Registerer.
bump patch version.

Author: danialkeimasi

README.md

@@ -37,25 +37,25 @@ Instead of this, which violates the Open-Closed Principle (OCP):
 ```python
 
 
-def hello(args):
+def hello2(args):
     return "hello to you too"
 
 
-def info(args):
+def info2(args):
     return "how can i help you?"
 
 
-def play(args):
+def play2(args):
     return "let me play a song for you"
 
 
 def command_handler(command, args):
     if command == "hello":
-        return hello(args)
+        return hello2(args)
     if command == "info":
-        return info(args)
+        return info2(args)
     if command == "play":
-        return play(args)
+        return play2(args)
 
 
 command = "info"
@@ -79,10 +79,11 @@ let's create a registry:
 ```python
 
 import abc
+import typing
 
 
 class Animal(abc.ABC):
-    is_wild: bool = None
+    is_wild: typing.Optional[bool] = None
 
     @abc.abstractmethod
     def walk(self):
@@ -117,7 +118,7 @@ class Sheep(Animal):
 
 
 # use your custom slug as unique identifier:
-@animal_registry.register("kitty")
+@animal_registry.register("mamad")
 class Cat(Animal):
     is_wild = False
 
@@ -229,7 +230,7 @@ Here is all the things you can do with the `Registerer` class:
 ### <kbd>class</kbd> `Registerer`
 A utility that can be used to create a registry object to register class or functions. 
 
-<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L22"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L17"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `Registerer.__init__`
 
@@ -266,7 +267,7 @@ get actual registered items as list (classes or functions)
 
 ---
 
-<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L61"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L56"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 #### <kbd>method</kbd> `Registerer.is_registered`
 
@@ -278,12 +279,12 @@ is the slug registered?
 
 ---
 
-<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L125"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L120"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 #### <kbd>method</kbd> `Registerer.register`
 
 ```python
-register(item_or_custom_slug: Union[~T, str] = None, **kwargs)
+register(item_or_custom_slug: Optional[~T, str] = None, **kwargs)
 ```
 
 register a class or item to the registry 
@@ -321,7 +322,7 @@ assert postgresql_connection.env == "prod"
 
 ---
 
-<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L76"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/danialkeimasi/python-registerer/tree/main/registerer/registry.py#L71"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 #### <kbd>method</kbd> `Registerer.validate`
 

docgen/README.py

@@ -37,25 +37,25 @@ def play(args):
 """
 
 
-def hello(args):
+def hello2(args):
     return "hello to you too"
 
 
-def info(args):
+def info2(args):
     return "how can i help you?"
 
 
-def play(args):
+def play2(args):
     return "let me play a song for you"
 
 
 def command_handler(command, args):
     if command == "hello":
-        return hello(args)
+        return hello2(args)
     if command == "info":
-        return info(args)
+        return info2(args)
     if command == "play":
-        return play(args)
+        return play2(args)
 
 
 command = "info"
@@ -79,10 +79,11 @@ def command_handler(command, args):
 """
 
 import abc
+import typing
 
 
 class Animal(abc.ABC):
-    is_wild: bool = None
+    is_wild: typing.Optional[bool] = None
 
     @abc.abstractmethod
     def walk(self):
@@ -117,7 +118,7 @@ def walk(self):
 
 
 # use your custom slug as unique identifier:
-@animal_registry.register("kitty")
+@animal_registry.register("mamad")
 class Cat(Animal):
     is_wild = False
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "registerer"
-version = "0.4.2"
+version = "0.4.3"
 description = "Everything you need to implement maintainable and easy to use registry patterns in your project."
 authors = ["Danial Keimasi <danialkeimasi@gmail.com>"]
 license = "MIT"

registerer/registry.py

@@ -8,17 +8,12 @@
 )
 from registerer.validators import RegistryValidator
 
-T = typing.TypeVar("T")
+T = typing.TypeVar("T", typing.Type, typing.Any)
 
 
 class Registerer(typing.Generic[T]):
     """A utility that can be used to create a registry object to register class or functions."""
 
-    _registry_dict: typing.Dict[str, T] = None
-    parent_class: typing.Optional[T] = None
-    max_size: typing.Optional[int] = None
-    validators: typing.Optional[typing.List] = None
-
     def __init__(
         self,
         parent_class: typing.Optional[T] = None,
@@ -39,10 +34,10 @@ def __init__(
         Raises:
             RegistryCreationError: Can't create proper registry object.
         """
-        self._registry_dict = {}
-        self.parent_class = parent_class if parent_class else self.parent_class
-        self.max_size = max_size
-        self.validators = (validators if validators else []) + (self.validators if self.validators else [])
+        self._registry_dict: typing.Dict[str, T] = {}
+        self.parent_class: typing.Optional[T] = parent_class
+        self.max_size: typing.Optional[int] = max_size
+        self.validators: typing.List = validators if validators else []
 
         if self.max_size is not None and (not isinstance(self.max_size, int) or self.max_size <= 0):
             raise RegistryCreationError("max_size should be a int bigger than zero or None.")
@@ -94,7 +89,7 @@ def validate(self, item: T):
         for validator in self.validators:
             validator(item)
 
-    def __register(self, custom_slug: str = None, **kwargs):
+    def __register(self, custom_slug: typing.Optional[str] = None, **kwargs):
         """the inner function that handles register
 
         Args:
@@ -122,7 +117,7 @@ def _wrapper_function(item: T):
 
         return _wrapper_function
 
-    def register(self, item_or_custom_slug: typing.Union[T, str] = None, **kwargs):
+    def register(self, item_or_custom_slug: typing.Optional[typing.Union[T, str]] = None, **kwargs):
         """register a class or item to the registry
         example:
 
@@ -158,7 +153,7 @@ def postgresql_connection:
         if item_or_custom_slug is not None and kwargs == {} and not isinstance(item_or_custom_slug, str):
             # register function is not called,
             # and item_or_custom_slug is a item (function or class).
-            return self.__register()(item_or_custom_slug)
+            return self.__register()(typing.cast(T, item_or_custom_slug))
 
         if item_or_custom_slug is None and kwargs == {}:
             # unnecessary call
@@ -168,7 +163,7 @@ def postgresql_connection:
             )
 
         # item_or_custom_slug is a custom_slug
-        return self.__register(item_or_custom_slug, **kwargs)
+        return self.__register(typing.cast(str, item_or_custom_slug), **kwargs)
 
     def __repr__(self) -> str:
         parent = f"{self.parent_class.__name__}" if self.parent_class else ""

registerer/validators.py

@@ -10,7 +10,7 @@ class RegistryValidator:
 
     """
 
-    def __init__(self, validator, *, error: str = None) -> None:
+    def __init__(self, validator, *, error: typing.Optional[str] = None) -> None:
         self.validator = validator
         self.error = error
 

tests/test_validators.py

@@ -22,7 +22,7 @@ class Foo:
         with self.assertRaises(RegistrationError):
 
             @registry.register("no")
-            class Foo:
+            class Foo2:
                 pass