Merge pull request #2202 from Pinata-Consulting/python-black

python: ran black .

Author: maliberty

.github/workflows/black.yaml

@@ -0,0 +1,11 @@
+name: Lint Python
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable
+

docs/conf.py

@@ -17,9 +17,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'OpenROAD Flow'
-copyright = 'The Regents of the University of California, 2021'
-author = 'OpenROAD Team'
+project = "OpenROAD Flow"
+copyright = "The Regents of the University of California, 2021"
+author = "OpenROAD Team"
 
 
 # -- General configuration ---------------------------------------------------
@@ -28,56 +28,56 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
-    'sphinx_external_toc',
-    'sphinx_copybutton',
-    'myst_parser',
-    'sphinxcontrib.mermaid'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx_external_toc",
+    "sphinx_copybutton",
+    "myst_parser",
+    "sphinxcontrib.mermaid",
 ]
 
 myst_enable_extensions = [
-    'amsmath',
-    'colon_fence',
-    'deflist',
-    'dollarmath',
-    'html_admonition',
-    'html_image',
-    'replacements',
-    'smartquotes',
-    'substitution',
-    'tasklist',
-    'html_image',
+    "amsmath",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "html_admonition",
+    "html_image",
+    "replacements",
+    "smartquotes",
+    "substitution",
+    "tasklist",
+    "html_image",
 ]
 
-external_toc_path = 'toc.yml'
+external_toc_path = "toc.yml"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-source_suffix = ['.md']
+source_suffix = [".md"]
 
 # The master toctree document.
-master_doc = 'index2.md'
+master_doc = "index2.md"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
-    '_build',
-    'Thumbs.db',
-    '.DS_Store',
-    '**/LICENSE',
-    '**/LICENSE.md',
-    'README.md',
-    'docs/releases/PostAlpha2.1BranchMethodology.md',
-    'main',
-    'index.md'
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "**/LICENSE",
+    "**/LICENSE.md",
+    "README.md",
+    "docs/releases/PostAlpha2.1BranchMethodology.md",
+    "main",
+    "index.md",
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.
@@ -97,7 +97,6 @@
     "show_navbar_depth": 2,
     "use_issues_button": True,
     "use_download_button": True,
-
     # list for more fine-grained ordering of icons
     "icon_links": [
         {
@@ -126,81 +125,87 @@
             "icon": "https://img.shields.io/github/stars/The-OpenROAD-Project/OpenROAD-flow-scripts",
             "type": "url",
         },
-   ],
+    ],
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 
+
 def get_file_from_url(url, fname):
     r = requests.get(url)
-    with open(fname, 'wb') as f:
+    with open(fname, "wb") as f:
         f.write(r.content)
 
+
 def swap_prefix(file, old, new):
-    with open(file, 'r') as f:
+    with open(file, "r") as f:
         lines = f.read()
     lines = lines.replace(old, new)
-    with open(file, 'wt') as f:
+    with open(file, "wt") as f:
         f.write(lines)
 
+
 def setup(app):
     import shutil
-    
+
     # symlink does not work for ORFS because of long recursive file links
-    shutil.copy('../README.md', 'mainREADME.md')
-    swap_prefix('mainREADME.md', '```mermaid', '```{mermaid}\n:align: center\n')   
+    shutil.copy("../README.md", "mainREADME.md")
+    swap_prefix("mainREADME.md", "```mermaid", "```{mermaid}\n:align: center\n")
 
     # Grab the reference file from OR
-    url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/docs/contrib/GitGuide.md'
-    get_file_from_url(url, 'contrib/GitGuide.md') 
-    
+    url = "https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/docs/contrib/GitGuide.md"
+    get_file_from_url(url, "contrib/GitGuide.md")
+
     # Temporarily using commit number, will change once OR commit merged.
-    url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/3563176d00daeb613eed2ccf9442137b0ae2cad3/docs/index.md'
-    get_file_from_url(url, 'SupportedOS.md')
+    url = "https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/3563176d00daeb613eed2ccf9442137b0ae2cad3/docs/index.md"
+    get_file_from_url(url, "SupportedOS.md")
 
     # edit OpenROAD to OpenROAD-flow-scripts for GitGuide
-    with open('contrib/GitGuide.md', 'r') as f:
+    with open("contrib/GitGuide.md", "r") as f:
         content = f.read()
-    content = content.replace('user/Build.md', '../index.md#build-or-installing-orfs-dependencies')
-    content = content.replace('OpenROAD', 'OpenROAD-flow-scripts')
-    content = content.replace('The-OpenROAD-flow-scripts', 'The-OpenROAD')
-    with open('contrib/GitGuide.md', 'w') as f:
+    content = content.replace(
+        "user/Build.md", "../index.md#build-or-installing-orfs-dependencies"
+    )
+    content = content.replace("OpenROAD", "OpenROAD-flow-scripts")
+    content = content.replace("The-OpenROAD-flow-scripts", "The-OpenROAD")
+    with open("contrib/GitGuide.md", "w") as f:
         f.write(content)
 
     # Create a copy of the index.md file
     import shutil
-    shutil.copy('index.md', 'index2.md')
 
