style: include new linter rules and fix files

api/directus.py

@@ -39,7 +39,7 @@ class DirectusAPI:
             print(f"Error: {e}")
             return None
         return data
-    
+
     def get_one(self, endpoint, params = None):
         if params is None:
             params = {}
@@ -50,7 +50,7 @@ class DirectusAPI:
             return None
         else:
             raise Exception("One result expected, but got more than one result")
-            
+
     def get_file(self, endpoint, params = None):
         if params is None:
             params = {}
@@ -58,4 +58,4 @@ class DirectusAPI:
         data = result.content
         if data is None:
             raise Exception("No data from API")
-        return data
+        return data

pyproject.toml

@@ -15,6 +15,7 @@ select = [
     # pycodestyle
     # Ensure PEP8-compatible code style.
     "E",
+    "W",
     # pep8-naming
     # Ensure consisten, PEP8-compatible naming.
     "N",
@@ -38,6 +39,11 @@ select = [
     "C90",
     # ruff-specific: No unused noqa directives
     "RUF100",
+    ## Write modern python code
+    # Use f-strings instead of joining strings
+    "FLY",
+    # Check refurb rules
+    "FURB",
 ]
 
 [tool.pytest.ini_options]

renderer/comment.py

@@ -1,7 +1,6 @@
 import re
 
 from mistletoe.block_token import BlockToken
-from mistletoe.span_token import SpanToken
 
 
 class BlockComment(BlockToken):

renderer/fifty_ohm_html_renderer.py

@@ -172,7 +172,10 @@ class FiftyOhmHtmlRenderer(HtmlRenderer):
         return f"{lookup[token.first]}{token.second}{lookup[token.third]}"
 
     def render_references(self, token):
-        return f'<a href="{self.section_url}#ref_{token.first}" onclick="highlightRef(\'{token.first}\');">{self.ref_id}</a>'
+        return (
+            f'<a href="{self.section_url}#ref_{token.first}"'
+            f" onclick=\"highlightRef('{token.first}');\">{self.ref_id}</a>"
+        )
 
     def render_question(self, token):
         return self.question_renderer(token.question_number)

renderer/fifty_ohm_latex_renderer.py

@@ -87,7 +87,7 @@ class FiftyOhmLaTeXRenderer(LaTeXRenderer):
         return rf"\{tagtype}{{{self.render_inner(token)}}}"
 
     def render_halfwidth_spaces(self, token):
-        return f"{token.first}.\,{token.second}."
+        return rf"{token.first}.\,{token.second}."
 
     def render_nonbreaking_spaces(self, token):
         return f"{token.first}~{token.second}"
@@ -124,7 +124,7 @@ class FiftyOhmLaTeXRenderer(LaTeXRenderer):
             align += alignment
 
         table = f"\\begin{{DARCtabular}}{{{align}}}\n"
-        
+
         for row in token.children:
             for j, cell in enumerate(row.children):
                 table += self.render_inner(cell)

renderer/include.py

@@ -21,4 +21,4 @@ class Include(BlockToken):
         return ident
 
     def __init__(self, match):
-        self.ident = match
+        self.ident = match

renderer/photo.py

@@ -16,4 +16,4 @@ class Photo(SpanToken):
         self.id = match_object.group(1)
         self.ref = match_object.group(2)
         self.text = match_object.group(3)
-        self.number = "TODO"
+        self.number = "TODO"

renderer/picture.py

@@ -16,4 +16,4 @@ class Picture(SpanToken):
         self.id = match_object.group(1)
         self.ref = match_object.group(2)
         self.text = match_object.group(3)
-        self.number = "TODO"
+        self.number = "TODO"

test/test_comment.py

@@ -24,7 +24,7 @@ def test_comment_latex():
     assertions = {
         "%Comment\nBar": "% Comment\n\nBar\n",
         "%Comment\n": "% Comment\n",
-        "Foo 100 % Bar": "\nFoo 100 \% Bar\n",
+        "Foo 100 % Bar": "\nFoo 100 \\% Bar\n",
         "Foo\n%Comment\nBar": "\nFoo\n% Comment\n\nBar\n",
     }
 

test/test_halfwidth_spaces.py

@@ -17,6 +17,6 @@ def test_halfwidth_space_html():
 @pytest.mark.latex
 def test_halfwidth_space_latex():
     input = "Dies ist z.B. ein Test. D.h. hier sollten d.h. Spaces ersetzt worden sein."
-    target = "\nDies ist z.\,B. ein Test. D.\,h. hier sollten d.\,h. Spaces ersetzt worden sein.\n"
+    target = "\nDies ist z.\\,B. ein Test. D.\\,h. hier sollten d.\\,h. Spaces ersetzt worden sein.\n"
 
     assert mistletoe.markdown(input, FiftyOhmLaTeXRenderer) == target

test/test_include.py

@@ -15,4 +15,4 @@ def test_include_html():
 
     with FiftyOhmHtmlRenderer(include_handler=test_function) as renderer:
         for assertion in assertions:
-            assert renderer.render(Document(assertion)) == assertions[assertion]
+            assert renderer.render(Document(assertion)) == assertions[assertion]

test/test_morse.py

@@ -8,12 +8,12 @@ from test.util import paragraph
 @pytest.mark.html
 def test_morse_html():
     assertions = {
-        '[morse:a]': FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]]),
-        '[morse:a] abc [morse:a]': FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]])+ ' abc ' + FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]]),
-        '[morse: a]': FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]]),
-        '[morse: aaa]': FiftyOhmHtmlRenderer.render_morse_helper([[1, 2], [1, 2], [1, 2]]),
-        '[morse: a a]': FiftyOhmHtmlRenderer.render_morse_helper([[1, 2], [3], [1, 2]]),
-        '[morse: db0]': FiftyOhmHtmlRenderer.render_morse_helper([[2, 1, 1], [2, 1, 1, 1], [2, 2, 2, 2, 2]]),
+        "[morse:a]": FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]]),
+        "[morse:a] abc [morse:a]": f"{FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]])} abc {FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]])}",  # noqa: E501
+        "[morse: a]": FiftyOhmHtmlRenderer.render_morse_helper([[1, 2]]),
+        "[morse: aaa]": FiftyOhmHtmlRenderer.render_morse_helper([[1, 2], [1, 2], [1, 2]]),
+        "[morse: a a]": FiftyOhmHtmlRenderer.render_morse_helper([[1, 2], [3], [1, 2]]),
+        "[morse: db0]": FiftyOhmHtmlRenderer.render_morse_helper([[2, 1, 1], [2, 1, 1, 1], [2, 2, 2, 2, 2]]),
     }
 
     for assertion in assertions:

