modn: improve ruff compliance

Run `ruff format` on code base.

Author: scanny

docs/conf.py

@@ -270,9 +270,7 @@
 
 # Custom sidebar templates, maps document names to template names.
 # html_sidebars = {}
-html_sidebars = {
-    "**": ["localtoc.html", "relations.html", "sidebarlinks.html", "searchbox.html"]
-}
+html_sidebars = {"**": ["localtoc.html", "relations.html", "sidebarlinks.html", "searchbox.html"]}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

features/steps/block.py

@@ -13,9 +13,7 @@
 
 @given("a _Cell object with paragraphs and tables")
 def given_a_cell_with_paragraphs_and_tables(context: Context):
-    context.cell = (
-        Document(test_docx("blk-paras-and-tables")).tables[1].rows[0].cells[0]
-    )
+    context.cell = Document(test_docx("blk-paras-and-tables")).tables[1].rows[0].cells[0]
 
 
 @given("a Document object with paragraphs and tables")

features/steps/document.py

@@ -126,17 +126,13 @@ def when_add_picture_specifying_width_and_height(context):
 @when("I add a picture specifying a height of 1.5 inches")
 def when_add_picture_specifying_height(context):
     document = context.document
-    context.picture = document.add_picture(
-        test_file("monty-truth.png"), height=Inches(1.5)
-    )
+    context.picture = document.add_picture(test_file("monty-truth.png"), height=Inches(1.5))
 
 
 @when("I add a picture specifying a width of 1.5 inches")
 def when_add_picture_specifying_width(context):
     document = context.document
-    context.picture = document.add_picture(
-        test_file("monty-truth.png"), width=Inches(1.5)
-    )
+    context.picture = document.add_picture(test_file("monty-truth.png"), width=Inches(1.5))
 
 
 @when("I add a picture specifying only the image file")

features/steps/hyperlink.py

@@ -27,9 +27,7 @@ def given_a_hyperlink_having_a_uri_fragment(context: Context):
 
 
 @given("a hyperlink having address {address} and fragment {fragment}")
