Merge pull request #78 from ionite34/dev

Author: ionite34

docs/source/conf.py

@@ -15,7 +15,7 @@
 project = "einspect"
 copyright = "2023, Ionite"
 author = "Ionite"
-release = "v0.5.13"
+release = "v0.5.15"
 
 
 # -- General configuration ---------------------------------------------------

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "einspect"
-version = "0.5.13"
+version = "0.5.15"
 packages = [{ include = "einspect", from = "src" }]
 description = "Extended Inspect - view and modify memory structs of runtime objects."
 authors = ["ionite34 <dev@ionite.io>"]
@@ -42,7 +42,7 @@ python = ">=3.8,<3.13"
 typing-extensions = "^4.4.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.2.0"
+pytest = "^7.2.2"
 pytest-cov = "^4.0.0"
 pytest-xdist = "^3.1.0"
 mypy = "^0.991"
@@ -62,11 +62,11 @@ jupyter = "^1.0.0"
 
 [tool.poetry.group.ci.dependencies]
 typing-extensions = "^4.4.0"
-pytest = "^7.2.0"
+pytest = "^7.2.2"
 
 [tool.poetry.group.ci-cov.dependencies]
 typing-extensions = "^4.4.0"
-pytest = "^7.2.0"
+pytest = "^7.2.2"
 pytest-cov = "^4.0.0"
 
 [tool.poetry.group.docs.dependencies]

pyproject.toml

@@ -7,11 +7,10 @@
 from einspect.views.unsafe import global_unsafe
 from einspect.views.view_type import impl
 
-# Runtime patches
-einspect._patch.run()
-
-__all__ = ("view", "unsafe", "impl", "orig", "ptr", "NULL")
-
-__version__ = "0.5.13"
+__all__ = ("view", "unsafe", "impl", "orig", "ptr", "NULL", "__version__")
+__version__ = "0.5.15"
 
 unsafe = global_unsafe
+
+# Runtime patches
+einspect._patch.run()

src/einspect/__init__.py

@@ -36,6 +36,10 @@ class PyDictKeysObject(Struct):
     Defines a DictKeysObject Structure.
 
     https://github.com/python/cpython/blob/3.11/Include/internal/pycore_dict.h#L87-L125
+
+    ..
+        source: Include/internal/pycore_dict.h (struct _dictkeysobject) #[59827ad2d5]
+        source[<3.11]: Objects/dict-common.h (struct _dictkeysobject) #[12e0897a69]
     """
 
     dk_refcnt: int

src/einspect/structs/py_dict.py

@@ -18,6 +18,10 @@ class PyListObject(PyVarObject[list, None, _VT], IsGC):
     Defines a PyListObject Structure.
 
     https://github.com/python/cpython/blob/3.11/Include/cpython/listobject.h
+
+    ..
+        source: Include/cpython/listobject.h (struct PyListObject) #[15e5541daa]
+        source[<3.9]: Include/listobject.h (struct PyListObject) #[15e5541daa]
     """
 
     ob_item: ptr[ptr[PyObject[_VT, None, None]]]

src/einspect/structs/py_list.py

@@ -67,7 +67,15 @@ def py_set(obj_ptr: ptr[PyObject], value: object | PyObject | ptr[PyObject]) ->
 
 
 class PyObject(Struct, AsRef, Generic[_T, _KT, _VT]):
-    """Defines a base PyObject Structure."""
+    """
+    Defines a base PyObject Structure.
+
+    ..
+        source: Include/object.h (struct _object)
+        source[=3.8]: #[cc8cfe0d6c]
+        source[<3.11]: #[c39f0de871]
+        source[<3.13]: #[79c692b04c]
+    """
 
     ob_refcnt: int
     ob_type: Annotated[ptr[PyTypeObject[Type[_T]]], c_void_p]

src/einspect/structs/py_object.py

@@ -33,6 +33,10 @@ class PySetObject(PyObject[set, None, _T], IsGC):
     Defines a PySetObject Structure.
 
     https://github.com/python/cpython/blob/3.11/Include/cpython/setobject.h#L36-L59
