setdoc 1.3.4__tar.gz → 1.3.6__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 1.3.4
+Version: 1.3.6
 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.6}/docs/v1.3.rst

@@ -25,8 +25,11 @@ The typing conforms strictly to ``mypy``.
 Features
 --------
 
-``class setdoc.SetDoc(doc: Any)``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``setdoc.core``
+'''''''''''''''
+
+``class setdoc.core.SetDoc.SetDoc(doc: Optional[str])``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The instances of this ``dataclass`` work as decorators
 that set the docstring of the decorated ``target`` to ``doc``.
@@ -71,29 +74,32 @@ It sets ``target.__doc__`` to ``doc``.
 
 This value that is used for ``__doc__``.
 
-``setdoc.basic(value: types.FunctionType) -> types.FunctionType``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``setdoc.core.basic.basic(value: Value) -> Value``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. container:: versionadded
 
     **Added in version 1.1.**
 
-``setdoc.getbasicdoc(name: str) -> str``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``setdoc.core.getbasicdoc.getbasicdoc(name: str) -> str``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. container:: versionadded
 
     **Added in version 1.2.**
 
-``setdoc.setdoc = setdoc.SetDoc``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``setdoc.setdoc: type[setdoc.core.SetDoc.SetDoc] = setdoc.core.SetDoc.SetDoc``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This module variable is alias for ``SetDoc`` included for legacy.
 
+``setdoc.tests``
+''''''''''''''''
+
 ``setdoc.tests.test() -> unittest.TextTestResult``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This project can be tested through its test function.
+This project can be tested through its ``test`` function.
 
 .. code-block:: python
 

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

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

{setdoc-1.3.4/src/setdoc/core → setdoc-1.3.6/src/setdoc}/__init__.py

@@ -4,4 +4,4 @@ from setdoc.core.SetDoc import SetDoc
 
 __all__ = ["SetDoc", "basic", "getbasicdoc", "setdoc"]
 
-setdoc = SetDoc  # legacy
+setdoc: type[SetDoc] = SetDoc  # legacy

{setdoc-1.3.4 → setdoc-1.3.6}/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.6}/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.6/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.6/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.6/src/setdoc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 1.3.4
+Version: 1.3.6
 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.6}/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

setdoc-1.3.4/src/setdoc/__init__.py

@@ -1 +0,0 @@
-from setdoc.core import *