bugfix: crash with iterable variables in type-lax mode (#581)

## Misc. Enhancements/Bugfixes

* `openlane.config.Variable`

* Fixed an issue when strict type-checking is disabled where empty
strings would crash iterable objects.

## Tool Updates

* Fixed mypy to 1.9.0 to match NixOS 24.05.

* Checked `poetry.lock` into version control to improve reproducibility.

.gitignore

@@ -15,6 +15,7 @@ build/
 dist/
 requirements.frz.txt
 openlane_ipynb/
+requirements_tmp.txt
 
 # Nix
 result
@@ -41,7 +42,3 @@ sandbox/
 node_modules/
 yarn.lock
 package.json
-
-# We're not using poetry2nix just yet
-poetry.lock
-requirements_tmp.txt

Changelog.md

@@ -14,19 +14,38 @@
 ## Documentation
 -->
 
+# 2.1.10
+
+## Misc. Enhancements/Bugfixes
+
+* `openlane.config.Variable`
+
+  * Fixed an issue when strict type-checking is disabled where empty strings
+    would crash iterable objects.
+
+## Tool Updates
+
+* Fixed mypy to 1.9.0 to match NixOS 24.05.
+
+* Checked `poetry.lock` into version control to improve reproducibility.
+
 # 2.1.9
 
 ## Steps
 
 * `OpenROAD.CheckAntennas`
-  * Fixed table being printed to file with wrong width
+
+  * Fixed table being printed to file with wrong width.
+
 * `OpenROAD.STA*PnR`
-  * Fixed table being printed to file with wrong width
+
+  * Fixed table being printed to file with wrong width.
 
 ## Flows
 
 * `SynthesisExploration`
-  * Fixed table being printed to file with wrong width
+
+  * Fixed table being printed to file with wrong width.
 
 # 2.1.8
 
@@ -35,7 +54,7 @@
 * `OpenROAD.STA*PnR`
 
   * Fixed a bug in STA metrics where paths with exactly zero slack are counted
-    as violations
+    as violations.
 
 # 2.1.7
 

openlane/config/variable.py

@@ -436,7 +436,7 @@ def __process(
                     raw = raw.split(";")
                 else:
                     raw = raw.split()
-                if raw[-1] == "":
+                if len(raw) and raw[-1] == "":
                     raw.pop()  # Trailing commas
             else:
                 raise ValueError(

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openlane"
-version = "2.1.9"
+version = "2.1.10"
 description = "An infrastructure for implementing chip design flows"
 authors = ["Efabless Corporation and Contributors <[email protected]>"]
 readme = "Readme.md"
@@ -35,7 +35,7 @@ flake8 = ">=4"
 flake8-no-implicit-concat = "0.3.3"
 flake8-pytest-style = "*"
 
-mypy = "*"
+mypy = ">=1.9.0,<1.10.0"
 lxml-stubs = "*"
 types-urllib3 = "*"
 types-typed-ast = "*"

test/config/test_config.py

@@ -55,6 +55,7 @@ def test_dict_config():
                 )
             },
             "DEFAULT_CORNER": "nom_tt_025C_1v80",
+            "RANDOM_ARRAY": None,
         },
         meta=Meta(version=2, flow=None),
     )
@@ -107,6 +108,7 @@ def test_json_config():
                 )
             },
             "DEFAULT_CORNER": "nom_tt_025C_1v80",
+            "RANDOM_ARRAY": None,
         },
         meta=Meta(version=2, flow="Whatever"),
     ), "Generated configuration does not match expected value"
@@ -127,8 +129,11 @@ def test_tcl_config():
             set ::env(DESIGN_NAME) "whatever"
             set ::env(VERILOG_FILES) "\\
                 /cwd/src/a.v\\
-                    /cwd/src/b.v\\
+                /cwd/src/b.v\\
             "
+                    
+            set ::env(RANDOM_ARRAY) ""
+            
             # cant test glob because of the mock filesystem
             """
         )
@@ -160,6 +165,7 @@ def test_tcl_config():
                 )
             },
             "DEFAULT_CORNER": "nom_tt_025C_1v80",
+            "RANDOM_ARRAY": [],
         },
         meta=Meta(version=1, flow=None),
     ), "Generated configuration does not match expected value"
@@ -221,6 +227,7 @@ def test_mixed_configs():
                 )
             },
             "DEFAULT_CORNER": "whatever",
+            "RANDOM_ARRAY": None,
         },
         meta=Meta(version=2, flow="Whatever"),
     ), "Generated configuration does not match expected value"

test/conftest.py

@@ -145,6 +145,11 @@ def _chdir_tmp(request: SubRequest):
         default="nom_tt_025C_1v80",
         pdk=True,
     ),
+    Variable(
+        "RANDOM_ARRAY",
+        Optional[List[str]],
+        description="x",
+    ),
 ]
 MOCK_FLOW_VARS = [
     Variable(

test/steps/test_step.py

@@ -334,6 +334,7 @@ class StepTest(Step):
             "nom_*": "/pdk/dummy/libs.ref/techlef/dummy_scl/dummy_tech_lef.tlef"
         },
         "DEFAULT_CORNER": "nom_tt_025C_1v80",
+        "RANDOM_ARRAY": None,
     }
     step = StepTest(
         config=Config(config_dict),