lint: fix flake8-pytest-style diagnostics

scanny · scanny · commit 878f75854ec8 · 2023-10-01T20:08:32.000-07:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,6 +58,8 @@ python_functions = ["it_", "they_", "and_it_", "but_it_"]
 exclude = []
 ignore = [
     "COM812",   # -- over-aggressively insists on trailing commas where not desired --
+    "PT001",    # -- wants @pytest.fixture() instead of @pytest.fixture --
+    "PT005",    # -- wants @pytest.fixture() instead of @pytest.fixture --
 ]
 select = [
     "C4",       # -- flake8-comprehensions --
@@ -66,7 +68,7 @@ select = [
     "F",        # -- pyflakes --
     "I",        # -- isort (imports) --
     "PLR0402",  # -- Name compared with itself like `foo == foo` --
-    # "PT",       # -- flake8-pytest-style --
+    "PT",       # -- flake8-pytest-style --
     # "SIM",      # -- flake8-simplify --
     "UP015",    # -- redundant `open()` mode parameter (like "r" is default) --
     "UP018",    # -- Unnecessary {literal_type} call like `str("abc")`. (rewrite as a literal) --
diff --git a/tests/opc/test_package.py b/tests/opc/test_package.py
@@ -233,16 +233,16 @@ def part_related_by_(self, request):
         return method_mock(request, OpcPackage, "part_related_by")
 
     @pytest.fixture
-    def parts(self, request, parts_):
+    def parts(self, parts_):
         """
         Return a mock patching property OpcPackage.parts, reversing the
         patch after each use.
         """
-        _patch = patch.object(
+        p = patch.object(
             OpcPackage, "parts", new_callable=PropertyMock, return_value=parts_
         )
-        request.addfinalizer(_patch.stop)
-        return _patch.start()
+        yield p.start()
+        p.stop()
 
     @pytest.fixture
     def parts_(self, request):
diff --git a/tests/opc/test_packuri.py b/tests/opc/test_packuri.py
@@ -29,7 +29,7 @@ def it_can_construct_from_relative_ref(self):
         assert pack_uri == "/ppt/slideLayouts/slideLayout1.xml"
 
     def it_should_raise_on_construct_with_bad_pack_uri_str(self):
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="PackURI must begin with slash"):
             PackURI("foobar")
 
     def it_can_calculate_baseURI(self):
diff --git a/tests/opc/test_part.py b/tests/opc/test_part.py
@@ -326,24 +326,20 @@ def cls_method_fn_(self, request, cls_selector_fn_):
     @pytest.fixture
     def cls_selector_fixture(
         self,
-        request,
         cls_selector_fn_,
         cls_method_fn_,
         part_load_params,
         CustomPartClass_,
         part_of_custom_type_,
     ):
-        def reset_part_class_selector():
-            PartFactory.part_class_selector = original_part_class_selector
-
         original_part_class_selector = PartFactory.part_class_selector
-        request.addfinalizer(reset_part_class_selector)
-        return (
+        yield (
             cls_selector_fn_,
             part_load_params,
             CustomPartClass_,
             part_of_custom_type_,
         )
+        PartFactory.part_class_selector = original_part_class_selector
 
     @pytest.fixture
     def cls_selector_fn_(self, request, CustomPartClass_):
diff --git a/tests/opc/test_phys_pkg.py b/tests/opc/test_phys_pkg.py
@@ -1,11 +1,7 @@
 """Test suite for docx.opc.phys_pkg module."""
 
-try:
-    from io import BytesIO  # Python 3
-except ImportError:
-    from StringIO import StringIO as BytesIO
-
 import hashlib
+import io
 from zipfile import ZIP_DEFLATED, ZipFile
 
 import pytest
@@ -119,10 +115,10 @@ def it_returns_none_when_part_has_no_rels_xml(self, phys_reader):
     # fixtures ---------------------------------------------
 
     @pytest.fixture(scope="class")
-    def phys_reader(self, request):
+    def phys_reader(self):
         phys_reader = _ZipPkgReader(zip_pkg_path)
-        request.addfinalizer(phys_reader.close)
-        return phys_reader
+        yield phys_reader
+        phys_reader.close()
 
     @pytest.fixture
     def pkg_file_(self, request):
@@ -167,10 +163,10 @@ def it_can_write_a_blob(self, pkg_file):
     # fixtures ---------------------------------------------
 
     @pytest.fixture
-    def pkg_file(self, request):
-        pkg_file = BytesIO()
-        request.addfinalizer(pkg_file.close)
-        return pkg_file
+    def pkg_file(self):
+        pkg_file = io.BytesIO()
+        yield pkg_file
+        pkg_file.close()
 
 
 # fixtures -------------------------------------------------
diff --git a/tests/opc/test_pkgreader.py b/tests/opc/test_pkgreader.py
@@ -231,10 +231,10 @@ def partnames_(self, request):
         return partname_, partname_2_
 
     @pytest.fixture
-    def PhysPkgReader_(self, request):
-        _patch = patch("docx.opc.pkgreader.PhysPkgReader", spec_set=_ZipPkgReader)
-        request.addfinalizer(_patch.stop)
-        return _patch.start()
+    def PhysPkgReader_(self):
+        p = patch("docx.opc.pkgreader.PhysPkgReader", spec_set=_ZipPkgReader)
+        yield p.start()
+        p.stop()
 
     @pytest.fixture
     def reltypes_(self, request):
@@ -464,7 +464,7 @@ def it_raises_on_target_partname_when_external(self):
             target_mode=RTM.EXTERNAL,
         )
         srel = _SerializedRelationship("/", rel_elm)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="target_partname attribute on Relat"):
             srel.target_partname
 
 
diff --git a/tests/opc/test_pkgwriter.py b/tests/opc/test_pkgwriter.py
@@ -92,10 +92,10 @@ def parts_(self, request):
         return instance_mock(request, list)
 
     @pytest.fixture
-    def PhysPkgWriter_(self, request):
-        _patch = patch("docx.opc.pkgwriter.PhysPkgWriter")
-        request.addfinalizer(_patch.stop)
-        return _patch.start()
+    def PhysPkgWriter_(self):
+        p = patch("docx.opc.pkgwriter.PhysPkgWriter")
+        yield p.start()
+        p.stop()
 
     @pytest.fixture
     def phys_pkg_writer_(self, request):
@@ -106,7 +106,7 @@ def write_cti_fixture(self, _ContentTypesItem_, parts_, phys_pkg_writer_, blob_)
         return _ContentTypesItem_, parts_, phys_pkg_writer_, blob_
 
     @pytest.fixture
-    def _write_methods(self, request):
+    def _write_methods(self):
         """Mock that patches all the _write_* methods of PackageWriter"""
         root_mock = Mock(name="PackageWriter")
         patch1 = patch.object(PackageWriter, "_write_content_types_stream")
@@ -116,13 +116,11 @@ def _write_methods(self, request):
         root_mock.attach_mock(patch2.start(), "_write_pkg_rels")
         root_mock.attach_mock(patch3.start(), "_write_parts")
 
-        def fin():
-            patch1.stop()
-            patch2.stop()
-            patch3.stop()
+        yield root_mock
 
-        request.addfinalizer(fin)
-        return root_mock
+        patch1.stop()
+        patch2.stop()
+        patch3.stop()
 
     @pytest.fixture
     def xml_for_(self, request):
diff --git a/tests/opc/test_rel.py b/tests/opc/test_rel.py
@@ -1,3 +1,5 @@
+# pyright: reportPrivateUsage=false
+
 """Unit test suite for the docx.opc.rel module."""
 
 import pytest
@@ -27,7 +29,7 @@ def it_remembers_construction_values(self):
 
     def it_should_raise_on_target_part_access_on_external_rel(self):
         rel = _Relationship(None, None, None, None, external=True)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="target_part property on _Relat"):
             rel.target_part
 
     def it_should_have_target_ref_for_external_rel(self):
