setdoc 1.3.2__tar.gz → 1.3.4__tar.gz

{setdoc-1.3.2/src/setdoc.egg-info → setdoc-1.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 1.3.2
+Version: 1.3.4
 Summary: This project helps to set the doc string.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT

{setdoc-1.3.2 → setdoc-1.3.4}/docs/v1.3.rst

@@ -16,7 +16,7 @@ Open your terminal and run:
 Typing
 ------
 
-The typing conforms (not strictly) to ``mypy``.
+The typing conforms strictly to ``mypy``.
 
 .. container:: versionadded
 
@@ -60,8 +60,8 @@ Usage:
     print(mul.__doc__)
     # Output: This function multiplies two numbers.
 
-``__call__(target: Any) -> Any``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``__call__(target: Target) -> Target``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This magic method implements calling the current instance.
 It sets ``target.__doc__`` to ``doc``.
@@ -71,8 +71,8 @@ It sets ``target.__doc__`` to ``doc``.
 
 This value that is used for ``__doc__``.
 
-``setdoc.basic(value: Any) -> Any``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``setdoc.basic(value: types.FunctionType) -> types.FunctionType``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. container:: versionadded
 

{setdoc-1.3.2 → setdoc-1.3.4}/pyproject.toml

@@ -27,7 +27,7 @@ license-files = [
 name = "setdoc"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.3.2"
+version = "1.3.4"
 
 [project.urls]
 Download = "https://pypi.org/project/setdoc/#files"
@@ -40,4 +40,4 @@ files = [
     ".",
 ]
 python_version = "3.11"
-strict = false
+strict = true

{setdoc-1.3.2 → setdoc-1.3.4}/src/setdoc/_utils/__init__.py

@@ -2,7 +2,7 @@ import enum
 import functools
 import tomllib
 from importlib import resources
-from typing import *
+from typing import Any, Self
 
 __all__ = ["Cfg"]
 
@@ -11,7 +11,7 @@ class Cfg(enum.Enum):
     cfg = None
 
     @functools.cached_property
-    def data(self: Self) -> dict:
+    def data(self: Self) -> dict[str, Any]:
         "This cached property holds the cfg data."
         text: str
         text = resources.read_text("setdoc._utils", "cfg.toml")

{setdoc-1.3.2 → setdoc-1.3.4}/src/setdoc/_utils/cfg.toml

@@ -86,4 +86,4 @@ issuperset = "This method determines if self is a superset of other."
 items = "This method returns all defined key-value-pairs."
 keys = "This method returns all keys with a defined value."
 setdefault = "This method returns the value of an item after guaranteeing its existence."
-values = This method returns all values with a defined key."
+values = "This method returns all values with a defined key."

{setdoc-1.3.2 → setdoc-1.3.4}/src/setdoc/core/SetDoc.py

@@ -1,8 +1,10 @@
 import dataclasses
-from typing import *
+from typing import Any, Self, TypeVar
 
 __all__ = ["SetDoc"]
 
+Target = TypeVar("Target")
+
 
 @dataclasses.dataclass
 class SetDoc:
@@ -10,7 +12,7 @@ class SetDoc:
 
     doc: Any
 
-    def __call__(self: Self, target: Any) -> Any:
+    def __call__(self: Self, target: Target) -> Target:
         "This magic method implements calling the current instance. It sets the doc string of the passed target to the value stored in the doc field of the setdoc object."
         target.__doc__ = self.doc
         return target

{setdoc-1.3.2 → setdoc-1.3.4}/src/setdoc/core/basic.py

@@ -1,11 +1,11 @@
-from typing import *
+import types
 
 from setdoc.core.getbasicdoc import getbasicdoc
 
 __all__ = ["basic"]
 
 
-def basic(value: Any) -> Any:
+def basic(value: types.FunctionType) -> types.FunctionType:
     "This decorator sets the docstring of the given value to what is suggested by its name."
     value.__doc__ = getbasicdoc(value.__name__)
     return value

{setdoc-1.3.2 → setdoc-1.3.4}/src/setdoc/core/getbasicdoc.py

@@ -1,4 +1,4 @@
-from typing import *
+from typing import cast
 
 from setdoc._utils import Cfg
 
@@ -7,4 +7,4 @@ __all__ = ["getbasicdoc"]
 
 def getbasicdoc(name: str) -> str:
     "This function returns the basic docstring for a given name."
-    return Cfg.cfg.data["basic"][name]
+    return cast(str, Cfg.cfg.data["basic"][name])

{setdoc-1.3.2 → setdoc-1.3.4}/src/setdoc/tests/test_core.py

@@ -1,15 +1,15 @@
 import types
 import unittest
-from typing import *
+from typing import Any, Self
 
-from setdoc.core import setdoc
+from setdoc.core.SetDoc import SetDoc
 
 
 class TestSetDocDecorator(unittest.TestCase):
 
     def test_setdoc_on_function(self: Self) -> None:
         # Test the decorator on a standalone function
-        @setdoc("This is a test function")
+        @SetDoc("This is a test function")
         def test_func() -> None:
             pass
 
@@ -17,7 +17,7 @@ class TestSetDocDecorator(unittest.TestCase):
 
     def test_setdoc_on_class(self: Self) -> None:
         # Test the decorator on a class
-        @setdoc("This is a test class")
+        @SetDoc("This is a test class")
         class TestClass:
             pass
 
@@ -26,7 +26,7 @@ class TestSetDocDecorator(unittest.TestCase):
     def test_setdoc_on_class_method(self: Self) -> None:
         # Test the decorator on a class method
         class MyClass:
-            @setdoc("This is a test method")
+            @SetDoc("This is a test method")
             def my_method(self: Self) -> None:
                 pass
 
@@ -38,7 +38,7 @@ class TestSetDocDecorator(unittest.TestCase):
         # Test the decorator on a static method
         class MyClass:
             @staticmethod
-            @setdoc("This is a static method")
+            @SetDoc("This is a static method")
             def my_static_method() -> None:
                 pass
 
@@ -46,9 +46,9 @@ class TestSetDocDecorator(unittest.TestCase):
 
     def test_setdoc_on_class_with_init(self: Self) -> None:
         # Test the decorator on a class that has an __init__ method
-        @setdoc("This is a class with __init__")
+        @SetDoc("This is a class with __init__")
         class InitClass:
-            def __init__(self, x):
+            def __init__(self: Self, x: Any) -> None:
                 self.x = x
 
         instance: InitClass
@@ -58,7 +58,7 @@ class TestSetDocDecorator(unittest.TestCase):
 
     def test_setdoc_with_none_doc(self: Self) -> None:
         # Test with None to see if it handles absence of documentation
-        @setdoc(None)
+        @SetDoc(None)
         def none_doc_func() -> None:
             pass
 
@@ -71,8 +71,8 @@ class TestSetDocDecorator(unittest.TestCase):
                 self._value = value
 
             @property
-            @setdoc("This is a property")
-            def value(self: Self) -> None:
+            @SetDoc("This is a property")
+            def value(self: Self) -> Any:
                 return self._value
 
         instance: PropertyClass
@@ -84,7 +84,7 @@ class TestSetDocDecorator(unittest.TestCase):
         # Test the decorator on a class method
         class MyClass:
             @classmethod
-            @setdoc("This is a class method")
+            @SetDoc("This is a class method")
             def my_class_method(cls: type) -> None:
                 pass
 
@@ -92,20 +92,20 @@ class TestSetDocDecorator(unittest.TestCase):
 
     def test_setdoc_on_nested_function(self: Self) -> None:
         # Test the decorator on a nested function
-        def outer_func() -> types.FunctionType:
-            @setdoc("This is a nested function")
+        def outer_func() -> Any:
+            @SetDoc("This is a nested function")
             def inner_func() -> None:
                 pass
 
             return inner_func
 
-        nested_func: types.FunctionType
+        nested_func: Any
         nested_func = outer_func()
         self.assertEqual(nested_func.__doc__, "This is a nested function")
 
     def test_setdoc_on_function_with_existing_doc(self: Self) -> None:
         # Test if decorator replaces an existing docstring
-        @setdoc("New docstring")
+        @SetDoc("New docstring")
         def pre_doc_func() -> None:
             "Old docstring"
             pass

{setdoc-1.3.2 → setdoc-1.3.4/src/setdoc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 1.3.2
+Version: 1.3.4
 Summary: This project helps to set the doc string.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT