optimism 3.1.2__tar.gz → 3.1.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: optimism
-Version: 3.1.2
+Version: 3.1.3
 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

{optimism-3.1.2 → optimism-3.1.3}/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.3"
 
 # ...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.3/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.3}/optimism/optimism.py

@@ -200,6 +200,13 @@ TODO: Workaround for tracing in interactive console?
 
 ## Changelog
 
+- 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 +353,7 @@ TODO: Workaround for tracing in interactive console?
 
 # TODO: Cache compiled ASTs!
 
-__version__ = "3.1.2"
+__version__ = "3.1.3"
 
 from typing import (
     Any, Dict, List, Optional, Tuple, Literal as LiteralType, Callable,
@@ -7270,7 +7277,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 +7348,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 +7375,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 +7879,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"
@@ -9913,16 +9931,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.3}/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
 ]
@@ -1247,6 +1248,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 +1295,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'
+""",
     ]
 }
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: optimism
-Version: 3.1.2
+Version: 3.1.3
 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

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))