Merge pull request #56 from jepperaskdk/pr/module-class-clash

Fix module and class name clash

changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.2.1] - 2024-08-26
+
+### Added
+
+- Fixed bug where module and class name-clash would cause the wrong type to be compared.
+
 ## [0.2.0] - 2024-08-09
 
 ### Added

pydoctest/utilities.py

@@ -41,7 +41,7 @@ def get_type_from_module(type_string: str, module: ModuleType) -> LocateResult:
     """
     # First let pydoc attempt to locate the type
     located_type: Type = cast(Type, locate(type_string))
-    if located_type:
+    if located_type and not isinstance(located_type, ModuleType):
         return LocateResult(located_type, 'locate')
 
     # Try to eval it.

pydoctest/version.py

@@ -1 +1 @@
-VERSION = "0.2.0"
+VERSION = "0.2.1"

tests/test_class/method_with_module.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+
+
+def method_module_class_clash(date: datetime) -> datetime:
+    """
+    This should work.
+
+    Args:
+        date (datetime): The date.
+
+    Returns:
+        datetime: [description]
+    """
+    return date

tests/test_class/test_class.py

@@ -6,6 +6,7 @@
 import tests.test_class.nodocstring_class
 import tests.test_class.incorrect_class
 import tests.test_class.raises_class
+import tests.test_class.method_with_module
 
 
 class TestDocs():
@@ -198,3 +199,11 @@ def test_raises_on_function_with_multiline_string(self) -> None:
         config.fail_on_raises_section = True
         result = validate_function(tests.test_class.raises_class.RaisesClass.func_with_raise_multiline_string, config, tests.test_class.incorrect_class)
         assert result.result == ResultType.OK
+
+    def test_module_class_name_clash(self) -> None:
+        """
+        Solves: https://github.com/jepperaskdk/pydoctest/issues/34.
+        """
+        config = Configuration.get_default_configuration()
+        result = validate_function(tests.test_class.method_with_module.method_module_class_clash, config, tests.test_class.method_with_module)
+        assert result.result == ResultType.OK