paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2026-02-03 23:22:42 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore(mypy): Annotate None returns for typing improvements (#11213)

Browse Source
This commit is contained in:
Sebastian Steinbeißer
2026-02-02 17:44:12 +01:00
committed by GitHub
parent a9c0b06e28
commit 3b5ffbf9fa
113 changed files with 1598 additions and 1510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
src/documents/tests/test_barcodes.py
View File

@@ -55,7 +55,7 @@ class TestBarcode(
GetReaderPluginMixin,
TestCase,
):
def test_scan_file_for_separating_barcodes(self):
def test_scan_file_for_separating_barcodes(self) -> None:
"""
GIVEN:
- PDF containing barcodes
@@ -76,7 +76,7 @@ class TestBarcode(
@override_settings(
CONSUMER_BARCODE_TIFF_SUPPORT=True,
)
def test_scan_tiff_for_separating_barcodes(self):
def test_scan_tiff_for_separating_barcodes(self) -> None:
"""
GIVEN:
- TIFF image containing barcodes
@@ -96,7 +96,7 @@ class TestBarcode(
@override_settings(
CONSUMER_BARCODE_TIFF_SUPPORT=True,
)
def test_scan_tiff_with_alpha_for_separating_barcodes(self):
def test_scan_tiff_with_alpha_for_separating_barcodes(self) -> None:
"""
GIVEN:
- TIFF image containing barcodes
@@ -113,7 +113,7 @@ class TestBarcode(
self.assertDictEqual(separator_page_numbers, {1: False})
def test_scan_file_for_separating_barcodes_none_present(self):
def test_scan_file_for_separating_barcodes_none_present(self) -> None:
"""
GIVEN:
- File with no barcodes
@@ -131,7 +131,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {})
def test_scan_file_for_separating_barcodes_middle_page(self):
def test_scan_file_for_separating_barcodes_middle_page(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 1 (zero indexed)
@@ -149,7 +149,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {1: False})
def test_scan_file_for_separating_barcodes_multiple_pages(self):
def test_scan_file_for_separating_barcodes_multiple_pages(self) -> None:
"""
GIVEN:
- PDF file containing a separator on pages 2 and 5 (zero indexed)
@@ -167,7 +167,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {2: False, 5: False})
def test_scan_file_for_separating_barcodes_hard_to_detect(self):
def test_scan_file_for_separating_barcodes_hard_to_detect(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 1 (zero indexed)
@@ -192,7 +192,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {1: False})
def test_scan_file_for_separating_barcodes_unreadable(self):
def test_scan_file_for_separating_barcodes_unreadable(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 1 (zero indexed)
@@ -211,7 +211,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {})
def test_scan_file_for_separating_barcodes_fax_decode(self):
def test_scan_file_for_separating_barcodes_fax_decode(self) -> None:
"""
GIVEN:
- A PDF containing an image encoded as CCITT Group 4 encoding
@@ -229,7 +229,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {1: False})
def test_scan_file_for_separating_qr_barcodes(self):
def test_scan_file_for_separating_qr_barcodes(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 0 (zero indexed)
@@ -249,7 +249,7 @@ class TestBarcode(
self.assertDictEqual(separator_page_numbers, {0: False})
@override_settings(CONSUMER_BARCODE_STRING="CUSTOM BARCODE")
def test_scan_file_for_separating_custom_barcodes(self):
def test_scan_file_for_separating_custom_barcodes(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 0 (zero indexed)
@@ -269,7 +269,7 @@ class TestBarcode(
self.assertDictEqual(separator_page_numbers, {0: False})
@override_settings(CONSUMER_BARCODE_STRING="CUSTOM BARCODE")
def test_scan_file_for_separating_custom_qr_barcodes(self):
def test_scan_file_for_separating_custom_qr_barcodes(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 0 (zero indexed)
@@ -290,7 +290,7 @@ class TestBarcode(
self.assertDictEqual(separator_page_numbers, {0: False})
@override_settings(CONSUMER_BARCODE_STRING="CUSTOM BARCODE")
def test_scan_file_for_separating_custom_128_barcodes(self):
def test_scan_file_for_separating_custom_128_barcodes(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 0 (zero indexed)
@@ -310,7 +310,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {0: False})
def test_scan_file_for_separating_wrong_qr_barcodes(self):
def test_scan_file_for_separating_wrong_qr_barcodes(self) -> None:
"""
GIVEN:
- PDF file containing a separator on page 0 (zero indexed)
@@ -331,7 +331,7 @@ class TestBarcode(
self.assertDictEqual(separator_page_numbers, {})
@override_settings(CONSUMER_BARCODE_STRING="ADAR-NEXTDOC")
def test_scan_file_qr_barcodes_was_problem(self):
def test_scan_file_qr_barcodes_was_problem(self) -> None:
"""
GIVEN:
- Input PDF with certain QR codes that aren't detected at current size
@@ -350,7 +350,7 @@ class TestBarcode(
self.assertGreater(len(reader.barcodes), 0)
self.assertDictEqual(separator_page_numbers, {1: False})
def test_scan_file_for_separating_barcodes_password(self):
def test_scan_file_for_separating_barcodes_password(self) -> None:
"""
GIVEN:
- Password protected PDF
@@ -372,7 +372,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertDictEqual(separator_page_numbers, {})
def test_separate_pages(self):
def test_separate_pages(self) -> None:
"""
GIVEN:
- Input PDF 2 pages after separation
@@ -389,7 +389,7 @@ class TestBarcode(
self.assertEqual(reader.pdf_file, test_file)
self.assertEqual(len(documents), 2)
def test_separate_pages_double_code(self):
def test_separate_pages_double_code(self) -> None:
"""
GIVEN:
- Input PDF with two patch code pages in a row
@@ -406,7 +406,7 @@ class TestBarcode(
self.assertEqual(len(documents), 2)
@override_settings(CONSUMER_ENABLE_BARCODES=True)
def test_separate_pages_no_list(self):
def test_separate_pages_no_list(self) -> None:
"""
GIVEN:
- Input file to separate
@@ -427,7 +427,7 @@ class TestBarcode(
CONSUMER_ENABLE_BARCODES=True,
CONSUMER_BARCODE_TIFF_SUPPORT=True,
)
def test_consume_barcode_unsupported_jpg_file(self):
def test_consume_barcode_unsupported_jpg_file(self) -> None:
"""
GIVEN:
- JPEG image as input
@@ -446,7 +446,7 @@ class TestBarcode(
CONSUMER_ENABLE_BARCODES=True,
CONSUMER_ENABLE_ASN_BARCODE=True,
)
def test_separate_pages_by_asn_barcodes_and_patcht(self):
def test_separate_pages_by_asn_barcodes_and_patcht(self) -> None:
"""
GIVEN:
- Input PDF with a patch code on page 3 and ASN barcodes on pages 1,5,6,9,11
@@ -483,7 +483,7 @@ class TestBarcode(
CONSUMER_ENABLE_BARCODES=True,
CONSUMER_ENABLE_ASN_BARCODE=True,
)
def test_separate_pages_by_asn_barcodes(self):
def test_separate_pages_by_asn_barcodes(self) -> None:
"""
GIVEN:
- Input PDF with ASN barcodes on pages 1,3,4,7,9
@@ -517,7 +517,7 @@ class TestBarcode(
CONSUMER_ENABLE_ASN_BARCODE=True,
CONSUMER_BARCODE_RETAIN_SPLIT_PAGES=True,
)
def test_separate_pages_by_asn_barcodes_and_patcht_retain_pages(self):
def test_separate_pages_by_asn_barcodes_and_patcht_retain_pages(self) -> None:
"""
GIVEN:
- Input PDF with a patch code on page 3 and ASN barcodes on pages 1,5,6,9,11
@@ -548,7 +548,7 @@ class TestBarcode(
},
)
def test_barcode_config(self):
def test_barcode_config(self) -> None:
"""
GIVEN:
- Barcode app config is set (settings are not)
@@ -579,7 +579,7 @@ class TestBarcodeNewConsume(
TestCase,
):
@override_settings(CONSUMER_ENABLE_BARCODES=True)
def test_consume_barcode_file(self):
def test_consume_barcode_file(self) -> None:
"""
GIVEN:
- Incoming file with at 1 barcode producing 2 documents
@@ -642,7 +642,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
reader.cleanup()
@override_settings(CONSUMER_ASN_BARCODE_PREFIX="CUSTOM-PREFIX-")
def test_scan_file_for_asn_custom_prefix(self):
def test_scan_file_for_asn_custom_prefix(self) -> None:
"""
GIVEN:
- PDF containing an ASN barcode with custom prefix
@@ -660,7 +660,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
self.assertEqual(reader.pdf_file, test_file)
self.assertEqual(asn, 123)
def test_scan_file_for_asn_barcode(self):
def test_scan_file_for_asn_barcode(self) -> None:
"""
GIVEN:
- PDF containing an ASN barcode
@@ -679,7 +679,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
self.assertEqual(reader.pdf_file, test_file)
self.assertEqual(asn, 123)
def test_scan_file_for_asn_not_found(self):
def test_scan_file_for_asn_not_found(self) -> None:
"""
GIVEN:
- PDF without an ASN barcode
@@ -696,7 +696,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
self.assertEqual(reader.pdf_file, test_file)
self.assertEqual(asn, None)
def test_scan_file_for_asn_barcode_invalid(self):
def test_scan_file_for_asn_barcode_invalid(self) -> None:
"""
GIVEN:
- PDF containing an ASN barcode
@@ -718,7 +718,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
self.assertEqual(asn, None)
@override_settings(CONSUMER_ENABLE_ASN_BARCODE=True)
def test_consume_barcode_file_asn_assignment(self):
def test_consume_barcode_file_asn_assignment(self) -> None:
"""
GIVEN:
- PDF containing an ASN barcode
@@ -749,7 +749,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
self.assertEqual(document.archive_serial_number, 123)
@override_settings(CONSUMER_BARCODE_SCANNER="PYZBAR")
def test_scan_file_for_qrcode_without_upscale(self):
def test_scan_file_for_qrcode_without_upscale(self) -> None:
"""
GIVEN:
- A printed and scanned PDF document with a rather small QR code
@@ -769,7 +769,7 @@ class TestAsnBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
@override_settings(CONSUMER_BARCODE_SCANNER="PYZBAR")
@override_settings(CONSUMER_BARCODE_DPI=600)
@override_settings(CONSUMER_BARCODE_UPSCALE=1.5)
def test_scan_file_for_qrcode_with_upscale(self):
def test_scan_file_for_qrcode_with_upscale(self) -> None:
"""
GIVEN:
- A printed and scanned PDF document with a rather small QR code
@@ -826,7 +826,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_ENABLE_TAG_BARCODE=True,
CONSUMER_TAG_BARCODE_MAPPING={"TAG:(.*)": "\\g<1>"},
)
def test_barcode_without_tag_match(self):
def test_barcode_without_tag_match(self) -> None:
"""
GIVEN:
- Barcode that does not match any TAG mapping pattern
@@ -852,7 +852,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
)
@override_settings(CONSUMER_ENABLE_TAG_BARCODE=True)
def test_scan_file_without_matching_barcodes(self):
def test_scan_file_without_matching_barcodes(self) -> None:
"""
GIVEN:
- PDF containing tag barcodes but none with matching prefix (default "TAG:")
@@ -871,7 +871,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_ENABLE_TAG_BARCODE=False,
CONSUMER_TAG_BARCODE_MAPPING={"CUSTOM-PREFIX-(.*)": "\\g<1>"},
)
def test_scan_file_with_matching_barcode_but_function_disabled(self):
def test_scan_file_with_matching_barcode_but_function_disabled(self) -> None:
"""
GIVEN:
- PDF containing a tag barcode with matching custom prefix
@@ -891,7 +891,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_ENABLE_TAG_BARCODE=True,
CONSUMER_TAG_BARCODE_MAPPING={"CUSTOM-PREFIX-(.*)": "\\g<1>"},
)
def test_scan_file_for_tag_custom_prefix(self):
def test_scan_file_for_tag_custom_prefix(self) -> None:
"""
GIVEN:
- PDF containing a tag barcode with custom prefix
@@ -917,7 +917,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_ENABLE_TAG_BARCODE=True,
CONSUMER_TAG_BARCODE_MAPPING={"ASN(.*)": "\\g<1>"},
)
def test_scan_file_for_many_custom_tags(self):
def test_scan_file_for_many_custom_tags(self) -> None:
"""
GIVEN:
- PDF containing multiple tag barcode with custom prefix
@@ -944,7 +944,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_ENABLE_TAG_BARCODE=True,
CONSUMER_TAG_BARCODE_MAPPING={"CUSTOM-PREFIX-(.*)": "\\g<3>"},
)
def test_scan_file_for_tag_raises_value_error(self):
def test_scan_file_for_tag_raises_value_error(self) -> None:
"""
GIVEN:
- Any error occurs during tag barcode processing
@@ -963,7 +963,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_TAG_BARCODE_SPLIT=True,
CONSUMER_TAG_BARCODE_MAPPING={"TAG:(.*)": "\\g<1>"},
)
def test_split_on_tag_barcodes(self):
def test_split_on_tag_barcodes(self) -> None:
"""
GIVEN:
- PDF containing barcodes with TAG: prefix
@@ -989,7 +989,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_TAG_BARCODE_SPLIT=False,
CONSUMER_TAG_BARCODE_MAPPING={"TAG:(.*)": "\\g<1>"},
)
def test_no_split_when_tag_split_disabled(self):
def test_no_split_when_tag_split_disabled(self) -> None:
"""
GIVEN:
- PDF containing TAG barcodes (TAG:invoice, TAG:receipt)
@@ -1018,7 +1018,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CELERY_TASK_ALWAYS_EAGER=True,
OCR_MODE="skip",
)
def test_consume_barcode_file_tag_split_and_assignment(self):
def test_consume_barcode_file_tag_split_and_assignment(self) -> None:
"""
GIVEN:
- PDF containing TAG barcodes on pages 2 and 4 (TAG:invoice, TAG:receipt)
@@ -1066,7 +1066,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_TAG_BARCODE_SPLIT=True,
CONSUMER_TAG_BARCODE_MAPPING={"ASN(.*)": "ASN_\\g<1>", "TAG:(.*)": "\\g<1>"},
)
def test_split_by_mixed_asn_tag_backwards_compat(self):
def test_split_by_mixed_asn_tag_backwards_compat(self) -> None:
"""
GIVEN:
- PDF with mixed ASN and TAG barcodes
@@ -1095,7 +1095,7 @@ class TestTagBarcode(DirectoriesMixin, SampleDirMixin, GetReaderPluginMixin, Tes
CONSUMER_TAG_BARCODE_SPLIT=True,
CONSUMER_TAG_BARCODE_MAPPING={"TAG:(.*)": "\\g<1>"},
)
def test_split_by_tag_multiple_per_page(self):
def test_split_by_tag_multiple_per_page(self) -> None:
"""
GIVEN:
- PDF with multiple TAG barcodes on same page