setdoc 1.1.0__tar.gz → 1.1.2__tar.gz

{setdoc-1.1.0 → setdoc-1.1.2}/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-1.1.2/MANIFEST.in

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

setdoc-1.1.2/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: setdoc
+Version: 1.1.2
+Summary: This project helps to set the doc string.
+Author-email: Johannes <johannes.programming@gmail.com>
+License-Expression: MIT
+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 :: 5 - Production/Stable
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Dynamic: license-file
+
+======
+setdoc
+======
+
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://setdoc.johannes-programming.online/ <https://setdoc.johannes-programming.online/>`_.

setdoc-1.1.2/README.rst

@@ -0,0 +1,7 @@
+======
+setdoc
+======
+
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://setdoc.johannes-programming.online/ <https://setdoc.johannes-programming.online/>`_.

setdoc-1.1.2/docs/v1.0.rst

@@ -0,0 +1,106 @@
+Introduction
+------------
+
+This project helps to set the doc string.
+
+Installation
+------------
+
+To install ``setdoc``, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install setdoc
+
+Typing
+------
+
+This project is (not strictly) typed in accordance with ``mypy``.
+
+Features
+--------
+
+``class setdoc.SetDoc(doc: Any)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The instances of this ``dataclass`` work as decorators
+that set the docstring of the decorated ``target`` to ``doc``.
+
+Usage:
+
+.. code-block:: python
+
+    from typing import *
+    from setdoc import SetDoc
+
+    # Create a setdoc instance with the desired docstring
+    doc_updater: SetDoc
+    doc_updater = SetDoc("This function adds two numbers.")
+
+    # Apply it to a target function
+    @doc_updater
+    def add(a: int, b: int) -> int:
+        return a + b
+
+    # The function now has an updated docstring
+    print(add.__doc__)
+    # Output: This function adds two numbers.
+
+    # Apply it directly to another target function
+    @SetDoc("This function multiplies two numbers.")
+    def mul(a: int, b: int) -> int:
+        return a * b
+
+    # The function now has an updated docstring
+    print(mul.__doc__)
+    # Output: This function multiplies two numbers.
+
+``__call__(target: Any) -> Any``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This magic method implements calling the current instance.
+It sets ``target.__doc__`` to ``doc``.
+
+``doc: Any``
+^^^^^^^^^^^^
+
+This value that is used for ``__doc__``.
+
+``setdoc.setdoc = setdoc.SetDoc``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This module variable is alias for ``SetDoc`` included for legacy.
+
+``setdoc.tests.test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its test function.
+
+.. code-block:: python
+
+    import setdoc.tests
+    setdoc.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/setdoc/#files
+- Index: https://pypi.org/project/setdoc/
+- Source: https://github.com/johannes-programming/setdoc/
+- Website: https://setdoc.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

setdoc-1.1.2/docs/v1.1.rst

@@ -0,0 +1,113 @@
+Introduction
+------------
+
+This project helps to set the doc string.
+
+Installation
+------------
+
+To install ``setdoc``, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install setdoc
+
+Typing
+------
+
+This project is (not strictly) typed in accordance with ``mypy``.
+
+Features
+--------
+
+``class setdoc.SetDoc(doc: Any)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The instances of this ``dataclass`` work as decorators
+that set the docstring of the decorated ``target`` to ``doc``.
+
+Usage:
+
+.. code-block:: python
+
+    from typing import *
+    from setdoc import SetDoc
+
+    # Create a setdoc instance with the desired docstring
+    doc_updater: SetDoc
+    doc_updater = SetDoc("This function adds two numbers.")
+
+    # Apply it to a target function
+    @doc_updater
+    def add(a: int, b: int) -> int:
+        return a + b
+
+    # The function now has an updated docstring
+    print(add.__doc__)
+    # Output: This function adds two numbers.
+
+    # Apply it directly to another target function
+    @SetDoc("This function multiplies two numbers.")
+    def mul(a: int, b: int) -> int:
+        return a * b
+
+    # The function now has an updated docstring
+    print(mul.__doc__)
+    # Output: This function multiplies two numbers.
+
+``__call__(target: Any) -> Any``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This magic method implements calling the current instance.
+It sets ``target.__doc__`` to ``doc``.
+
+``doc: Any``
+^^^^^^^^^^^^
+
+This value that is used for ``__doc__``.
+
+``setdoc.basic(value: Any) -> Any``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container:: versionadded
+
+    **Added in version 1.1.**
+
+``setdoc.setdoc = setdoc.SetDoc``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This module variable is alias for ``SetDoc`` included for legacy.
+
+``setdoc.tests.test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its test function.
+
+.. code-block:: python
+
+    import setdoc.tests
+    setdoc.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/setdoc/#files
+- Index: https://pypi.org/project/setdoc/
+- Source: https://github.com/johannes-programming/setdoc/
+- Website: https://setdoc.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

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

