setdoc 0.1.4__tar.gz → 1.1.0__tar.gz

setdoc-1.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/setdoc *.toml

{setdoc-0.1.4/src/setdoc.egg-info → setdoc-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 0.1.4
+Version: 1.1.0
 Summary: This project helps to set the doc string.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
@@ -28,7 +28,7 @@ Project-URL: Download, https://pypi.org/project/setdoc/#files
 Project-URL: Index, https://pypi.org/project/setdoc/
 Project-URL: Source, https://github.com/johannes-programming/setdoc/
 Project-URL: Website, https://setdoc.johannes-programming.online/
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent

{setdoc-0.1.4 → setdoc-1.1.0}/pyproject.toml

@@ -9,7 +9,7 @@ authors = [
     { email = "johannes.programming@gmail.com", name = "Johannes" },
 ]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
@@ -24,7 +24,7 @@ keywords = []
 name = "setdoc"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "0.1.4"
+version = "1.1.0"
 
 [project.license]
 file = "LICENSE.txt"

setdoc-1.1.0/src/setdoc/core/__init__.py

@@ -0,0 +1,40 @@
+import dataclasses
+import enum
+import functools
+import tomllib
+from importlib import resources
+from typing import *
+
+__all__ = ["SetDoc", "setdoc", "basic"]
+
+
+class Util(enum.Enum):
+    util = None
+
+    @functools.cached_property
+    def data(self: Self) -> dict:
+        "This cached property holds the cfg data."
+        text: str = resources.read_text("setdoc.core", "cfg.toml")
+        ans: dict = tomllib.loads(text)
+        return ans
+
+
+@dataclasses.dataclass
+class SetDoc:
+    "This class helps to set doc strings."
+
+    doc: Any
+
+    def __call__(self: Self, target: Any) -> Any:
+        "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 = SetDoc  # legacy
+
+
+def basic(value: Any) -> Any:
+    "This decorator sets the docstring of the given value to what is suggested by its name."
+    value.__doc__ = Util.util.data["basic"][value.__name__]
+    return value

setdoc-1.1.0/src/setdoc/core/cfg.toml

@@ -0,0 +1,41 @@
+[basic]
+__add__ = "This magic method implements self+other."
+__and__ = "This magic method implements self&other."
+__divmod__ = "This magic method implements divmod(self, other)."
+__eq__ = "This magic method implements self==other."
+__floordiv__ = "This magic method implements self//other."
+__ge__ = "This magic method implements self>=other."
+__gt__ = "This magic method implements self>other."
+__int__ = "This magic method implements int(self)."
+__le__ = "This magic method implements self<=other."
+__len__ = "This magic method implements len(self)."
+__lshift__ = "This magic method implements self<<other."
+__lt__ = "This magic method implements self<other."
+__matmul__ = "This magic method implements self@other."
+__mod__ = "This magic method implements self%other."
+__mul__ = "This magic method implements self*other."
+__ne__ = "This magic method implements self!=other."
+__neg__ = "This magic method implements -self."
+__or__ = "This magic method implements self|other."
+__pos__ = "This magic method implements +self."
+__pow__ = "This magic method implements self**other."
+__radd__ = "This magic method implements other+self."
+__rand__ = "This magic method implements other&self."
+__rdivmod__ = "This magic method implements divmod(other, self)."
+__repr__ = "This magic method implements repr(self)."
+__rfloordiv__ = "This magic method implements other//self."
+__rlshift__ = "This magic method implements other<<self."
+__rmatmul__ = "This magic method implements other@self."
+__rmod__ = "This magic method implements other%self."
+__rmul__ = "This magic method implements other*self."
+__ror__ = "This magic method implements other|self."
+__rpow__ = "This magic method implements other**self."
+__rrshift__ = "This magic method implements other>>self."
+__rshift__ = "This magic method implements self>>other."
+__rsub__ = "This magic method implements other-self."
+__rtruediv__ = "This magic method implements other/self."
+__rxor__ = "This magic method implements other^self."
+__str__ = "This magic method implements str(self)."
+__sub__ = "This magic method implements self-other."
+__truediv__ = "This magic method implements self/other."
+__xor__ = "This magic method implements self^other."

{setdoc-0.1.4 → setdoc-1.1.0/src/setdoc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 0.1.4
+Version: 1.1.0
 Summary: This project helps to set the doc string.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
@@ -28,7 +28,7 @@ Project-URL: Download, https://pypi.org/project/setdoc/#files
 Project-URL: Index, https://pypi.org/project/setdoc/
 Project-URL: Source, https://github.com/johannes-programming/setdoc/
 Project-URL: Website, https://setdoc.johannes-programming.online/
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent

{setdoc-0.1.4 → setdoc-1.1.0}/src/setdoc.egg-info/SOURCES.txt

@@ -4,10 +4,11 @@ README.rst
 pyproject.toml
 setup.cfg
 src/setdoc/__init__.py
-src/setdoc/core.py
 src/setdoc.egg-info/PKG-INFO
 src/setdoc.egg-info/SOURCES.txt
 src/setdoc.egg-info/dependency_links.txt
 src/setdoc.egg-info/top_level.txt
+src/setdoc/core/__init__.py
+src/setdoc/core/cfg.toml
 src/setdoc/tests/__init__.py
 src/setdoc/tests/test_core.py

setdoc-0.1.4/src/setdoc/core.py

@@ -1,19 +0,0 @@
-import dataclasses
-from typing import *
-
-__all__ = ["SetDoc", "setdoc"]
-
-
-@dataclasses.dataclass
-class SetDoc:
-    "This class helps to set doc strings."
-
-    doc: Any
-
-    def __call__(self: Self, target: Any) -> Any:
-        "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 = SetDoc