atrace 0.1.3__tar.gz → 0.1.6__tar.gz

{atrace-0.1.3 → atrace-0.1.6}/.github/workflows/publish-to-pypi.yml

@@ -25,6 +25,12 @@ jobs:
         uses: astral-sh/setup-uv@v7
       - name: Install Python 3.13
         run: uv python install 3.13
+      - name: Lint
+        run: uv run ruff check src tests
+      - name: Type check
+        run: uv run mypy src tests
+      - name: Run tests
+        run: uv run pytest
       - name: Build
         run: uv build
       - name: Publish

{atrace-0.1.3 → atrace-0.1.6}/.gitignore

@@ -11,3 +11,6 @@ wheels/
 
 # Mac
 .DS_Store
+
+# IDEs
+.vscode

atrace-0.1.6/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: atrace
+Version: 0.1.6
+Summary: Generate trace tables for programs
+Project-URL: Repository, https://github.com/nwolff/atrace.git
+Author-email: Nicholas Wolff <nwolff@gmail.com>
+Requires-Python: >=3.10
+Requires-Dist: tabulate>=0.9.0
+Description-Content-Type: text/markdown
+
+# Usage
+
+Automatically prints a trace table of a program once the execution is finished.
+
+Just import the module.
+
+An idea of how things look:
+
+```
+
+```
+
+Does not work with :
+
+- Multithreaded programs
+- Multi-module programs
+- Classes
+
+# TODO
+
+- Unit tests for the capture part (because the line numbers are so hard). If pytest adds too much magic, then revert to UnitTest
+- Fix line numbers in trace_vars. https://discuss.python.org/t/trace-a-line-after-the-line-but-not-only-before-the-line/89475/7
+  This might not even be possible. Start solving it without functions in the scope.
+
+- Handle returns (with and without return statements)
+
+- Thonny, which adds a lot of indirection and magic. Try and find a way to edit the package directly when running in thonny
+
+# Later
+
+- localize the names of the line and output columns in the report
+
+# Done
+
+- Sets the program print to stdout unhindered (this is important for input to work properly),
+  but captures the prints at the same time to show in the trace at the end.
+- Emits the trace at the end if the application ends normally and abruptly (exception, signal, etc.)
+- Shows bindings to local variables when entering a function
+- Handles mutations to objects like lists (by copying the previous version and then comparing)
+- Parallel assignations show up properly
+- Changes to variables in other scopes (for instance global)
+
+# Build
+
+Automatically deployed to pypi every time a new tag is pushed: https://pypi.org/project/atrace/
+
+# Inspiration
+
+https://github.com/DarshanLakshman/PyTracerTool/blob/master/PyTracerTool/pytracertool.py
+
+Does almost everything I want, but has many flaws:
+
+- it chokes trying to deepcopy some objects
+- it cannot be simply imported into a module
+- it fumbles the handling of output (preventing programs with input from working properly).
+- it repeats values for no good reason
+- its line numbers are very confused

atrace-0.1.6/README.md

@@ -0,0 +1,57 @@
+# Usage
+
+Automatically prints a trace table of a program once the execution is finished.
+
+Just import the module.
+
+An idea of how things look:
+
+```
+
+```
+
+Does not work with :
+
+- Multithreaded programs
+- Multi-module programs
+- Classes
+
+# TODO
+
+- Unit tests for the capture part (because the line numbers are so hard). If pytest adds too much magic, then revert to UnitTest
+- Fix line numbers in trace_vars. https://discuss.python.org/t/trace-a-line-after-the-line-but-not-only-before-the-line/89475/7
+  This might not even be possible. Start solving it without functions in the scope.
+
+- Handle returns (with and without return statements)
+
+- Thonny, which adds a lot of indirection and magic. Try and find a way to edit the package directly when running in thonny
+
+# Later
+
+- localize the names of the line and output columns in the report
+
+# Done
+
+- Sets the program print to stdout unhindered (this is important for input to work properly),
+  but captures the prints at the same time to show in the trace at the end.
+- Emits the trace at the end if the application ends normally and abruptly (exception, signal, etc.)
+- Shows bindings to local variables when entering a function
+- Handles mutations to objects like lists (by copying the previous version and then comparing)
+- Parallel assignations show up properly
+- Changes to variables in other scopes (for instance global)
+
+# Build
+
+Automatically deployed to pypi every time a new tag is pushed: https://pypi.org/project/atrace/
+
+# Inspiration
+
+https://github.com/DarshanLakshman/PyTracerTool/blob/master/PyTracerTool/pytracertool.py
+
+Does almost everything I want, but has many flaws:
+
+- it chokes trying to deepcopy some objects
+- it cannot be simply imported into a module
+- it fumbles the handling of output (preventing programs with input from working properly).
+- it repeats values for no good reason
+- its line numbers are very confused

{atrace-0.1.3 → atrace-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "atrace"
-version = "0.1.3"
+version = "0.1.6"
 description = "Generate trace tables for programs"
 readme = "README.md"
 authors = [{ name = "Nicholas Wolff", email = "nwolff@gmail.com" }]
@@ -15,4 +15,12 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [dependency-groups]
-dev = ["mypy>=1.19.1", "ruff>=0.14.14"]
+dev = [
+ "mypy>=1.19.1",
+ "pytest>=9.0.2",
+ "ruff>=0.14.14",
+ "types-tabulate>=0.9.0.20241207",
+]
+
+[tool.uv.workspace]
+members = ["src/examples"]

{atrace-0.1.3 → atrace-0.1.6}/src/atrace/__init__.py

@@ -3,27 +3,13 @@ import inspect
 import signal
 import sys
 from types import FrameType
-from typing import Any, Optional
+from typing import Optional
 
-from . import model, report, tracers
+from . import model, outputlogger, report, vartracer
 
 trace: model.Trace = []
 
 
-def just_kicking_off(frame: FrameType, event: str, arg: Any):
-    return None
-
-
-def get_importer_frame() -> Optional[FrameType]:
-    # Get the current call stack
-    for frame_info in inspect.stack():
-        # Filter out internal importlib frames and the current module's frame
-        filename = frame_info.filename
-        if not filename.startswith("<") and filename != __file__:
-            return frame_info.frame
-    return None
-
-
 original_stdout = sys.stdout
 
 
@@ -32,29 +18,39 @@ def exit_handler():
     report.dump_report(trace)
 
 
+# https://stackoverflow.com/questions/23468042/the-invocation-of-signal-handler-and-atexit-handler-in-python
 def sig_handler(_signo, _frame):
     sys.exit(0)
 
 
+def get_importer_frame() -> Optional[FrameType]:
+    # Get the current call stack
+    for frame_info in inspect.stack():
+        # Filter out internal importlib frames and the current module's frame
+        filename = frame_info.filename
+        if not filename.startswith("<") and filename != __file__:
+            return frame_info.frame
+    return None
+
+
 def setup():
-    # This kicks off the tracing machinery (so that the lines below work)
-    sys.settrace(just_kicking_off)
+    """See https://docs.python.org/3/library/sys.html#sys.settrace for an explanation of all the convoluted things in here"""
 
     # We want to only trace the module that imports us
     importer_frame = get_importer_frame()
     if importer_frame:
         module_of_interest = inspect.getmodule(importer_frame)
         if module_of_interest:
-            var_tracer = tracers.VarTracer(
-                trace=trace, module_of_interest=module_of_interest
-            )
-            # Setup tracing outside of functions
-            importer_frame.f_trace = var_tracer.trace_vars
+            var_tracer = vartracer.VarTracer(trace, module_of_interest)
 
-            # Setup tracing inside of functions
+            # Setup tracing inside of functions.
+            # Order is important. This must be called before seting the trace function for the current frame
             sys.settrace(var_tracer.trace_vars)
 
-    sys.stdout = tracers.OutputLogger(trace=trace, stdout=sys.stdout)
+            # Setup tracing outside of functions
+            importer_frame.f_trace = var_tracer.trace_vars
+
+    sys.stdout = outputlogger.OutputLogger(trace=trace, stdout=sys.stdout)
 
     atexit.register(exit_handler)
     catchable_sigs = set(signal.Signals) - {signal.SIGKILL, signal.SIGSTOP}
@@ -62,4 +58,21 @@ def setup():
         signal.signal(sig, sig_handler)
 
 
-setup()
+def var_trace_for_code(code: str) -> model.Trace:
+    trace: model.Trace = []
+    # We want to only trace the module that imports us
+    importer_frame = get_importer_frame()
+    if importer_frame:
+        module_of_interest = inspect.getmodule(importer_frame)
+        if module_of_interest:
+            var_tracer = vartracer.VarTracer(trace, module_of_interest)
+            try:
+                sys.settrace(var_tracer.trace_vars)
+                exec(code)
+            finally:
+                sys.settrace(None)
+    return trace
+
+
+if "pytest" not in sys.modules:
+    setup()

{atrace-0.1.3 → atrace-0.1.6}/src/atrace/model.py

@@ -2,28 +2,34 @@ from dataclasses import dataclass
 from typing import Any, TypeAlias
 
 
-@dataclass
+@dataclass(frozen=True)
 class PrintEvent:
     text: str
 
 
-@dataclass
+@dataclass(frozen=True)
 class Variable:
-    module: str | None
+    scope: str
     name: str
 
 
-@dataclass
+@dataclass(frozen=True)
+class ReturnEvent:
+    function_name: str
+    return_value: Any
+
+
+@dataclass(frozen=True)
 class VariableChangeEvent:
     variable: Variable
     value: Any
 
 
-@dataclass
+@dataclass(frozen=True)
 class TraceItem:
     line_no: int
     function_name: str
-    event: PrintEvent | VariableChangeEvent | None
+    event: PrintEvent | VariableChangeEvent | ReturnEvent
 
 
 Trace: TypeAlias = list[TraceItem]

atrace-0.1.6/src/atrace/outputlogger.py

@@ -0,0 +1,35 @@
+import sys
+from typing import TextIO
+
+from . import model
+
+
+class OutputLogger:
+    """
+    OutputLogger wraps stdout, passing down writes and flushes to it, while simultaneously capturing the text to the trace.
+    """
+
+    def __init__(self, trace: model.Trace, stdout: TextIO):
+        self.trace = trace
+        self.stdout = stdout
+
+    def write(self, text: str) -> None:
+        """
+        Write to stdout and record the text in the trace
+        """
+        self.stdout.write(text)
+
+        frame = sys._getframe(1)
+        # An alternative that uses a public API, but then the type checker bothers me
+        # frame = inspect.currentframe().f_back
+
+        self.trace.append(
+            model.TraceItem(
+                line_no=frame.f_lineno,
+                function_name=frame.f_code.co_name,
+                event=model.PrintEvent(text),
+            )
+        )
+
+    def flush(self):
+        self.stdout.flush()

atrace-0.1.6/src/atrace/report.py

@@ -0,0 +1,74 @@
+from dataclasses import dataclass
+from typing import Any, TypeAlias
+
+from tabulate import tabulate
+
+from . import model
+
+
+@dataclass
+class Instant:
+    line_no: int
+    variable_changes: dict[model.Variable, Any]
+    output: str
+
+
+Instants: TypeAlias = list[Instant]
+
+
+def trace_to_instants(trace: model.Trace) -> Instants:
+    instants = []
+    instant = None
+    for trace_item in trace:
+        if instant is None or instant.line_no != trace_item.line_no:
+            instant = Instant(trace_item.line_no, {}, "")
+            instants.append(instant)
+
+        match trace_item.event:
+            case model.PrintEvent(text):
+                instant.output += text
+            case model.VariableChangeEvent(variable, value):
+                # Don't clobber an existing value a variable if it changes again on the same line
+                # (this happens for example in tight loops)
+                if variable in instant.variable_changes:
+                    instant = Instant(trace_item.line_no, {}, "")
+                    instants.append(instant)
+                instant.variable_changes[variable] = value
+            case model.ReturnEvent():
+                pass  # XXX
+
+    return instants
+
+
+def variable_to_column_name(var: model.Variable) -> str:
+    return var.name if var.scope == "<module>" else f"({var.scope}) {var.name}"
+
+
+def formatted_table_from_instants(instants: Instants) -> str:
+    variables = []
+
+    for instant in instants:
+        for variable in instant.variable_changes:
+            if variable not in variables:
+                variables.append(variable)
+
+    LINE_NO, OUTPUT = "ligne", "affichage"
+
+    table = []
+    for instant in instants:
+        row: dict[str, Any] = {}
+        table.append(row)
+
+        row[LINE_NO] = instant.line_no
+        for variable in variables:
+            cell_for_variable = instant.variable_changes.get(variable, "")
+            row[variable_to_column_name(variable)] = cell_for_variable
+        row[OUTPUT] = instant.output
+
+    return tabulate(table, headers="keys", tablefmt="simple_outline")
+
+
+def dump_report(trace: model.Trace) -> None:
+    instants = trace_to_instants(trace)
+    formatted_table = formatted_table_from_instants(instants)
+    print(formatted_table)

atrace-0.1.3/src/atrace/tracers.py → atrace-0.1.6/src/atrace/vartracer.py

@@ -1,8 +1,7 @@
 import copy
 import inspect
-import sys
 from types import FrameType, ModuleType
-from typing import Any, TextIO
+from typing import Any
 
 from atrace import model
 
@@ -24,7 +23,7 @@ def copy_carefully(d: dict[str, Any]):
     for k, v in d.items():
         try:
             v_copy = copy.deepcopy(v)
-        except:
+        except Exception:
             v_copy = v
         res[k] = v_copy
     return res
@@ -34,14 +33,21 @@ class VarTracer:
     def __init__(self, trace: model.Trace, module_of_interest: ModuleType):
         self.trace = trace
         self.module_of_interest = module_of_interest
-        self.last_locals = {}
+        self.last_locals: dict[str, Any] = {}
 
     def trace_vars(self, frame: FrameType, event: str, arg: Any):
         if inspect.getmodule(frame) != self.module_of_interest:
             return
         if event == "return":
-            return
-        # print("####", event, frame.f_lineno, frame.f_code)
+            self.trace.append(
+                model.TraceItem(
+                    line_no=frame.f_lineno,
+                    function_name=frame.f_code.co_name,
+                    event=model.ReturnEvent(
+                        function_name=frame.f_code.co_name, return_value=arg  # XXX
+                    ),
+                )
+            )
 
         code = frame.f_code
 
@@ -51,17 +57,15 @@ class VarTracer:
             old_locals = self.last_locals[code.co_name]
 
         locals_now = copy_carefully(filtered_variables(frame.f_locals))
-        # print("locals_now", locals_now)
 
         for var, new_val in filtered_variables(locals_now).items():
             if var not in old_locals or old_locals[var] != new_val:
-                # print("çççç", frame.f_lineno, var)
                 self.trace.append(
                     model.TraceItem(
                         line_no=frame.f_lineno,
                         function_name=frame.f_code.co_name,
                         event=model.VariableChangeEvent(
-                            variable=model.Variable(module=code.co_name, name=var),
+                            variable=model.Variable(scope=code.co_name, name=var),
                             value=new_val,
                         ),
                     )
@@ -69,34 +73,3 @@ class VarTracer:
 
         self.last_locals[code.co_name] = locals_now
         return self.trace_vars
-
-
-class OutputLogger(object):
-    """
-    OutputLogger captures and logs the output produced by print statements during code execution.
-    """
-
-    def __init__(self, trace: model.Trace, stdout: TextIO):
-        self.trace = trace
-        self.stdout = stdout
-
-    def write(self, text: str) -> None:
-        """
-        Write to stdout and record it in the trace
-        """
-        self.stdout.write(text)
-
-        frame = sys._getframe(1)
-        # An alternative that uses a public API, but then the type checker bothers me
-        # frame = inspect.currentframe().f_back
-
-        self.trace.append(
-            model.TraceItem(
-                line_no=frame.f_lineno,
-                function_name=frame.f_code.co_name,
-                event=model.PrintEvent(text),
-            )
-        )
-
-    def flush(self):
-        self.stdout.flush()

{atrace-0.1.3/src → atrace-0.1.6/src/examples}/complete_example.py

@@ -1,17 +1,21 @@
-import atrace
+import atrace  # noqa
 
 x, y = 3, 6
 
 while x < y:
     x = x + 1
-    y = y - 1
 
 print("x", x)
-print("y", x)
 
-l = ["riri", "fifi", "loulou"]
-while l:
-    print(l.pop(0))
+t = (1, 2)
+
+kids = ["riri", "fifi", "loulou"]
+while kids:
+    print(kids.pop(0))
+
+
+for i in range(5):
+    print(i)
 
 
 def double(a):

atrace-0.1.6/src/examples/function_example.py

@@ -0,0 +1,9 @@
+import atrace  # noqa
+
+
+def f(a, b):
+    c = a + b
+    return c
+
+
+print(f(3, 14))

atrace-0.1.6/src/examples/global_example.py

@@ -0,0 +1,13 @@
+import atrace  # noqa
+
+c = "first value of c"
+
+
+def f(a, b):
+    global c
+    c = a + b
+    d = a - b
+    return c, d
+
+
+print(f(3, 14))

{atrace-0.1.3/inspiration → atrace-0.1.6/src/examples}/pyproject.toml

@@ -1,7 +1,9 @@
 [project]
-name = "inspiration"
+name = "examples"
 version = "0.1.0"
 description = "Add your description here"
 readme = "README.md"
-requires-python = ">=3.7"
-dependencies = ["pytracertool>=2.0.4"]
+requires-python = ">=3.10"
+dependencies = [
+    "tabulate>=0.9.0",
+]

atrace-0.1.6/src/examples/small_example.py

@@ -0,0 +1,18 @@
+import atrace  # noqa
+
+x, y = 1, 3
+
+while x < y:
+    x = x + 1
+
+print("x:", x)
+
+t = 1, 2
+
+
+def f(a, b):
+    c = a + " " + b
+    return c + "!"
+
+
+print(f("Bonjour", "tout le monde"))

atrace-0.1.6/src/examples/tiny_example.py

@@ -0,0 +1,4 @@
+import atrace  # noqa
+
+x = 1
+print(x)

atrace-0.1.6/tests/no_test_sample.py

@@ -0,0 +1,16 @@
+# import sys
+
+import atrace
+
+# from atrace import model, vartracer
+
+code = """
+print("hello")
+x = 1
+x = x + 1
+y, z = 7, 8
+"""
+
+trace = atrace.var_trace_for_code(code)
+print(trace)
+assert 1 == 0  # To show the output