{ "module": "hexa.parse_abc", "content": { "path": "hexa.parse_abc", "docstring": "Parse an ABC Python module into a hexa PortNode tree.", "objects": { "annotations": { "name": "annotations", "kind": "alias", "path": "hexa.parse_abc.annotations", "signature": "", "docstring": null }, "dataclasses": { "name": "dataclasses", "kind": "alias", "path": "hexa.parse_abc.dataclasses", "signature": "", "docstring": null }, "importlib": { "name": "importlib", "kind": "alias", "path": "hexa.parse_abc.importlib", "signature": "", "docstring": null }, "inspect": { "name": "inspect", "kind": "alias", "path": "hexa.parse_abc.inspect", "signature": "", "docstring": null }, "sys": { "name": "sys", "kind": "alias", "path": "hexa.parse_abc.sys", "signature": "", "docstring": null }, "ABC": { "name": "ABC", "kind": "alias", "path": "hexa.parse_abc.ABC", "signature": "", "docstring": null }, "Path": { "name": "Path", "kind": "alias", "path": "hexa.parse_abc.Path", "signature": "", "docstring": null }, "Any": { "name": "Any", "kind": "alias", "path": "hexa.parse_abc.Any", "signature": "", "docstring": null }, "ConfigValue": { "name": "ConfigValue", "kind": "attribute", "path": "hexa.parse_abc.ConfigValue", "signature": "", "docstring": null }, "MethodSpec": { "name": "MethodSpec", "kind": "class", "path": "hexa.parse_abc.MethodSpec", "signature": "", "docstring": "Specification of a single abstract method.", "members": { "name": { "name": "name", "kind": "attribute", "path": "hexa.parse_abc.MethodSpec.name", "signature": "", "docstring": null }, "args": { "name": "args", "kind": "attribute", "path": "hexa.parse_abc.MethodSpec.args", "signature": "", "docstring": null }, "kwargs": { "name": "kwargs", "kind": "attribute", "path": "hexa.parse_abc.MethodSpec.kwargs", "signature": "", "docstring": null } } }, "PortNode": { "name": "PortNode", "kind": "class", "path": "hexa.parse_abc.PortNode", "signature": "", "docstring": "A node in the hexa port tree.\n\nParameters\n----------\nname : str\n Slot name, e.g. ``\"parser\"``, ``\"amount_balance\"``.\nkind : str\n One of ``\"leaf\"``, ``\"port\"``, or ``\"parent\"``.\n - ``\"leaf\"``: no children (e.g. ``NumberPort``)\n - ``\"port\"``: has children (e.g. ``TransactionParserPort``)\n - ``\"parent\"``: the root of the tree (e.g. ``ExtractionPipeline``)\nport_cls : str\n ABC class name that gives this port its shape, e.g.\n ``\"TransactionParserPort\"``. Every port has a concrete typed shape.\nattributes : dict[str, ConfigValue]\n Annotated attributes: ``name -> type_expr`` for scalars, or a nested\n ``dict`` of sub-attributes (a struct) for grouped/structured values.\nchildren : list[PortNode]\n Nested port slots.\nmethods : dict[str, MethodSpec]\n Abstract methods keyed by method name.", "members": { "name": { "name": "name", "kind": "attribute", "path": "hexa.parse_abc.PortNode.name", "signature": "", "docstring": null }, "port_cls": { "name": "port_cls", "kind": "attribute", "path": "hexa.parse_abc.PortNode.port_cls", "signature": "", "docstring": null }, "kind": { "name": "kind", "kind": "attribute", "path": "hexa.parse_abc.PortNode.kind", "signature": "", "docstring": null }, "attributes": { "name": "attributes", "kind": "attribute", "path": "hexa.parse_abc.PortNode.attributes", "signature": "", "docstring": null }, "children": { "name": "children", "kind": "attribute", "path": "hexa.parse_abc.PortNode.children", "signature": "", "docstring": null }, "methods": { "name": "methods", "kind": "attribute", "path": "hexa.parse_abc.PortNode.methods", "signature": "", "docstring": null }, "find": { "name": "find", "kind": "function", "path": "hexa.parse_abc.PortNode.find", "signature": "", "docstring": "Find a direct child by slot name." }, "walk": { "name": "walk", "kind": "function", "path": "hexa.parse_abc.PortNode.walk", "signature": "", "docstring": "Return all nodes in depth-first order (self first)." }, "diff": { "name": "diff", "kind": "function", "path": "hexa.parse_abc.PortNode.diff", "signature": "", "docstring": "Return a list of human-readable difference strings.\n\nAn empty list means the trees are equal." } } }, "parse_abc": { "name": "parse_abc", "kind": "function", "path": "hexa.parse_abc.parse_abc", "signature": "", "docstring": "Parse an ABC Python module into a :class:`PortNode` tree.\n\nABC classes become port nodes. A nested-struct attribute is expressed as a\n``@dataclass`` annotation on an ABC port (e.g. ``source: ExtractionSource``\nwhere ``ExtractionSource`` is a ``@dataclass``); the dataclass's fields are\nexpanded into a nested ``attributes`` entry.\n\nParameters\n----------\nmodule_or_path : str | Path | Any\n A file path to a ``.py`` file, a module import string, or a loaded module.\n\nReturns\n-------\nPortNode\n The root node of the tree." } } } }