@@ -10,7 +10,6 @@ authors = [
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
@@ -21,16 +20,24 @@ classifiers = [
 dependencies = []
 description = "This project helps to set the doc string."
 keywords = []
+license = "MIT"
+license-files = [
+    "LICENSE.txt",
+]
 name = "setdoc"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.1.0"
-
-[project.license]
-file = "LICENSE.txt"
+version = "1.1.2"
 
 [project.urls]
 Download = "https://pypi.org/project/setdoc/#files"
 Index = "https://pypi.org/project/setdoc/"
 Source = "https://github.com/johannes-programming/setdoc/"
 Website = "https://setdoc.johannes-programming.online/"
+
+[tool.mypy]
+files = [
+    ".",
+]
+python_version = "3.11"
+strict = false

setdoc-1.1.2/src/setdoc/__init__.py

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

{setdoc-1.1.0 → setdoc-1.1.2}/src/setdoc/core/cfg.toml

@@ -1,11 +1,29 @@
 [basic]
 __add__ = "This magic method implements self+other."
 __and__ = "This magic method implements self&other."
+__contains__ = "This magic method implements other in self."
+__delitem__ = "This magic method implements del self[key]."
 __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."
+__getitem__ = "This magic method implements self[key]."
 __gt__ = "This magic method implements self>other."
+__iadd__ = "This magic method implements self+=other."
+__iand__ = "This magic method implements self&=other."
+__ifloordiv__ = "This magic method implements self//=other."
+__ilshift__ = "This magic method implements self<<=other."
+__imatmul__ = "This magic method implements self@=other."
+__imod__ = "This magic method implements self%=other."
+__imul__ = "This magic method implements self*=other."
+__ior__ = "This magic method implements self|=other."
+__ipow__ = "This magic method implements self**=other."
+__irshift__ = "This magic method implements self>>=other."
+__isub__ = "This magic method implements self-=other."
+__itruediv__ = "This magic method implements self/=other."
+__ixor__ = "This magic method implements self^=other."
+__iter__ = "This magic method implements iter(self)."
+__init__ = "This magic method initializes self."
 __int__ = "This magic method implements int(self)."
 __le__ = "This magic method implements self<=other."
 __len__ = "This magic method implements len(self)."
@@ -35,6 +53,7 @@ __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."
+__setitem__ = "This magic method implements self[key]=value."
 __str__ = "This magic method implements str(self)."
 __sub__ = "This magic method implements self-other."
 __truediv__ = "This magic method implements self/other."

{setdoc-1.1.0 → setdoc-1.1.2}/src/setdoc/tests/test_core.py

@@ -88,13 +88,14 @@ class TestSetDocDecorator(unittest.TestCase):
 
     def test_setdoc_on_nested_function(self: Self) -> None:
         # Test the decorator on a nested function
-        def outer_func() -> None:
+        def outer_func() -> Any:
             @setdoc("This is a nested function")
             def inner_func() -> None:
                 pass
 
             return inner_func
 
+        nested_func: Any
         nested_func = outer_func()
         self.assertEqual(nested_func.__doc__, "This is a nested function")
 

setdoc-1.1.2/src/setdoc.egg-info/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: setdoc
+Version: 1.1.2
+Summary: This project helps to set the doc string.
+Author-email: Johannes <johannes.programming@gmail.com>
+License-Expression: MIT
+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 :: 5 - Production/Stable
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Dynamic: license-file
+
+======
+setdoc
+======
+
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://setdoc.johannes-programming.online/ <https://setdoc.johannes-programming.online/>`_.

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

@@ -3,6 +3,8 @@ MANIFEST.in
 README.rst
 pyproject.toml
 setup.cfg
+docs/v1.0.rst
+docs/v1.1.rst
 src/setdoc/__init__.py
 src/setdoc.egg-info/PKG-INFO
 src/setdoc.egg-info/SOURCES.txt

setdoc-1.1.0/MANIFEST.in

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

setdoc-1.1.0/PKG-INFO

@@ -1,48 +0,0 @@
-Metadata-Version: 2.4
-Name: setdoc
-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)
-        
-        Copyright (c) 2024 Johannes
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        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.
-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 :: 5 - Production/Stable
-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
-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.

setdoc-1.1.0/README.rst

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

setdoc-1.1.0/src/setdoc/__init__.py

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

setdoc-1.1.0/src/setdoc.egg-info/PKG-INFO

@@ -1,48 +0,0 @@
-Metadata-Version: 2.4
-Name: setdoc
-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)
-        
-        Copyright (c) 2024 Johannes
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        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.
-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 :: 5 - Production/Stable
-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
-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.