+
+    ..
+        source: Include/cpython/setobject.h (struct PySetObject) #[5a21a4c7be]
+        source[<3.11]: Include/setobject.h (struct PySetObject) #[5a21a4c7be]
     """
 
     fill: int  # Number active and dummy entries

src/einspect/structs/py_set.py

@@ -19,6 +19,9 @@ class PyTupleObject(PyVarObject[tuple, None, _VT], IsGC):
     Defines a PyTupleObject Structure.
 
     https://github.com/python/cpython/blob/3.11/Include/cpython/tupleobject.h
+
+    ..
+        source: Include/cpython/tupleobject.h (struct PyTupleObject) #[58f9cac944]
     """
 
     # Size of this array is only known after creation

src/einspect/structs/py_tuple.py

@@ -38,6 +38,9 @@ class PyTypeObject(PyVarObject[_T, None, None]):
     Defines a PyTypeObject Structure.
 
     https://github.com/python/cpython/blob/3.11/Doc/includes/typestruct.h
+
+    ..
+        source: Include/cpython/object.h (struct _typeobject)
     """
 
     tp_name: Annotated[bytes, c_char_p]
@@ -171,11 +174,12 @@ def setattr_safe(self, name: str, value: Any) -> None:
             field_type = field[1]
             # For c_char_p types, set encoded bytes
             if field_type is c_char_p:
-                setattr(self, slot.name, value.encode("utf-8"))
+                return setattr(self, slot.name, value.encode("utf-8"))
             # For ptr[PyObject] types, set PyObject pointer
             elif field_type == POINTER(PyObject):
-                setattr(self, slot.name, PyObject.from_object(value).as_ref())
+                return setattr(self, slot.name, PyObject.from_object(value).as_ref())
 
+        # If not a recognized slot, set with PyObject_SetAttr api
         self.SetAttr(name, value)
 
     def _try_del_tp_dict(self, name: str) -> None:

src/einspect/structs/py_type.py

@@ -99,3 +99,22 @@ def real(self):
     # Restore original
     view(int).restore("real")
     assert int.real is not real
+
+
+def test_impl_view():
+    v = view(frozenset)
+    v["__name__"] = "custom_frozenset"
+    v["__getitem__"] = lambda self, item: len(self) * item
+
+    assert frozenset.__name__ == "custom_frozenset"
+    assert repr(frozenset) == "<class 'custom_frozenset'>"
+
+    # noinspection PyTypeChecker,PyUnresolvedReferences
+    res = frozenset({1, 2})[5]
+    assert res == 10
+
+    v.restore("__name__", "__getitem__")
+
+    with pytest.raises(TypeError):
+        # noinspection PyTypeChecker,PyUnresolvedReferences
+        _ = frozenset({1, 2})[5]

tests/test_impl.py

@@ -1,28 +1,133 @@
 import typer
-from rich import Console
+from rich.columns import Columns
+from rich.console import Console, ConsoleRenderable, Group
+from rich.panel import Panel
+from rich.style import Style
 from rich.syntax import Syntax
+from rich.tree import Tree
 
-from tools.sources import branch_range, extract_struct, fetch_git
+from tools.sources import (
+    CPYTHON_MAIN_VERSION,
+    SourceBlock,
+    branch_range,
+    build_link,
+    check_hash,
+    extract_struct,
+    fetch_git,
+    hash_source,
+)
+from tools.struct_meta import StructMetadata
 
 console = Console()
+cp = console.print
 app = typer.Typer()
 
+PANEL_STYLE = Style(color="grey0")
+
+
+def make_struct_tree(title: str, panel: Panel) -> Tree:
+    """Create a tree with a panel as a leaf."""
+    tree = Tree(title)
+    tree.add(panel)
+    return tree
+
+
+def make_panel_code(heading: str, body: dict[str, str], code: Syntax | str) -> Panel:
+    """Create a panel with a heading and a table of field titles."""
+    body_entries = (f"[bold]{title}[/bold]: {value}" for title, value in body.items())
+    column = Columns(body_entries, equal=True)
+    return Panel(
+        Group(column, code), title=heading, title_align="left", border_style=PANEL_STYLE
+    )
+
+
+def make_panel_msg(heading: str, msg: str | ConsoleRenderable) -> Panel:
+    """Create a panel with a heading and a message."""
+    return Panel(
+        msg,
+        title=heading,
+    )
+
 
 @app.command()
 def compare_src(path: str, struct: str, min_tag: str = "3.8", max_tag: str = "main"):
     for branch in branch_range(min_tag, max_tag):
         text = fetch_git(path, branch)
-        struct_text = extract_struct(struct, text)
-        struct_fmt = Syntax(struct_text, "c", line_numbers=True)
-        console.print(f"[bold blue]{branch}[/bold blue]")
-        console.print(struct_fmt)
+        st = extract_struct(struct, text)
+        cp(f"[bold blue]{branch}[/bold blue]")
+        cp(f"[gray]{st.code_hash()}[/gray]")
+        cp(st.as_syntax())
 
 
 @app.command()
 def compare_meta(struct_name: str, min_tag: str = "3.8", max_tag: str = "main"):
     """Compare an einspect Struct with CPython source. Requires docstring metadata."""
+    metadata = StructMetadata.from_struct_name(struct_name)
 
+    # Title
+    cls_name = metadata.source_cls.__qualname__
+    module_name = metadata.source_cls.__module__
+    title = f"[grey0]{module_name}.[/grey0][bold cyan]{cls_name}[/bold cyan]"
+    cp(title)
+
+    last_hash: str | None = None
+    last_code: SourceBlock | None = None
     for branch in branch_range(min_tag, max_tag):
-        text = fetch_git(path, branch)
-        console.print(f"[bold blue]{branch}[/bold blue]")
-        console.print(text)
+        if branch == "main":
+            version = CPYTHON_MAIN_VERSION
+        else:
+            version = tuple(int(v) for v in branch.split("."))
+
+        # Build panel
+        title = f"[bold blue]{branch}[/bold blue]"
+        body: dict[str, str] = {}
+
+        try:
+            entry = metadata.get_version(version)
+        except KeyError as e:
+            cp(make_panel_msg(title, f"[bold red]{e}[/bold red]"))
+            continue
+
+        git_text = fetch_git(entry.file, branch)
+        if entry.def_kind == "struct":
+            try:
+                st = extract_struct(entry.def_name, git_text)
+            except ValueError as e:
+                link = build_link(entry.file, branch)
+                raise ValueError(
+                    f"Struct {entry.def_name!r} not found in {branch!r} branch {link}"
+                ) from e
+
+            # Hashes
+            remote_hash = st.code_hash()
+            body["hash"] = f"[plum4]{remote_hash}[/plum4]"
+            if local_hash := entry.hash:
+                if not check_hash(local_hash):
+                    body[
+                        "hash (local)"
+                    ] = f"[bold red]{local_hash}[/bold red] [red](invalid)[/red]"
+                elif remote_hash != local_hash:
+                    body[
+                        "hash (local)"
+                    ] = f"[bold yellow]{local_hash}[/bold yellow] [red](does not match)[/red]"
+                else:
+                    body["hash (local)"] = f"[green]{local_hash}[/green]"
+
+            if last_hash == remote_hash:
+                code = "[grey0]No changes[/grey0]"
+            else:
+                last_hash = remote_hash
+                st = st.normalize()
+                code = st.as_syntax(line_numbers=True)
+
+                # Add diff
+                if last_code:
+                    code = st.diff(last_code).as_syntax(line_numbers=True)
+
+                last_code = st
+
+            panel = make_panel_code(title, body, code)
+            cp(panel)
+
+        else:
+            raise ValueError(f"Unsupported definition kind: {entry.def_kind}")