atrace 0.1.3__tar.gz → 0.1.5__tar.gz

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

@@ -25,6 +25,8 @@ jobs:
         uses: astral-sh/setup-uv@v7
       - name: Install Python 3.13
         run: uv python install 3.13
+      - name: Check
+        run: uv run ruff check src
       - name: Build
         run: uv build
       - name: Publish

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

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

atrace-0.1.5/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: atrace
+Version: 0.1.5
+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 animated example of a trace table: https://www.101computing.net/using-trace-tables/
+
+An idea of how things look:
+
+```
++-----------+-----+-----+---------+---------------+-----------------------+-------------------------+
+|    ligne  |   x |   y | (f) a   | (f) b         | (f) c                 |  affichage              |
++===========+=====+=====+=========+===============+=======================+=========================+
+|         5 |   1 |   3 |         |               |                       |                         |
+|         7 |   2 |     |         |               |                       |                         |
+|         5 |     |   2 |         |               |                       |                         |
+|         7 |   3 |     |         |               |                       |                         |
+|         5 |     |   1 |         |               |                       |                         |
+|         7 |   4 |     |         |               |                       |                         |
+|         5 |     |     |         |               |                       |                         |
+|         9 |     |     |         |               |                       | somme:  4               |
+|        12 |     |     | Bonjour | tout le monde |                       |                         |
+|        14 |     |     |         |               | Bonjour tout le monde | Bonjour tout le monde ! |
++-----------+-----+-----+---------+---------------+-----------------------+-------------------------+
+```
+
+Does not work with :
+
+- Multithreaded programs
+- Multi-module programs
+- Classes
+
+# TODO
+
+- 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 is a bitch
+- Thonny, which adds a lot of indirection and magic
+
+# Later
+
+- Make robust. In other words should never raise an exception.
+- mypy, unit-tests. Integrate in build pipeline
+- localize the names of the line and output columns in the report
+- Handle classes better
+
+# Possible enhancements
+
+- More details when recursive invocations
+- Think about how to show returns
+- Find if there could be a good use for colors in the trace
+
+# 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
+
+# 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.5/README.md

@@ -0,0 +1,76 @@
+# Usage
+
+Automatically prints a trace table of a program once the execution is finished.
+
+Just import the module.
+
+An animated example of a trace table: https://www.101computing.net/using-trace-tables/
+
+An idea of how things look:
+
+```
++-----------+-----+-----+---------+---------------+-----------------------+-------------------------+
+|    ligne  |   x |   y | (f) a   | (f) b         | (f) c                 |  affichage              |
++===========+=====+=====+=========+===============+=======================+=========================+
+|         5 |   1 |   3 |         |               |                       |                         |
+|         7 |   2 |     |         |               |                       |                         |
+|         5 |     |   2 |         |               |                       |                         |
+|         7 |   3 |     |         |               |                       |                         |
+|         5 |     |   1 |         |               |                       |                         |
+|         7 |   4 |     |         |               |                       |                         |
+|         5 |     |     |         |               |                       |                         |
+|         9 |     |     |         |               |                       | somme:  4               |
+|        12 |     |     | Bonjour | tout le monde |                       |                         |
+|        14 |     |     |         |               | Bonjour tout le monde | Bonjour tout le monde ! |
++-----------+-----+-----+---------+---------------+-----------------------+-------------------------+
+```
+
+Does not work with :
+
+- Multithreaded programs
+- Multi-module programs
+- Classes
+
+# TODO
+
+- 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 is a bitch
+- Thonny, which adds a lot of indirection and magic
+
+# Later
+
+- Make robust. In other words should never raise an exception.
+- mypy, unit-tests. Integrate in build pipeline
+- localize the names of the line and output columns in the report
+- Handle classes better
+
+# Possible enhancements
+
+- More details when recursive invocations
+- Think about how to show returns
+- Find if there could be a good use for colors in the trace
+
+# 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
+
+# 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.5}/pyproject.toml

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

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

@@ -5,7 +5,7 @@ import sys
 from types import FrameType
 from typing import Any, Optional
 
-from . import model, report, tracers
+from . import model, outputlogger, report, vartracer
 
 trace: model.Trace = []
 
@@ -32,11 +32,14 @@ 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 setup():
+    """See https://docs.python.org/3/library/sys.html#sys.settrace for an explanation of all the convoluted things in here"""
+
     # This kicks off the tracing machinery (so that the lines below work)
     sys.settrace(just_kicking_off)
 
@@ -45,16 +48,15 @@ def setup():
     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
-            )
+            var_tracer = vartracer.VarTracer(trace, module_of_interest)
+
             # Setup tracing outside of functions
             importer_frame.f_trace = var_tracer.trace_vars
 
             # Setup tracing inside of functions
             sys.settrace(var_tracer.trace_vars)
 
-    sys.stdout = tracers.OutputLogger(trace=trace, stdout=sys.stdout)
+    sys.stdout = outputlogger.OutputLogger(trace=trace, stdout=sys.stdout)
 
     atexit.register(exit_handler)
     catchable_sigs = set(signal.Signals) - {signal.SIGKILL, signal.SIGSTOP}

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

@@ -7,13 +7,13 @@ class PrintEvent:
     text: str
 
 
-@dataclass
+@dataclass(frozen=True)
 class Variable:
-    module: str | None
+    function_name: str | None
     name: str
 
 
-@dataclass
+@dataclass(frozen=True)
 class VariableChangeEvent:
     variable: Variable
     value: Any
@@ -23,7 +23,7 @@ class VariableChangeEvent:
 class TraceItem:
     line_no: int
     function_name: str
-    event: PrintEvent | VariableChangeEvent | None
+    event: PrintEvent | VariableChangeEvent
 
 
 Trace: TypeAlias = list[TraceItem]

atrace-0.1.5/src/atrace/outputlogger.py

@@ -0,0 +1,35 @@
+import sys
+from typing import TextIO
+
+from . import model
+
+
+class OutputLogger:
+    """
+    OutputLogger wraps stdout, writing to it and 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.5/src/atrace/report.py

@@ -0,0 +1,98 @@
+from dataclasses import dataclass
+from typing import Any
+
+from tabulate import tabulate
+
+from . import model
+
+
+def collect_variable_list(trace: model.Trace) -> list[model.Variable]:
+    variable_list = []
+    for traceItem in trace:
+        match traceItem.event:
+            case model.VariableChangeEvent(variable_name, _):
+                if variable_name not in variable_list:
+                    variable_list.append(variable_name)
+    return variable_list
+
+
+def coalesce_print_events(trace: model.Trace) -> model.Trace:
+    last_print_item = None
+    for trace_item in trace:
+        match trace_item.event:
+            case model.PrintEvent(text):
+                if (
+                    last_print_item is None
+                    or trace_item.line_no != last_print_item.line_no
+                ):
+                    last_print_item = trace_item
+                else:
+                    last_print_item.event.text += text
+                    trace_item.event = None  # Mark for deletion
+            case _:
+                last_print_item = None
+
+    return [item for item in trace if item.event is not None]
+
+
+def contains_prints(trace: model.Trace) -> bool:
+    for trace_item in trace:
+        match trace_item.event:
+            case model.PrintEvent:
+                return True
+    return False
+
+
+def variable_to_column_name(var: model.Variable) -> str:
+    context = None if var.function_name == "<module>" else var.function_name
+    return "(" + context + ") " + var.name if context else var.name
+
+
+@dataclass
+class Line:
+    line_no: int
+    variable_changes: dict[str, Any]
+    output: str | None
+
+
+def dump_report(trace: model.Trace) -> None:
+    trace = coalesce_print_events(trace)
+
+    # Build intermediate "lines" datastructure, that collects all events that happen on a given line
+    lines = []
+    current_line = None
+    for trace_item in trace:
+        if current_line is None or current_line.line_no != trace_item.line_no:
+            current_line = Line(trace_item.line_no, {}, None)
+            lines.append(current_line)
+
+        match trace_item.event:
+            case model.VariableChangeEvent(variable, value):
+                # Don't clobber a new value if it changes on the same line
+                # (this happens for example in tight loops)
+                if variable in current_line.variable_changes:
+                    current_line = Line(trace_item.line_no, {}, None)
+                    lines.append(current_line)
+
+                current_line.variable_changes[variable_to_column_name(variable)] = value
+            case model.PrintEvent(text):
+                current_line.output = text
+
+    # The extra spaces so the names cannot collide with variable names
+    LINE_NO, OUTPUT = " ligne", "affichage "
+
+    variable_list = collect_variable_list(trace)
+    headers = [LINE_NO] + [variable_to_column_name(v) for v in variable_list] + [OUTPUT]
+    table = []
+    for line in lines:
+        table_row = [line.line_no]
+        for column_name in headers[1:-1]:
+            variable_value = line.variable_changes.get(column_name)
+            if variable_value:
+                table_row.append(variable_value)
+            else:
+                table_row.append(None)
+        table_row.append(line.output)
+        table.append(table_row)
+
+    print(tabulate(table, headers=headers, tablefmt="outline"))

atrace-0.1.3/src/atrace/tracers.py → atrace-0.1.5/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
@@ -41,7 +40,6 @@ class VarTracer:
             return
         if event == "return":
             return
-        # print("####", event, frame.f_lineno, frame.f_code)
 
         code = frame.f_code
 
@@ -51,17 +49,17 @@ 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(
+                                function_name=code.co_name, name=var
+                            ),
                             value=new_val,
                         ),
                     )
@@ -69,34 +67,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.5/src/examples}/complete_example.py

@@ -1,17 +1,19 @@
-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))
+kids = ["riri", "fifi", "loulou"]
+while kids:
+    print(kids.pop(0))
+
+
+for i in range(5):
+    print(i)
 
 
 def double(a):
@@ -19,6 +21,8 @@ def double(a):
     return b
 
 
+ligne = 666  # To test if it messes up the table header ligne
+
 print(double(6))
 
 

{atrace-0.1.3/src → atrace-0.1.5/src/examples}/example_with_classes.py

@@ -1,4 +1,4 @@
-import atrace
+import atrace  # noqa
 
 
 class Animal:

{atrace-0.1.3/inspiration → atrace-0.1.5/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.3/src → atrace-0.1.5/src/examples}/small_example.py

@@ -1,4 +1,4 @@
-import atrace
+import atrace  # noqa
 
 x, y = 1, 3
 
@@ -6,12 +6,12 @@ while y > 0:
     x = x + 1
     y = y - 1
 
-print("sum", x)
+print("somme: ", x)
 
 
 def f(a, b):
     c = a + " " + b
-    print(c)
+    print(c, "!")
 
 
-f("hello", "everyone")
+f("Bonjour", "tout le monde")

atrace-0.1.5/src/examples/tiny_example.py

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

{atrace-0.1.3 → atrace-0.1.5}/uv.lock

@@ -2,9 +2,15 @@ version = 1
 revision = 2
 requires-python = ">=3.10"
 
+[manifest]
+members = [
+    "atrace",
+    "examples",
+]
+
 [[package]]
 name = "atrace"
-version = "0.1.2"
+version = "0.1.5"
 source = { editable = "." }
 dependencies = [
     { name = "tabulate" },
@@ -25,6 +31,17 @@ dev = [
     { name = "ruff", specifier = ">=0.14.14" },
 ]
 
+[[package]]
+name = "examples"
+version = "0.1.0"
+source = { virtual = "src/examples" }
+dependencies = [
+    { name = "tabulate" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "tabulate", specifier = ">=0.9.0" }]
+
 [[package]]
 name = "librt"
 version = "0.7.8"

atrace-0.1.3/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-    "spellright.language": [
-        "fr",
-        "en"
-    ],
-    "spellright.documentTypes": [
-        "markdown",
-        "latex",
-        "plaintext"
-    ]
-}