test/test_nonbreaking_spaces.py

@@ -18,7 +18,7 @@ def test_paragraph_html():
 def test_three_points_html():
     assertions = {
         "Heute hatte ich ... zum Mittagessen.": "Heute hatte ich ... zum Mittagessen.",
-        "Niemals hätte ich gedacht, dass...ich ...nicht kann.": "Niemals hätte ich gedacht, dass...ich ...nicht kann.",
+        "Niemals hätte ich gedacht, dass...ich ...nicht kann.": "Niemals hätte ich gedacht, dass...ich ...nicht kann.",  # noqa: E501
         "Oh nein ...ein Pinguin.": "Oh nein ...ein Pinguin.",
         "Haha .. . Hahaha": "Haha .. . Hahaha",
     }
@@ -55,7 +55,7 @@ def test_paragraph_latex():
 def test_three_points_latex():
     assertions = {
         "Heute hatte ich ... zum Mittagessen.": "\nHeute hatte ich~...~zum Mittagessen.\n",
-        "Niemals hätte ich gedacht, dass...ich ...nicht kann.": "\nNiemals hätte ich gedacht, dass...ich~...nicht kann.\n",
+        "Niemals hätte ich gedacht, dass...ich ...nicht kann.": "\nNiemals hätte ich gedacht, dass...ich~...nicht kann.\n",  # noqa: E501
         "Oh nein ...ein Pinguin.": "\nOh nein~...ein Pinguin.\n",
         "Haha .. . Hahaha": "\nHaha .. . Hahaha\n",
     }

