librelane 2.4.0.dev10__tar.gz → 2.4.0.dev11__tar.gz

{librelane-2.4.0.dev10 → librelane-2.4.0.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: librelane
-Version: 2.4.0.dev10
+Version: 2.4.0.dev11
 Summary: An infrastructure for implementing chip design flows
 Home-page: https://github.com/librelane/librelane
 License: Apache-2.0

{librelane-2.4.0.dev10 → librelane-2.4.0.dev11}/librelane/common/types.py

@@ -16,6 +16,7 @@ import sys
 import tempfile
 from math import isfinite
 from decimal import Decimal
+from weakref import finalize
 from collections import UserString
 from typing import Any, Union, ClassVar, Tuple, Optional
 
@@ -112,6 +113,4 @@ class ScopedFile(Path):
         super().__init__(self._ntf.name)
         self._ntf.write(contents)
         self._ntf.close()
-
-    def __del__(self):
-        os.unlink(self._ntf.name)
+        self._ntf_cleanup = finalize(self, os.unlink, self._ntf.name)

{librelane-2.4.0.dev10 → librelane-2.4.0.dev11}/librelane/flows/flow.py

@@ -375,7 +375,7 @@ class Flow(ABC):
         self.progress_bar = FlowProgressBar(self.name)
 
     @classmethod
-    def get_help_md(Self) -> str:  # pragma: no cover
+    def get_help_md(Self, myst_anchors: bool = True) -> str:  # pragma: no cover
         """
         :returns: rendered Markdown help for this Flow
         """
@@ -383,10 +383,12 @@ class Flow(ABC):
         if Self.__doc__:
             doc_string = textwrap.dedent(Self.__doc__)
 
+        flow_anchor = f"(flow-{slugify(Self.__name__, lower=True)})="
+
         result = (
             textwrap.dedent(
                 f"""\
-                (flow-{slugify(Self.__name__, lower=True)})=
+                {flow_anchor * myst_anchors}
                 ### {Self.__name__}
 
                 ```{{eval-rst}}
@@ -426,7 +428,8 @@ class Flow(ABC):
             for var in flow_config_vars:
                 units = var.units or ""
                 pdk_superscript = "<sup>PDK</sup>" if var.pdk else ""
-                result += f"| `{var.name}`{{#{var._get_docs_identifier(Self.__name__)}}}{pdk_superscript} | {var.type_repr_md()} | {var.desc_repr_md()} | `{var.default}` | {units} |\n"
+                var_anchor = f"{{#{var._get_docs_identifier(Self.__name__)}}}"
+                result += f"| `{var.name}`{var_anchor * myst_anchors} {pdk_superscript} | {var.type_repr_md()} | {var.desc_repr_md()} | `{var.default}` | {units} |\n"
             result += "\n"
 
         if len(Self.Steps):
@@ -438,10 +441,35 @@ class Flow(ABC):
                     name = step.name
                 else:
                     name = step.id
-                result += f"* [`{step.id}`](./step_config_vars.md#{slugify(name)})\n"
+                if myst_anchors:
+                    result += (
+                        f"* [`{step.id}`](./step_config_vars.md#{slugify(name)})\n"
+                    )
+                else:
+                    result += f"* {step.id}"
 
         return result
 
+    @classmethod
+    def display_help(Self):  # pragma: no cover
+        """
+        Displays Markdown help for a given flow.
+
+        If in an IPython environment, it's rendered using ``IPython.display``.
+        Otherwise, it's rendered using ``rich.markdown``.
+        """
+        try:
+            get_ipython()  # type: ignore
+
+            import IPython.display
+
+            IPython.display.display(IPython.display.Markdown(Self.get_help_md()))
+        except NameError:
+            from ..logging import console
+            from rich.markdown import Markdown
+
+            console.log(Markdown(Self.get_help_md()))
+
     def get_all_config_variables(self) -> List[Variable]:
         """
         :returns: All configuration variables for this Flow, including

{librelane-2.4.0.dev10 → librelane-2.4.0.dev11}/librelane/steps/step.py

@@ -625,6 +625,7 @@ class Step(ABC):
         *,
         docstring_override: str = "",
         use_dropdown: bool = False,
+        myst_anchors: bool = False,
     ):  # pragma: no cover
         """
         Renders Markdown help for this step to a string.
@@ -682,11 +683,12 @@ class Step(ABC):
                 result += f"| {input_str} | {output_str} |\n"
 
         if len(Self.config_vars):
+            all_vars_anchor = f"({Self.id.lower()}-configuration-variables)="
             result += textwrap.dedent(
                 f"""
-                ({Self.id.lower()}-configuration-variables)=
+                {all_vars_anchor * myst_anchors}
                 #### Configuration Variables
-
+                
                 | Variable Name | Type | Description | Default | Units |
                 | - | - | - | - | - |
                 """
@@ -694,13 +696,15 @@ class Step(ABC):
             for var in Self.config_vars:
                 units = var.units or ""
                 pdk_superscript = "<sup>PDK</sup>" if var.pdk else ""
-                result += f"| `{var.name}`{{#{var._get_docs_identifier(Self.id)}}}{pdk_superscript} | {var.type_repr_md(for_document=True)} | {var.desc_repr_md()} | `{var.default}` | {units} |\n"
+                var_anchor = f"{{#{var._get_docs_identifier(Self.id)}}}"
+                result += f"| `{var.name}`{var_anchor * myst_anchors} {pdk_superscript} | {var.type_repr_md(for_document=True)} | {var.desc_repr_md()} | `{var.default}` | {units} |\n"
             result += "\n"
 
+        step_anchor = f"(step-{slugify(Self.id.lower())})="
         result = (
             textwrap.dedent(
                 f"""
-                (step-{slugify(Self.id.lower())})=
+                {step_anchor * myst_anchors}
                 ### {Self.__get_desc()}
                 """
             )
@@ -712,11 +716,22 @@ class Step(ABC):
     @classmethod
     def display_help(Self):  # pragma: no cover
         """
-        IPython-only. Displays Markdown help for a given step.
+        Displays Markdown help for this Step.
+
+        If in an IPython environment, it's rendered using ``IPython.display``.
+        Otherwise, it's rendered using ``rich.markdown``.
         """
-        import IPython.display
+        try:
+            get_ipython()  # type: ignore
+
+            import IPython.display
+
+            IPython.display.display(IPython.display.Markdown(Self.get_help_md()))
+        except NameError:
+            from ..logging import console
+            from rich.markdown import Markdown
 
-        IPython.display.display(IPython.display.Markdown(Self.get_help_md()))
+            console.log(Markdown(Self.get_help_md()))
 
     def _repr_markdown_(self) -> str:  # pragma: no cover
         """

{librelane-2.4.0.dev10 → librelane-2.4.0.dev11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "librelane"
-version = "2.4.0.dev10"
+version = "2.4.0.dev11"
 description = "An infrastructure for implementing chip design flows"
 # Technically, maintainer. We cannot use the maintainers field until
 # poetry-core>=2.0.0 which requires Python version 3.9+. This field does