setdoc 1.3.4__tar.gz → 1.3.5__tar.gz

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

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

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

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

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

@@ -1,16 +1,18 @@
 import dataclasses
-from typing import Any, Self, TypeVar
+from typing import Optional, Self, TypeVar
+
+from setdoc.typing.SupportsDoc import SupportsDoc
 
 __all__ = ["SetDoc"]
 
-Target = TypeVar("Target")
+Target = TypeVar("Target", bound=SupportsDoc)
 
 
 @dataclasses.dataclass
 class SetDoc:
     "This class helps to set doc strings."
 
-    doc: Any
+    doc: Optional[str]
 
     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."

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

@@ -1,11 +1,14 @@
-import types
+from typing import TypeVar
 
 from setdoc.core.getbasicdoc import getbasicdoc
+from setdoc.typing.SupportsDocAndName import SupportsDocAndName
 
 __all__ = ["basic"]
 
+Value = TypeVar("Value", bound=SupportsDocAndName)
 
-def basic(value: types.FunctionType) -> types.FunctionType:
+
+def basic(value: Value) -> Value:
     "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.5/src/setdoc/typing/SupportsDoc.py

@@ -0,0 +1,7 @@
+from typing import Optional, Protocol
+
+__all__ = ["SupportsDoc"]
+
+
+class SupportsDoc(Protocol):
+    __doc__: Optional[str]

setdoc-1.3.5/src/setdoc/typing/SupportsDocAndName.py

@@ -0,0 +1,7 @@
+from .SupportsDoc import SupportsDoc
+
+__all__ = ["SupportsDocAndName"]
+
+
+class SupportsDocAndName(SupportsDoc):
+    __name__: str

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

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

{setdoc-1.3.4 → setdoc-1.3.5}/src/setdoc.egg-info/SOURCES.txt

@@ -20,4 +20,7 @@ src/setdoc/core/__init__.py
 src/setdoc/core/basic.py
 src/setdoc/core/getbasicdoc.py
 src/setdoc/tests/__init__.py
-src/setdoc/tests/test_core.py
+src/setdoc/tests/test_core.py
+src/setdoc/typing/SupportsDoc.py
+src/setdoc/typing/SupportsDocAndName.py
+src/setdoc/typing/__init__.py