522 pre commit compatibillity issue with pythonpath

docsig/_core.py

@@ -6,6 +6,7 @@
 from __future__ import annotations as _
 
 import logging as _logging
+import os as _os
 import sys as _sys
 from pathlib import Path as _Path
 
@@ -141,10 +142,14 @@ def _from_file(
     check_class_constructor,
 ) -> _Parent:
     try:
-        string = path.read_text(encoding="utf-8")
+        code = path.read_text(encoding="utf-8")
         parent = _from_str(
+            context={
+                "code": code,
+                "module_name": derive_module_name(path),
+                "path": path,
+            },
             messages=messages,
-            string=string,
             path=path,
             ignore_args=ignore_args,
             ignore_kwargs=ignore_kwargs,
@@ -162,7 +167,7 @@ def _from_file(
 
 
 def _from_str(  # pylint: disable=too-many-arguments
-    string: str,
+    context: dict,
     messages: _Messages,
     ignore_args: bool,
     ignore_kwargs: bool,
@@ -172,8 +177,8 @@ def _from_str(  # pylint: disable=too-many-arguments
     logger = _logging.getLogger(__package__)
     try:
         parent = _Parent(
-            _ast.parse(string),
-            _Directives.from_text(string, messages),
+            _ast.parse(**context),
+            _Directives.from_text(context["code"], messages),
             path,
             ignore_args,
             ignore_kwargs,
@@ -427,7 +432,9 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         return max(retcodes)
 
     module = _from_str(
-        string,
+        {
+            "code": string,
+        },
         disable or _Messages(),
         ignore_args,
         ignore_kwargs,
@@ -449,3 +456,20 @@ def docsig(  # pylint: disable=too-many-locals,too-many-arguments
         target or _Messages(),
     )
     return _report(failures, no_ansi=no_ansi)
+
+
+def derive_module_name(
+    file_path: str | _Path,
+) -> str:
+    """Extract Python module names from paths.
+
+    A dot separated Python module name is generated from the given file
+    path.
+
+    :param file_path: A file system path.
+    :returns: The converted Python module name.
+    """
+    converted = _os.path.splitext(str(file_path))[0]
+    converted = converted.replace(_os.sep, ".")
+    converted = converted.replace("-", "_")
+    return converted

docsig/_report.py

@@ -7,6 +7,8 @@
 
 import typing as _t
 
+from astroid.nodes.scoped_nodes import scoped_nodes as _scoped_nodes
+
 from ._module import Error as _Error
 from ._module import Function as _Function
 from ._stub import UNNAMED as _UNNAMED
@@ -57,7 +59,11 @@ def __init__(
             self._func.messages.extend(i for i in _E.all if i not in target)
 
         self._name = self._func.name
-        if self._func.parent is not None and self._func.parent.name:
+        if (
+            self._func.parent is not None
+            and self._func.parent.name
+            and not isinstance(self._func.parent, _scoped_nodes.Module)
+        ):
             self._name = f"{self._func.parent.name}.{self._func.name}"
 
         self._check_property_returns = check_property_returns

tests/_test.py

@@ -572,8 +572,12 @@ def test_string_argument(
     :param template: String data.
     :param expected: Expected output.
     """
-    assert main(*CHECK_ARGS, long.string, template, test_flake8=False) == int(
-        name.startswith(FAIL)
-    )
+    assert main(
+        "mocked_path",
+        *CHECK_ARGS,
+        long.string,
+        template,
+        test_flake8=False,
+    ) == int(name.startswith(FAIL))
     std = capsys.readouterr()
     assert expected in std.out

tests/benchmark_test.py

@@ -11,9 +11,10 @@
 
 
 @pytest.mark.parametrize(
-    "template",
+    "template,path",
     [
-        '''
+        (
+            '''
 class Klass:
     def __init__(self, param1, param2) -> None:
         """Info about class.
@@ -22,7 +23,10 @@ def __init__(self, param1, param2) -> None:
         :param param1: Info about param1.
         """
 ''',
-        '''
+            "klass.py",
+        ),
+        (
+            '''
 class Klass:
     """Info about class.
 
@@ -33,7 +37,10 @@ class Klass:
     def __init__(self, param1, param2) -> None:
         pass
 ''',
-        '''
+            "klass.py",
+        ),
+        (
+            '''
 class Klass:
     def __get__(self, param1, param2) -> None:
         """Info about class.
@@ -42,7 +49,10 @@ def __get__(self, param1, param2) -> None:
         :param param1: Info about param1.
         """
 ''',
-        '''
+            "klass.py",
+        ),
+        (
+            '''
 def my_function(argument: int = 42) -> int:
     """
     Function that prints a message and returns the argument + 1
@@ -67,7 +77,10 @@ def my_external_function(argument: int = 42) -> int:
 
     return argument + 1
 ''',
-        '''
+            "my_function.py",
+        ),
+        (
+            '''
 class Parent:
     def method(self) -> None:
         """This is documented."""
@@ -77,25 +90,37 @@ class Child(Parent):
     def method(self) -> None:
         self._set: _t.Set[T] = set()
 ''',
-        '''
+            "parent_and_child.py",
+        ),
+        (
+            '''
 class Klass:
     @property
     def prop(self) -> str:
         """This is documented."""
 ''',
-        '''
+            "klass_with_property.py",
+        ),
+        (
+            '''
 class _Klass:
     @property
     def prop(self, param1) -> str:
         """This is documented."""
 ''',
-        '''
+            "klass_with_documented_property.py",
+        ),
+        (
+            '''
 class Parent:
     def _protected(self, param1) -> None:
         """This is documented."""
         self._set: _t.Set[T] = set()
 ''',
-        '''
+            "parent_with_protected.py",
+        ),
+        (
+            '''
 def function(param1, param2, *args) -> None:
     """Proper docstring.
 
@@ -104,7 +129,10 @@ def function(param1, param2, *args) -> None:
     :param args: Pass
     """
 ''',
-        '''
+            "function_with_args.py",
+        ),
+        (
+            '''
 def function(param1, param2, **kwargs) -> None:
     """Proper docstring.
 
@@ -113,17 +141,25 @@ def function(param1, param2, **kwargs) -> None:
     :param kwargs: Pass
     """
 ''',
-        '''
+            "function_with_kwargs.py",
+        ),
+        (
+            '''
 def function(param1, param2, *args) -> None:
     """Proper docstring."""
 ''',
-        '''
+            "function_with_undocumented_params.py",
+        ),
+        (
+            '''
 def function() -> None:
     """Proper docstring.
 
     :return: Returncode.
-    """
+    """,
 ''',
+            "function_with_documented_return.py",
+        ),
     ],
     ids=[
         "c_init",
@@ -141,11 +177,12 @@ def function() -> None:
     ],
 )
 @pytest.mark.benchmark
-def test_bench(bench: MockMainType, template: str) -> None:
+def test_bench(bench: MockMainType, template: str, path: str) -> None:
     """A small benchmark test.
 
     :param bench: Benchmark fixture that is active when environment
         allows it to be.
     :param template: String data.
+    :param path: An associated mock file path.
     """
-    bench(docsig, string=template)
+    bench(docsig, path, string=template)