setdoc 0.0.0.dev0__tar.gz → 0.1.1__tar.gz

{setdoc-0.0.0.dev0 → setdoc-0.1.1}/LICENSE.txt

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 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. 
+SOFTWARE.

{setdoc-0.0.0.dev0/src/setdoc.egg-info → setdoc-0.1.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: setdoc
-Version: 0.0.0.dev0
-Summary: setdoc
+Version: 0.1.1
+Summary: Set the doc string.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
         
@@ -23,12 +23,13 @@ License: The MIT License (MIT)
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         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. 
-        
+        SOFTWARE.
 Project-URL: Documentation, https://pypi.org/project/setdoc
 Project-URL: Download, https://pypi.org/project/setdoc/#files
-Project-URL: Source, https://github.com/johannes-programming/setdoc
-Classifier: Development Status :: 1 - Planning
+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: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -41,36 +42,4 @@ License-File: LICENSE.txt
 setdoc
 ======
 
-Overview
---------
-
-setdoc
-
-Installation
-------------
-
-To install ``setdoc``, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install setdoc
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/setdoc>`_
-* `Download <https://pypi.org/project/setdoc/#files>`_
-* `Source <https://github.com/johannes-programming/setdoc>`_
-
-Credits
--------
-
-* Author: Johannes
-* Email: `johannes-programming@mailfence.com <mailto:johannes-programming@mailfence.com>`_
-
-Thank you for using ``setdoc``!
+Visit the website `http://setdoc.johannes-programming.online <http://setdoc.johannes-programming.online>`_ for more information.

setdoc-0.1.1/README.rst

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

{setdoc-0.0.0.dev0 → setdoc-0.1.1}/pyproject.toml

@@ -9,19 +9,19 @@ authors = [
     { email = "johannes-programming@mailfence.com", name = "Johannes" },
 ]
 classifiers = [
-    "Development Status :: 1 - Planning",
+    "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
 ]
 dependencies = []
-description = "setdoc"
+description = "Set the doc string."
 keywords = []
 name = "setdoc"
 readme = "README.rst"
 requires-python = ">=3.12.5"
-version = "0.0.0.dev0"
+version = "0.1.1"
 
 [project.license]
 file = "LICENSE.txt"
@@ -29,4 +29,6 @@ file = "LICENSE.txt"
 [project.urls]
 Documentation = "https://pypi.org/project/setdoc"
 Download = "https://pypi.org/project/setdoc/#files"
-Source = "https://github.com/johannes-programming/setdoc"
+Index = "https://pypi.org/project/setdoc/"
+Source = "https://github.com/johannes-programming/setdoc/"
+Website = "https://setdoc.johannes-programming.online/"

setdoc-0.1.1/src/setdoc/__init__.py

@@ -0,0 +1,2 @@
+from setdoc.core import *
+from setdoc.tests import *

setdoc-0.1.1/src/setdoc/core.py

@@ -0,0 +1,15 @@
+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.1/src/setdoc/tests/test_core.py

@@ -0,0 +1,112 @@
+import unittest
+from typing import *
+
+from setdoc.core import setdoc
+
+
+class TestSetDocDecorator(unittest.TestCase):
+
+    def test_setdoc_on_function(self):
+        # Test the decorator on a standalone function
+        @setdoc("This is a test function")
+        def test_func():
+            pass
+
+        self.assertEqual(test_func.__doc__, "This is a test function")
+
+    def test_setdoc_on_class(self):
+        # Test the decorator on a class
+        @setdoc("This is a test class")
+        class TestClass:
+            pass
+
+        self.assertEqual(TestClass.__doc__, "This is a test class")
+
+    def test_setdoc_on_class_method(self):
+        # Test the decorator on a class method
+        class MyClass:
+            @setdoc("This is a test method")
+            def my_method(self):
+                pass
+
+        instance = MyClass()
+        self.assertEqual(instance.my_method.__doc__, "This is a test method")
+
+    def test_setdoc_on_static_method(self):
+        # Test the decorator on a static method
+        class MyClass:
+            @staticmethod
+            @setdoc("This is a static method")
+            def my_static_method():
+                pass
+
+        self.assertEqual(MyClass.my_static_method.__doc__, "This is a static method")
+
+    def test_setdoc_on_class_with_init(self):
+        # 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)
+        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):
+        # Test with None to see if it handles absence of documentation
+        @setdoc(None)
+        def none_doc_func():
+            pass
+
+        self.assertIsNone(none_doc_func.__doc__)
+
+    def test_setdoc_on_class_property(self):
+        # Test the decorator on a property
+        class PropertyClass:
+            def __init__(self, value):
+                self._value = value
+
+            @property
+            @setdoc("This is a property")
+            def value(self):
+                return self._value
+
+        instance = PropertyClass(10)
+        self.assertEqual(PropertyClass.value.__doc__, "This is a property")
+        self.assertEqual(instance.value, 10)
+
+    def test_setdoc_on_classmethod(self):
+        # Test the decorator on a class method
+        class MyClass:
+            @classmethod
+            @setdoc("This is a class method")
+            def my_class_method(cls):
+                pass
+
+        self.assertEqual(MyClass.my_class_method.__doc__, "This is a class method")
+
+    def test_setdoc_on_nested_function(self):
+        # Test the decorator on a nested function
+        def outer_func():
+            @setdoc("This is a nested function")
+            def inner_func():
+                pass
+
+            return inner_func
+
+        nested_func = outer_func()
+        self.assertEqual(nested_func.__doc__, "This is a nested function")
+
+    def test_setdoc_on_function_with_existing_doc(self):
+        # Test if decorator replaces an existing docstring
+        @setdoc("New docstring")
+        def pre_doc_func():
+            """Old docstring"""
+            pass
+
+        self.assertEqual(pre_doc_func.__doc__, "New docstring")
+
+
+if __name__ == "__main__":
+    unittest.main()

