cmp3 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

cmp3/core/__init__.py

@@ -11,14 +11,22 @@ def cmp(x: Any, y: Any, /, *, mode: str = "portingguide") -> float | int:
     if mode == "portingguide":
         return (x > y) - (x < y)
     if mode == "poset":
-        if (x <= y) and (y <= x):
+        return cmp_poset(x, y)
+    raise ValueError("%r is not an appropriate value for mode." % mode)
+
+
+def cmp_poset(x: Any, y: Any, /) -> float | int:
+    "This function returns a value that compares to 0 as x compares to y under the assumption that both arguments belong to a poset."
+    if x <= y:
+        if y <= x:
             return 0
-        if (x <= y) and (not y <= x):
+        else:
             return -1
-        if (not x <= y) and (y <= x):
+    else:
+        if y <= x:
             return 1
-        return float("nan")
-    raise ValueError
+        else:
+            return float("nan")
 
 
 def cmpDeco(cls: type, /) -> type:

cmp3/tests/test_all.py

@@ -0,0 +1,113 @@
+import math
+import unittest
+from typing import *
+
+from cmp3.core import CmpABC, cmp, cmp_poset, cmpDeco
+
+
+class TestCmpFunction(unittest.TestCase):
+    def test_portingguide_less(self: Self) -> None:
+        self.assertEqual(cmp(1, 2), -1)
+        self.assertEqual(cmp(-5, -1), -1)
+
+    def test_portingguide_equal(self: Self) -> None:
+        self.assertEqual(cmp(3, 3), 0)
+        self.assertEqual(cmp("a", "a"), 0)
+
+    def test_portingguide_greater(self: Self) -> None:
+        self.assertEqual(cmp(2, 1), 1)
+        self.assertEqual(cmp("b", "a"), 1)
+
+    def test_poset_mode_uses_poset_semantics(self: Self) -> None:
+        # For totally ordered ints, this should behave like normal cmp
+        self.assertEqual(cmp(1, 2, mode="poset"), -1)
+        self.assertEqual(cmp(2, 1, mode="poset"), 1)
+        self.assertEqual(cmp(5, 5, mode="poset"), 0)
+
+    def test_invalid_mode_raises(self: Self) -> None:
+        with self.assertRaises(ValueError):
+            cmp(1, 2, mode="something-else")
+
+
+class TestCmpPoset(unittest.TestCase):
+    def test_total_order_ints(self: Self) -> None:
+        self.assertEqual(cmp_poset(1, 2), -1)
+        self.assertEqual(cmp_poset(2, 1), 1)
+        self.assertEqual(cmp_poset(3, 3), 0)
+
+    def test_incomparable_returns_nan(self: Self) -> None:
+        class Incomparable:
+            def __le__(self: Self, other: Any) -> bool:
+                # Always False, so no order relation is established
+                return False
+
+        result: Any
+        x: Incomparable
+        y: Incomparable
+
+        x = Incomparable()
+        y = Incomparable()
+        result = cmp_poset(x, y)
+        self.assertTrue(math.isnan(result))
+
+
+# A concrete implementation of CmpABC for testing
+class Box(CmpABC):
+    def __init__(self: Self, value: Any) -> None:
+        self.value = value
+
+    def __cmp__(self: Self, other: Any) -> Any:
+        if not isinstance(other, Box):
+            return NotImplemented
+        return (self.value > other.value) - (self.value < other.value)
+
+
+@cmpDeco
+class DecoratedBox:
+    def __init__(self: Self, value: Any) -> None:
+        self.value = value
+
+    def __cmp__(self: Self, other: Any) -> Any:
+        if not isinstance(other, DecoratedBox):
+            return NotImplemented
+        return (self.value > other.value) - (self.value < other.value)
+
+
+class TestCmpABCAndDeco(unittest.TestCase):
+    def test_cmpabc_is_abstract(self: Self) -> None:
+        with self.assertRaises(TypeError):
+            CmpABC()  # type: ignore[abstract]  # must not be instantiable
+
+    def test_cmpabc_comparisons(self: Self) -> None:
+        a: Box
+        b: Box
+        c: Box
+        a = Box(1)
+        b = Box(2)
+        c = Box(1)
+
+        self.assertTrue(a < b)
+        self.assertTrue(a <= b)
+        self.assertTrue(b > a)
+        self.assertTrue(b >= a)
+        self.assertTrue(a == c)
+        self.assertTrue(a != b)
+
+    def test_cmpdeco_on_regular_class(self: Self) -> None:
+        x: DecoratedBox
+        y: DecoratedBox
+        z: DecoratedBox
+        x = DecoratedBox(10)
+        y = DecoratedBox(20)
+        z = DecoratedBox(10)
+
+        self.assertTrue(x < y)
+        self.assertTrue(x <= y)
+        self.assertTrue(y > x)
+        self.assertTrue(y >= x)
+        self.assertTrue(x == z)
+        self.assertTrue(x != y)
+
+
+if __name__ == "__main__":
+    unittest.main()

cmp3/tests/test_core.py

@@ -0,0 +1,119 @@
+import math
+import unittest
+from typing import *
+
+from cmp3 import core
+
+
+class TestCmpPortingGuide(unittest.TestCase):
+    def test_equal(self: Self) -> None:
+        self.assertEqual(core.cmp(1, 1), 0)
+        self.assertEqual(core.cmp("a", "a"), 0)
+
+    def test_less(self: Self) -> None:
+        self.assertEqual(core.cmp(1, 2), -1)
+        self.assertEqual(core.cmp("a", "b"), -1)
+
+    def test_greater(self: Self) -> None:
+        self.assertEqual(core.cmp(2, 1), 1)
+        self.assertEqual(core.cmp("b", "a"), 1)
+
+    def test_invalid_mode_raises(self: Self) -> None:
+        with self.assertRaises(ValueError):
+            core.cmp(1, 2, mode="invalid-mode")
+
+
+class TestCmpPoset(unittest.TestCase):
+    def test_poset_equal(self: Self) -> None:
+        # subset ordering: same set
+        self.assertEqual(core.cmp_poset({1, 2}, {1, 2}), 0)
+
+    def test_poset_less(self: Self) -> None:
+        # subset ordering: strict subset
+        self.assertEqual(core.cmp_poset({1}, {1, 2}), -1)
+
+    def test_poset_greater(self: Self) -> None:
+        # subset ordering: strict superset
+        self.assertEqual(core.cmp_poset({1, 2}, {1}), 1)
+
+    def test_poset_incomparable(self: Self) -> None:
+        # incomparable in subset ordering
+        res: Any
+        res = core.cmp_poset({1}, {2})
+        self.assertTrue(math.isnan(res))
+
+
+class TestCmpModePoset(unittest.TestCase):
+    def test_cmp_uses_poset_mode(self: Self) -> None:
+        self.assertEqual(core.cmp({1}, {1, 2}, mode="poset"), -1)
+        self.assertEqual(core.cmp({1, 2}, {1}, mode="poset"), 1)
+        self.assertTrue(math.isnan(core.cmp({1}, {2}, mode="poset")))
+
+
+class Number(core.CmpABC):
+    def __init__(self: Self, value: int) -> None:
+        self.value = value
+
+    def __cmp__(self: Self, other: Any) -> Any:
+        if not isinstance(other, Number):
+            return NotImplemented
+        # classic 3-way comparison
+        return (self.value > other.value) - (self.value < other.value)
+
+
+class TestCmpDecoAndCmpABC(unittest.TestCase):
+    def setUp(self: Self) -> None:
+        self.a = Number(1)
+        self.b = Number(2)
+        self.c = Number(1)
+
+    def test_eq_ne(self: Self) -> None:
+        self.assertTrue(self.a == self.c)
+        self.assertFalse(self.a == self.b)
+        self.assertTrue(self.a != self.b)
+        self.assertFalse(self.a != self.c)
+
+    def test_lt_le(self: Self) -> None:
+        self.assertTrue(self.a < self.b)
+        self.assertTrue(self.a <= self.b)
+        self.assertTrue(self.a <= self.c)
+        self.assertFalse(self.b < self.a)
+
+    def test_gt_ge(self: Self) -> None:
+        self.assertTrue(self.b > self.a)
+        self.assertTrue(self.b >= self.a)
+        self.assertTrue(self.b >= self.c)
+        self.assertFalse(self.a > self.b)
+
+    def test_cmpabc_is_abstract(self: Self) -> None:
+        with self.assertRaises(TypeError):
+            core.CmpABC()  # abstract, cannot be instantiated
+
+
+class TestCmpDecoOnPlainClass(unittest.TestCase):
+    def test_decorator_on_non_abc_class(self: Self) -> None:
+        @core.cmpDeco
+        class Plain:
+            def __init__(self: Self, x: int) -> None:
+                self.x = x
+
+            def __cmp__(self: Self, other: Any) -> Any:
+                if not isinstance(other, Plain):
+                    return NotImplemented
+                return (self.x > other.x) - (self.x < other.x)
+
+        p1: Plain
+        p2: Plain
+        p3: Plain
+        p1 = Plain(1)
+        p2 = Plain(2)
+        p3 = Plain(1)
+
+        self.assertTrue(p1 < p2)
+        self.assertTrue(p2 > p1)
+        self.assertTrue(p1 == p3)
+        self.assertTrue(p1 != p2)
+
+
+if __name__ == "__main__":
+    unittest.main()