test/test_qso.py

@@ -23,11 +23,11 @@ def test_qso_html():
     for assertion in assertions:
         assert mistletoe.markdown(assertion, FiftyOhmHtmlRenderer) == assertions[assertion]
 
+
 @pytest.mark.slide
 def test_qso_slide():
     assertions = {
-        "<qso>\nfoo\n> bar\n</qso>":
-            '<div class="qso r-fit-text">\n<div class="qso_own fragment fade-right">foo</div>\n<div class="qso_other fragment fade-left">bar</div>\n</div>\n\n',
+        "<qso>\nfoo\n> bar\n</qso>": '<div class="qso r-fit-text">\n<div class="qso_own fragment fade-right">foo</div>\n<div class="qso_other fragment fade-left">bar</div>\n</div>\n\n',  # noqa: E501
     }
 
     for assertion in assertions:

test/test_question.py

@@ -46,10 +46,10 @@ def test_question_translation_html():
 @pytest.mark.latex
 def test_question_latex():
     assertions = {
-        "[question:123]": "\question{123}",
-        "\n[question:123]\n": "\question{123}",
-        "\n[question:123]\n[question:123]": "\question{123}\question{123}",
-        "Foo\n[question:123]\nBar": "\nFoo\n\question{123}\nBar\n",
+        "[question:123]": r"\question{123}",
+        "\n[question:123]\n": r"\question{123}",
+        "\n[question:123]\n[question:123]": r"\question{123}\question{123}",
+        "Foo\n[question:123]\nBar": "\nFoo\n\\question{123}\nBar\n",
     }
 
     def test_function(input):

test/test_quote.py

@@ -24,11 +24,11 @@ def test_quote_html():
 @pytest.mark.latex
 def test_quote_latex():
     assertions = {
-        '"quote"': "\n\enquote{quote}\n",
-        '" quote "': "\n\enquote{ quote }\n",
-        '"quote" "': '\n\enquote{quote} "\n',
-        '"quo te1" filltext "qu ot e2"': "\n\enquote{quo te1} filltext \enquote{qu ot e2}\n",
-        '"quo *te1*" filltext "qu ot e2"': "\n\enquote{quo \emph{te1}} filltext \enquote{qu ot e2}\n",
+        '"quote"': "\n\\enquote{quote}\n",
+        '" quote "': "\n\\enquote{ quote }\n",
+        '"quote" "': '\n\\enquote{quote} "\n',
+        '"quo te1" filltext "qu ot e2"': "\n\\enquote{quo te1} filltext \\enquote{qu ot e2}\n",
+        '"quo *te1*" filltext "qu ot e2"': "\n\\enquote{quo \\emph{te1}} filltext \\enquote{qu ot e2}\n",
         '""': '\n""\n',
     }
 

test/test_references.py

@@ -10,9 +10,9 @@ def test_references_html():
     # Right now this tests only the default values.
     # The correct behavior can be tested when the information is added to the renderer class
     assertions = {
-        "[ref:e_oszilloskop_bildschirmfoto_sinus]": '<a href="section.html#ref_e_oszilloskop_bildschirmfoto_sinus" onclick="highlightRef(\'e_oszilloskop_bildschirmfoto_sinus\');">0</a>',
+        "[ref:e_oszilloskop_bildschirmfoto_sinus]": '<a href="section.html#ref_e_oszilloskop_bildschirmfoto_sinus" onclick="highlightRef(\'e_oszilloskop_bildschirmfoto_sinus\');">0</a>',  # noqa: E501
         "[ref:n_rst_r]": '<a href="section.html#ref_n_rst_r" onclick="highlightRef(\'n_rst_r\');">0</a>',
-        "[ref:Uuuuuh]": '<a href="section.html#ref_Uuuuuh" onclick="highlightRef(\'Uuuuuh\');">0</a>',  # Test the default parameters
+        "[ref:Uuuuuh]": '<a href="section.html#ref_Uuuuuh" onclick="highlightRef(\'Uuuuuh\');">0</a>',  # Test the default parameters  # noqa: E501
     }
 
     for key, value in assertions.items():