-    # Use re to find the desired content 
-    start_pattern = '## Supported Operating Systems'
-    end_pattern = '## Code of conduct'
-    with open('SupportedOS.md', 'r') as f:
+    shutil.copy("index.md", "index2.md")
+
+    # Use re to find the desired content
+    start_pattern = "## Supported Operating Systems"
+    end_pattern = "## Code of conduct"
+    with open("SupportedOS.md", "r") as f:
         markdown_content = f.read()
 
-    match = re.search(f'{start_pattern}(.*?){end_pattern}', markdown_content, re.DOTALL)
-    
-    assert match is not None, 'No match found, check the OR Doc pattern on index.md'
+    match = re.search(f"{start_pattern}(.*?){end_pattern}", markdown_content, re.DOTALL)
+
+    assert match is not None, "No match found, check the OR Doc pattern on index.md"
     extracted_content = match.group(1)
     extracted_content = "\n#### Supported Operating Systems" + extracted_content
     print(extracted_content)
-    
+
     # Find insert position
-    with open('index2.md', 'r') as f:
+    with open("index2.md", "r") as f:
         existing_content = f.read()
-    match = re.search(r'### Setup', existing_content)
-    assert match is not None, 'Check search keyword.'
-    with open('index2.md', 'w') as f:
+    match = re.search(r"### Setup", existing_content)
+    assert match is not None, "Check search keyword."
+    with open("index2.md", "w") as f:
         insert_position = match.end() + 1
         before_insert = existing_content[:insert_position]
         after_insert = existing_content[insert_position:]
 
         # Combine the parts with the extracted content
         updated_content = before_insert + extracted_content + after_insert
-    
+
         f.write(updated_content)
-      
+
     # Get Manpage file
-    url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/src/utl/README.md'
-    get_file_from_url(url, 'Manpage.md')
+    url = "https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/src/utl/README.md"
+    get_file_from_url(url, "Manpage.md")

docs/revert-links.py

@@ -1,11 +1,12 @@
 #!/usr/bin/env python3
 
+
 def swap_prefix(file, old, new):
-    with open(file, 'r') as f:
+    with open(file, "r") as f:
         lines = f.read()
     lines = lines.replace(old, new)
-    with open(file, 'wt') as f:
+    with open(file, "wt") as f:
         f.write(lines)
 
 
-swap_prefix('mainREADME.md', '```{mermaid}\n:align: center\n', '```mermaid')
+swap_prefix("mainREADME.md", "```{mermaid}\n:align: center\n", "```mermaid")

flow/designs/asap7/mock-array/config.py

@@ -8,10 +8,10 @@
 # make_tracks M5 -x_offset 0.012 -x_pitch 0.048 -y_offset 0.012 -y_pitch 0.048
 #
 # the macro needs to be on a multiple of the track pattern
-placement_grid_x     = 0.048 * int(os.environ.get("MOCK_ARRAY_SCALE"))
-placement_grid_y     = 0.048 * int(os.environ.get("MOCK_ARRAY_SCALE"))
+placement_grid_x = 0.048 * int(os.environ.get("MOCK_ARRAY_SCALE"))
+placement_grid_y = 0.048 * int(os.environ.get("MOCK_ARRAY_SCALE"))
 
-# number of Elements in row and column, can be control by user via environment variable 
+# number of Elements in row and column, can be control by user via environment variable
 # MOCK_ARRAY_TABLE (rows, cols, width, height, pitch_x, pitch_y)
 #  rows, cols       - number of Element in rows, cols
 #  width, height    - width and height of each Element
@@ -21,15 +21,17 @@
 #
 #  pitch_x, pitch_y - placement pitch for each Element, in x and y direction
 # specification are in unit of placement grid
-rows, cols, ce_x, ce_y, pitch_x, pitch_y = map(int, os.environ.get("MOCK_ARRAY_TABLE").split())
+rows, cols, ce_x, ce_y, pitch_x, pitch_y = map(
+    int, os.environ.get("MOCK_ARRAY_TABLE").split()
+)
 
 # Element size is set to multiple of placement grid above
-ce_width    = ce_x * placement_grid_x
-ce_height   = ce_y * placement_grid_y
+ce_width = ce_x * placement_grid_x
+ce_height = ce_y * placement_grid_y
 
-# top level core offset 
-margin_x    = placement_grid_x
-margin_y    = placement_grid_y
+# top level core offset
+margin_x = placement_grid_x
+margin_y = placement_grid_y
 
 # Element core margin
 ce_margin_x = placement_grid_x * 0.5
@@ -43,8 +45,12 @@
 array_offset_y = array_spacing_y + margin_y
 
 # top level core and die size
-core_width  = 2 * array_spacing_x + ((placement_grid_x * pitch_x) * (cols - 1)) + ce_width
-core_height = 2 * array_spacing_y + ((placement_grid_y * pitch_y) * (rows - 1)) + ce_height
-
-die_width  = core_width  + (margin_x * 2)
+core_width = (
+    2 * array_spacing_x + ((placement_grid_x * pitch_x) * (cols - 1)) + ce_width
+)
+core_height = (
+    2 * array_spacing_y + ((placement_grid_y * pitch_y) * (rows - 1)) + ce_height
+)
+
+die_width = core_width + (margin_x * 2)
 die_height = core_height + (margin_y * 2)