inside a list are injected into to the preceeding tag
html = []
- html.append(f'')
+ html.append(
+ f''
+ )
num_rows = 0
for row in rows:
if isinstance(row, List):
if len(row) > 0 and any(row):
- html.append(' ')
- html.append(' ')
+ html.append(" ")
+ html.append(
+ ' '
+ )
for cell in row:
if cell is not None:
# Inject attributes to the preceeding | tag where needed
- html.append(f' | {cell} | '.replace('>
')
- html.append(' | ')
+ html.append(
+ f' {cell} | '.replace(">
")
+ html.append(" | ")
num_rows = num_rows + 1
elif row is not None:
- html.append(' | ')
- html.append(f' {row}')
- html.append(' | ')
+ html.append(" | ")
+ html.append(f" {row}")
+ html.append(" | ")
num_rows = num_rows + 1
if num_rows == 0: # empty table
- html.append(' | ') # generate empty cell to avoid GraphViz errors
- html.append(' ')
+ html.append(
+ " | "
+ ) # generate empty cell to avoid GraphViz errors
+ html.append(" ")
return html
+
def html_bgcolor_attr(color: Color) -> str:
"""Return attributes for bgcolor or '' if no color."""
- return f' bgcolor="{translate_color(color, "HEX")}"' if color else ''
+ return f' bgcolor="{translate_color(color, "HEX")}"' if color else ""
-def html_bgcolor(color: Color, _extra_attr: str = '') -> str:
+
+def html_bgcolor(color: Color, _extra_attr: str = "") -> str:
"""Return | attributes prefix for bgcolor or '' if no color."""
- return f'' if color else ''
+ return f"" if color else ""
+
def html_colorbar(color: Color) -> str:
"""Return attributes prefix for bgcolor and minimum width or None if no color."""
return html_bgcolor(color, ' width="4"') if color else None
+
def html_image(image):
from wireviz.DataClasses import Image
+
if not image:
return None
# The leading attributes belong to the preceeding tag. See where used below.
@@ -60,25 +75,38 @@ def html_image(image):
if image.fixedsize:
# Close the preceeding tag and enclose the image cell in a table without
# borders to avoid narrow borders when the fixed width < the node width.
- html = f'''>
+ html = f""">
- '''
- return f'''{html_line_breaks(image.caption)}'
- if image and image.caption else None)
+
+ return (
+ f'{html_line_breaks(image.caption)}'
+ if image and image.caption
+ else None
+ )
+
def html_size_attr(image):
from wireviz.DataClasses import Image
# Return Graphviz HTML attributes to specify minimum or fixed size of a TABLE or TD object
- return ((f' width="{image.width}"' if image.width else '')
- + (f' height="{image.height}"' if image.height else '')
- + ( ' fixedsize="true"' if image.fixedsize else '')) if image else ''
+ return (
+ (
+ (f' width="{image.width}"' if image.width else "")
+ + (f' height="{image.height}"' if image.height else "")
+ + (' fixedsize="true"' if image.fixedsize else "")
+ )
+ if image
+ else ""
+ )
+
def html_line_breaks(inp):
- return remove_links(inp).replace('\n', '
') if isinstance(inp, str) else inp
+ return remove_links(inp).replace("\n", "
") if isinstance(inp, str) else inp
diff --git a/src/wireviz/wv_helper.py b/src/wireviz/wv_helper.py
index 844556d..7cbe125 100644
--- a/src/wireviz/wv_helper.py
+++ b/src/wireviz/wv_helper.py
@@ -5,31 +5,33 @@ from pathlib import Path
from typing import Dict, List
awg_equiv_table = {
- '0.09': '28',
- '0.14': '26',
- '0.25': '24',
- '0.34': '22',
- '0.5': '21',
- '0.75': '20',
- '1': '18',
- '1.5': '16',
- '2.5': '14',
- '4': '12',
- '6': '10',
- '10': '8',
- '16': '6',
- '25': '4',
- '35': '2',
- '50': '1',
+ "0.09": "28",
+ "0.14": "26",
+ "0.25": "24",
+ "0.34": "22",
+ "0.5": "21",
+ "0.75": "20",
+ "1": "18",
+ "1.5": "16",
+ "2.5": "14",
+ "4": "12",
+ "6": "10",
+ "10": "8",
+ "16": "6",
+ "25": "4",
+ "35": "2",
+ "50": "1",
}
-mm2_equiv_table = {v:k for k,v in awg_equiv_table.items()}
+mm2_equiv_table = {v: k for k, v in awg_equiv_table.items()}
+
def awg_equiv(mm2):
- return awg_equiv_table.get(str(mm2), 'Unknown')
+ return awg_equiv_table.get(str(mm2), "Unknown")
+
def mm2_equiv(awg):
- return mm2_equiv_table.get(str(awg), 'Unknown')
+ return mm2_equiv_table.get(str(awg), "Unknown")
def expand(yaml_data):
@@ -42,8 +44,8 @@ def expand(yaml_data):
yaml_data = [yaml_data]
for e in yaml_data:
e = str(e)
- if '-' in e:
- a, b = e.split('-', 1)
+ if "-" in e:
+ a, b = e.split("-", 1)
try:
a = int(a)
b = int(b)
@@ -56,7 +58,9 @@ def expand(yaml_data):
else: # a == b
output.append(a) # range of length 1
except:
- output.append(e) # '-' was not a delimiter between two ints, pass e through unchanged
+ output.append(
+ e
+ ) # '-' was not a delimiter between two ints, pass e through unchanged
else:
try:
x = int(e) # single int
@@ -81,36 +85,46 @@ def int2tuple(inp):
def flatten2d(inp):
- return [[str(item) if not isinstance(item, List) else ', '.join(item) for item in row] for row in inp]
+ return [
+ [str(item) if not isinstance(item, List) else ", ".join(item) for item in row]
+ for row in inp
+ ]
def tuplelist2tsv(inp, header=None):
- output = ''
+ output = ""
if header is not None:
inp.insert(0, header)
inp = flatten2d(inp)
for row in inp:
- output = output + '\t'.join(str(remove_links(item)) for item in row) + '\n'
+ output = output + "\t".join(str(remove_links(item)) for item in row) + "\n"
return output
def remove_links(inp):
- return re.sub(r'<[aA] [^>]*>([^<]*)', r'\1', inp) if isinstance(inp, str) else inp
+ return (
+ re.sub(r"<[aA] [^>]*>([^<]*)", r"\1", inp)
+ if isinstance(inp, str)
+ else inp
+ )
def clean_whitespace(inp):
- return ' '.join(inp.split()).replace(' ,', ',') if isinstance(inp, str) else inp
+ return " ".join(inp.split()).replace(" ,", ",") if isinstance(inp, str) else inp
def open_file_read(filename):
# TODO: Intelligently determine encoding
- return open(filename, 'r', encoding='UTF-8')
+ return open(filename, "r", encoding="UTF-8")
+
def open_file_write(filename):
- return open(filename, 'w', encoding='UTF-8')
+ return open(filename, "w", encoding="UTF-8")
+
def open_file_append(filename):
- return open(filename, 'a', encoding='UTF-8')
+ return open(filename, "a", encoding="UTF-8")
+
def is_arrow(inp):
"""
@@ -122,19 +136,23 @@ def is_arrow(inp):
<==, ==, ==>, <=>
"""
# regex by @shiraneyo
- return bool(re.match(r"^\s*(?P-+|=+)(?P>?)\s*$", inp))
+ return bool(
+ re.match(r"^\s*(?P-+|=+)(?P>?)\s*$", inp)
+ )
+
def aspect_ratio(image_src):
try:
from PIL import Image
+
image = Image.open(image_src)
if image.width > 0 and image.height > 0:
return image.width / image.height
- print(f'aspect_ratio(): Invalid image size {image.width} x {image.height}')
+ print(f"aspect_ratio(): Invalid image size {image.width} x {image.height}")
# ModuleNotFoundError and FileNotFoundError are the most expected, but all are handled equally.
except Exception as error:
- print(f'aspect_ratio(): {type(error).__name__}: {error}')
- return 1 # Assume 1:1 when unable to read actual image size
+ print(f"aspect_ratio(): {type(error).__name__}: {error}")
+ return 1 # Assume 1:1 when unable to read actual image size
def smart_file_resolve(filename: str, possible_paths: (str, List[str])) -> Path:
@@ -145,13 +163,17 @@ def smart_file_resolve(filename: str, possible_paths: (str, List[str])) -> Path:
if filename.exists():
return filename
else:
- raise Exception(f'{filename} does not exist.')
+ raise Exception(f"{filename} does not exist.")
else: # search all possible paths in decreasing order of precedence
- possible_paths = [Path(path).resolve() for path in possible_paths if path is not None]
+ possible_paths = [
+ Path(path).resolve() for path in possible_paths if path is not None
+ ]
for possible_path in possible_paths:
resolved_path = (possible_path / filename).resolve()
if resolved_path.exists():
return resolved_path
else:
- raise Exception(f'{filename} was not found in any of the following locations: \n' +
- '\n'.join([str(x) for x in possible_paths]))
+ raise Exception(
+ f"{filename} was not found in any of the following locations: \n"
+ + "\n".join([str(x) for x in possible_paths])
+ )
diff --git a/src/wireviz/wv_html.py b/src/wireviz/wv_html.py
index 9a9a968..6389503 100644
--- a/src/wireviz/wv_html.py
+++ b/src/wireviz/wv_html.py
@@ -15,83 +15,106 @@ from wireviz.wv_helper import (
)
-def generate_html_output(filename: Union[str, Path], bom_list: List[List[str]], metadata: Metadata, options: Options):
+def generate_html_output(
+ filename: Union[str, Path],
+ bom_list: List[List[str]],
+ metadata: Metadata,
+ options: Options,
+):
# load HTML template
- templatename = metadata.get('template',{}).get('name')
+ templatename = metadata.get("template", {}).get("name")
if templatename:
# if relative path to template was provided, check directory of YAML file first, fall back to built-in template directory
- templatefile = smart_file_resolve(f'{templatename}.html', [Path(filename).parent, Path(__file__).parent / 'templates'])
+ templatefile = smart_file_resolve(
+ f"{templatename}.html",
+ [Path(filename).parent, Path(__file__).parent / "templates"],
+ )
else:
# fall back to built-in simple template if no template was provided
- templatefile = Path(__file__).parent / 'templates/simple.html'
+ templatefile = Path(__file__).parent / "templates/simple.html"
with open_file_read(templatefile) as file:
html = file.read()
# embed SVG diagram
- with open_file_read(f'{filename}.svg') as file:
+ with open_file_read(f"{filename}.svg") as file:
svgdata = re.sub(
- '^<[?]xml [^?>]*[?]>[^<]*]*>',
- '',
- file.read(), 1)
+ "^<[?]xml [^?>]*[?]>[^<]*]*>",
+ "",
+ file.read(),
+ 1,
+ )
# generate BOM table
bom = flatten2d(bom_list)
# generate BOM header (may be at the top or bottom of the table)
- bom_header_html = ' \n'
+ bom_header_html = " \n"
for item in bom[0]:
- th_class = f'bom_col_{item.lower()}'
+ th_class = f"bom_col_{item.lower()}"
bom_header_html = f'{bom_header_html} | {item} | \n'
- bom_header_html = f'{bom_header_html} \n'
+ bom_header_html = f"{bom_header_html} \n"
# generate BOM contents
bom_contents = []
for row in bom[1:]:
- row_html = ' \n'
+ row_html = " \n"
for i, item in enumerate(row):
- td_class = f'bom_col_{bom[0][i].lower()}'
+ td_class = f"bom_col_{bom[0][i].lower()}"
row_html = f'{row_html} | {item} | \n'
- row_html = f'{row_html} \n'
+ row_html = f"{row_html} \n"
bom_contents.append(row_html)
- bom_html = '\n' + bom_header_html + ''.join(bom_contents) + ' \n'
- bom_html_reversed = '\n' + ''.join(list(reversed(bom_contents))) + bom_header_html + ' \n'
+ bom_html = (
+ '\n' + bom_header_html + "".join(bom_contents) + " \n"
+ )
+ bom_html_reversed = (
+ '\n'
+ + "".join(list(reversed(bom_contents)))
+ + bom_header_html
+ + " \n"
+ )
# prepare simple replacements
replacements = {
- '': f'{APP_NAME} {__version__} - {APP_URL}',
- '': options.fontname,
- '': wv_colors.translate_color(options.bgcolor, "hex"),
- '': svgdata,
- '': bom_html,
- '': bom_html_reversed,
- '': '1', # TODO: handle multi-page documents
- '': '1', # TODO: handle multi-page documents
+ "": f"{APP_NAME} {__version__} - {APP_URL}",
+ "": options.fontname,
+ "": wv_colors.translate_color(options.bgcolor, "hex"),
+ "": svgdata,
+ "": bom_html,
+ "": bom_html_reversed,
+ "": "1", # TODO: handle multi-page documents
+ "": "1", # TODO: handle multi-page documents
}
# prepare metadata replacements
if metadata:
for item, contents in metadata.items():
if isinstance(contents, (str, int, float)):
- replacements[f''] = html_line_breaks(str(contents))
+ replacements[f""] = html_line_breaks(str(contents))
elif isinstance(contents, Dict): # useful for authors, revisions
for index, (category, entry) in enumerate(contents.items()):
if isinstance(entry, Dict):
- replacements[f''] = str(category)
+ replacements[f""] = str(category)
for entry_key, entry_value in entry.items():
- replacements[f''] = html_line_breaks(str(entry_value))
+ replacements[
+ f""
+ ] = html_line_breaks(str(entry_value))
- replacements['"sheetsize_default"'] = '"{}"'.format(metadata.get('template',{}).get('sheetsize', '')) # include quotes so no replacement happens within |