Rename inconsistent public APIs (#216)

- tags_add()/tags_remove() → add_tags()/remove_tags()
- cisco_style_text() → indented_text()
- dump_simple() → to_lines()
- config_to_get_to() → remediation()
- depth() method → depth property
- Rename private helpers _config_to_get_to/_left/_right accordingly

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: jtdub

CHANGELOG.md

@@ -20,6 +20,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Renamed `load_hconfig_v2_options` to `load_driver_rules` (#221).
 - Renamed `load_hconfig_v2_tags` to `load_tag_rules` (#221).
+- Renamed `tags_add()`/`tags_remove()` to `add_tags()`/`remove_tags()` (#216).
+- Renamed `cisco_style_text()` to `indented_text()` (#216).
+- Renamed `dump_simple()` to `to_lines()` (#216).
+- Renamed `config_to_get_to()` to `remediation()` (#216).
+- Converted `depth()` method to `depth` property (#216).
 
 ### Removed
 

CLAUDE.md

@@ -63,9 +63,9 @@ Three-layer design: **Tree** (parse/represent config), **Driver** (platform-spec
 
 ### Tree Layer
 
-- `HConfig` (root.py) — root node, owns the driver reference. Key methods: `config_to_get_to()`, `future()`, `difference()`, `dump_simple()`.
+- `HConfig` (root.py) — root node, owns the driver reference. Key methods: `remediation()`, `future()`, `difference()`, `to_lines()`.
 - `HConfigChild` (child.py) — tree node with `text`, `parent`, `children`, `tags`, `comments`. Provides `is_lineage_match()` for rule evaluation and `negate()` for negation logic.
-- `HConfigBase` (base.py) — abstract base shared by both. Provides `add_child()`, `get_children_deep()`, `_config_to_get_to()` (left pass = negate missing, right pass = add new).
+- `HConfigBase` (base.py) — abstract base shared by both. Provides `add_child()`, `get_children_deep()`, `_remediation()` (left pass = negate missing, right pass = add new).
 - `HConfigChildren` (children.py) — ordered collection with O(1) dict lookup by text.
 
 ### Driver Layer (`platforms/`)

docs/architecture.md

@@ -26,7 +26,7 @@ The tree layer lives in `hier_config/base.py`, `hier_config/root.py`, `hier_conf
 
 - A reference to the **driver** for the platform.
 - An `HConfigChildren` collection of top-level `HConfigChild` nodes.
-- High-level operations: `future()`, `config_to_get_to()`, `merge()`, `difference()`, `dump()`.
+- High-level operations: `future()`, `remediation()`, `merge()`, `difference()`, `dump()`.
 
 Create an `HConfig` object via the constructor function:
 
@@ -62,7 +62,7 @@ Both `HConfig` and `HConfigChild` inherit from `HConfigBase`, which provides:
 
 - Child manipulation: `add_child`, `add_children`, `add_deep_copy_of`, `add_shallow_copy_of`.
 - Searching: `get_child`, `get_children`, `get_child_deep`, `get_children_deep`.
-- Diffing: `unified_diff`, `_config_to_get_to`, `_difference`.
+- Diffing: `unified_diff`, `_remediation`, `_difference`.
 - Future prediction: `_future`, `_future_pre`.
 
 ---
@@ -129,9 +129,9 @@ remediation = workflow.remediation_config   # what to apply
 rollback    = workflow.rollback_config      # how to revert
 ```
 
-Internally it calls `running_config.config_to_get_to(generated_config)` which traverses the tree and calls `_config_to_get_to_left` (what to negate) and `_config_to_get_to_right` (what to add).
+Internally it calls `running_config.remediation(generated_config)` which traverses the tree and calls `_remediation_left` (what to negate) and `_remediation_right` (what to add).
 
-### `config_to_get_to()`
+### `remediation()`
 
 This method computes the **minimal delta** between two configs:
 
@@ -204,7 +204,7 @@ HConfig tree                  (HConfigBase / HConfigChild nodes)
     │
     ├──► HConfig.future()     → predicted post-change HConfig
     │
-    ├──► HConfig.config_to_get_to()
+    ├──► HConfig.remediation()
     │         │
     │         ▼
     │     delta HConfig       (remediation commands)

docs/drivers.md

@@ -210,7 +210,7 @@ intended = get_hconfig(Platform.HP_PROCURVE, intended_text)
 workflow = WorkflowRemediation(running, intended)
 
 for line in workflow.remediation_config.all_children_sorted():
-    print(line.cisco_style_text())
+    print(line.indented_text())
 ```
 
 ---
@@ -239,7 +239,7 @@ intended = get_hconfig(Platform.HP_COMWARE5, intended_text)
 workflow = WorkflowRemediation(running, intended)
 
 for line in workflow.remediation_config.all_children_sorted():
-    print(line.cisco_style_text())
+    print(line.indented_text())
 ```
 
 ---

docs/future-config.md

@@ -7,7 +7,7 @@ This feature is useful in scenarios where you need to determine the anticipated
 - Verifying that a configuration change was successfully applied to a device
     - For example, checking if the post-change configuration matches the predicted future configuration
 - Generating a future-state configuration that can be analyzed by tools like Batfish to assess the potential impact of a change
-- Building rollback configurations: once the future configuration state is known, a rollback configuration can be generated by simply creating the remediation in reverse `(rollback = future.config_to_get_to(running))`.
+- Building rollback configurations: once the future configuration state is known, a rollback configuration can be generated by simply creating the remediation in reverse `(rollback = future.remediation(running))`.
     - When building rollbacks for a series of configuration changes, you can use the future configuration from each change as input for the subsequent change. For example, use the future configuration after Change 1 as the input for determining the future configuration after Change 2, and so on.
 
 ## `merge()` versus `future()`
@@ -21,9 +21,9 @@ If you receive a `DuplicateChildError` while calling `merge()`, consider whether
 
 ```python
 post_change_1_config = running_config.future(change_1_config)
-change_1_rollback_config = post_change_1_config.config_to_get_to(running_config)
+change_1_rollback_config = post_change_1_config.remediation(running_config)
 post_change_2_config = post_change_1_config.future(change_2_config)
-change_2_rollback_config = post_change_2_config.config_to_get_to(post_change_1_config)
+change_2_rollback_config = post_change_2_config.remediation(post_change_1_config)
 ```
 
 
@@ -53,7 +53,7 @@ The `future()` algorithm is a best-effort simulation.  The following cases are n
 
 5. **ACL idempotency check.**
    The extended ACL idempotency logic (sequence-number based matching) that drives
-   `config_to_get_to()` is not replicated in `future()`.
+   `remediation()` is not replicated in `future()`.
 
 6. **And likely others.**
    Complex platform-specific interactions (e.g. VRF-aware BGP sections, route-policy
@@ -93,7 +93,7 @@ configuration because their identities differ within the `neighbor` hierarchy.
 >>> print("Running Config")
 Running Config
 >>> for line in running_config.all_children():
-...     print(line.cisco_style_text())
+...     print(line.indented_text())
 ...
 hostname aggr-example.rtr
 ip access-list extended TEST
@@ -116,7 +116,7 @@ interface Vlan3
 >>> print("Remediation Config")
 Remediation Config
 >>> for line in remediation_config.all_children():
-...     print(line.cisco_style_text())
+...     print(line.indented_text())
 ...
 vlan 3
   name switch_mgmt_10.0.3.0/24
@@ -139,7 +139,7 @@ interface Vlan4
 >>> print("Future Config")
 Future Config
 >>> for line in running_config.future(remediation_config).all_children():
-...     print(line.cisco_style_text())
+...     print(line.indented_text())
 ...
 vlan 3
   name switch_mgmt_10.0.3.0/24

docs/getting-started.md

@@ -48,7 +48,7 @@ The `remediation_config` attribute generates the configuration needed to apply t
 >>> print("Remediation configuration:")
 Remediation configuration:
 >>> for line in workflow.remediation_config.all_children_sorted():
-...     print(line.cisco_style_text())
+...     print(line.indented_text())
 ...
 vlan 3
   name switch_mgmt_10.0.3.0/24
@@ -79,7 +79,7 @@ Similarly, the `rollback_config` attribute generates a configuration that can re
 >>> print("Rollback configuration:")
 Rollback configuration:
 >>> for line in workflow.rollback_config.all_children_sorted():
-...     print(line.cisco_style_text())
+...     print(line.indented_text())
 ...
 no vlan 4
 no interface Vlan4

docs/glossary.md

@@ -24,7 +24,7 @@ A Python class that encodes all operating-system-specific behaviour for one netw
 
 A configuration command where only the *last* value applied takes effect — applying the same command twice with different values results in only the second value being active.  Typical examples: `hostname`, `ip address`, `description`.
 
-hier_config uses `IdempotentCommandsRule` to identify these commands.  During `config_to_get_to()`, when both the running and intended configs contain a command that matches an idempotency rule, the running value is **not** negated before the new value is applied (the new value simply overwrites it).
+hier_config uses `IdempotentCommandsRule` to identify these commands.  During `remediation()`, when both the running and intended configs contain a command that matches an idempotency rule, the running value is **not** negated before the new value is applied (the new value simply overwrites it).
 
 **Example rule:**
 
@@ -126,7 +126,7 @@ A `SectionalExitingRule` that instructs hier_config to emit a closing token at t
 
 ## Sectional overwrite
 
-A `SectionalOverwriteRule` that tells `config_to_get_to()` to **negate the entire section** and then re-create it from the intended config rather than performing a line-by-line diff.  Appropriate for configuration blocks where the order of entries matters globally or where partial changes are not supported by the OS.
+A `SectionalOverwriteRule` that tells `remediation()` to **negate the entire section** and then re-create it from the intended config rather than performing a line-by-line diff.  Appropriate for configuration blocks where the order of entries matters globally or where partial changes are not supported by the OS.
 
 ---
 

docs/index.md

@@ -44,7 +44,7 @@ intended = get_hconfig(Platform.CISCO_IOS, intended_config_text)
 workflow = WorkflowRemediation(running, intended)
 
 for line in workflow.remediation_config.all_children_sorted():
-    print(line.cisco_style_text())
+    print(line.indented_text())
 ```
 
 ---

hier_config/base.py

@@ -26,7 +26,7 @@ class HConfigBase(ABC):  # noqa: PLR0904
 
     Both `HConfig` (the root) and `HConfigChild` (individual nodes) inherit from
     this class.  It provides the shared tree-manipulation API: adding, searching,
-    and diffing children, as well as the `_future` / `_config_to_get_to` algorithms
+    and diffing children, as well as the `_future` / `_remediation` algorithms
     that power `WorkflowRemediation`.
     """
 
@@ -62,6 +62,7 @@ def driver(self) -> HConfigDriverBase:
     def lineage(self) -> Iterator[HConfigChild]:
         pass
 
+    @property
     @abstractmethod
     def depth(self) -> int:
         pass
@@ -231,7 +232,7 @@ def add_shallow_copy_of(
         new_child.comments.update(child_to_add.comments)
         new_child.order_weight = child_to_add.order_weight
         if child_to_add.is_leaf:
-            new_child.tags_add(child_to_add.tags)
+            new_child.add_tags(child_to_add.tags)
 
         return new_child
 
@@ -372,7 +373,7 @@ def _with_tags(
 
         return new_instance
 
-    def _config_to_get_to(
+    def _remediation(
         self,
         target: _HConfigRootOrChildT,
         delta: _HConfigRootOrChildT,
@@ -382,8 +383,8 @@ def _config_to_get_to(
         target is the destination(i.e. generated_config).
 
         """
-        self._config_to_get_to_left(target, delta)
-        self._config_to_get_to_right(target, delta)
+        self._remediation_left(target, delta)
+        self._remediation_right(target, delta)
 
         return delta
 
@@ -441,7 +442,7 @@ def _difference(
 
         return delta
 
-    def _config_to_get_to_left(
+    def _remediation_left(
         self,
         target: HConfig | HConfigChild,
         delta: HConfig | HConfigChild,
@@ -462,7 +463,7 @@ def _config_to_get_to_left(
             if self_child.children:
                 negated.comments.add(f"removes {len(self_child.children) + 1} lines")
 
-    def _config_to_get_to_right(
+    def _remediation_right(
         self,
         target: HConfig | HConfigChild,
         delta: HConfig | HConfigChild,
@@ -481,7 +482,7 @@ def _config_to_get_to_right(
                 # This creates a new HConfigChild object just in case there are some delta children.
                 # This is not very efficient, think of a way to not do this.
                 subtree = delta.instantiate_child(target_child.text)
-                self_child._config_to_get_to(target_child, subtree)  # noqa: SLF001
+                self_child._remediation(target_child, subtree)  # noqa: SLF001
                 if subtree.children:
                     delta.children.append(subtree)
             # The child is absent, add it.

hier_config/child.py

@@ -114,15 +114,13 @@ def root(self) -> HConfig:
         return self.parent.root
 
     def lines(self, *, sectional_exiting: bool = False) -> Iterable[str]:
-        yield self.cisco_style_text()
+        yield self.indented_text()
         for child in sorted(self.children):
             yield from child.lines(sectional_exiting=sectional_exiting)
 
         if sectional_exiting and (exit_text := self.sectional_exit):
             depth = (
-                self.depth() - 1
-                if self.sectional_exit_text_parent_level
-                else self.depth()
+                self.depth - 1 if self.sectional_exit_text_parent_level else self.depth
             )
             yield " " * self.driver.rules.indentation * depth + exit_text
 
@@ -147,9 +145,10 @@ def delete_sectional_exit(self) -> None:
         if (exit_text := self.sectional_exit) and exit_text == potential_exit.text:
             potential_exit.delete()
 
+    @property
     def depth(self) -> int:
         """Returns the distance to the root HConfig object i.e. indent level."""
-        return self.parent.depth() + 1
+        return self.parent.depth + 1
 
     def move(self, new_parent: HConfig | HConfigChild) -> None:
         """Move one HConfigChild object to different HConfig parent object.
@@ -179,12 +178,12 @@ def path(self) -> Iterator[str]:
         for child in self.lineage():
             yield child.text
 
-    def cisco_style_text(
+    def indented_text(
         self,
         style: str = "without_comments",
         tag: str | None = None,
     ) -> str:
-        """Return a Cisco style formated line i.e. indentation_level + text ! comments."""
+        """Return an indented text line i.e. indentation_level + text ! comments."""
         comments: list[str] = []
         if style == "without_comments":
             pass
@@ -210,27 +209,27 @@ def cisco_style_text(
 
     @property
     def indentation(self) -> str:
-        return " " * self.driver.rules.indentation * (self.depth() - 1)
+        return " " * self.driver.rules.indentation * (self.depth - 1)
 
     def delete(self) -> None:
         """Delete the current object from its parent."""
         self.parent.children.delete(self)
 
-    def tags_add(self, tag: str | Iterable[str]) -> None:
+    def add_tags(self, tag: str | Iterable[str]) -> None:
         """Add a tag to self._tags on all leaf nodes."""
         if self.is_branch:
             for child in self.children:
-                child.tags_add(tag)
+                child.add_tags(tag)
         elif isinstance(tag, str):
             self._tags.add(tag)
         else:
             self._tags.update(tag)
 
-    def tags_remove(self, tag: str | Iterable[str]) -> None:
+    def remove_tags(self, tag: str | Iterable[str]) -> None:
         """Remove a tag from self._tags on all leaf nodes."""
         if self.is_branch:
             for child in self.children:
-                child.tags_remove(tag)
+                child.remove_tags(tag)
         elif isinstance(tag, str):
             self._tags.remove(tag)
         else:
@@ -348,7 +347,7 @@ def overwrite_with(
         comment is attached to the new entry, and a ``"dropping section"``
         comment is added to the negated entry when applicable.
 
-        Used by :meth:`_config_to_get_to_right` when a sectional-overwrite
+        Used by :meth:`_remediation_right` when a sectional-overwrite
         rule is active for ``self.text``.
         """
         if self.children != target.children: