Merge pull request #1 from mortymacs/development

Rename ABCMeta to ABC, add more tests, support 3.10

Author: mortymacs

.github/workflows/python-test.yml

@@ -13,12 +13,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -36,7 +36,12 @@ jobs:
         black -C abcmeta/
     - name: Lint with pylint
       run: |
-        pylint abcmeta/
+        pylint --disable=consider-using-f-string abcmeta/
     - name: Test
       run: |
-        python test.py
+        PYTHONPATH=. python tests/correct_class_test.py
+        PYTHONPATH=. python tests/incorrect_class_1_test.py |& grep -F "AttributeError: Derived class 'ABCDerived' has not implemented 'method_1' method of the parent class 'ABCParent'"
+        PYTHONPATH=. python tests/incorrect_class_2_test.py |& grep -F "Derived method expected to get 3 parameters but gets 2"
+        PYTHONPATH=. python tests/incorrect_class_3_test.py |& grep -F "Derived method expected to get 'name:<class 'str'>' paramter's type, but gets 'name:<class 'int'>'"
+        PYTHONPATH=. python tests/incorrect_class_4_test.py |& grep -F "Derived method expected to get 'name' paramter, but gets 'family'"
+        PYTHONPATH=. python tests/incorrect_class_5_test.py |& grep -F "Derived method expected to return in 'typing.Dict[str, str]' type, but returns 'typing.Dict[str, int]'"

abcmeta/__init__.py

@@ -13,7 +13,7 @@
 from difflib import ndiff
 from typing import Any, Callable, List, Optional, Text, Tuple, Type
 
-__all__ = ["ABCMeta", "abstractmethod"]
+__all__ = ["ABC", "abstractmethod"]
 
 
 def _get_signature(method: Callable) -> Tuple[Type, List[Tuple[Text, Type]], Text]:
@@ -133,8 +133,8 @@ def abstractmethod(funcobj: Callable) -> Callable:
 
 
 # pylint: disable=too-few-public-methods
-class ABCMeta(metaclass=BuiltinABCMeta):
-    """Abstract base meta class."""
+class ABC(metaclass=BuiltinABCMeta):
+    """Abstract base class"""
 
     def __init_subclass__(cls):
         """Python built-in method."""

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="abcmeta",
-    version="1.0.2",
+    version="2.0.0",
     author="Morteza NourelahiAlamdari",
     author_email="[email protected]",
     description="Python meta class and abstract method library with restrictions.",
@@ -16,6 +16,7 @@
     project_urls={"Bug Tracker": "https://github.com/mortymacs/abcmeta/issues"},
     classifiers=[
         "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.7",

test.py tests/correct_class_test.py

@@ -1,10 +1,10 @@
 """Unit test for abcmeta library."""
 from typing import Dict, Text, Tuple
 
-from abcmeta import ABCMeta, abstractmethod
+from abcmeta import ABC, abstractmethod
 
 
-class ABCMetaParent(ABCMeta):
+class ABCParent(ABC):
     @abstractmethod
     def method_1(self, name, age):
         pass
@@ -21,7 +21,7 @@ def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
         """Abstract method."""
 
 
-class ABCMetaDerived(ABCMetaParent):
+class ABCMetaDerived(ABCParent):
     def method_1(self, name, age):
         pass
 

tests/incorrect_class_1_test.py

@@ -0,0 +1,32 @@
+"""Test for abcmeta library.
+
+incompleted derived class.
+"""
+from typing import Dict, Text, Tuple
+
+from abcmeta import ABC, abstractmethod
+
+
+class ABCParent(ABC):
+    @abstractmethod
+    def method_1(self, name, age):
+        pass
+
+    @abstractmethod
+    def method_2(self, name: Text, age: int) -> Dict[Text, Text]:
+        """Abstract method."""
+
+    def method_3(self):
+        pass
+
+    @abstractmethod
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        """Abstract method."""
+
+
+class ABCDerived(ABCParent):
+    def method(self, name):
+        pass
+
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        return ("name", "test")

tests/incorrect_class_2_test.py

@@ -0,0 +1,35 @@
+"""Test for abcmeta library.
+
+incompleted parameters in the derived class.
+"""
+from typing import Dict, Text, Tuple
+
+from abcmeta import ABC, abstractmethod
+
+
+class ABCParent(ABC):
+    @abstractmethod
+    def method_1(self, name, age):
+        pass
+
+    @abstractmethod
+    def method_2(self, name: Text, age: int) -> Dict[Text, Text]:
+        """Abstract method."""
+
+    def method_3(self):
+        pass
+
+    @abstractmethod
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        """Abstract method."""
+
+
+class ABCDerived(ABCParent):
+    def method_1(self, name):
+        pass
+
+    def method_2(self, name: Text, age: int) -> Dict[Text, Text]:
+        return {"name": "test"}
+
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        return ("name", "test")

tests/incorrect_class_3_test.py

@@ -0,0 +1,35 @@
+"""Test for abcmeta library.
+
+different parameter type in the derived class.
+"""
+from typing import Dict, Text, Tuple
+
+from abcmeta import ABC, abstractmethod
+
+
+class ABCParent(ABC):
+    @abstractmethod
+    def method_1(self, name, age):
+        pass
+
+    @abstractmethod
+    def method_2(self, name: Text, age: int) -> Dict[Text, Text]:
+        """Abstract method."""
+
+    def method_3(self):
+        pass
+
+    @abstractmethod
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        """Abstract method."""
+
+
+class ABCDerived(ABCParent):
+    def method_1(self, name, age):
+        pass
+
+    def method_2(self, name: int, age: int) -> Dict[Text, Text]:
+        return {"name": "test"}
+
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        return ("name", "test")

tests/incorrect_class_4_test.py

@@ -0,0 +1,35 @@
+"""Test for abcmeta library.
+
+different parameter name in the derived class.
+"""
+from typing import Dict, Text, Tuple
+
+from abcmeta import ABC, abstractmethod
+
+
+class ABCParent(ABC):
+    @abstractmethod
+    def method_1(self, name, age):
+        pass
+
+    @abstractmethod
+    def method_2(self, name: Text, age: int) -> Dict[Text, Text]:
+        """Abstract method."""
+
+    def method_3(self):
+        pass
+
+    @abstractmethod
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        """Abstract method."""
+
+
+class ABCDerived(ABCParent):
+    def method_1(self, name, age):
+        pass
+
+    def method_2(self, name: str, age: int) -> Dict[Text, Text]:
+        return {"name": "test"}
+
+    def method_4(self, family: Text, age: int) -> Tuple[Text, Text]:
+        return ("name", "test")

tests/incorrect_class_5_test.py

@@ -0,0 +1,35 @@
+"""Test for abcmeta library.
+
+different return type in the derived class.
+"""
+from typing import Dict, Text, Tuple
+
+from abcmeta import ABC, abstractmethod
+
+
+class ABCParent(ABC):
+    @abstractmethod
+    def method_1(self, name, age):
+        pass
+
+    @abstractmethod
+    def method_2(self, name: Text, age: int) -> Dict[Text, Text]:
+        """Abstract method."""
+
+    def method_3(self):
+        pass
+
+    @abstractmethod
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        """Abstract method."""
+
+
+class ABCDerived(ABCParent):
+    def method_1(self, name, age):
+        pass
+
+    def method_2(self, name: Text, age: int) -> Dict[Text, int]:
+        return {"name": "test"}
+
+    def method_4(self, name: Text, age: int) -> Tuple[Text, Text]:
+        return ("name", "test")