setdoc 1.2.9__tar.gz → 1.2.11__tar.gz

{setdoc-1.2.9/src/setdoc.egg-info → setdoc-1.2.11}/PKG-INFO

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

{setdoc-1.2.9 → setdoc-1.2.11}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [
-    "setuptools>=61.0",
+    "setuptools>=64.0",
 ]
 
 [project]
@@ -24,7 +24,7 @@ keywords = []
 name = "setdoc"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.2.9"
+version = "1.2.11"
 
 [project.license]
 file = "LICENSE.txt"

setdoc-1.2.11/src/setdoc/_utils/__init__.py

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

setdoc-1.2.11/src/setdoc/core/SetDoc.py

@@ -0,0 +1,16 @@
+import dataclasses
+from typing import *
+
+__all__ = ["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-1.2.11/src/setdoc/core/__init__.py

@@ -0,0 +1,7 @@
+from setdoc.core.basic import basic
+from setdoc.core.getbasicdoc import getbasicdoc
+from setdoc.core.SetDoc import SetDoc
+
+__all__ = ["SetDoc", "basic", "getbasicdoc", "setdoc"]
+
+setdoc = SetDoc  # legacy

setdoc-1.2.11/src/setdoc/core/basic.py

@@ -0,0 +1,11 @@
+from typing import *
+
+from setdoc.core.getbasicdoc import getbasicdoc
+
+__all__ = ["basic"]
+
+
+def basic(value: Any) -> Any:
+    "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.2.11/src/setdoc/core/getbasicdoc.py

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

{setdoc-1.2.9 → setdoc-1.2.11/src/setdoc.egg-info}/PKG-INFO

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

{setdoc-1.2.9 → setdoc-1.2.11}/src/setdoc.egg-info/SOURCES.txt

@@ -8,7 +8,11 @@ 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/_utils/__init__.py
+src/setdoc/_utils/cfg.toml
+src/setdoc/core/SetDoc.py
 src/setdoc/core/__init__.py
-src/setdoc/core/cfg.toml
+src/setdoc/core/basic.py
+src/setdoc/core/getbasicdoc.py
 src/setdoc/tests/__init__.py
 src/setdoc/tests/test_core.py

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

@@ -1,45 +0,0 @@
-import dataclasses
-import enum
-import functools
-import tomllib
-from importlib import resources
-from typing import *
-
-__all__ = ["SetDoc", "basic", "getbasicdoc", "setdoc"]
-
-
-class Util(enum.Enum):
-    util = None
-
-    @functools.cached_property
-    def data(self: Self) -> dict:
-        "This cached property holds the cfg data."
-        text: str
-        text = resources.read_text("setdoc.core", "cfg.toml")
-        return tomllib.loads(text)
-
-
-@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__ = getbasicdoc(value.__name__)
-    return value
-
-
-def getbasicdoc(name: str) -> str:
-    "This function returns the basic docstring for a given name."
-    return Util.util.data["basic"][name]