{setdoc-0.0.0.dev0 → setdoc-0.1.1/src/setdoc.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: setdoc
-Version: 0.0.0.dev0
-Summary: setdoc
+Version: 0.1.1
+Summary: Set the doc string.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
         
@@ -23,12 +23,13 @@ License: The MIT License (MIT)
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         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. 
-        
+        SOFTWARE.
 Project-URL: Documentation, https://pypi.org/project/setdoc
 Project-URL: Download, https://pypi.org/project/setdoc/#files
-Project-URL: Source, https://github.com/johannes-programming/setdoc
-Classifier: Development Status :: 1 - Planning
+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: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -41,36 +42,4 @@ License-File: LICENSE.txt
 setdoc
 ======
 
-Overview
---------
-
-setdoc
-
-Installation
-------------
-
-To install ``setdoc``, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install setdoc
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/setdoc>`_
-* `Download <https://pypi.org/project/setdoc/#files>`_
-* `Source <https://github.com/johannes-programming/setdoc>`_
-
-Credits
--------
-
-* Author: Johannes
-* Email: `johannes-programming@mailfence.com <mailto:johannes-programming@mailfence.com>`_
-
-Thank you for using ``setdoc``!
+Visit the website `http://setdoc.johannes-programming.online <http://setdoc.johannes-programming.online>`_ for more information.

{setdoc-0.0.0.dev0 → setdoc-0.1.1}/src/setdoc.egg-info/SOURCES.txt

@@ -4,10 +4,11 @@ README.rst
 pyproject.toml
 setup.cfg
 src/setdoc/__init__.py
-src/setdoc/__main__.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/tests/__init__.py
-src/setdoc/tests/test_1984.py
+src/setdoc/tests/test_1984.py
+src/setdoc/tests/test_core.py

setdoc-0.0.0.dev0/README.rst

@@ -1,37 +0,0 @@
-======
-setdoc
-======
-
-Overview
---------
-
-setdoc
-
-Installation
-------------
-
-To install ``setdoc``, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install setdoc
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/setdoc>`_
-* `Download <https://pypi.org/project/setdoc/#files>`_
-* `Source <https://github.com/johannes-programming/setdoc>`_
-
-Credits
--------
-
-* Author: Johannes
-* Email: `johannes-programming@mailfence.com <mailto:johannes-programming@mailfence.com>`_
-
-Thank you for using ``setdoc``!

setdoc-0.0.0.dev0/src/setdoc/__init__.py

@@ -1,6 +0,0 @@
-def main(args=None):
-    print("Hello World!")
-
-
-if __name__ == "__main__":
-    main()

setdoc-0.0.0.dev0/src/setdoc/__main__.py

@@ -1,4 +0,0 @@
-from setdoc import main
-
-if __name__ == "__main__":
-    main()