scaevola 1.0.11__py3-none-any.whl → 1.0.12__py3-none-any.whl

scaevola/core.py

@@ -5,65 +5,65 @@ __all__ = ["Scaevola"]
 
 class Scaevola:
     def __ge__(self, other: Any) -> Any:
-        """Return self>=other."""
+        "This magic method implements self>=other."
         return type(self)(other) <= self
 
     def __gt__(self, other: Any) -> Any:
-        """Return self>other."""
+        "This magic method implements self>other."
         return type(self)(other) < self
 
     def __radd__(self, other: Any) -> Any:
-        """Return other+self."""
+        "This magic method implements other+self."
         return type(self)(other) + self
 
     def __rand__(self, other: Any) -> Any:
-        """Return other&self."""
+        "This magic method implements other&self."
         return type(self)(other) & self
 
     def __rdivmod__(self, other: Any) -> Any:
-        """Return divmod(other, self)."""
+        "This magic method implements divmod(other, self)."
         return divmod(type(self)(other), self)
 
     def __rfloordiv__(self, other: Any) -> Any:
-        """Return other//self."""
+        "This magic method implements other//self."
         return type(self)(other) // self
 
     def __rlshift__(self, other: Any) -> Any:
-        """Return other<<self."""
+        "This magic method implements other<<self."
         return type(self)(other) << self
 
     def __rmatmul__(self, other: Any) -> Any:
-        """Return other@self."""
+        "This magic method implements other@self."
         return type(self)(other) @ self
 
     def __rmod__(self, other: Any) -> Any:
-        """Return other%self."""
+        "This magic method implements other%self."
         return type(self)(other) % self
 
     def __rmul__(self, other: Any) -> Any:
-        """Return other*self."""
+        "This magic method implements other*self."
         return type(self)(other) * self
 
     def __ror__(self, other: Any) -> Any:
-        """Return other|self."""
+        "This magic method implements other|self."
         return type(self)(other) | self
 
     def __rpow__(self, other: Any) -> Any:
-        """Return pow(other, self)."""
+        "This magic method implements pow(other, self)."
         return type(self)(other) ** self
 
     def __rrshift__(self, other: Any) -> Any:
-        """Return other>>self."""
+        "This magic method implements other>>self."
         return type(self)(other) >> self
 
     def __rsub__(self, other: Any) -> Any:
-        """Return other-self."""
+        "This magic method implements other-self."
         return type(self)(other) - self
 
     def __rtruediv__(self, other: Any) -> Any:
-        """Return other/self."""
+        "This magic method implements other/self."
         return type(self)(other) / self
 
     def __rxor__(self, other: Any) -> Any:
-        """Return other^self."""
+        "This magic method implements other^self."
         return type(self)(other) ^ self

scaevola/tests/__init__.py

@@ -3,7 +3,7 @@ import unittest
 __all__ = ["test"]
 
 
-def test():
+def test() -> unittest.TextTestResult:
     loader = unittest.TestLoader()
     tests = loader.discover(start_dir="scaevola.tests")
     runner = unittest.TextTestRunner()

scaevola/tests/test_0.py

@@ -0,0 +1,41 @@
+import unittest
+
+from scaevola.core import Scaevola
+
+
+class TestScaevolaDocstrings(unittest.TestCase):
+    def test_methods_have_docstrings(self):
+        methods_to_check = [
+            "__ge__",
+            "__gt__",
+            "__radd__",
+            "__rand__",
+            "__rdivmod__",
+            "__rfloordiv__",
+            "__rlshift__",
+            "__rmatmul__",
+            "__rmod__",
+            "__rmul__",
+            "__ror__",
+            "__rpow__",
+            "__rrshift__",
+            "__rsub__",
+            "__rtruediv__",
+            "__rxor__",
+        ]
+
+        for name in methods_to_check:
+            method = getattr(Scaevola, name, None)
+            with self.subTest(method=name):
+                self.assertIsNotNone(
+                    method.__doc__, f"Method {name} is missing a docstring"
+                )
+                self.assertGreater(
+                    len(method.__doc__.strip()),
+                    0,
+                    f"Method {name} has an empty docstring",
+                )
+
+
+if __name__ == "__main__":
+    unittest.main()