@@ -172,7 +174,7 @@ def rels(self):
         return rels
 
     @pytest.fixture
-    def rels_elm(self, request):
+    def rels_elm(self):
         """
         Return a rels_elm mock that will be returned from
         CT_Relationships.new()
@@ -186,8 +188,8 @@ def rels_elm(self, request):
         # patch CT_Relationships to return that rels_elm
         patch_ = patch.object(CT_Relationships, "new", return_value=rels_elm)
         patch_.start()
-        request.addfinalizer(patch_.stop)
-        return rels_elm
+        yield rels_elm
+        patch_.stop()
 
     @pytest.fixture
     def _rel_with_known_target_part(self, _rId, reltype, _target_part, _baseURI):
diff --git a/tests/oxml/test__init__.py b/tests/oxml/test__init__.py
@@ -63,7 +63,7 @@ def it_accepts_unicode_providing_there_is_no_encoding_declaration(self):
         parse_xml(xml_text)
         # but adding encoding in the declaration raises ValueError
         xml_text = "%s\n%s" % (enc_decl, xml_body)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="Unicode strings with encoding declara"):
             parse_xml(xml_text)
 
     def it_uses_registered_element_classes(self, xml_bytes):
diff --git a/tests/oxml/test_table.py b/tests/oxml/test_table.py
@@ -19,7 +19,7 @@ def it_can_add_a_trPr(self, add_trPr_fixture):
 
     def it_raises_on_tc_at_grid_col(self, tc_raise_fixture):
         tr, idx = tc_raise_fixture
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError):  # noqa: PT011
             tr.tc_at_grid_col(idx)
 
     # fixtures -------------------------------------------------------
@@ -123,7 +123,7 @@ def it_can_move_its_content_to_help_merge(self, move_fixture):
 
     def it_raises_on_tr_above(self, tr_above_raise_fixture):
         tc = tr_above_raise_fixture
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="no tr above topmost tr"):
             tc._tr_above
 
     # fixtures -------------------------------------------------------
diff --git a/tests/styles/test_styles.py b/tests/styles/test_styles.py
@@ -60,7 +60,7 @@ def it_can_add_a_new_style(self, add_fixture):
 
     def it_raises_when_style_name_already_used(self, add_raises_fixture):
         styles, name = add_raises_fixture
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="document already contains style 'Hea"):
             styles.add_style(name, None)
 
     def it_can_get_the_default_style_for_a_type(self, default_fixture):
@@ -156,7 +156,7 @@ def it_gets_a_style_id_from_a_style_to_help(self, id_style_fixture):
 
     def it_raises_on_style_type_mismatch(self, id_style_raises_fixture):
         styles, style_, style_type = id_style_raises_fixture
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="assigned style is type 1, need type 2"):
             styles._get_style_id_from_style(style_, style_type)
 
     def it_provides_access_to_the_latent_styles(self, latent_styles_fixture):
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -24,7 +24,7 @@ def it_opens_the_default_docx_if_none_specified(self, default_fixture):
 
     def it_raises_on_not_a_Word_file(self, raise_fixture):
         not_a_docx = raise_fixture
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="file 'foobar.xlsx' is not a Word file,"):
             Document(not_a_docx)
 
     # fixtures -------------------------------------------------------
diff --git a/tests/test_document.py b/tests/test_document.py
@@ -33,9 +33,9 @@ def it_can_add_a_heading(self, add_heading_fixture, add_paragraph_, paragraph_):
 
     def it_raises_on_heading_level_out_of_range(self):
         document = Document(None, None)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="level must be in range 0-9, got -1"):
             document.add_heading(level=-1)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="level must be in range 0-9, got 10"):
             document.add_heading(level=10)
 
     def it_can_add_a_page_break(self, add_paragraph_, paragraph_, run_):
diff --git a/tests/test_enum.py b/tests/test_enum.py
@@ -68,9 +68,9 @@ def it_provides_the_enumeration_value_for_each_named_member(self):
     def it_knows_if_a_setting_is_valid(self):
         FOOBAR.validate(None)
         FOOBAR.validate(FOOBAR.READ_WRITE)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="foobar not a member of FOOBAR enumerat"):
             FOOBAR.validate("foobar")
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match=r"READ_ONLY \(-2\) not a member of FOOB"):
             FOOBAR.validate(FOOBAR.READ_ONLY)
 
     def it_can_be_referred_to_by_a_convenience_alias_if_defined(self):
@@ -89,7 +89,7 @@ class DescribeXmlEnumeration(object):
     def it_knows_the_XML_value_for_each_of_its_xml_members(self):
         assert XMLFOO.to_xml(XMLFOO.XML_RW) == "attrVal"
         assert XMLFOO.to_xml(42) == "attrVal"
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match=r"value 'RO \(-2\)' not in enumeration "):
             XMLFOO.to_xml(XMLFOO.RO)
 
     def it_can_map_each_of_its_xml_members_from_the_XML_value(self):
diff --git a/tests/test_shape.py b/tests/test_shape.py
@@ -40,11 +40,11 @@ def it_provides_indexed_access_to_inline_shapes(self, inline_shapes_fixture):
 
     def it_raises_on_indexed_access_out_of_range(self, inline_shapes_fixture):
         inline_shapes, inline_shape_count = inline_shapes_fixture
-        with pytest.raises(IndexError):
-            too_low = -1 - inline_shape_count
+        too_low = -1 - inline_shape_count
+        with pytest.raises(IndexError, match=r"inline shape index \[-3\] out of rang"):
             inline_shapes[too_low]
-        with pytest.raises(IndexError):
-            too_high = inline_shape_count
+        too_high = inline_shape_count
+        with pytest.raises(IndexError, match=r"inline shape index \[2\] out of range"):
             inline_shapes[too_high]
 
     def it_knows_the_part_it_belongs_to(self, inline_shapes_with_parent_):
diff --git a/tests/test_shared.py b/tests/test_shared.py
@@ -112,11 +112,11 @@ def units_fixture(self, request):
 class DescribeRGBColor(object):
     def it_is_natively_constructed_using_three_ints_0_to_255(self):
         RGBColor(0x12, 0x34, 0x56)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match=r"RGBColor\(\) takes three integer valu"):
             RGBColor("12", "34", "56")
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match=r"\(\) takes three integer values 0-255"):
             RGBColor(-1, 34, 56)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match=r"RGBColor\(\) takes three integer valu"):
             RGBColor(12, 256, 56)
 
     def it_can_construct_from_a_hex_string_rgb_value(self):
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -930,11 +930,12 @@ def it_provides_sliced_access_to_rows(self, slice_fixture):
 
     def it_raises_on_indexed_access_out_of_range(self, rows_fixture):
         rows, row_count = rows_fixture
-        with pytest.raises(IndexError):
-            too_low = -1 - row_count
+        too_low = -1 - row_count
+        too_high = row_count
+
+        with pytest.raises(IndexError, match="list index out of range"):
             rows[too_low]
-        with pytest.raises(IndexError):
-            too_high = row_count
+        with pytest.raises(IndexError, match="list index out of range"):
             rows[too_high]
 
     def it_provides_access_to_the_table_it_belongs_to(self, table_fixture):
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -46,7 +46,7 @@ def it_can_change_its_underline_type(self, underline_set_fixture):
 
     def it_raises_on_assign_invalid_underline_type(self, underline_raise_fixture):
         run, underline = underline_raise_fixture
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="' not in enumeration WD_UNDERLINE"):
             run.underline = underline
 
     def it_provides_access_to_its_font(self, font_fixture):
