-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
initial scaffold for tunable variables
Signed-off-by: Jack Luar <[email protected]>
- Loading branch information
Showing
6 changed files
with
256 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,97 @@ | ||
| #!/usr/bin/env python3 | ||
| # variables.yaml is the single source of truth w.r.t. metainformation about | ||
| # the ORFS variables. | ||
| # | ||
| # This script injects an autogenerated section in FlowVariables.md with | ||
| # information about the variables from variables.yaml. | ||
| """ | ||
| This script injects an autogenerated section in FlowVariables.md with | ||
| information about the variables from variables.yaml. | ||
| variables.yaml is the single source of truth w.r.t. metainformation about | ||
| the ORFS variables. | ||
| """ | ||
| import os | ||
| import yaml | ||
|
|
||
| dir_path = os.path.dirname(os.path.realpath(__file__)) | ||
|
|
||
| yaml_path = os.path.join(dir_path, "variables.yaml") | ||
| preferred_order = ["synth", "floorplan", "place", "cts", "grt", "route", "final"] | ||
| table_header = "| Variable | Description | Default |\n| --- | --- | --- |\n" | ||
|
|
||
| with open(yaml_path, "r") as file: | ||
| data = yaml.safe_load(file) | ||
|
|
||
| preferred_order = ["synth", "floorplan", "place", "cts", "grt", "route", "final"] | ||
| stages = {stage for value in data.values() for stage in value.get("stages", [])} | ||
| # convert set of stages to stages in a list in the preferred order, but | ||
| # list all stages | ||
| stages = [stage for stage in preferred_order if stage in stages] + [ | ||
| stage for stage in stages if stage not in preferred_order | ||
| ] | ||
| def load_yaml(yaml_path: str) -> dict: | ||
| if not os.path.exists(yaml_path): | ||
| raise FileNotFoundError(f"File {yaml_path} not found") | ||
| with open(yaml_path, "r") as file: | ||
| return yaml.safe_load(file) | ||
|
|
||
| markdown_table = "" | ||
|
|
||
| markdown_table += "## Variables in alphabetic order\n\n" | ||
| table_header = "| Variable | Description | Default |\n| --- | --- | --- |\n" | ||
| table_rows = "" | ||
| for key in sorted(data): | ||
| value = data[key] | ||
| description = value.get("description", "").replace("\n", " ").strip() | ||
| table_rows += ( | ||
| def preprocess(data: dict) -> list: | ||
| # convert set of stages to stages in a list in the preferred order, but | ||
| # list all stages | ||
| stages = {stage for value in data.values() for stage in value.get("stages", [])} | ||
| stages = [stage for stage in preferred_order if stage in stages] + [ | ||
| stage for stage in stages if stage not in preferred_order | ||
| ] | ||
| return stages | ||
|
|
||
|
|
||
| def generate_md(data: dict, stages: list) -> None: | ||
| # Populate overview section | ||
| markdown_table = "## Variables in alphabetic order\n\n" | ||
| table_rows = "\n".join( | ||
| f'| <a name="{key}"></a>{key}' | ||
| + f"| {description}" | ||
| + f'| {value.get("default", "")} |\n' | ||
| + f"| {value.get('description', '').replace('\n', ' ').strip()}" | ||
| + f'| {value.get("default", "")} |' | ||
| for key, value in sorted(data.items()) | ||
| ) | ||
| markdown_table += table_header + table_rows + "\n\n" | ||
|
|
||
| markdown_table += table_header + table_rows | ||
|
|
||
| for stage in stages + ["All stages", "Uncategorized"]: | ||
| markdown_table += f"## {stage} variables\n\n" | ||
| stage_keys = [ | ||
| key | ||
| for key in sorted(data) | ||
| if ( | ||
| ("stages" in data[key] and stage in data[key]["stages"]) | ||
| or ("stages" not in data[key] and stage == "Uncategorized") | ||
| or ( | ||
| stage == "All stages" | ||
| and set(data[key].get("stages", [])) == set(stages) | ||
| # Populate stages section | ||
| for stage in stages + ["All stages", "Uncategorized"]: | ||
| markdown_table += f"## {stage.capitalize()} variables\n\n" | ||
| stage_keys = [ | ||
| key | ||
| for key in sorted(data) | ||
| if ( | ||
| ("stages" in data[key] and stage in data[key]["stages"]) | ||
| or ("stages" not in data[key] and stage == "Uncategorized") | ||
| or ( | ||
| stage == "All stages" | ||
| and set(data[key].get("stages", [])) == set(stages) | ||
| ) | ||
| ) | ||
| ) | ||
| ] | ||
| markdown_table += "\n".join(map(lambda k: f"- [{k}](#{k})", stage_keys)) | ||
| markdown_table += "\n\n" | ||
|
|
||
| docs = os.path.join(dir_path, "..", "..", "docs", "user", "FlowVariables.md") | ||
| with open(docs, "r") as file: | ||
| lines = file.readlines() | ||
|
|
||
| # Find the section to replace | ||
| start_marker = "# Automatically generated" | ||
| end_marker = "# " | ||
| start_index = None | ||
| end_index = len(lines) | ||
|
|
||
| for i, line in enumerate(lines): | ||
| if line.startswith(start_marker): | ||
| start_index = i + 1 | ||
| elif start_index is not None and line.startswith(end_marker): | ||
| end_index = i | ||
| break | ||
|
|
||
| if start_index is None: | ||
| raise ValueError("Start marker not found") | ||
|
|
||
| # Replace the section with the new table | ||
| new_lines = lines[:start_index] + [markdown_table] + lines[end_index:] | ||
|
|
||
| # Write the updated content back to FlowVariables.md | ||
| with open(docs, "w") as file: | ||
| file.writelines(new_lines) | ||
| ] | ||
| markdown_table += "\n".join(map(lambda k: f"- [{k}](#{k})", stage_keys)) | ||
| markdown_table += "\n\n" | ||
|
|
||
| # Read the existing content of FlowVariables.md | ||
| docs = os.path.join(dir_path, "..", "..", "docs", "user", "FlowVariables.md") | ||
| with open(docs, "r") as file: | ||
| lines = file.readlines() | ||
|
|
||
| # Find the section to replace | ||
| start_marker = "# Automatically generated" | ||
| end_marker = "# " | ||
| start_index = None | ||
| end_index = len(lines) | ||
|
|
||
| for i, line in enumerate(lines): | ||
| if line.startswith(start_marker): | ||
| start_index = i + 1 | ||
| elif start_index is not None and line.startswith(end_marker): | ||
| end_index = i | ||
| break | ||
|
|
||
| if start_index is None: | ||
| raise ValueError("Start marker not found") | ||
|
|
||
| # Replace the section with the new table | ||
| new_lines = lines[:start_index] + [markdown_table] + lines[end_index:] | ||
|
|
||
| # Write the updated content back to FlowVariables.md | ||
| with open(docs, "w") as file: | ||
| file.writelines(new_lines) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| data = load_yaml(yaml_path) | ||
| stages = preprocess(data) | ||
| generate_md(data, stages) | ||
| print("FlowVariables.md updated successfully") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| import os | ||
| import yaml | ||
|
|
||
| dir_path = os.path.dirname(os.path.realpath(__file__)) | ||
|
|
||
| yaml_path = os.path.join(dir_path, "variables.yaml") | ||
| with open(yaml_path, "r") as file: | ||
| data = yaml.safe_load(file) | ||
|
|
||
| for key, value in data.items(): | ||
| if value.get("tunable", False) is False: | ||
| continue | ||
| print(f"{key}") |
Oops, something went wrong.