scaevola 1.0.15__tar.gz → 1.1.0__tar.gz

{scaevola-1.0.15/src/scaevola.egg-info → scaevola-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scaevola
-Version: 1.0.15
+Version: 1.1.0
 Summary: This project provides a class with preset right handed magic methods.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)

{scaevola-1.0.15 → scaevola-1.1.0}/pyproject.toml

@@ -24,7 +24,7 @@ keywords = []
 name = "scaevola"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.0.15"
+version = "1.1.0"
 
 [project.license]
 file = "LICENSE.txt"

scaevola-1.1.0/src/scaevola/core/__init__.py

@@ -0,0 +1,85 @@
+import enum
+import functools
+import operator
+import tomllib
+import types
+from importlib import resources
+from typing import *
+
+__all__ = ["Scaevola", "auto", "getfuncnames", "makefunc"]
+
+
+class Util(enum.Enum):
+    "This enum provides a singleton."
+    util = None
+
+    @functools.cached_property
+    def data(self: Self) -> dict:
+        "This cached property holds the cfg data."
+        text: str = resources.read_text("scaevola.core", "cfg.toml")
+        ans: dict = tomllib.loads(text)
+        return ans
+
+    @functools.cached_property
+    def funcdata(self: Self) -> dict:
+        "This cached property holds the data for easy function making."
+        ans: dict = dict()
+        name: str
+        doc: str
+        inner: Callable
+        name = "__ge__"
+        doc = self.data["docs"]["ge"]
+        inner = operator.le
+        ans[name] = dict(doc=doc, inner=inner)
+        name = "__gt__"
+        doc = self.data["docs"]["gt"]
+        inner = operator.lt
+        ans[name] = dict(doc=doc, inner=inner)
+        name = "__rdivmod__"
+        doc = self.data["docs"]["rdivmod"]
+        inner = divmod
+        ans[name] = dict(doc=doc, inner=inner)
+        x: Any
+        y: Any
+        for x, y in self.data["operator"].items():
+            name = "__r%s__" % x.rstrip("_")
+            doc = self.data["docs"]["operator"] % y
+            inner = getattr(operator, x)
+            ans[name] = dict(doc=doc, inner=inner)
+        ans = dict(sorted(ans.items()))
+        return ans
+
+
+def auto(cls: type) -> type:
+    "This decorator implements all the righthand functions."
+    name: str
+    for name in getfuncnames():
+        if name not in cls.__dict__.keys():
+            makefunc(cls, name)
+    return cls
+
+
+def getfuncnames() -> list[str]:
+    "This function returns the names of all righthand functions."
+    return list(Util.util.funcdata.keys())
+
+
+def makefunc(cls: type, name: str) -> types.FunctionType:
+    "This function implements a certain righthand function."
+    inner: Callable = Util.util.funcdata[name]["inner"]
+
+    def outer(self: Self, other: Any) -> Any:
+        "This docstring will be overwritten."
+        return inner(type(self)(other), self)
+
+    outer.__doc__ = Util.util.funcdata[name]["doc"]
+    outer.__module__ = cls.__module__
+    outer.__name__ = name
+    outer.__qualname__ = cls.__qualname__ + "." + name
+    setattr(cls, name, outer)
+    return outer
+
+
+@auto
+class Scaevola:
+    pass

scaevola-1.0.15/src/scaevola/tests/test_0.py → scaevola-1.1.0/src/scaevola/tests/test_doc.py

@@ -1,10 +1,11 @@
 import unittest
+from typing import *
 
 from scaevola.core import Scaevola
 
 
 class TestScaevolaDocstrings(unittest.TestCase):
-    def test_methods_have_docstrings(self):
+    def test_methods_have_docstrings(self: Self) -> None:
         methods_to_check = [
             "__ge__",
             "__gt__",
@@ -25,15 +26,11 @@ class TestScaevolaDocstrings(unittest.TestCase):
         ]
 
         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",
+                magic = getattr(Scaevola, name, None)
+                self.assertTrue(
+                    magic.__doc__.startswith("This magic method "),
+                    "doc=%r" % magic.__doc__,
                 )
 
 

{scaevola-1.0.15 → scaevola-1.1.0}/src/scaevola/tests/test_op.py

@@ -1,4 +1,5 @@
 import unittest
+from typing import *
 
 from scaevola.core import Scaevola
 

scaevola-1.1.0/src/scaevola/tests/test_slots_Scaevola.py

@@ -0,0 +1,34 @@
+import unittest
+from typing import *
+
+from scaevola.core import Scaevola
+
+
+class Foo(Scaevola):
+    __slots__ = ("x", "y")
+
+
+class Bar(Scaevola):
+    pass
+
+
+class TestSlots(unittest.TestCase):
+    def test_foo(self: Self) -> None:
+        foo: Foo = Foo()
+        foo.x = 4
+        foo.y = 2
+        foo.z = 0
+        self.assertEqual(foo.x, 4)
+        self.assertEqual(foo.y, 2)
+        self.assertEqual(foo.z, 0)
+
+    def test_bar(self: Self) -> None:
+        bar: Bar = Bar()
+        bar.x = 4
+        bar.y = 2
+        self.assertEqual(bar.x, 4)
+        self.assertEqual(bar.y, 2)
+
+
+if __name__ == "__main__":
+    unittest.main()

scaevola-1.1.0/src/scaevola/tests/test_slots_auto.py

@@ -0,0 +1,36 @@
+import unittest
+from typing import *
+
+from scaevola.core import auto
+
+
+@auto
+class Foo:
+    __slots__ = ("x", "y")
+
+
+@auto
+class Bar:
+    pass
+
+
+class TestSlots(unittest.TestCase):
+    def test_foo(self: Self) -> None:
+        foo: Foo = Foo()
+        foo.x = 4
+        foo.y = 2
+        self.assertEqual(foo.x, 4)
+        self.assertEqual(foo.y, 2)
+        with self.assertRaises(AttributeError):
+            foo.z = 0
+
+    def test_bar(self: Self) -> None:
+        bar: Bar = Bar()
+        bar.x = 4
+        bar.y = 2
+        self.assertEqual(bar.x, 4)
+        self.assertEqual(bar.y, 2)
+
+
+if __name__ == "__main__":
+    unittest.main()

{scaevola-1.0.15 → scaevola-1.1.0/src/scaevola.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scaevola
-Version: 1.0.15
+Version: 1.1.0
 Summary: This project provides a class with preset right handed magic methods.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)

{scaevola-1.0.15 → scaevola-1.1.0}/src/scaevola.egg-info/SOURCES.txt

@@ -4,11 +4,13 @@ README.rst
 pyproject.toml
 setup.cfg
 src/scaevola/__init__.py
-src/scaevola/core.py
 src/scaevola.egg-info/PKG-INFO
 src/scaevola.egg-info/SOURCES.txt
 src/scaevola.egg-info/dependency_links.txt
 src/scaevola.egg-info/top_level.txt
+src/scaevola/core/__init__.py
 src/scaevola/tests/__init__.py
-src/scaevola/tests/test_0.py
-src/scaevola/tests/test_op.py
+src/scaevola/tests/test_doc.py
+src/scaevola/tests/test_op.py
+src/scaevola/tests/test_slots_Scaevola.py
+src/scaevola/tests/test_slots_auto.py

scaevola-1.0.15/src/scaevola/core.py

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