setdoc 1.3.7__tar.gz → 1.3.9__tar.gz

{setdoc-1.3.7/src/setdoc.egg-info → setdoc-1.3.9}/PKG-INFO

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

{setdoc-1.3.7 → setdoc-1.3.9}/pyproject.toml

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

{setdoc-1.3.7 → setdoc-1.3.9}/src/setdoc/_utils/__init__.py

@@ -2,7 +2,7 @@ import enum
 import functools
 import tomllib
 from importlib import resources
-from typing import Any, Self
+from typing import Any, Self, cast
 
 __all__ = ["Cfg"]
 
@@ -10,6 +10,10 @@ __all__ = ["Cfg"]
 class Cfg(enum.Enum):
     cfg = None
 
+    @functools.cached_property
+    def basic(self: Self) -> dict[str, Any]:
+        return cast(dict[str, Any], self.data["basic"])
+
     @functools.cached_property
     def data(self: Self) -> dict[str, Any]:
         "This cached property holds the cfg data."

{setdoc-1.3.7 → setdoc-1.3.9}/src/setdoc/_utils/cfg.toml

@@ -76,8 +76,10 @@ __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."
+append = "This method appends item at the end of self."
 copy = "This method returns a new copy of self."
 data = "This property represents the underlying data."
+get = "This method returns self[key] if it exists, otherwise default."
 index = "This method returns the index of the first occurrence."
 insert = "This method inserts value at index."
 isdisjoint = "This method determines if self and other have no intersection."

setdoc-1.3.9/src/setdoc/core/getbasicdoc.py

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

{setdoc-1.3.7 → setdoc-1.3.9}/src/setdoc/tests/test_core.py

@@ -1,9 +1,10 @@
-import types
 import unittest
 from typing import Any, Self
 
 from setdoc.core.SetDoc import SetDoc
 
+__all__ = ["TestSetDocDecorator"]
+
 
 class TestSetDocDecorator(unittest.TestCase):
 
@@ -42,7 +43,9 @@ class TestSetDocDecorator(unittest.TestCase):
             def my_static_method() -> None:
                 pass
 
-        self.assertEqual(MyClass.my_static_method.__doc__, "This is a static method")
+        self.assertEqual(
+            MyClass.my_static_method.__doc__, "This is a static method"
+        )
 
     def test_setdoc_on_class_with_init(self: Self) -> None:
         # Test the decorator on a class that has an __init__ method
@@ -88,7 +91,9 @@ class TestSetDocDecorator(unittest.TestCase):
             def my_class_method(cls: type) -> None:
                 pass
 
-        self.assertEqual(MyClass.my_class_method.__doc__, "This is a class method")
+        self.assertEqual(
+            MyClass.my_class_method.__doc__, "This is a class method"
+        )
 
     def test_setdoc_on_nested_function(self: Self) -> None:
         # Test the decorator on a nested function

{setdoc-1.3.7 → setdoc-1.3.9/src/setdoc.egg-info}/PKG-INFO

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

setdoc-1.3.7/src/setdoc/core/getbasicdoc.py

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