{scaevola-1.0.11.dist-info → scaevola-1.0.12.dist-info}/METADATA

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: scaevola
-Version: 1.0.11
-Summary: class with preset right handed magic methods
+Version: 1.0.12
+Summary: This project provides a class with preset right handed magic methods.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
         
@@ -24,16 +24,18 @@ 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/scaevola
 Project-URL: Download, https://pypi.org/project/scaevola/#files
 Project-URL: Index, https://pypi.org/project/scaevola/
-Project-URL: Source, https://github.com/johannes-programming/scaevola
+Project-URL: Source, https://github.com/johannes-programming/scaevola/
 Project-URL: Website, https://scaevola.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.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
@@ -42,6 +44,4 @@ License-File: LICENSE.txt
 scaevola
 ========
 
-Pad nucleotide sequence.
-Visit the website for more information:
-`https://scaevola.johannes-programming.online <https://scaevola.johannes-programming.online>`_
+Visit the website for more information: `https://scaevola.johannes-programming.online/ <https://scaevola.johannes-programming.online/>`_

scaevola-1.0.12.dist-info/RECORD

@@ -0,0 +1,10 @@
+scaevola/__init__.py,sha256=KAt5tVgdikLvbdauzJTkCsxH3vJKrff4LB1CH8OklYM,57
+scaevola/core.py,sha256=DgSJ9ak-VqupPjB6ICwbglDhtmG-id58FlZ30unpU64,2269
+scaevola/tests/__init__.py,sha256=QhiVlxbRnZlt4CSCc4yAPIRHo-BVzKpxzl80CmZC_Js,256
+scaevola/tests/test_0.py,sha256=K5M1B5GfH5gX3ZqHXtyCd5WZrI3SsZNSKDon5z13KQI,1088
+scaevola/tests/test_op.py,sha256=OfXTuqdPouiZontb-aVZ5r33uTYijibkpO0Kmf4veKU,5115
+scaevola-1.0.12.dist-info/LICENSE.txt,sha256=QwqYepQwTN5xG57cngKt6xxYD9z9hw9d3lcI8zSLiNg,1074
+scaevola-1.0.12.dist-info/METADATA,sha256=-fyLrXibFoG9YbmZsQ7lMM1BvHsDjoDWR5jdtjDrr6I,2315
+scaevola-1.0.12.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+scaevola-1.0.12.dist-info/top_level.txt,sha256=1oM62lKpwPWVxHtGCB2tN-TIs0bzZaSkB9dlI3Eoesw,9
+scaevola-1.0.12.dist-info/RECORD,,

{scaevola-1.0.11.dist-info → scaevola-1.0.12.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

scaevola-1.0.11.dist-info/RECORD

@@ -1,9 +0,0 @@
-scaevola/__init__.py,sha256=KAt5tVgdikLvbdauzJTkCsxH3vJKrff4LB1CH8OklYM,57
-scaevola/core.py,sha256=8BrwNl4jyc5kRY9yUbK1xE8R_HI2ytET_b3Ve_T_Xng,1981
-scaevola/tests/__init__.py,sha256=ks4pt_cFlcE6dNvV8osJ7Ezzewqqqm4LPnP9Qod20tM,229
-scaevola/tests/tests_operators.py,sha256=OfXTuqdPouiZontb-aVZ5r33uTYijibkpO0Kmf4veKU,5115
-scaevola-1.0.11.dist-info/LICENSE.txt,sha256=QwqYepQwTN5xG57cngKt6xxYD9z9hw9d3lcI8zSLiNg,1074
-scaevola-1.0.11.dist-info/METADATA,sha256=hSESzq-CcddVobyBSXkyESyALNIUEXui6hiCW-2Dvr0,2259
-scaevola-1.0.11.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-scaevola-1.0.11.dist-info/top_level.txt,sha256=1oM62lKpwPWVxHtGCB2tN-TIs0bzZaSkB9dlI3Eoesw,9
-scaevola-1.0.11.dist-info/RECORD,,