-def given_a_hyperlink_having_address_and_fragment(
-    context: Context, address: str, fragment: str
-):
+def given_a_hyperlink_having_address_and_fragment(context: Context, address: str, fragment: str):
     paragraph_idxs: Dict[Tuple[str, str], int] = {
         ("''", "linkedBookmark"): 1,
         ("https://foo.com", "''"): 2,
@@ -73,60 +71,46 @@ def given_a_hyperlink_having_one_or_more_runs(context: Context, one_or_more: str
 def then_hyperlink_address_is_the_URL_of_the_hyperlink(context: Context):
     actual_value = context.hyperlink.address
     expected_value = "http://yahoo.com/"
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("hyperlink.contains_page_break is {value}")
 def then_hyperlink_contains_page_break_is_value(context: Context, value: str):
     actual_value = context.hyperlink.contains_page_break
     expected_value = {"True": True, "False": False}[value]
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("hyperlink.fragment is the URI fragment of the hyperlink")
 def then_hyperlink_fragment_is_the_URI_fragment_of_the_hyperlink(context: Context):
     actual_value = context.hyperlink.fragment
     expected_value = "linkedBookmark"
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("hyperlink.runs contains only Run instances")
 def then_hyperlink_runs_contains_only_Run_instances(context: Context):
     actual_value = [type(item).__name__ for item in context.hyperlink.runs]
     expected_value = ["Run" for _ in context.hyperlink.runs]
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("hyperlink.runs has length {value}")
 def then_hyperlink_runs_has_length(context: Context, value: str):
     actual_value = len(context.hyperlink.runs)
     expected_value = int(value)
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("hyperlink.text is the visible text of the hyperlink")
 def then_hyperlink_text_is_the_visible_text_of_the_hyperlink(context: Context):
     actual_value = context.hyperlink.text
     expected_value = "awesome hyperlink"
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("hyperlink.url is {value}")
 def then_hyperlink_url_is_value(context: Context, value: str):
     actual_value = context.hyperlink.url
     expected_value = "" if value == "''" else value
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"

features/steps/pagebreak.py

@@ -38,33 +38,23 @@ def then_rendered_page_break_preceding_paragraph_fragment_includes_the_hyperlink
 
     actual_value = type(para_frag).__name__
     expected_value = "Paragraph"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.text
     expected_value = "Page break in>><<this hyperlink"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.alignment
     expected_value = WD_PARAGRAPH_ALIGNMENT.RIGHT  # pyright: ignore
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.hyperlinks[0].runs[0].style.name
     expected_value = "Hyperlink"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.hyperlinks[0].address
     expected_value = "http://google.com/"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
 
 @then("rendered_page_break.preceding_paragraph_fragment is the content before break")
@@ -75,27 +65,19 @@ def then_rendered_page_break_preceding_paragraph_fragment_is_the_content_before_
 
     actual_value = type(para_frag).__name__
     expected_value = "Paragraph"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.text
     expected_value = "Page break here>>"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.alignment
     expected_value = WD_PARAGRAPH_ALIGNMENT.CENTER  # pyright: ignore
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.runs[0].style.name
     expected_value = "Default Paragraph Font"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
 
 @then("rendered_page_break.following_paragraph_fragment excludes the hyperlink")
@@ -107,37 +89,27 @@ def then_rendered_page_break_following_paragraph_fragment_excludes_the_hyperlink
     # -- paragraph fragment is a Paragraph object --
     actual_value = type(para_frag).__name__
     expected_value = "Paragraph"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     # -- paragraph text is only the fragment after the page-break --
     actual_value = para_frag.text
     expected_value = " and another one here>><<with text following"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     # -- paragraph properties are preserved --
     actual_value = para_frag.alignment
     expected_value = WD_PARAGRAPH_ALIGNMENT.RIGHT  # pyright: ignore
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     # -- paragraph has no hyperlinks --
     actual_value = para_frag.hyperlinks
     expected_value = []
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     # -- following paragraph fragment retains any remaining page-breaks --
     actual_value = [type(rpb).__name__ for rpb in para_frag.rendered_page_breaks]
     expected_value = ["RenderedPageBreak"]
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
 
 @then("rendered_page_break.following_paragraph_fragment is the content after break")
@@ -148,24 +120,16 @@ def then_rendered_page_break_following_paragraph_fragment_is_the_content_after_b
 
     actual_value = type(para_frag).__name__
     expected_value = "Paragraph"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.text
     expected_value = "<<followed by more text."
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.alignment
     expected_value = WD_PARAGRAPH_ALIGNMENT.CENTER  # pyright: ignore
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"
 
     actual_value = para_frag.runs[0].style.name
     expected_value = "Default Paragraph Font"
-    assert (
-        actual_value == expected_value
-    ), f"expected: '{expected_value}', got: '{actual_value}'"
+    assert actual_value == expected_value, f"expected: '{expected_value}', got: '{actual_value}'"

features/steps/paragraph.py

@@ -120,16 +120,12 @@ def when_I_set_the_paragraph_text(context: Context):
 def then_paragraph_contains_page_break_is_value(context: Context, value: str):
     actual_value = context.paragraph.contains_page_break
     expected_value = {"True": True, "False": False}[value]
-    assert (
-        actual_value == expected_value
-    ), f"expected: {expected_value}, got: {actual_value}"
+    assert actual_value == expected_value, f"expected: {expected_value}, got: {actual_value}"
 
 
 @then("paragraph.hyperlinks contains only Hyperlink instances")
 def then_paragraph_hyperlinks_contains_only_Hyperlink_instances(context: Context):
-    assert all(
-        type(item).__name__ == "Hyperlink" for item in context.paragraph.hyperlinks
-    )
+    assert all(type(item).__name__ == "Hyperlink" for item in context.paragraph.hyperlinks)
 
 
 @then("paragraph.hyperlinks has length {value}")
@@ -163,9 +159,7 @@ def then_paragraph_paragraph_format_is_its_parfmt_object(context: Context):
 def then_paragraph_rendered_page_breaks_has_length(context: Context, value: str):
     actual_value = len(context.paragraph.rendered_page_breaks)
     expected_value = int(value)
-    assert (
-        actual_value == expected_value
-    ), f"got: {actual_value}, expected: {expected_value}"
+    assert actual_value == expected_value, f"got: {actual_value}, expected: {expected_value}"
 
 
 @then("paragraph.rendered_page_breaks contains only RenderedPageBreak instances")
@@ -216,9 +210,7 @@ def then_document_contains_text_I_added(context: Context):
 
 
 @then("the paragraph alignment property value is {align_value}")
-def then_the_paragraph_alignment_prop_value_is_value(
-    context: Context, align_value: str
-):
+def then_the_paragraph_alignment_prop_value_is_value(context: Context, align_value: str):
     expected_value: Any = {
         "None": None,
         "WD_ALIGN_PARAGRAPH.LEFT": WD_PARAGRAPH_ALIGNMENT.LEFT,  # pyright: ignore

features/steps/parfmt.py

@@ -160,9 +160,7 @@ def then_paragraph_format_alignment_is_value(context, value):
 
 @then("paragraph_format.line_spacing is {value}")
 def then_paragraph_format_line_spacing_is_value(context, value):
-    expected_value = (
-        None if value == "None" else float(value) if "." in value else int(value)
-    )
+    expected_value = None if value == "None" else float(value) if "." in value else int(value)
     paragraph_format = context.paragraph_format
 
     if expected_value is None or isinstance(expected_value, int):

features/steps/section.py

@@ -73,9 +73,7 @@ def given_a_section_having_known_orientation(context: Context, orientation: str)
 
 
 @when("I assign {bool_val} to section.different_first_page_header_footer")
-def when_I_assign_value_to_section_different_first_page_hdrftr(
-    context: Context, bool_val: str
-):
+def when_I_assign_value_to_section_different_first_page_hdrftr(context: Context, bool_val: str):
     context.section.different_first_page_header_footer = eval(bool_val)
 
 
@@ -158,9 +156,7 @@ def then_len_sections_is_3(context: Context):
 def then_section_different_first_page_header_footer_is(context: Context, bool_val: str):
     actual = context.section.different_first_page_header_footer
     expected = eval(bool_val)
-    assert actual == expected, (
-        "section.different_first_page_header_footer is %s" % actual
-    )
+    assert actual == expected, "section.different_first_page_header_footer is %s" % actual
 
 
 @then("section.even_page_footer is a _Footer object")
@@ -213,9 +209,7 @@ def step_impl(context: Context):
 
 
 @then("section.{propname}.is_linked_to_previous is True")
-def then_section_hdrftr_prop_is_linked_to_previous_is_True(
-    context: Context, propname: str
-):
+def then_section_hdrftr_prop_is_linked_to_previous_is_True(context: Context, propname: str):
     actual = getattr(context.section, propname).is_linked_to_previous
     expected = True
     assert actual == expected, "section.%s.is_linked_to_previous is %s" % (
@@ -241,9 +235,7 @@ def then_the_reported_margin_is_inches(context: Context, margin_side: str, inche
 
 
 @then("the reported page orientation is {orientation}")
-def then_the_reported_page_orientation_is_orientation(
-    context: Context, orientation: str
-):
+def then_the_reported_page_orientation_is_orientation(context: Context, orientation: str):
     expected_value = {
         "WD_ORIENT.LANDSCAPE": WD_ORIENT.LANDSCAPE,
         "WD_ORIENT.PORTRAIT": WD_ORIENT.PORTRAIT,

features/steps/settings.py

@@ -22,9 +22,7 @@ def given_a_document_having_no_settings_part(context):
 
 @given("a Settings object {with_or_without} odd and even page headers as settings")
 def given_a_Settings_object_with_or_without_odd_and_even_hdrs(context, with_or_without):
-    testfile_name = {"with": "doc-odd-even-hdrs", "without": "sct-section-props"}[
-        with_or_without
-    ]
+    testfile_name = {"with": "doc-odd-even-hdrs", "without": "sct-section-props"}[with_or_without]
     context.settings = Document(test_docx(testfile_name)).settings
 
 
@@ -49,6 +47,4 @@ def then_document_settings_is_a_Settings_object(context):
 def then_settings_odd_and_even_pages_header_footer_is(context, bool_val):
     actual = context.settings.odd_and_even_pages_header_footer
     expected = eval(bool_val)
-    assert actual == expected, (
-        "settings.odd_and_even_pages_header_footer is %s" % actual
-    )
+    assert actual == expected, "settings.odd_and_even_pages_header_footer is %s" % actual

features/steps/shape.py

@@ -111,9 +111,10 @@ def then_the_document_contains_the_inline_picture(context):
     image_part = document.part.related_parts[rId]
     image_sha1 = hashlib.sha1(image_part.blob).hexdigest()
     expected_sha1 = "79769f1e202add2e963158b532e36c2c0f76a70c"
-    assert (
-        image_sha1 == expected_sha1
-    ), "image SHA1 doesn't match, expected %s, got %s" % (expected_sha1, image_sha1)
+    assert image_sha1 == expected_sha1, "image SHA1 doesn't match, expected %s, got %s" % (
+        expected_sha1,
+        image_sha1,
+    )
 
 
 @then("the length of the inline shape collection is 5")