From 26fa657e4a92a260aa03ca73ceda4fdc6aa30f13 Mon Sep 17 00:00:00 2001 From: Tim Grelka Date: Sun, 8 Dec 2024 11:33:21 +0100 Subject: [PATCH 1/5] feat: render units with non-breaking space --- renderer/fifty_ohm_html_renderer.py | 49 ++++++++++++++++++++++++--- renderer/unit.py | 51 +++++++++++++++++++++++++++++ test/test_unit_token.py | 18 ++++++++++ 3 files changed, 114 insertions(+), 4 deletions(-) create mode 100644 renderer/unit.py create mode 100644 test/test_unit_token.py diff --git a/renderer/fifty_ohm_html_renderer.py b/renderer/fifty_ohm_html_renderer.py index fa6a6ab..ed2f077 100644 --- a/renderer/fifty_ohm_html_renderer.py +++ b/renderer/fifty_ohm_html_renderer.py @@ -1,12 +1,45 @@ from mistletoe import HtmlRenderer -from renderer.comment import Comment -from renderer.quote import Quote +from .comment import Comment +from .unit import Unit +from .quote import Quote + + +units = { + "A": "A", + "Ah": "Ah", + "A/mm²": "A/mm²", + "baud": "baud", + "Bit": "Bit", + "Bit/s": "Bit/s", + "dB": "dB", + "dBi": "dBi", + "dBm": "dBm", + "dBW": "dBW", + "F": "F", + "J": "J", + "Hz": "Hz", + "H": "H", + "cm": "cm", + "m": "m", + "m²": "m²", + "Ohm": "Ω", + "ppm": "ppm", + "pps": "pps", + "s": "s", + "V": "V", + "W": "W", + "Wh": "Wh", + "°": "°", + "%": "%", +} + +no_space_units = ["°", "%"] class FiftyOhmHtmlRenderer(HtmlRenderer): def __init__(self): - super().__init__(Comment, Quote) + super().__init__(Comment, Unit, Quote) def render_comment(): return None @@ -15,4 +48,12 @@ class FiftyOhmHtmlRenderer(HtmlRenderer): return f"„{self.render_inner(token)}“" def render_underline(self, token): - return f"{self.render_inner(token)}" \ No newline at end of file + return f"{self.render_inner(token)}" + + @staticmethod + def render_unit(token): + unit = token.prefix + units[token.unit] + if token.unit in no_space_units: + return f"{token.value}{unit}" + else: + return f"{token.value} {unit}" diff --git a/renderer/unit.py b/renderer/unit.py new file mode 100644 index 0000000..7364ff0 --- /dev/null +++ b/renderer/unit.py @@ -0,0 +1,51 @@ +import re + +from mistletoe.span_token import SpanToken + + +class Unit(SpanToken): + units = [ + "A", + "Ah", + "A/mm²", + "baud", + "Bit", + "Bit/s", + "dB", + "dBi", + "dBm", + "dBW", + "F", + "J", + "Hz", + "H", + "cm", + "m", + "m²", + "Ohm", + "ppm", + "pps", + "s", + "V", + "W", + "Wh", + "°", + "%", + ] + prefixes = ["p", "n", "μ", "m", "k", "M", "G"] + + pattern = re.compile( + r"([0-9,]+) ?(" + # Group all prefixes together in a capture group + # Empty string at end of list is required so the group always exists in the resulting match + + "|".join(prefixes + [""]) + + ")(" + # Group all units together in a capture group. + + "|".join(units) + + r")(?!\w)" + ) + + def __init__(self, match): + self.value = match.group(1) + self.prefix = match.group(2) + self.unit = match.group(3) diff --git a/test/test_unit_token.py b/test/test_unit_token.py new file mode 100644 index 0000000..47c929e --- /dev/null +++ b/test/test_unit_token.py @@ -0,0 +1,18 @@ +import mistletoe + +from renderer.fifty_ohm_html_renderer import FiftyOhmHtmlRenderer + +from .util import paragraph + + +def test_unit_html(): + assertions = { + "0,1 V": "0,1 V", + "33 A": "33 A", + "1 Ah": "1 Ah", + "100 mOhm": "100 mΩ", + "25 Ohm": "25 Ω", + } + + for input, output in assertions.items(): + assert mistletoe.markdown(input, FiftyOhmHtmlRenderer) == paragraph(output) From 8bf03e5b20fcafff7386437708da65cb67570e22 Mon Sep 17 00:00:00 2001 From: Tim Grelka Date: Sun, 8 Dec 2024 11:36:02 +0100 Subject: [PATCH 2/5] refactor: create module --- renderer/__init__.py | 0 renderer/__main__.py | 8 -------- 2 files changed, 8 deletions(-) create mode 100644 renderer/__init__.py delete mode 100644 renderer/__main__.py diff --git a/renderer/__init__.py b/renderer/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/renderer/__main__.py b/renderer/__main__.py deleted file mode 100644 index b8a5ddf..0000000 --- a/renderer/__main__.py +++ /dev/null @@ -1,8 +0,0 @@ -import sys - -import mistletoe -from fifty_ohm_html_renderer import FiftyOhmHtmlRenderer - -if __name__ == "__main__": - with open(sys.argv[1]) as fin, open(sys.argv[2], "w") as fout: - fout.write(mistletoe.markdown(fin, FiftyOhmHtmlRenderer)) From a1626d730f62dffe2efbce0d9a3db388011f7330 Mon Sep 17 00:00:00 2001 From: Tim Grelka Date: Sun, 8 Dec 2024 16:01:30 +0100 Subject: [PATCH 3/5] refactor: use helper to format unit --- renderer/fifty_ohm_html_renderer.py | 49 +++++++++-------------------- 1 file changed, 15 insertions(+), 34 deletions(-) diff --git a/renderer/fifty_ohm_html_renderer.py b/renderer/fifty_ohm_html_renderer.py index bec6559..db41c4b 100644 --- a/renderer/fifty_ohm_html_renderer.py +++ b/renderer/fifty_ohm_html_renderer.py @@ -12,36 +12,6 @@ from renderer.tag import Tag from renderer.underline import Underline from renderer.unit import Unit -units = { - "A": "A", - "Ah": "Ah", - "A/mm²": "A/mm²", - "baud": "baud", - "Bit": "Bit", - "Bit/s": "Bit/s", - "dB": "dB", - "dBi": "dBi", - "dBm": "dBm", - "dBW": "dBW", - "F": "F", - "J": "J", - "Hz": "Hz", - "H": "H", - "cm": "cm", - "m": "m", - "m²": "m²", - "ppm": "ppm", - "pps": "pps", - "s": "s", - "V": "V", - "W": "W", - "Wh": "Wh", - "°": "°", - "%": "%", -} - -no_space_units = ["°", "%"] - class FiftyOhmHtmlRenderer(HtmlRenderer): margin_anchor_id = 0 @@ -82,14 +52,25 @@ class FiftyOhmHtmlRenderer(HtmlRenderer): def render_underline(self, token): return f"{self.render_inner(token)}" - @staticmethod - def render_unit(token): - unit = token.prefix + units[token.unit] - if token.unit in no_space_units: + @classmethod + def render_unit(cls, token): + unit = token.prefix + cls.format_unit(token.unit) + if token.unit in ["°", "%"]: return f"{token.value}{unit}" else: return f"{token.value} {unit}" + units = { + "Ohm": "Ω", + } + + @classmethod + def format_unit(cls, unit): + if unit in cls.units.keys(): + return cls.units[unit] + else: + return unit + def render_thematic_break(self, token): self.margin_anchor_id += 1 return f'' From 25a1e6bbac57aa1d478d887d0d1f6faad2ad60fb Mon Sep 17 00:00:00 2001 From: Tim Grelka Date: Tue, 10 Dec 2024 11:02:19 +0100 Subject: [PATCH 4/5] feat: improve tests for unit rendering --- test/test_unit.py | 45 +++++++++++++++++++++++++++++++++++++++++ test/test_unit_token.py | 18 ----------------- test/util.py | 4 ++-- 3 files changed, 47 insertions(+), 20 deletions(-) create mode 100644 test/test_unit.py delete mode 100644 test/test_unit_token.py diff --git a/test/test_unit.py b/test/test_unit.py new file mode 100644 index 0000000..eb736cd --- /dev/null +++ b/test/test_unit.py @@ -0,0 +1,45 @@ +import mistletoe +import pytest + +from renderer.fifty_ohm_html_renderer import FiftyOhmHtmlRenderer + +from .util import paragraph + + +@pytest.mark.html +def test_basic_units_html(): + """Test basic units: Insert non-breaking, smaller space.""" + assertions = { + "1 V": "1 V", + "0,12 V": "0,12 V", + "0,75 kW": "0,75 kW", + "33 A": "33 A", + "1 Ah": "1 Ah", # Ah can be a tricky case if the RegEx is wrong, as A might match before Ah, thus rendering the output with an "A" unit + } + + for input, output in assertions.items(): + assert mistletoe.markdown(input, FiftyOhmHtmlRenderer) == paragraph(output) + + +@pytest.mark.html +def test_translated_units_html(): + """Test translated units: Replace Ohm with Ω.""" + assertions = { + "50 Ohm": "50 Ω", + "100 mOhm": "100 mΩ", + } + + for input, output in assertions.items(): + assert mistletoe.markdown(input, FiftyOhmHtmlRenderer) == paragraph(output) + + +@pytest.mark.html +def test_special_units_html(): + """Test special units: Don't put space before ° and %.""" + assertions = { + "100%": "100%", + "42,24°": "42,24°", + } + + for input, output in assertions.items(): + assert mistletoe.markdown(input, FiftyOhmHtmlRenderer) == paragraph(output) diff --git a/test/test_unit_token.py b/test/test_unit_token.py deleted file mode 100644 index 47c929e..0000000 --- a/test/test_unit_token.py +++ /dev/null @@ -1,18 +0,0 @@ -import mistletoe - -from renderer.fifty_ohm_html_renderer import FiftyOhmHtmlRenderer - -from .util import paragraph - - -def test_unit_html(): - assertions = { - "0,1 V": "0,1 V", - "33 A": "33 A", - "1 Ah": "1 Ah", - "100 mOhm": "100 mΩ", - "25 Ohm": "25 Ω", - } - - for input, output in assertions.items(): - assert mistletoe.markdown(input, FiftyOhmHtmlRenderer) == paragraph(output) diff --git a/test/util.py b/test/util.py index f30aa79..a86b9eb 100644 --- a/test/util.py +++ b/test/util.py @@ -1,2 +1,2 @@ -def paragraph(text) : - return f'

{text}

\n' \ No newline at end of file +def paragraph(text): + return f"

{text}

\n" From 4c82c9fb146332bd3abe8e2d1d0308aafbdc54d4 Mon Sep 17 00:00:00 2001 From: Tim Grelka Date: Wed, 11 Dec 2024 00:42:24 +0100 Subject: [PATCH 5/5] refactor: improve code readability --- renderer/fifty_ohm_html_renderer.py | 12 +++++++++--- renderer/unit.py | 16 ++++++++++------ 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/renderer/fifty_ohm_html_renderer.py b/renderer/fifty_ohm_html_renderer.py index db41c4b..b568b0c 100644 --- a/renderer/fifty_ohm_html_renderer.py +++ b/renderer/fifty_ohm_html_renderer.py @@ -53,11 +53,13 @@ class FiftyOhmHtmlRenderer(HtmlRenderer): return f"{self.render_inner(token)}" @classmethod - def render_unit(cls, token): - unit = token.prefix + cls.format_unit(token.unit) + def render_unit(cls, token: Unit): + unit = token.prefix + cls.convert_unit_helper(token.unit) if token.unit in ["°", "%"]: + # Special cases with no space between value and unit. return f"{token.value}{unit}" else: + # Default case is rendered with a narrow no-break space. return f"{token.value} {unit}" units = { @@ -65,7 +67,11 @@ class FiftyOhmHtmlRenderer(HtmlRenderer): } @classmethod - def format_unit(cls, unit): + def convert_unit_helper(cls, unit: str) -> str: + """Converts human-typable units to their preferred representation. + + :param str unit: The unit to convert + """ if unit in cls.units.keys(): return cls.units[unit] else: diff --git a/renderer/unit.py b/renderer/unit.py index 7364ff0..4a6b9f0 100644 --- a/renderer/unit.py +++ b/renderer/unit.py @@ -35,17 +35,21 @@ class Unit(SpanToken): prefixes = ["p", "n", "μ", "m", "k", "M", "G"] pattern = re.compile( - r"([0-9,]+) ?(" + r"(?P[0-9,]+) ?(?P" # Group all prefixes together in a capture group # Empty string at end of list is required so the group always exists in the resulting match + "|".join(prefixes + [""]) - + ")(" + + ")(?P" # Group all units together in a capture group. + "|".join(units) + r")(?!\w)" ) - def __init__(self, match): - self.value = match.group(1) - self.prefix = match.group(2) - self.unit = match.group(3) + value: str + prefix: str + unit: str + + def __init__(self, match: re.Match): + self.value = match.group("value") + self.prefix = match.group("prefix") or "" + self.unit = match.group("unit")