setdoc 1.3.5__tar.gz → 1.3.7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. {setdoc-1.3.5/src/setdoc.egg-info → setdoc-1.3.7}/PKG-INFO +1 -1
  2. {setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.3.rst +15 -9
  3. {setdoc-1.3.5 → setdoc-1.3.7}/pyproject.toml +1 -1
  4. {setdoc-1.3.5/src/setdoc/core → setdoc-1.3.7/src/setdoc}/__init__.py +1 -1
  5. setdoc-1.3.7/src/setdoc/typing/SupportsDocAndName.py +8 -0
  6. setdoc-1.3.7/src/setdoc/typing/__init__.py +0 -0
  7. {setdoc-1.3.5 → setdoc-1.3.7/src/setdoc.egg-info}/PKG-INFO +1 -1
  8. setdoc-1.3.5/src/setdoc/__init__.py +0 -1
  9. setdoc-1.3.5/src/setdoc/typing/SupportsDocAndName.py +0 -7
  10. {setdoc-1.3.5 → setdoc-1.3.7}/LICENSE.txt +0 -0
  11. {setdoc-1.3.5 → setdoc-1.3.7}/MANIFEST.in +0 -0
  12. {setdoc-1.3.5 → setdoc-1.3.7}/README.rst +0 -0
  13. {setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.0.rst +0 -0
  14. {setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.1.rst +0 -0
  15. {setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.2.rst +0 -0
  16. {setdoc-1.3.5 → setdoc-1.3.7}/setup.cfg +0 -0
  17. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/_utils/__init__.py +0 -0
  18. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/_utils/cfg.toml +0 -0
  19. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/core/SetDoc.py +0 -0
  20. {setdoc-1.3.5/src/setdoc/typing → setdoc-1.3.7/src/setdoc/core}/__init__.py +0 -0
  21. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/core/basic.py +0 -0
  22. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/core/getbasicdoc.py +0 -0
  23. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/py.typed +0 -0
  24. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/tests/__init__.py +0 -0
  25. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/tests/test_core.py +0 -0
  26. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/typing/SupportsDoc.py +0 -0
  27. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc.egg-info/SOURCES.txt +0 -0
  28. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc.egg-info/dependency_links.txt +0 -0
  29. {setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc.egg-info/top_level.txt +0 -0
{setdoc-1.3.5/src/setdoc.egg-info → setdoc-1.3.7}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: setdoc
3
- Version: 1.3.5
3
+ Version: 1.3.7
4
4
  Summary: This project helps to set the doc string.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
{setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.3.rst RENAMED
@@ -25,8 +25,11 @@ The typing conforms strictly to ``mypy``.
25
25
  Features
26
26
  --------
27
27
 
28
- ``class setdoc.SetDoc(doc: Any)``
29
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28
+ ``setdoc.core``
29
+ '''''''''''''''
30
+
31
+ ``class setdoc.core.SetDoc.SetDoc(doc: Optional[str])``
32
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30
33
 
31
34
  The instances of this ``dataclass`` work as decorators
32
35
  that set the docstring of the decorated ``target`` to ``doc``.
@@ -71,29 +74,32 @@ It sets ``target.__doc__`` to ``doc``.
71
74
 
72
75
  This value that is used for ``__doc__``.
73
76
 
74
- ``setdoc.basic(value: types.FunctionType) -> types.FunctionType``
75
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77
+ ``setdoc.core.basic.basic(value: Value) -> Value``
78
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76
79
 
77
80
  .. container:: versionadded
78
81
 
79
82
  **Added in version 1.1.**
80
83
 
81
- ``setdoc.getbasicdoc(name: str) -> str``
82
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84
+ ``setdoc.core.getbasicdoc.getbasicdoc(name: str) -> str``
85
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83
86
 
84
87
  .. container:: versionadded
85
88
 
86
89
  **Added in version 1.2.**
87
90
 
88
- ``setdoc.setdoc = setdoc.SetDoc``
89
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
+ ``setdoc.setdoc: type[setdoc.core.SetDoc.SetDoc] = setdoc.core.SetDoc.SetDoc``
92
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
93
 
91
94
  This module variable is alias for ``SetDoc`` included for legacy.
92
95
 
96
+ ``setdoc.tests``
97
+ ''''''''''''''''
98
+
93
99
  ``setdoc.tests.test() -> unittest.TextTestResult``
94
100
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
101
 
96
- This project can be tested through its test function.
102
+ This project can be tested through its ``test`` function.
97
103
 
98
104
  .. code-block:: python
99
105
 
{setdoc-1.3.5 → setdoc-1.3.7}/pyproject.toml RENAMED
@@ -27,7 +27,7 @@ license-files = [
27
27
  name = "setdoc"
28
28
  readme = "README.rst"
29
29
  requires-python = ">=3.11"
30
- version = "1.3.5"
30
+ version = "1.3.7"
31
31
 
32
32
  [project.urls]
33
33
  Download = "https://pypi.org/project/setdoc/#files"
{setdoc-1.3.5/src/setdoc/core → setdoc-1.3.7/src/setdoc}/__init__.py RENAMED
@@ -4,4 +4,4 @@ from setdoc.core.SetDoc import SetDoc
4
4
 
5
5
  __all__ = ["SetDoc", "basic", "getbasicdoc", "setdoc"]
6
6
 
7
- setdoc = SetDoc # legacy
7
+ setdoc: type[SetDoc] = SetDoc # legacy
setdoc-1.3.7/src/setdoc/typing/SupportsDocAndName.py ADDED
@@ -0,0 +1,8 @@
1
+ from typing import Optional, Protocol
2
+
3
+ __all__ = ["SupportsDocAndName"]
4
+
5
+
6
+ class SupportsDocAndName(Protocol):
7
+ __doc__: Optional[str]
8
+ __name__: str
setdoc-1.3.7/src/setdoc/typing/__init__.py ADDED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7/src/setdoc.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: setdoc
3
- Version: 1.3.5
3
+ Version: 1.3.7
4
4
  Summary: This project helps to set the doc string.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
setdoc-1.3.5/src/setdoc/__init__.py DELETED
@@ -1 +0,0 @@
1
- from setdoc.core import *
setdoc-1.3.5/src/setdoc/typing/SupportsDocAndName.py DELETED
@@ -1,7 +0,0 @@
1
- from .SupportsDoc import SupportsDoc
2
-
3
- __all__ = ["SupportsDocAndName"]
4
-
5
-
6
- class SupportsDocAndName(SupportsDoc):
7
- __name__: str
{setdoc-1.3.5 → setdoc-1.3.7}/LICENSE.txt RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/MANIFEST.in RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/README.rst RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.0.rst RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.1.rst RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/docs/v1.2.rst RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/setup.cfg RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/core/SetDoc.py RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/core/basic.py RENAMED
File without changes
{setdoc-1.3.5 → setdoc-1.3.7}/src/setdoc/py.typed RENAMED
File without changes