librelane 3.0.0.dev33__py3-none-any.whl → 3.0.0.dev35__py3-none-any.whl

librelane/flows/cli.py

@@ -1,3 +1,7 @@
+# Copyright 2025 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
 # Copyright 2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,6 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import os
+import sys
 from functools import partial, wraps
 from concurrent.futures import ThreadPoolExecutor
 from typing import Optional, Union
@@ -21,12 +26,15 @@ from click import (
     Parameter,
     echo,
 )
+from click.formatting import join_options
 from cloup import (
     option,
     argument,
     option_group,
     Choice,
-    Path,
+    Argument,
+    Option as CloupOption,
+    Path as CloupPath,
 )
 from cloup.constraints import (
     mutually_exclusive,
@@ -39,6 +47,70 @@ from ..logging import set_log_level, verbose, err, options, LogLevels
 from ..state import State, InvalidState
 
 
+class Option(CloupOption):
+    """
+    A slight modification of cloup.Option that consumes the environment
+    variable(s) in envvar upon use.
+    """
+
+    def resolve_envvar_value(self, ctx: Context) -> Optional[str]:
+        if self.envvar is None:
+            return None
+        evs = self.envvar
+        if isinstance(evs, str):
+            evs = [evs]
+        for envvar in self.envvar:
+            rv = os.environ.pop(envvar, None)
+            if rv:
+                return rv
+        return None
+
+
+class Path(CloupPath):
+    """
+    A modification of cloup.Path that rejects paths starting with a tilde (~)
+    as too ambiguous. This is because of user confusion.
+    """
+
+    def convert(
+        self,
+        value: Union[str, os.PathLike],
+        param: Optional[Parameter],
+        ctx: Optional[Context],
+    ):
+        value = str(value)
+        assert param is not None
+        assert ctx is not None
+
+        is_cmd = False
+        if sys.platform == "win32":
+            import psutil
+
+            is_cmd = psutil.Process(os.getppid()).name().lower().endswith("cmd.exe")
+        if not is_cmd and value.startswith("~"):
+            usage, _ = join_options(param.opts)
+            if isinstance(param, Argument):
+                usage = ""
+            buffer = f"'{value}' starts with a tilde, which is ambiguous.\n"
+            buffer += "  * If you meant your home directory, make sure your POSIX shell is able to expand the tilde:\n"
+            buffer += f"    * GOOD: {ctx.command_path} {usage} {value}   …\n"
+            if usage != "":
+                buffer += f"    * BAD:  {ctx.command_path} {usage}={value}   …\n"
+            buffer += f'    * BAD:  {ctx.command_path} {usage} "{value}" …\n'
+            env_vars = []
+            if param.envvar is not None:
+                if isinstance(param.envvar, str):
+                    env_vars = [param.envvar]
+                else:
+                    env_vars = list(param.envvar)
+            for var in env_vars:
+                buffer += f"    * GOOD: {var}={value}   {ctx.command_path} …\n"
+                buffer += f'    * BAD:  {var}="{value}" {ctx.command_path} …\n'
+            buffer += '  * If you want a relative file or directory that starts with a literal "~", use an absolute path.\n'
+            self.fail(buffer, param, ctx)
+        return super().convert(value, param, ctx)
+
+
 def set_log_level_cb(
     ctx: Context,
     param: Parameter,
@@ -181,7 +253,7 @@ def cloup_flow_opts(
         Ciel is used by default for this CLI or not.
     :returns: The wrapper
     """
-    o = partial(option, show_default=True)
+    o = partial(option, cls=CloupOption, show_default=True)
 
     def decorate(f):
         if config_options:
@@ -355,21 +427,23 @@ def cloup_flow_opts(
                         dir_okay=True,
                     ),
                     is_eager=True,
-                    default=os.environ.pop("PDK_ROOT", None),
+                    envvar=["PDK_ROOT"],
                     help="Override Ciel PDK root folder. Required if Ciel is not installed, but a default value can also be set via the environment variable PDK_ROOT.",
                 ),
                 o(
                     "-p",
                     "--pdk",
                     type=str,
-                    default=os.environ.pop("PDK", "sky130A"),
+                    envvar=["PDK"],
+                    default="sky130A",
                     help="The process design kit to use.",
                 ),
                 o(
                     "-s",
                     "--scl",
                     type=str,
-                    default=os.environ.pop("STD_CELL_LIBRARY", None),
+                    envvar=["STD_CELL_LIBRARY"],
+                    # no default, default is obtained dynamically from PDK
                     help="The standard cell library to use. If None, the PDK's default standard cell library is used.",
                 ),
             )(f)

librelane/scripts/magic/extract_spice.tcl

@@ -79,9 +79,11 @@ extract no capacitance
 extract no coupling
 extract no resistance
 extract no adjust
-if { ! $::env(MAGIC_NO_EXT_UNIQUE) } {
-    extract unique
+
+if { $::env(MAGIC_EXT_UNIQUE) != "none" } {
+    extract unique $::env(MAGIC_EXT_UNIQUE)
 }
+
 # extract warn all
 extract
 

librelane/steps/magic.py

@@ -458,15 +458,18 @@ class SpiceExtraction(MagicStep):
         Variable(
             "MAGIC_EXT_ABSTRACT_CELLS",
             Optional[List[str]],
-            "A list of regular experssions which are matched against the cells of a "
+            "A list of regular expressions which are matched against the cells of a "
             + "the design. Matches are abstracted (black-boxed) during SPICE extraction.",
         ),
         Variable(
-            "MAGIC_NO_EXT_UNIQUE",
-            bool,
-            "Enables connections by label in LVS by skipping `extract unique` in Magic extractions.",
-            default=False,
-            deprecated_names=["LVS_CONNECT_BY_LABEL"],
+            "MAGIC_EXT_UNIQUE",
+            Literal["all", "notopports", "noports", "none"],
+            'Runs `extract unique` with the specified option. The default is "all", and "none" disables `extract unique`, allowing connections between separate nets by label in LVS.',
+            default="all",
+            deprecated_names=[
+                ("MAGIC_NO_EXT_UNIQUE", lambda o: "none" if o else "all"),
+                ("LVS_CONNECT_BY_LABEL", lambda o: "none" if o else "all"),
+            ],
         ),
         Variable(
             "MAGIC_EXT_SHORT_RESISTOR",

{librelane-3.0.0.dev33.dist-info → librelane-3.0.0.dev35.dist-info}/METADATA

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

{librelane-3.0.0.dev33.dist-info → librelane-3.0.0.dev35.dist-info}/RECORD

@@ -42,7 +42,7 @@ librelane/examples/spm-user_project_wrapper/user_project_wrapper.v,sha256=zc6GC5
 librelane/flows/__init__.py,sha256=ghtmUG-taVpHJ3CKJRYZGn3dU0r93araT1EIGlBEsxg,896
 librelane/flows/builtins.py,sha256=tR14Qc1ZUey2w-Ar4DWOvxuP7LGPtMecCJq8WgcYJpk,773
 librelane/flows/classic.py,sha256=JB9gVgP2hHPhMuCJg7hvoj2BvJcvRec7suEXPgHmz14,10971
-librelane/flows/cli.py,sha256=_aJjlalCsmUeLiqy1D8VFmBJ0dLelx24erqaK2q-AOs,16706
+librelane/flows/cli.py,sha256=cW_S12VZqNVaWNcMlAKOVfbCALgl1AG_8rqvTcsvBDY,19324
 librelane/flows/flow.py,sha256=1zRhYQvnRte-VNcsVmAkikD_kZJVbgsqgLR-8CGYaLI,37034
 librelane/flows/misc.py,sha256=32Om3isexesfKKiJZCajNmINc-xdv7eVx_tgoh9SR6U,2015
 librelane/flows/optimizing.py,sha256=OwZz6WGmXpliwO8vtmhjKHD-kzDyNv-zoCECZIigXsI,6076
@@ -67,7 +67,7 @@ librelane/scripts/magic/def/antenna_check.tcl,sha256=T_r1CWgySFVlLMcoTrNXQ_aMRs_
 librelane/scripts/magic/def/mag.tcl,sha256=PuL3MH6pmZP5Qh2cJ0GygWNzaYjdCSCoAbOli-JB4fs,707
 librelane/scripts/magic/def/mag_gds.tcl,sha256=fwtQR9zPZpWqVmmLb-1hzY4WMCr4gbA3S0pTZsS9sss,2144
 librelane/scripts/magic/drc.tcl,sha256=gPGyI96lR10dJXcJACajzHaHiT6ayAYPJqrmmuQkABc,2395
-librelane/scripts/magic/extract_spice.tcl,sha256=-jDxVEGddch1YZLZXW1vFXhdLkeTjxk0d8eU1tBMBWc,2788
+librelane/scripts/magic/extract_spice.tcl,sha256=2NjDFbqRfTsWhD1s-NGcDr8e4o3Ejg-4vCEoLt22RCc,2820
 librelane/scripts/magic/gds/drc_batch.tcl,sha256=O76rwxSrQgoCuoxk36tRBZkQaeMfJknlHrQA3mtU2JU,2198
 librelane/scripts/magic/gds/erase_box.tcl,sha256=wsVSwMlkZFJa_MEGNsdXLnXFvjZlrl_lzIWkJjcDBgg,929
 librelane/scripts/magic/gds/extras_mag.tcl,sha256=1raG0URUezUDEKkdDeJqdlS0Y5gb4IzQFnjFysHHlmU,1304
@@ -156,7 +156,7 @@ librelane/steps/checker.py,sha256=HD5YFPAbHQKsFmBDrIAbo_0clZcCszNhIXb4lHaNIeQ,21
 librelane/steps/common_variables.py,sha256=eih2eA1m0FpL8ydF5WWattwh_SxtzI55eb8gggJtBuY,12494
 librelane/steps/cvc_rv.py,sha256=qeroQPjidSAMYSp3nJNiQBYt8V73kkz3JK97uioo7J8,5294
 librelane/steps/klayout.py,sha256=18B7trKjyD8HnGUVwrjQV8XRzGu298CuosM1WOzg9oM,23255
-librelane/steps/magic.py,sha256=m4cZH2VomJs0RudtV8avSaZVqRj1NP7Pm2P6qo2z2X0,20919
+librelane/steps/magic.py,sha256=Cc_qApOgeltIn7lKA7dBQ4Ud9EQtbMatsuGPEvqvpcQ,21183
 librelane/steps/misc.py,sha256=8ubCvFeFEspXrgnzNWINY5-TXTyalNtlvcX8TSw0qdg,5685
 librelane/steps/netgen.py,sha256=R9sDWv-9wKMdi2rkuLQdOc4uLlbYhXcKKd6WsZsnLt0,8953
 librelane/steps/odb.py,sha256=-zsXi0jVdtfBfAJI0OC4x1jI_B2OX5YVn4uAn6NyFdk,38424
@@ -167,7 +167,7 @@ librelane/steps/step.py,sha256=THIxZkhtkNYt1iRgMduD0ywrOTCaV7cCfUB2EqXN6-k,55751
 librelane/steps/tclstep.py,sha256=68AjCmbLhBscbzQDxRcPQVU-6UvZQNOalO7qNwUXCa4,10138
 librelane/steps/verilator.py,sha256=MWx2TpLqYyea9_jSeLG9c2S5ujvYERQZRFNaMhfHxZE,7916
 librelane/steps/yosys.py,sha256=lYdZPFvjcmdu_NE6rtB94_dysIK2qwGdGb480W6pg2w,12711
-librelane-3.0.0.dev33.dist-info/METADATA,sha256=u7-qZzdB2GVYUEeR1RAAyHvIC8GU4Y3cprFnjR_uJyU,6561
-librelane-3.0.0.dev33.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-librelane-3.0.0.dev33.dist-info/entry_points.txt,sha256=0eZs2NOH-w-W_GVRCs-ualst26XplkPpJkOnGWMaFw0,306
-librelane-3.0.0.dev33.dist-info/RECORD,,
+librelane-3.0.0.dev35.dist-info/METADATA,sha256=wYieL_eP8SWZNsfU8ZCsm2QXkAS8sUFXmkCyIyRhwuo,6561
+librelane-3.0.0.dev35.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+librelane-3.0.0.dev35.dist-info/entry_points.txt,sha256=0eZs2NOH-w-W_GVRCs-ualst26XplkPpJkOnGWMaFw0,306
+librelane-3.0.0.dev35.dist-info/RECORD,,