{cmp3-0.6.2.dist-info → cmp3-0.6.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmp3
-Version: 0.6.2
+Version: 0.6.4
 Summary: This project updates the concept of __cmp__ for python3.
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)

cmp3-0.6.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+cmp3/__init__.py,sha256=hxvwX8wZhft-DkMAoU3xz65RMZib8nPQQiAbxba27iQ,49
+cmp3/core/__init__.py,sha256=_xdO8zsRzwDegppawfT3zohm6xSHt5KC7C9jELqRYXQ,2199
+cmp3/tests/__init__.py,sha256=HqmxhnTFFqh9Nzl7STV5GeDYqDmhrc9e1TCHssUbC1s,426
+cmp3/tests/test_all.py,sha256=_RYEUhy3V7NjIZaA7JT2916lnXyIi6Xh1RY9dv4rD30,3342
+cmp3/tests/test_core.py,sha256=SygGk85rzFlq5dQ0S6ht7w3DwL3y9oPcVCNf0XxkwH0,3679
+cmp3-0.6.4.dist-info/licenses/LICENSE.txt,sha256=Jb9jm2E2hEO2LqnWwHeHt4cneyCbnZ1SBte0bgb9qoY,1074
+cmp3-0.6.4.dist-info/METADATA,sha256=Ukb66EeYszwm68_kGx02cOlw5lN6co7G_RlglxCXJqs,2300
+cmp3-0.6.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cmp3-0.6.4.dist-info/top_level.txt,sha256=FzJWsf0Xj_eeRJuFle30ZFjVZs8ahy7oLhYdWx8YkgA,5
+cmp3-0.6.4.dist-info/RECORD,,

{cmp3-0.6.2.dist-info → cmp3-0.6.4.dist-info}/WHEEL

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

cmp3/tests/test_1984.py

@@ -1,11 +0,0 @@
-import unittest
-from typing import *
-
-
-class Test1984(unittest.TestCase):
-    def test_1984(self: Self) -> None:
-        self.assertEqual(2 + 2, 4, "Ignorance is Strength")
-
-
-if __name__ == "__main__":
-    unittest.main()

cmp3-0.6.2.dist-info/RECORD

@@ -1,9 +0,0 @@
-cmp3/__init__.py,sha256=hxvwX8wZhft-DkMAoU3xz65RMZib8nPQQiAbxba27iQ,49
-cmp3/core/__init__.py,sha256=6uXJPePzO0rZVCYASVP2A3FU05F_87g1eTfkNdfOFCE,1947
-cmp3/tests/__init__.py,sha256=HqmxhnTFFqh9Nzl7STV5GeDYqDmhrc9e1TCHssUbC1s,426
-cmp3/tests/test_1984.py,sha256=_ami0cAP8vU0C8RpQhP1tLWnLFGTaeHlOG5O60RVKv8,222
-cmp3-0.6.2.dist-info/licenses/LICENSE.txt,sha256=Jb9jm2E2hEO2LqnWwHeHt4cneyCbnZ1SBte0bgb9qoY,1074
-cmp3-0.6.2.dist-info/METADATA,sha256=yUjZmwuPzD3MxbaB-8JgtyuXXXq-JJFIww7LKaO-cqI,2300
-cmp3-0.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cmp3-0.6.2.dist-info/top_level.txt,sha256=FzJWsf0Xj_eeRJuFle30ZFjVZs8ahy7oLhYdWx8YkgA,5
-cmp3-0.6.2.dist-info/RECORD,,