test/test_table.py

@@ -11,14 +11,14 @@ def test_table_html():
         "| l: a |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n</table>\n',
         "| r: a |": '<table>\n<tr>\n<th style="text-align: right;">a</th>\n</tr>\n</table>\n',
         "| c: a |": '<table>\n<tr>\n<th style="text-align: center;">a</th>\n</tr>\n</table>\n',
-        "| l: a |\n| b |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;">b</td>\n</tr>\n</table>\n',
-        "| l: a |\n| b |\n| c |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;">b</td>\n</tr>\n<tr>\n<td style="text-align: left;">c</td>\n</tr>\n</table>\n',
-        "| a |\n| b |\n| c |": "<table>\n<tr>\n<th>a</th>\n</tr>\n<tr>\n<td>b</td>\n</tr>\n<tr>\n<td>c</td>\n</tr>\n</table>\n",
-        "| l: a |\n| *b* |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;"><em>b</em></td>\n</tr>\n</table>\n',
-        "| l: a |\n| b |\n[table:n_ab:A und B]": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;">b</td>\n</tr>\n<caption>A und B</caption></table>\n',
+        "| l: a |\n| b |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;">b</td>\n</tr>\n</table>\n',  # noqa: E501
+        "| l: a |\n| b |\n| c |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;">b</td>\n</tr>\n<tr>\n<td style="text-align: left;">c</td>\n</tr>\n</table>\n',  # noqa: E501
+        "| a |\n| b |\n| c |": "<table>\n<tr>\n<th>a</th>\n</tr>\n<tr>\n<td>b</td>\n</tr>\n<tr>\n<td>c</td>\n</tr>\n</table>\n",  # noqa: E501
+        "| l: a |\n| *b* |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;"><em>b</em></td>\n</tr>\n</table>\n',  # noqa: E501
+        "| l: a |\n| b |\n[table:n_ab:A und B]": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;">b</td>\n</tr>\n<caption>A und B</caption></table>\n',  # noqa: E501
         "| l: *a* |": '<table>\n<tr>\n<th style="text-align: left;"><em>a</em></th>\n</tr>\n</table>\n',
-        "| l: a |\n| [morse:a] |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;"><span class="morse"><span class="morse_char">\n<span class="morse_char">\n▄</span>\n<span class="morse_char">\n▄▄▄</span>\n</span>\n</span></td>\n</tr>\n</table>\n',
-        "| l: abc | r: abc | X: abc |\n| 123 | 456 | 789 | \n | 987 | 654 | 321 | ": '<table>\n<tr>\n<th style="text-align: left;">abc</th>\n<th style="text-align: right;">abc</th>\n<th>abc</th>\n</tr>\n<tr>\n<td style="text-align: left;">123</td>\n<td style="text-align: right;">456</td>\n<td>789</td>\n</tr>\n<tr>\n<td style="text-align: left;">987</td>\n<td style="text-align: right;">654</td>\n<td>321</td>\n</tr>\n</table>\n',
+        "| l: a |\n| [morse:a] |": '<table>\n<tr>\n<th style="text-align: left;">a</th>\n</tr>\n<tr>\n<td style="text-align: left;"><span class="morse"><span class="morse_char">\n<span class="morse_char">\n▄</span>\n<span class="morse_char">\n▄▄▄</span>\n</span>\n</span></td>\n</tr>\n</table>\n',  # noqa: E501
+        "| l: abc | r: abc | X: abc |\n| 123 | 456 | 789 | \n | 987 | 654 | 321 | ": '<table>\n<tr>\n<th style="text-align: left;">abc</th>\n<th style="text-align: right;">abc</th>\n<th>abc</th>\n</tr>\n<tr>\n<td style="text-align: left;">123</td>\n<td style="text-align: right;">456</td>\n<td>789</td>\n</tr>\n<tr>\n<td style="text-align: left;">987</td>\n<td style="text-align: right;">654</td>\n<td>321</td>\n</tr>\n</table>\n',  # noqa: E501
     }
 
     with FiftyOhmHtmlRenderer() as renderer:

test/test_tag.py

@@ -76,17 +76,17 @@ def test_thematic_break_latex():
 @pytest.mark.latex
 def test_tag_latex():
     assertions = {
-        "<margin>\nFoo\n</margin>": "\Margin{\nFoo\n}",
-        "<danger>\nFoo\n</danger>": "\MarginDanger{\nFoo\n}",
-        "<warning>\nFoo\n</warning>": "\MarginWarning{\nFoo\n}",
-        "<attention>\nFoo\n</attention>": "\MarginAttention{\nFoo\n}",
-        "<tip>\nFoo\n</tip>": "\MarginTip{\nFoo\n}",
-        "<webtip>\nFoo\n</webtip>": "\WebTip{\nFoo\n}",
-        "<unit>\nFoo\n</unit>": "\MarginUnit{\nFoo\n}",
-        "<indepth>\nFoo\n</indepth>": "\MarginInDepth{\nFoo\n}",
-        "<webindepth>\nFoo\n</webindepth>": "\MarginWebInDepth{\nFoo\n}",
-        "<webmargin>\nFoo\n</webmargin>": "\WebMargin{\nFoo\n}",
-        "<fullwidth>\nFoo\n</fullwidth>": "\FullWidth{\nFoo\n}",
+        "<margin>\nFoo\n</margin>": "\\Margin{\nFoo\n}",
+        "<danger>\nFoo\n</danger>": "\\MarginDanger{\nFoo\n}",
+        "<warning>\nFoo\n</warning>": "\\MarginWarning{\nFoo\n}",
+        "<attention>\nFoo\n</attention>": "\\MarginAttention{\nFoo\n}",
+        "<tip>\nFoo\n</tip>": "\\MarginTip{\nFoo\n}",
+        "<webtip>\nFoo\n</webtip>": "\\WebTip{\nFoo\n}",
+        "<unit>\nFoo\n</unit>": "\\MarginUnit{\nFoo\n}",
+        "<indepth>\nFoo\n</indepth>": "\\MarginInDepth{\nFoo\n}",
+        "<webindepth>\nFoo\n</webindepth>": "\\MarginWebInDepth{\nFoo\n}",
+        "<webmargin>\nFoo\n</webmargin>": "\\WebMargin{\nFoo\n}",
+        "<fullwidth>\nFoo\n</fullwidth>": "\\FullWidth{\nFoo\n}",
         "<latexonly>\nFoo\n</latexonly>": "\nFoo\n",
         "<webonly>\nFoo\n</webonly>": "",
     }
@@ -98,9 +98,9 @@ def test_tag_latex():
 @pytest.mark.latex
 def test_thematic_break_and_tag_latex():
     assertions = {
-        "---\n<margin>\nFoo\n</margin>": "\Margin{\nFoo\n}",
-        "---\n<margin>\nFoo\n</margin>\n<margin>\nFoo\n</margin>": "\Margin{\nFoo\n}\Margin{\nFoo\n}",
-        "---\n<margin>\nFoo\n</margin>\n---\n<margin>\nFoo\n</margin>": "\Margin{\nFoo\n}\Margin{\nFoo\n}",
+        "---\n<margin>\nFoo\n</margin>": "\\Margin{\nFoo\n}",
+        "---\n<margin>\nFoo\n</margin>\n<margin>\nFoo\n</margin>": "\\Margin{\nFoo\n}\\Margin{\nFoo\n}",
+        "---\n<margin>\nFoo\n</margin>\n---\n<margin>\nFoo\n</margin>": "\\Margin{\nFoo\n}\\Margin{\nFoo\n}",
     }
 
     for assertion in assertions:

test/test_underline.py

@@ -23,7 +23,7 @@ def test_underline_latex():
     assertions = {
         "<u>Text</u>": "\n\\underline{Text}\n",
         "<u> Text Text </u>": "\n\\underline{ Text Text }\n",
-        "<u> Text *Text* </u>": "\n\\underline{ Text \emph{Text} }\n",
+        "<u> Text *Text* </u>": "\n\\underline{ Text \\emph{Text} }\n",
     }
 
     for assertion in assertions: