TST: Extending typing to tests; cover generic and scripts folder files

tests/generic/test_base.py

@@ -22,7 +22,7 @@ def test_text_string_object__looks_like_bom(source: bytes, expected: str) -> Non
 
 
 @pytest.mark.enable_socket
-def test_text_string_object__wrongly_detected_bom():
+def test_text_string_object__wrongly_detected_bom() -> None:
     url = "https://github.com/user-attachments/files/24401507/minimal.pdf"
     name = "issue3587.pdf"
     reader = PdfReader(BytesIO(get_data_from_url(url, name=name)))

tests/generic/test_data_structures.py

@@ -8,7 +8,7 @@
 from tests import RESOURCE_ROOT, get_data_from_url
 
 
-def test_dictionary_object__get_next_object_position():
+def test_dictionary_object__get_next_object_position() -> None:
     reader = PdfReader(RESOURCE_ROOT / "crazyones.pdf")
 
     # reader.xref = {0: {7: 15, 9: 10245, 12: 939, 14: 2999, 16: 4982, 18: 9949, 22: 11160}}
@@ -29,7 +29,7 @@ def test_dictionary_object__get_next_object_position():
     ) == 15
 
 
-def test_tree_object__cyclic_reference(caplog):
+def test_tree_object__cyclic_reference(caplog: pytest.LogCaptureFixture) -> None:
     writer = PdfWriter()
     child1 = writer._add_object(DictionaryObject())
     child2 = writer._add_object(DictionaryObject({NameObject("/Next"): child1}))
@@ -44,7 +44,7 @@ def test_tree_object__cyclic_reference(caplog):
 
 
 @pytest.mark.enable_socket
-def test_array_object__clone_same_object_multiple_times(caplog):
+def test_array_object__clone_same_object_multiple_times(caplog: pytest.LogCaptureFixture) -> None:
     url = "https://github.com/user-attachments/files/25412858/Draft_OSMF_financial_statement_2013.pdf"
     name = "issue2991.pdf"
     reader = PdfReader(BytesIO(get_data_from_url(url=url, name=name)))

tests/generic/test_files.py

@@ -4,6 +4,7 @@
 import subprocess
 from io import BytesIO
 
+import py
 import pytest
 
 from pypdf import PdfReader, PdfWriter
@@ -27,7 +28,8 @@
 
 
 @pytest.mark.skipif(PDFATTACH_BINARY is None, reason="Requires poppler-utils")
-def test_embedded_file__basic(tmpdir):
+def test_embedded_file__basic(tmpdir: py.path.LocalPath) -> None:
+    assert PDFATTACH_BINARY is not None
     clean_path = SAMPLE_ROOT / "002-trivial-libre-office-writer" / "002-trivial-libre-office-writer.pdf"
     attached_path = tmpdir / "attached.pdf"
     file_path = tmpdir / "test.txt"
@@ -49,7 +51,7 @@ def test_embedded_file__basic(tmpdir):
         assert repr(attachment) == "<EmbeddedFile name='test.txt'>"
 
 
-def test_embedded_file__artificial():
+def test_embedded_file__artificial() -> None:
     # No alternative name.
     pdf_object = DictionaryObject(answer=42)
     attachment = EmbeddedFile(name="dummy", pdf_object=pdf_object)
@@ -80,7 +82,7 @@ def test_embedded_file__artificial():
 
 
 @pytest.mark.enable_socket
-def test_embedded_file__kids():
+def test_embedded_file__kids() -> None:
     # Generated using the instructions available from
     # https://medium.com/@pymupdf/zugferd-and-ghostscript-how-to-create-industry-standard-and-compliant-pdf-e-invoices-83c9fde31ee5
     # Notes:
@@ -119,7 +121,7 @@ def test_embedded_file__kids():
 
 
 @pytest.mark.enable_socket
-def test_embedded_file__ensure_params__existing_params():
+def test_embedded_file__ensure_params__existing_params() -> None:
     url = "https://github.com/user-attachments/files/18691309/embedded_files_kids.pdf"
     name = "embedded_files_kids.pdf"
     reader = PdfReader(BytesIO(get_data_from_url(url, name=name)))
@@ -145,7 +147,7 @@ def test_embedded_file__ensure_params__existing_params():
     assert params_dict2[NameObject("/TestParam")] == TextStringObject("test_value")
 
 
-def test_embedded_file__name_is_read_only():
+def test_embedded_file__name_is_read_only() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -155,7 +157,7 @@ def test_embedded_file__name_is_read_only():
         embedded_file.name = "new_name.txt"
 
 
-def test_embedded_file__alternative_name_setter():
+def test_embedded_file__alternative_name_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -174,7 +176,7 @@ def test_embedded_file__alternative_name_setter():
     assert embedded_file.alternative_name == "PDF String"
 
 
-def test_embedded_file__alternative_name__uf_key_only():
+def test_embedded_file__alternative_name__uf_key_only() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -193,7 +195,7 @@ def test_embedded_file__alternative_name__uf_key_only():
     assert embedded_file.pdf_object[NameObject("/F")] == create_string_object("new_uf")
 
 
-def test_embedded_file__alternative_name__f_key_only():
+def test_embedded_file__alternative_name__f_key_only() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -213,7 +215,7 @@ def test_embedded_file__alternative_name__f_key_only():
     assert embedded_file.pdf_object[NameObject("/UF")] == create_string_object("new_f")
 
 
-def test_embedded_file__alternative_name__both_f_and_uf():
+def test_embedded_file__alternative_name__both_f_and_uf() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -231,7 +233,7 @@ def test_embedded_file__alternative_name__both_f_and_uf():
     assert embedded_file.alternative_name is None
 
 
-def test_embedded_file__description_setter():
+def test_embedded_file__description_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -246,7 +248,7 @@ def test_embedded_file__description_setter():
     assert embedded_file.description == "PDF Description"
 
 
-def test_embedded_file__subtype_setter():
+def test_embedded_file__subtype_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -261,7 +263,7 @@ def test_embedded_file__subtype_setter():
     assert embedded_file.subtype == "/application#2Fjson"
 
 
-def test_embedded_file__content_setter():
+def test_embedded_file__content_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
     assert embedded_file.content == b"content"
@@ -273,7 +275,7 @@ def test_embedded_file__content_setter():
     assert embedded_file.content == b"Lorem ipsum dolor sit amet"
 
 
-def test_embedded_file__size_setter():
+def test_embedded_file__size_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -288,7 +290,7 @@ def test_embedded_file__size_setter():
     assert embedded_file.size == 2048
 
 
-def test_embedded_file__size_getter():
+def test_embedded_file__size_getter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -300,7 +302,7 @@ def test_embedded_file__size_getter():
     assert retrieved_size == 4096
 
 
-def test_embedded_file__creation_date_setter():
+def test_embedded_file__creation_date_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -312,7 +314,7 @@ def test_embedded_file__creation_date_setter():
     assert embedded_file._ensure_params[NameObject("/CreationDate")] == NullObject()
 
 
-def test_embedded_file__modification_date_setter():
+def test_embedded_file__modification_date_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -324,7 +326,7 @@ def test_embedded_file__modification_date_setter():
     assert embedded_file._ensure_params[NameObject("/ModDate")] == NullObject()
 
 
-def test_embedded_file__checksum_setter():
+def test_embedded_file__checksum_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -340,15 +342,15 @@ def test_embedded_file__checksum_setter():
     assert embedded_file.checksum == b"pdf_checksum"
 
 
-def test_embedded_file__associated_file_relationship_setter():
+def test_embedded_file__associated_file_relationship_setter() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
     embedded_file.associated_file_relationship = NameObject("/Data")
     assert embedded_file.associated_file_relationship == "/Data"
 
 
-def test_embedded_file__setters_integration():
+def test_embedded_file__setters_integration() -> None:
     writer = PdfWriter()
     writer.add_blank_page(100, 100)
 
@@ -374,7 +376,7 @@ def test_embedded_file__setters_integration():
     assert "test.txt" in reader.attachments
 
 
-def test_embedded_file__null_object_handling():
+def test_embedded_file__null_object_handling() -> None:
     writer = PdfWriter()
     embedded_file = writer.add_attachment("test.txt", b"content")
 
@@ -397,13 +399,13 @@ def test_embedded_file__null_object_handling():
     assert embedded_file.checksum is None
 
 
-def test_embedded_file__delete_without_parent():
+def test_embedded_file__delete_without_parent() -> None:
     attachment = EmbeddedFile(name="test.txt", pdf_object=DictionaryObject())
     with pytest.raises(PyPdfError, match=r"^Parent required to delete file from document\.$"):
         attachment.delete()
 
 
-def test_embedded_file__delete_known():
+def test_embedded_file__delete_known() -> None:
     writer = PdfWriter()
     writer.add_blank_page(100, 100)
     attachment = writer.add_attachment("test.txt", b"content")
@@ -424,7 +426,7 @@ def test_embedded_file__delete_known():
         attachment.delete()
 
 
-def test_embedded_file__delete__no_indirect_reference():
+def test_embedded_file__delete__no_indirect_reference() -> None:
     writer = PdfWriter()
     writer.add_blank_page(100, 100)
 
@@ -441,7 +443,7 @@ def test_embedded_file__delete__no_indirect_reference():
 
 
 @pytest.mark.enable_socket
-def test_embedded_file__create__kids_based_name_tree():
+def test_embedded_file__create__kids_based_name_tree() -> None:
     """Test for issue #3473."""
     url = "https://github.com/user-attachments/files/18691309/embedded_files_kids.pdf"
     name = "embedded_files_kids.pdf"
@@ -476,7 +478,7 @@ def test_embedded_file__create__kids_based_name_tree():
     ]
 
 
-def test_embedded_file__create__neither_kids_nor_names():
+def test_embedded_file__create__neither_kids_nor_names() -> None:
     writer = PdfWriter()
     writer.add_blank_page(100, 100)
 
@@ -488,7 +490,7 @@ def test_embedded_file__create__neither_kids_nor_names():
         writer.add_attachment("test2.txt", b"content2")
 
 
-def test_embedded_file__get_insertion_index():
+def test_embedded_file__get_insertion_index() -> None:
     # Empty list.
     assert EmbeddedFile._get_insertion_index(ArrayObject(), "test.txt") == 0
 
@@ -549,7 +551,7 @@ def test_embedded_file__get_insertion_index():
     ) == 2
 
 
-def test_embedded_file__order():
+def test_embedded_file__order() -> None:
     writer = PdfWriter()
     writer.add_blank_page(100, 100)
 

tests/generic/test_image_inline.py

@@ -9,7 +9,7 @@
 from tests import get_data_from_url
 
 
-def test_is_followed_by_binary_data():
+def test_is_followed_by_binary_data() -> None:
     # Empty/too short stream.
     stream = BytesIO()
     assert not is_followed_by_binary_data(stream)
@@ -67,7 +67,7 @@ def test_is_followed_by_binary_data():
 
 
 @pytest.mark.enable_socket
-def test_extract_inline_dct__early_end_of_file():
+def test_extract_inline_dct__early_end_of_file() -> None:
     url = "https://github.com/user-attachments/files/23056988/inline_dct__early_eof.pdf"
     name = "inline_dct__early_eof.pdf"
     reader = PdfReader(BytesIO(get_data_from_url(url, name=name)))
@@ -78,7 +78,7 @@ def test_extract_inline_dct__early_end_of_file():
 
 
 @pytest.mark.enable_socket
-def test_extract_inline_dct__multiple_eod():
+def test_extract_inline_dct__multiple_eod() -> None:
     url = "https://github.com/user-attachments/files/23900687/cedolini_esempio-1.pdf"
     name = "issue3517.pdf"
     reader = PdfReader(BytesIO(get_data_from_url(url, name=name)))

tests/generic/test_link.py

@@ -9,7 +9,7 @@
 
 
 @pytest.mark.enable_socket
-def test_extract_links__null_object_in_old_page():
+def test_extract_links__null_object_in_old_page() -> None:
     url = "https://github.com/user-attachments/files/25507697/sample.pdf"
     name = "issue3656.pdf"
     reader = PdfReader(BytesIO(get_data_from_url(url=url, name=name)))
@@ -18,7 +18,7 @@ def test_extract_links__null_object_in_old_page():
     writer.append(reader)
 
 
-def test_extract_links(caplog):
+def test_extract_links(caplog: pytest.LogCaptureFixture) -> None:
     page1 = PageObject()
     page2 = PageObject()
 

tests/scripts/test_example_files.py

@@ -5,7 +5,7 @@
 from tests import read_yaml_to_list_of_dicts
 
 
-def test_consistency():
+def test_consistency() -> None:
     pdfs = read_yaml_to_list_of_dicts(Path(__file__).parent.parent / "example_files.yaml")
 
     # Ensure the names are unique

tests/scripts/test_make_release.py

@@ -32,13 +32,13 @@
         ("# CHANGELOG #", "#"),
     ]
 )
-def test_strip_header(data, expected):
+def test_strip_header(data: str, expected: str) -> None:
     """Removal of the 'CHANGELOG' header."""
     make_release = pytest.importorskip("make_release")
     assert make_release.strip_header(data) == expected
 
 
-def test_get_git_commits_since_tag():
+def test_get_git_commits_since_tag() -> None:
     make_release = pytest.importorskip("make_release")
 
     with open(COMMITS__VERSION_4_0_1, mode="rb") as commits, mock.patch(
@@ -84,7 +84,7 @@ def test_get_git_commits_since_tag():
     ]
 
 
-def test_get_formatted_changes():
+def test_get_formatted_changes() -> None:
     make_release = pytest.importorskip("make_release")
 
     with open(COMMITS__VERSION_4_0_1, mode="rb") as commits, mock.patch(
@@ -128,7 +128,7 @@ def test_get_formatted_changes():
     )
 
 
-def test_get_formatted_changes__other():
+def test_get_formatted_changes__other() -> None:
     make_release = pytest.importorskip("make_release")
 
     changes = [