From 9d3501f8c96d2587e1be71a9ac07bf8e555df2e8 Mon Sep 17 00:00:00 2001 From: Agustin Borgna Date: Wed, 21 Aug 2024 16:49:18 +0100 Subject: [PATCH] refactor!: Make `_DfBase` and `_DefinitionBuilder` public --- hugr-py/src/hugr/build/__init__.py | 6 +++--- hugr-py/src/hugr/build/cfg.py | 4 ++-- hugr-py/src/hugr/build/cond_loop.py | 6 +++--- hugr-py/src/hugr/build/dfg.py | 8 ++++---- hugr-py/src/hugr/build/function.py | 4 ++-- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/hugr-py/src/hugr/build/__init__.py b/hugr-py/src/hugr/build/__init__.py index 099700641..def20437f 100644 --- a/hugr-py/src/hugr/build/__init__.py +++ b/hugr-py/src/hugr/build/__init__.py @@ -3,7 +3,7 @@ from .base import ParentBuilder from .cfg import Block, Cfg from .cond_loop import Case, Conditional, If, TailLoop -from .dfg import Dfg, Function, _DefinitionBuilder, _DfBase +from .dfg import DefinitionBuilder, DfBase, Dfg, Function from .function import Module from .tracked_dfg import TrackedDfg @@ -19,6 +19,6 @@ "Module", "TrackedDfg", "Dfg", - "_DefinitionBuilder", - "_DfBase", + "DefinitionBuilder", + "DfBase", ] diff --git a/hugr-py/src/hugr/build/cfg.py b/hugr-py/src/hugr/build/cfg.py index 28af4c359..f6b9c277d 100644 --- a/hugr-py/src/hugr/build/cfg.py +++ b/hugr-py/src/hugr/build/cfg.py @@ -10,7 +10,7 @@ from hugr import ops, tys, val from hugr.build.base import ParentBuilder -from hugr.build.dfg import _DfBase +from hugr.build.dfg import DfBase from hugr.exceptions import MismatchedExit, NoSiblingAncestor, NotInSameCfg from hugr.hugr import Hugr @@ -19,7 +19,7 @@ from hugr.tys import Type, TypeRow -class Block(_DfBase[ops.DataflowBlock]): +class Block(DfBase[ops.DataflowBlock]): """Builder class for a basic block in a HUGR control flow graph.""" def set_outputs(self, *outputs: Wire) -> None: diff --git a/hugr-py/src/hugr/build/cond_loop.py b/hugr-py/src/hugr/build/cond_loop.py index 96b494299..02b046251 100644 --- a/hugr-py/src/hugr/build/cond_loop.py +++ b/hugr-py/src/hugr/build/cond_loop.py @@ -12,7 +12,7 @@ from hugr import ops from hugr.build.base import ParentBuilder -from hugr.build.dfg import _DfBase +from hugr.build.dfg import DfBase from hugr.hugr.base import Hugr from hugr.tys import Sum @@ -21,7 +21,7 @@ from hugr.tys import TypeRow -class Case(_DfBase[ops.Case]): +class Case(DfBase[ops.Case]): """Dataflow graph builder for a case in a conditional.""" _parent_cond: Conditional | None = None @@ -202,7 +202,7 @@ def add_case(self, case_id: int) -> Case: @dataclass -class TailLoop(_DfBase[ops.TailLoop]): +class TailLoop(DfBase[ops.TailLoop]): """Builder for a tail-controlled loop. Args: diff --git a/hugr-py/src/hugr/build/dfg.py b/hugr-py/src/hugr/build/dfg.py index 032111901..8c0fb95c6 100644 --- a/hugr-py/src/hugr/build/dfg.py +++ b/hugr-py/src/hugr/build/dfg.py @@ -31,7 +31,7 @@ @dataclass() -class _DefinitionBuilder(Generic[OpVar]): +class DefinitionBuilder(Generic[OpVar]): """Base class for builders that can define functions, constants, and aliases. As this class may be a root node, it does not extend `ParentBuilder`. @@ -96,7 +96,7 @@ def add_alias_defn(self, name: str, ty: Type, parent: ToNode | None = None) -> N @dataclass() -class _DfBase(ParentBuilder[DP], _DefinitionBuilder, AbstractContextManager): +class DfBase(ParentBuilder[DP], DefinitionBuilder, AbstractContextManager): """Base class for dataflow graph builders. Args: @@ -637,7 +637,7 @@ def _wire_up_port(self, node: Node, offset: PortOffset, p: Wire) -> tys.Type: return self._get_dataflow_type(src) -class Dfg(_DfBase[ops.DFG]): +class Dfg(DfBase[ops.DFG]): """Builder for a simple nested Dataflow graph, with root node of type :class:`DFG `. @@ -673,7 +673,7 @@ def _ancestral_sibling(h: Hugr, src: Node, tgt: Node) -> Node | None: @dataclass -class Function(_DfBase[ops.FuncDefn]): +class Function(DfBase[ops.FuncDefn]): """Build a function definition as a HUGR dataflow graph. Args: diff --git a/hugr-py/src/hugr/build/function.py b/hugr-py/src/hugr/build/function.py index a28826a43..97ff17d9c 100644 --- a/hugr-py/src/hugr/build/function.py +++ b/hugr-py/src/hugr/build/function.py @@ -6,7 +6,7 @@ from typing import TYPE_CHECKING from hugr import ops -from hugr.build.dfg import Function, _DefinitionBuilder +from hugr.build.dfg import DefinitionBuilder, Function from hugr.hugr import Hugr if TYPE_CHECKING: @@ -17,7 +17,7 @@ @dataclass -class Module(_DefinitionBuilder[ops.Module]): +class Module(DefinitionBuilder[ops.Module]): """Build a top-level HUGR module. Examples: