setdoc 0.1.2__tar.gz → 0.1.4__tar.gz

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

@@ -1,8 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: setdoc
-Version: 0.1.2
-Summary: Set the doc string.
-Author-email: Johannes <johannes-programming@mailfence.com>
+Version: 0.1.4
+Summary: This project helps to set the doc string.
+Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
         
         Copyright (c) 2024 Johannes
@@ -24,22 +24,25 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-Project-URL: Documentation, https://pypi.org/project/setdoc
 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: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.12.5
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
+Dynamic: license-file
 
 ======
 setdoc
 ======
 
-Visit the website `https://setdoc.johannes-programming.online <https://setdoc.johannes-programming.online>`_ for more information.
+Visit the website `https://setdoc.johannes-programming.online/ <https://setdoc.johannes-programming.online/>`_ for more information.

setdoc-0.1.4/README.rst

@@ -0,0 +1,5 @@
+======
+setdoc
+======
+
+Visit the website `https://setdoc.johannes-programming.online/ <https://setdoc.johannes-programming.online/>`_ for more information.

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

@@ -6,28 +6,30 @@ requires = [
 
 [project]
 authors = [
-    { email = "johannes-programming@mailfence.com", name = "Johannes" },
+    { email = "johannes.programming@gmail.com", name = "Johannes" },
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
 ]
 dependencies = []
-description = "Set the doc string."
+description = "This project helps to set the doc string."
 keywords = []
 name = "setdoc"
 readme = "README.rst"
-requires-python = ">=3.12.5"
-version = "0.1.2"
+requires-python = ">=3.11"
+version = "0.1.4"
 
 [project.license]
 file = "LICENSE.txt"
 
 [project.urls]
-Documentation = "https://pypi.org/project/setdoc"
 Download = "https://pypi.org/project/setdoc/#files"
 Index = "https://pypi.org/project/setdoc/"
 Source = "https://github.com/johannes-programming/setdoc/"

setdoc-0.1.4/src/setdoc/core.py

@@ -0,0 +1,19 @@
+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

setdoc-0.1.4/src/setdoc/tests/__init__.py

@@ -0,0 +1,11 @@
+import unittest
+
+__all__ = ["test"]
+
+
+def test() -> unittest.TextTestResult:
+    loader: unittest.TestLoader = unittest.TestLoader()
+    tests: unittest.TestSuite = loader.discover(start_dir="setdoc.tests")
+    runner: unittest.TextTestRunner = unittest.TextTestRunner()
+    result: unittest.TextTestResult = runner.run(tests)
+    return result

{setdoc-0.1.2 → setdoc-0.1.4}/src/setdoc/tests/test_core.py

@@ -6,15 +6,15 @@ from setdoc.core import setdoc
 
 class TestSetDocDecorator(unittest.TestCase):
 
-    def test_setdoc_on_function(self):
+    def test_setdoc_on_function(self: Self) -> None:
         # Test the decorator on a standalone function
         @setdoc("This is a test function")
-        def test_func():
+        def test_func() -> None:
             pass
 
         self.assertEqual(test_func.__doc__, "This is a test function")
 
-    def test_setdoc_on_class(self):
+    def test_setdoc_on_class(self: Self) -> None:
         # Test the decorator on a class
         @setdoc("This is a test class")
         class TestClass:
@@ -22,75 +22,75 @@ class TestSetDocDecorator(unittest.TestCase):
 
         self.assertEqual(TestClass.__doc__, "This is a test class")
 
-    def test_setdoc_on_class_method(self):
+    def test_setdoc_on_class_method(self: Self) -> None:
         # Test the decorator on a class method
         class MyClass:
             @setdoc("This is a test method")
-            def my_method(self):
+            def my_method(self: Self) -> None:
                 pass
 
         instance = MyClass()
         self.assertEqual(instance.my_method.__doc__, "This is a test method")
 
-    def test_setdoc_on_static_method(self):
+    def test_setdoc_on_static_method(self: Self) -> None:
         # Test the decorator on a static method
         class MyClass:
             @staticmethod
             @setdoc("This is a static method")
-            def my_static_method():
+            def my_static_method() -> None:
                 pass
 
         self.assertEqual(MyClass.my_static_method.__doc__, "This is a static method")
 
-    def test_setdoc_on_class_with_init(self):
+    def test_setdoc_on_class_with_init(self: Self) -> None:
         # Test the decorator on a class that has an __init__ method
         @setdoc("This is a class with __init__")
         class InitClass:
             def __init__(self, x):
                 self.x = x
 
-        instance = InitClass(5)
+        instance: InitClass = InitClass(5)
         self.assertEqual(InitClass.__doc__, "This is a class with __init__")
         self.assertEqual(instance.__doc__, "This is a class with __init__")
 
-    def test_setdoc_with_none_doc(self):
+    def test_setdoc_with_none_doc(self: Self) -> None:
         # Test with None to see if it handles absence of documentation
         @setdoc(None)
-        def none_doc_func():
+        def none_doc_func() -> None:
             pass
 
         self.assertIsNone(none_doc_func.__doc__)
 
-    def test_setdoc_on_class_property(self):
+    def test_setdoc_on_class_property(self: Self) -> None:
         # Test the decorator on a property
         class PropertyClass:
-            def __init__(self, value):
+            def __init__(self: Self, value: Any) -> None:
                 self._value = value
 
             @property
             @setdoc("This is a property")
-            def value(self):
+            def value(self: Self) -> None:
                 return self._value
 
-        instance = PropertyClass(10)
+        instance: PropertyClass = PropertyClass(10)
         self.assertEqual(PropertyClass.value.__doc__, "This is a property")
         self.assertEqual(instance.value, 10)
 
-    def test_setdoc_on_classmethod(self):
+    def test_setdoc_on_classmethod(self: Self) -> None:
         # Test the decorator on a class method
         class MyClass:
             @classmethod
             @setdoc("This is a class method")
-            def my_class_method(cls):
+            def my_class_method(cls: type) -> None:
                 pass
 
         self.assertEqual(MyClass.my_class_method.__doc__, "This is a class method")
 
-    def test_setdoc_on_nested_function(self):
+    def test_setdoc_on_nested_function(self: Self) -> None:
         # Test the decorator on a nested function
-        def outer_func():
+        def outer_func() -> None:
             @setdoc("This is a nested function")
-            def inner_func():
+            def inner_func() -> None:
                 pass
 
             return inner_func
@@ -98,11 +98,11 @@ class TestSetDocDecorator(unittest.TestCase):
         nested_func = outer_func()
         self.assertEqual(nested_func.__doc__, "This is a nested function")
 
-    def test_setdoc_on_function_with_existing_doc(self):
+    def test_setdoc_on_function_with_existing_doc(self: Self) -> None:
         # Test if decorator replaces an existing docstring
         @setdoc("New docstring")
-        def pre_doc_func():
-            """Old docstring"""
+        def pre_doc_func() -> None:
+            "Old docstring"
             pass
 
         self.assertEqual(pre_doc_func.__doc__, "New docstring")

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

@@ -1,8 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: setdoc
-Version: 0.1.2
-Summary: Set the doc string.
-Author-email: Johannes <johannes-programming@mailfence.com>
+Version: 0.1.4
+Summary: This project helps to set the doc string.
+Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
         
         Copyright (c) 2024 Johannes
@@ -24,22 +24,25 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-Project-URL: Documentation, https://pypi.org/project/setdoc
 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: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.12.5
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
+Dynamic: license-file
 
 ======
 setdoc
 ======
 
-Visit the website `https://setdoc.johannes-programming.online <https://setdoc.johannes-programming.online>`_ for more information.
+Visit the website `https://setdoc.johannes-programming.online/ <https://setdoc.johannes-programming.online/>`_ for more information.

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

@@ -10,5 +10,4 @@ src/setdoc.egg-info/SOURCES.txt
 src/setdoc.egg-info/dependency_links.txt
 src/setdoc.egg-info/top_level.txt
 src/setdoc/tests/__init__.py
-src/setdoc/tests/test_1984.py
 src/setdoc/tests/test_core.py

setdoc-0.1.2/README.rst

@@ -1,5 +0,0 @@
-======
-setdoc
-======
-
-Visit the website `https://setdoc.johannes-programming.online <https://setdoc.johannes-programming.online>`_ for more information.

setdoc-0.1.2/src/setdoc/core.py

@@ -1,15 +0,0 @@
-import dataclasses
-from typing import *
-
-__all__ = ["setdoc"]
-
-
-@dataclasses.dataclass
-class setdoc:
-    "A class to set doc strings."
-    doc: Any
-
-    def __call__(self, target: Any) -> Any:
-        "Set 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-0.1.2/src/setdoc/tests/__init__.py

@@ -1,11 +0,0 @@
-import unittest
-
-__all__ = ["test"]
-
-
-def test():
-    loader = unittest.TestLoader()
-    tests = loader.discover(start_dir="setdoc.tests")
-    runner = unittest.TextTestRunner()
-    result = runner.run(tests)
-    return result

setdoc-0.1.2/src/setdoc/tests/test_1984.py

@@ -1,10 +0,0 @@
-import unittest
-
-
-class Test1984(unittest.TestCase):
-    def test_1984(self):
-        self.assertEqual(2 + 2, 4, "Ignorance is Strength")
-
-
-if __name__ == "__main__":
-    unittest.main()