optimism 3.1.2__tar.gz → 3.1.4__tar.gz

{optimism-3.1.2 → optimism-3.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: optimism
-Version: 3.1.2
+Version: 3.1.4
 Summary: Very simple testing framework suitable for beginner programmers, with easy functions for accomplishing most common testing tasks like providing input. Requires Python 3.8+.
 Home-page: https://cs.wellesley.edu/~pmwh/optimism/docs/optimism.html
 Author: Peter Mawhorter
@@ -19,6 +19,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
 
 # `optimism`
 

{optimism-3.1.2 → optimism-3.1.4}/optimism/__init__.py

@@ -13,7 +13,7 @@ from .optimism import *
 # version from optimism, but we want the version to be defined in that
 # file so that a single-file distribution is equivalent to this packaged
 # distribution. So we define a version here as well, but...
-__version__ = "3.1.2"
+__version__ = "3.1.4"
 
 # ...then we assert it matches so testing will catch it if I forget to
 # keep them in sync before a release. T_T

{optimism-3.1.2 → optimism-3.1.4}/optimism/examples/code.py

@@ -94,3 +94,19 @@ fileTester.checkCodeContains(optimism.Constant(4.0 / 2, float))  # ✗
 fileTester.checkCodeContains(optimism.Constant(4.0 / 2, int))  # ✓
 fileTester.checkCodeContains(optimism.Constant(5.0, int))  # ✗
 fileTester.checkCodeContains(optimism.Constant(5.0, float))  # ✓
+
+# Test augmented assignment matching
+def aug():
+    x = 3
+    x += 4
+    x /= 10
+
+fileTester.checkCodeContains(
+    optimism.Def().contains(optimism.Operator('+'))
+)  # ✓
+fileTester.checkCodeContains(
+    optimism.Def().contains(optimism.Operator('/'))
+)  # ✓
+fileTester.checkCodeContains(
+    optimism.Def(name="aug").contains(optimism.Operator('/', max=0))
+)  # ✗

optimism-3.1.4/optimism/examples/memoryReports.py

@@ -0,0 +1,25 @@
+import optimism as opt
+
+words = ['hi', 'bye']
+pair = [words, words]
+print(opt.memoryReport(words=words, pair=pair))
+
+knot = [pair, words]
+knot.append(knot)
+print(opt.memoryReport(pair=pair, words=words, knot=knot))
+
+code = """\
+a = []
+b = []
+b.append([])
+a.append(b)
+a.append([])
+import math  # don't allow deep copy of env for this code
+"""
+
+tester = opt.testBlock(code)
+case = tester.case()
+case.checkVariableStructure('a', [[[]], []])
+case.checkCustom(
+    lambda result: result['scope']['a'][0] is result['scope']['b']
+)

{optimism-3.1.2 → optimism-3.1.4}/optimism/optimism.py

@@ -200,6 +200,18 @@ TODO: Workaround for tracing in interactive console?
 
 ## Changelog
 
+- Version 3.1.4 treats augmented assignments as operators for
+  `checkCodeContains` purposes, as they should have been all along. It
+  adds a new test for that in the `code.py` example file, and also fixes
+  up some modern mypy type warnings (even though they were mostly
+  spurious).
+- Version 3.1.3 Fixes a numbering bug with memory reports and also fixes
+  a pernicious `deepish_copy` bug: Structures that were supposed to be
+  duplicated would have their top levels duplicated twice separately
+  because the memo from `deepish_copy` was not being passed into
+  `deepcopy` (of course, fixing that the simple way caused more problems
+  when `deepcopy` would update the memo before erroring out). New tests
+  to catch these bugs were added, including doctests for `deepish_copy`.
 - Version 3.1.2 Adds shims to support Python versions 3.8-3.10 again,
   rather than just 3.11+.
 - Version 3.1.1 reformulates the module as a package so that it can add
@@ -346,7 +358,7 @@ TODO: Workaround for tracing in interactive console?
 
 # TODO: Cache compiled ASTs!
 
-__version__ = "3.1.2"
+__version__ = "3.1.4"
 
 from typing import (
     Any, Dict, List, Optional, Tuple, Literal as LiteralType, Callable,
@@ -371,7 +383,7 @@ SPLIT_CONSTANTS = hasattr(ast, "Num")
 
 # Type is required before 3.9 but deprecated in that version
 if sys.version_info >= (3, 9):
-    Type = type
+    from builtins import type as Type
 else:
     from typing import Type
 
@@ -390,19 +402,19 @@ except ImportError:
         def __getitem__(self, _):
             return Any
 
-    Unpack = UnpackShim()
+    Unpack = UnpackShim()  # type: ignore
 
 # Versions of Python before 3.10 don't support TypeAlias
 try:
     from typing import TypeAlias
 except ImportError:
-    TypeAlias = Type
+    TypeAlias = Type  # type: ignore
 
 # Versions of Python before 3.10 don't support NoneType
 try:
     from types import NoneType
 except ImportError:
-    NoneType = type(None)
+    NoneType = type(None)  # type: ignore
 
 #----------------#
 # Monkey Patches #
@@ -723,7 +735,11 @@ Type variable for `ClassInfo` definition.
 
 
 if sys.version_info > (3, 10):
-    ClassInfo: TypeAlias = Union[Type[T], Tuple['ClassInfo', ...], Type[Union]]
+    ClassInfo: TypeAlias = Union[
+        Type[T],
+        Tuple['ClassInfo', ...],
+        Type[Union]
+    ]
 else:
     ClassInfo: TypeAlias = Union[Type[T], Tuple['ClassInfo', ...]]
 """
@@ -3906,7 +3922,7 @@ class QuietSkipManager(TestManager[SilentCase]):
 # Test factories #
 #----------------#
 
-def testFunction(fn: FunctionType) -> FunctionManager:
+def testFunction(fn: Union[FunctionType, Callable]) -> FunctionManager:
     """
     Creates a test-manager for the given function.
     """
@@ -5998,7 +6014,9 @@ class Loop(ASTRequirement):
     """
     def __init__(
         self,
-        only: Optional[Iterable[ExtendedLoopType]] = None,
+        only: Optional[
+            Union[ExtendedLoopType, Iterable[ExtendedLoopType]]
+        ] = None,
         **kwargs: Unpack[NumArgs]
     ) -> None:
         """
@@ -6860,7 +6878,13 @@ class Operator(ASTRequirement):
     ) -> Iterator[Tuple[ast.AST, bool]]:
         for node in self._walkNodesOfType(
             syntax_tree,
-            (ast.UnaryOp, ast.BinOp, ast.BoolOp, ast.Compare)
+            (
+                ast.UnaryOp,
+                ast.BinOp,
+                ast.BoolOp,
+                ast.Compare,
+                ast.AugAssign
+            )
         ):
             # Determine not/partial/full status of match...
             match: LiteralType[True, "partial", False] = False
@@ -7139,7 +7163,7 @@ which has slots that used to contain complex sub-objects replaced with
 `MemReference` objects. See `memoryMap`.
 """
 
-SmallTypes: Tuple[Type] = (int, float, complex, bool, NoneType)
+SmallTypes: Tuple[Type, ...] = (int, float, complex, bool, NoneType)
 """
 The object types which are small enough to fit into a single field
 without using a pointer in theory, which we thus represent without using
@@ -7150,7 +7174,7 @@ with `isinstance`.
 # later so it cannot just be None. If we only wanted to support Python
 # 3.10+, we could use the union directly in isinstance.
 
-SmallType: TypeAlias = Union[int, float, complex, bool, NoneType]
+SmallType: TypeAlias = Union[int, float, complex, bool, None]
 """
 A union of the `SmallTypes`.
 """
@@ -7224,6 +7248,7 @@ def memoryMap(
      or (INLINE_STRINGS_IN_MEMORY_REPORTS and isinstance(obj, str))
     ):
         # Simple values are used as-is:
+        obj = cast(SmallType, obj)
         return None, obj
     elif isinstance(obj, (tuple, list, set)):
         # Structures are made shallow and referenced
@@ -7270,7 +7295,7 @@ def memoryMap(
         # not made shallow
         assigned[id(obj)] = (my_ref, obj)
         if count_from > 0:
-            return count_from, my_ref
+            return count_from - 1, my_ref
         else:
             return None, my_ref
 
@@ -7341,6 +7366,16 @@ def memoryReport(*objs: Any, **named: Any) -> str:
     >>> print(memoryReport(x=5, y=12.0), end='')
     x: 5
     y: 12.0
+    >>> a = ['hi', 'bye']
+    >>> b = [a, a]
+    >>> inlineStringsInMemoryReports(False)
+    >>> print(memoryReport(a=a, b=b), end='')
+    a: @0
+    b: @3
+    @0: [@1, @2]
+    @3: [@0, @0]
+    @1: 'hi'
+    @2: 'bye'
     """
     refs: MemoryMap = {}
     top = -1
@@ -7358,6 +7393,7 @@ def memoryReport(*objs: Any, **named: Any) -> str:
 
     # Order by named values (in order given) and then numeric values (by
     # number assigned)
+    # TODO: Consider ordering name refs by their names?
 
     result = ''
     handled = set()
@@ -7861,7 +7897,7 @@ def reportObjDiffs(
                 rev = [key for key in env if env[key] == cObj][0]
                 yield (
                     f"{prefix}: reference {repr(aObj)} cannot match"
-                    f" {repr(cObj)} because {repr({cObj})} is already"
+                    f" {repr(cObj)} because {repr(cObj)} is already"
                     f" assigned as the match for {repr(rev)}. This"
                     f" means you have used two references to"
                     f" different objects where the correct solution"
@@ -9863,6 +9899,11 @@ def get_ref_src(src: str, node: ast.AST) -> str:
 
     # We're going to have to do this ourself: find the start of the
     # expression and state-machine to find its end
+    if not hasattr(node, "lineno") or not hasattr(node, "col_offset"):
+        raise TypeError(
+            f"Node {node!r} is missing lineno and/or col_offset"
+            f" attribute(s)."
+        )
     start = get_src_index(src, node.lineno, node.col_offset)
 
     # Figure out the end point
@@ -9913,16 +9954,69 @@ def deepish_copy(obj: T, memo: Optional[dict] = None) -> T:
     copy.deepcopy wherever possible and making shallower copies
     elsewhere. Basically a middle-ground between copy.deepcopy and
     copy.copy.
+
+    TODO: Why does this break in a notebook?!?
+
+    For example:
+
+    >>> import math  # copy module is not deep-copyable
+    >>> stuff = ['a', math]
+    >>> outside = [stuff, math, stuff]
+    >>> copy.deepcopy(outside)  # can't copy list w/ module inside
+    Traceback (most recent call last):
+    ...
+    TypeError...
+    >>> clone = deepish_copy(outside)
+    >>> clone is outside
+    False
+    >>> clone  # doctest: +ELLIPSIS
+    [['a', <module 'math'...>], <module 'math'...>, ['a', <module 'math'...>]]
+    >>> outside  # doctest: +ELLIPSIS
+    [['a', <module 'math'...>], <module 'math'...>, ['a', <module 'math'...>]]
+    >>> clone == outside
+    True
+    >>> clone[0] is stuff
+    False
+    >>> clone[0] == stuff
+    True
+    >>> clone[1] is math  # can't copy modules, so it is tangled
+    True
+    >>> clone[1] == math
+    True
+    >>> clone[0][0] == 'a'
+    True
+    >>> clone[0][1] is math
+    True
+    >>> clone[1] is clone[0][1]  # alias preserved
+    True
+    >>> clone[0] is clone[2]
+    True
+    >>> # Now a test with a dictionary
+    >>> d = {'a': outside, 'b': stuff}
+    >>> copy.deepcopy(d)  # can't copy dictionary w/ module inside
+    Traceback (most recent call last):
+    ...
+    TypeError...
+    >>> dc = deepish_copy(d)
+    >>> dc['a'] is outside
+    False
+    >>> dc['a'] == outside
+    True
+    >>> dc['a'][0] is dc['b']
+    True
+    >>> dc['a'][2] is dc['b']
+    True
     """
     if memo is None:
         memo = {}
     if id(obj) in memo:
         return memo[id(obj)]
-
     result: T
     try:
-        result = copy.deepcopy(obj)
+        save = copy.copy(memo)
+        result = copy.deepcopy(obj, save)  # TODO: Is memo always compatible?
         # not sure about memo dict compatibility
+        memo.update(save)  # if we didn't crash out, update real memo
         memo[id(obj)] = result
         return result
 

{optimism-3.1.2 → optimism-3.1.4}/optimism/test_examples.py

@@ -29,7 +29,8 @@ EXAMPLES = [
     ("suites", []),
     ("literals", []),
     ("structure", []),
-    ("doctests", [])
+    ("doctests", []),
+    ("memoryReports", [])
     #("reverse_tracing", []),
     # TODO: Include this once the machinery for it is there
 ]
@@ -517,8 +518,9 @@ All 4 expectation(s) were met.
   Code does not contain the expected structure:
     at least 1 definition(s) of functionName
   Although it does partially satisfy the requirement:
-    Requirement partially satisfied via 0 full and 1 partial match(es):
+    Requirement partially satisfied via 0 full and 2 partial match(es):
       Partial match: FunctionDef on line 10
+      Partial match: FunctionDef on line 99
   checked code in file '{full_file}'""",
         "✓ {file}:44",
         """\
@@ -527,8 +529,9 @@ All 4 expectation(s) were met.
     at least 1 function definition(s) that also contain(s):
       at least 1 loop(s) or generator expression(s)
   Although it does partially satisfy the requirement:
-    Requirement partially satisfied via 0 full and 1 partial match(es):
+    Requirement partially satisfied via 0 full and 2 partial match(es):
       Partial match: FunctionDef on line 10
+      Partial match: FunctionDef on line 99
   checked code in file '{full_file}'""",
         """\
 ✗ {file}:46
@@ -600,24 +603,36 @@ All 4 expectation(s) were met.
   Code does not contain the expected structure:
     at least 1 constant 2.0
   Although it does partially satisfy the requirement:
-    Requirement partially satisfied via 0 full and 52 partial match(es):
+    Requirement partially satisfied via 0 full and 60 partial match(es):
 """ + ("""\
       Partial match: Constant on line 1
       Partial match: Constant on line 7""" if better_line_numbers else """\
       Partial match: Str on line 3
-      Partial match: NameConstant on line 7"""),  # not listing all 52...
+      Partial match: NameConstant on line 7"""),  # not listing all 60...
         "✓ {file}:94",
         """\
 ✗ {file}:95
   Code does not contain the expected structure:
     at least 1 constant 5.0
   Although it does partially satisfy the requirement:
-    Requirement partially satisfied via 0 full and 52 partial match(es):
+    Requirement partially satisfied via 0 full and 60 partial match(es):
 """ + ("""\
       Partial match: Constant on line 1
       Partial match: Constant on line 7""" if better_line_numbers else """\
       Partial match: Str on line 3
-      Partial match: NameConstant on line 7"""),  # not listing all 52...
+      Partial match: NameConstant on line 7"""),  # not listing all 60...
+        "✓ {file}:104",
+        "✓ {file}:107",
+        """\
+✗ {file}:110
+  Code does not contain the expected structure:
+    at least 1 definition(s) of aug that also contain(s):
+      no operator '/'
+  Although it does partially satisfy the requirement:
+    Requirement partially satisfied via 0 full and 2 partial match(es):
+      Partial match: FunctionDef on line 99
+      Partial match: FunctionDef on line 10
+"""
     ],
 
     "reverse_tracing": [
@@ -1247,6 +1262,10 @@ All 4 expectation(s) were met.
   Found only 2 matching distinct doctest example(s) (required 3).
   checked code in file 'doc_example.py'
 """
+    ],
+    "memoryReports": [
+        "✓ {file}:22",
+        "✓ {file}:23",
     ]
 }
 
@@ -1290,6 +1309,27 @@ Outcomes in suite A (again):
         "No more outcomes in suite A: []",
         "No more outcomes in suite B: []",
         "No more suite B.",
+    ],
+
+    "memoryReports": [
+        """\
+words: @0
+pair: @3
+@0: [@1, @2]
+@3: [@0, @0]
+@1: 'hi'
+@2: 'bye'
+""",
+        """\
+pair: @0
+words: @1
+knot: @4
+@0: [@1, @1]
+@1: [@2, @3]
+@4: [@0, @1, @4]
+@2: 'hi'
+@3: 'bye'
+""",
     ]
 }
 
@@ -1334,63 +1374,72 @@ def test_all():
     Tests each example file. The `examples` directory must be in the
     same place that this `test_examples.py` file lives.
     """
-    os.chdir(os.path.join(os.path.dirname(__file__), "examples"))
-    sys.path.insert(0, '.')
-    for (mname, inputs) in EXAMPLES:
-        optimism.detailLevel(0)
-        optimism.deleteAllTestSuites()
-        optimism.colors(False)
-        module, output, stdout = run_example(mname, inputs)
-        # Replace tracebacks with generic forms so we can match on
-        # specific errors being reported while ignoring the files & lines
-        # where they are reported.
-        stdout = re.sub(
-            r"Traceback \(most recent call last\):.*?^([ a-zA-Z]*Error:)",
-            "Traceback omitted\n\\1",
-            stdout,
-            flags=re.MULTILINE | re.DOTALL
-        )
-        output = re.sub(
-            r"Traceback \(most recent call last\):.*?^([ a-zA-Z]*Error:)",
-            "Traceback omitted\n\\1",
-            output,
-            flags=re.MULTILINE | re.DOTALL
-        )
-        #output = re.sub(r"Traceback \(most recent call last\).*?NameError:", "HAHAHA", output, flags=re.MULTILINE | re.DOTALL)
-        # Scrub line numbers from tracebacks so our expectations don't
-        # become hopelessly fragile
-        stdout = re.sub(r", line \d+,", ", line X,", stdout)
-        output = re.sub(r", line \d+,", ", line X,", output)
-        for ex in EXPECTATIONS[mname]:
-            exp = ex.format(
-                file=os.path.basename(module.__file__),
-                dir=(
-                    os.path.split(module.__file__)[0] + '/'
-                    if better_line_numbers
-                    else ''
-                ),
-                full_file=module.__file__,
-                opt_file=optimism.__file__,
+    olddir = os.getcwd()
+    try:
+        os.chdir(os.path.join(os.path.dirname(__file__), "examples"))
+        sys.path.insert(0, '.')
+        for (mname, inputs) in EXAMPLES:
+            optimism.detailLevel(0)
+            optimism.deleteAllTestSuites()
+            optimism.colors(False)
+            module, output, stdout = run_example(mname, inputs)
+            # Replace tracebacks with generic forms so we can match on
+            # specific errors being reported while ignoring the files & lines
+            # where they are reported.
+            stdout = re.sub(
+                r"Traceback \(most recent call last\):.*?^([ a-zA-Z]*Error:)",
+                "Traceback omitted\n\\1",
+                stdout,
+                flags=re.MULTILINE | re.DOTALL
             )
-            # Redundant, but makes issues easier to diagnose
-            for line in exp.splitlines():
-                if line not in output:
-                    print("\n\nLINE:\n" + line)
-                    print("\n\nOUTPUT:\n" + output)
-                assert (line in output), (line, output)
-            if exp not in output:
-                print("\n\nEXP:\n" + exp)
-                print("\n\nOUTPUT:\n" + output)
-            assert (exp in output), (exp, output)
-        if mname in STDOUT_EXPECT:
-            for ex in STDOUT_EXPECT[mname]:
+            output = re.sub(
+                r"Traceback \(most recent call last\):.*?^([ a-zA-Z]*Error:)",
+                "Traceback omitted\n\\1",
+                output,
+                flags=re.MULTILINE | re.DOTALL
+            )
+            #output = re.sub(r"Traceback \(most recent call last\).*?NameError:", "HAHAHA", output, flags=re.MULTILINE | re.DOTALL)
+            # Scrub line numbers from tracebacks so our expectations don't
+            # become hopelessly fragile
+            stdout = re.sub(r", line \d+,", ", line X,", stdout)
+            output = re.sub(r", line \d+,", ", line X,", output)
+            for ex in EXPECTATIONS[mname]:
                 exp = ex.format(
                     file=os.path.basename(module.__file__),
-                    dir=os.path.split(module.__file__)[0],
+                    dir=(
+                        os.path.split(module.__file__)[0] + '/'
+                        if better_line_numbers
+                        else ''
+                    ),
                     full_file=module.__file__,
                     opt_file=optimism.__file__,
                 )
+                # Redundant, but makes issues easier to diagnose
                 for line in exp.splitlines():
-                    assert (line in stdout), stdout
-                assert (exp in stdout), stdout
-    os.chdir("..")
+                    if line not in output:
+                        print("\n\nLINE:\n" + line)
+                        print("\n\nOUTPUT:\n" + output)
+                    assert (line in output), (line, output)
+                if exp not in output:
+                    print("\n\nEXP:\n" + exp)
+                    print("\n\nOUTPUT:\n" + output)
+                assert (exp in output), (exp, output)
+            if mname in STDOUT_EXPECT:
+                for ex in STDOUT_EXPECT[mname]:
+                    exp = ex.format(
+                        file=os.path.basename(module.__file__),
+                        dir=os.path.split(module.__file__)[0],
+                        full_file=module.__file__,
+                        opt_file=optimism.__file__,
+                    )
+                    for line in exp.splitlines():
+                        assert (line in stdout), stdout
+                    assert (exp in stdout), stdout
+    finally:
+        os.chdir(olddir)
+
+
+if __name__ == "__main__":
+    print('Testing example files...')
+    test_all()
+    print('...all tests passed.')

{optimism-3.1.2 → optimism-3.1.4}/optimism.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: optimism
-Version: 3.1.2
+Version: 3.1.4
 Summary: Very simple testing framework suitable for beginner programmers, with easy functions for accomplishing most common testing tasks like providing input. Requires Python 3.8+.
 Home-page: https://cs.wellesley.edu/~pmwh/optimism/docs/optimism.html
 Author: Peter Mawhorter
@@ -19,6 +19,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
 
 # `optimism`
 

optimism-3.1.2/optimism/examples/memoryReports.py

@@ -1,9 +0,0 @@
-import optimism as opt
-
-words = ['hi', 'bye']
-pair = [words, words]
-print(opt.memoryReport(words=words, pair=pair))
-
-knot = [pair, words]
-knot.append(knot)
-print(opt.memoryReport(pair=pair, words=words, knot=knot))