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

src/documents/tests/test_consumer.py

@@ -35,7 +35,7 @@ from paperless_mail.parsers import MailDocumentParser
 
 
 class _BaseTestParser(DocumentParser):
-    def get_settings(self):
+    def get_settings(self) -> None:
         """
         This parser does not implement additional settings yet
         """
@@ -43,7 +43,7 @@ class _BaseTestParser(DocumentParser):
 
 
 class DummyParser(_BaseTestParser):
-    def __init__(self, logging_group, scratch_dir, archive_path):
+    def __init__(self, logging_group, scratch_dir, archive_path) -> None:
         super().__init__(logging_group, None)
         _, self.fake_thumb = tempfile.mkstemp(suffix=".webp", dir=scratch_dir)
         self.archive_path = archive_path
@@ -51,7 +51,7 @@ class DummyParser(_BaseTestParser):
     def get_thumbnail(self, document_path, mime_type, file_name=None):
         return self.fake_thumb
 
-    def parse(self, document_path, mime_type, file_name=None):
+    def parse(self, document_path, mime_type, file_name=None) -> None:
         self.text = "The Text"
 
 
@@ -59,18 +59,18 @@ class CopyParser(_BaseTestParser):
     def get_thumbnail(self, document_path, mime_type, file_name=None):
         return self.fake_thumb
 
-    def __init__(self, logging_group, progress_callback=None):
+    def __init__(self, logging_group, progress_callback=None) -> None:
         super().__init__(logging_group, progress_callback)
         _, self.fake_thumb = tempfile.mkstemp(suffix=".webp", dir=self.tempdir)
 
-    def parse(self, document_path, mime_type, file_name=None):
+    def parse(self, document_path, mime_type, file_name=None) -> None:
         self.text = "The text"
         self.archive_path = Path(self.tempdir / "archive.pdf")
         shutil.copy(document_path, self.archive_path)
 
 
 class FaultyParser(_BaseTestParser):
-    def __init__(self, logging_group, scratch_dir):
+    def __init__(self, logging_group, scratch_dir) -> None:
         super().__init__(logging_group)
         _, self.fake_thumb = tempfile.mkstemp(suffix=".webp", dir=scratch_dir)
 
@@ -82,7 +82,7 @@ class FaultyParser(_BaseTestParser):
 
 
 class FaultyGenericExceptionParser(_BaseTestParser):
-    def __init__(self, logging_group, scratch_dir):
+    def __init__(self, logging_group, scratch_dir) -> None:
         super().__init__(logging_group)
         _, self.fake_thumb = tempfile.mkstemp(suffix=".webp", dir=scratch_dir)
 
@@ -127,7 +127,7 @@ class TestConsumer(
         first_progress_max=100,
         last_progress=100,
         last_progress_max=100,
-    ):
+    ) -> None:
         self.assertGreaterEqual(len(self.status.payloads), 2)
 
         payload = self.status.payloads[0]
@@ -158,7 +158,7 @@ class TestConsumer(
     ):
         return FaultyGenericExceptionParser(logging_group, self.dirs.scratch_dir)
 
-    def setUp(self):
+    def setUp(self) -> None:
         super().setUp()
 
         patcher = mock.patch("documents.parsers.document_consumer_declaration.send")
@@ -208,7 +208,7 @@ class TestConsumer(
         return dst
 
     @override_settings(FILENAME_FORMAT=None, TIME_ZONE="America/Chicago")
-    def testNormalOperation(self):
+    def testNormalOperation(self) -> None:
         filename = self.get_test_file()
 
         # Get the local time, as an aware datetime
@@ -250,7 +250,7 @@ class TestConsumer(
         self.assertEqual(document.created.day, rough_create_date_local.day)
 
     @override_settings(FILENAME_FORMAT=None)
-    def testDeleteMacFiles(self):
+    def testDeleteMacFiles(self) -> None:
         # https://github.com/jonaswinkler/paperless-ng/discussions/1037
 
         filename = self.get_test_file()
@@ -272,7 +272,7 @@ class TestConsumer(
         self.assertIsNotFile(shadow_file)
         self.assertIsNotFile(filename)
 
-    def testOverrideFilename(self):
+    def testOverrideFilename(self) -> None:
         filename = self.get_test_file()
         override_filename = "Statement for November.pdf"
 
@@ -290,7 +290,7 @@ class TestConsumer(
 
         self._assert_first_last_send_progress()
 
-    def testOverrideTitle(self):
+    def testOverrideTitle(self) -> None:
         with self.get_consumer(
             self.get_test_file(),
             DocumentMetadataOverrides(title="Override Title"),
@@ -304,7 +304,7 @@ class TestConsumer(
         self.assertEqual(document.title, "Override Title")
         self._assert_first_last_send_progress()
 
-    def testOverrideCorrespondent(self):
+    def testOverrideCorrespondent(self) -> None:
         c = Correspondent.objects.create(name="test")
 
         with self.get_consumer(
@@ -320,7 +320,7 @@ class TestConsumer(
         self.assertEqual(document.correspondent.id, c.id)
         self._assert_first_last_send_progress()
 
-    def testOverrideDocumentType(self):
+    def testOverrideDocumentType(self) -> None:
         dt = DocumentType.objects.create(name="test")
 
         with self.get_consumer(
@@ -334,7 +334,7 @@ class TestConsumer(
         self.assertEqual(document.document_type.id, dt.id)
         self._assert_first_last_send_progress()
 
-    def testOverrideStoragePath(self):
+    def testOverrideStoragePath(self) -> None:
         sp = StoragePath.objects.create(name="test")
 
         with self.get_consumer(
@@ -348,7 +348,7 @@ class TestConsumer(
         self.assertEqual(document.storage_path.id, sp.id)
         self._assert_first_last_send_progress()
 
-    def testOverrideTags(self):
+    def testOverrideTags(self) -> None:
         t1 = Tag.objects.create(name="t1")
         t2 = Tag.objects.create(name="t2")
         t3 = Tag.objects.create(name="t3")
@@ -366,7 +366,7 @@ class TestConsumer(
         self.assertIn(t3, document.tags.all())
         self._assert_first_last_send_progress()
 
-    def testOverrideCustomFields(self):
+    def testOverrideCustomFields(self) -> None:
         cf1 = CustomField.objects.create(name="Custom Field 1", data_type="string")
         cf2 = CustomField.objects.create(
             name="Custom Field 2",
@@ -400,7 +400,7 @@ class TestConsumer(
         )
         self._assert_first_last_send_progress()
 
-    def testOverrideAsn(self):
+    def testOverrideAsn(self) -> None:
         with self.get_consumer(
             self.get_test_file(),
             DocumentMetadataOverrides(asn=123),
@@ -412,7 +412,7 @@ class TestConsumer(
         self.assertEqual(document.archive_serial_number, 123)
         self._assert_first_last_send_progress()
 
-    def testMetadataOverridesSkipAsnPropagation(self):
+    def testMetadataOverridesSkipAsnPropagation(self) -> None:
         overrides = DocumentMetadataOverrides()
         incoming = DocumentMetadataOverrides(skip_asn=True)
 
@@ -420,7 +420,7 @@ class TestConsumer(
 
         self.assertTrue(overrides.skip_asn)
 
-    def testOverrideTitlePlaceholders(self):
+    def testOverrideTitlePlaceholders(self) -> None:
         c = Correspondent.objects.create(name="Correspondent Name")
         dt = DocumentType.objects.create(name="DocType Name")
 
@@ -440,7 +440,7 @@ class TestConsumer(
         self.assertEqual(document.title, f"{c.name}{dt.name} {now.strftime('%m-%y')}")
         self._assert_first_last_send_progress()
 
-    def testOverrideOwner(self):
+    def testOverrideOwner(self) -> None:
         testuser = User.objects.create(username="testuser")
 
         with self.get_consumer(
@@ -454,7 +454,7 @@ class TestConsumer(
         self.assertEqual(document.owner, testuser)
         self._assert_first_last_send_progress()
 
-    def testOverridePermissions(self):
+    def testOverridePermissions(self) -> None:
         testuser = User.objects.create(username="testuser")
         testgroup = Group.objects.create(name="testgroup")
 
@@ -475,13 +475,13 @@ class TestConsumer(
         self.assertTrue(group_checker.has_perm("view_document", document))
         self._assert_first_last_send_progress()
 
-    def testNotAFile(self):
+    def testNotAFile(self) -> None:
         with self.assertRaisesMessage(ConsumerError, "File not found"):
             with self.get_consumer(Path("non-existing-file")) as consumer:
                 consumer.run()
         self._assert_first_last_send_progress(last_status="FAILED")
 
-    def testDuplicates1(self):
+    def testDuplicates1(self) -> None:
         with self.get_consumer(self.get_test_file()) as consumer:
             consumer.run()
 
@@ -491,7 +491,7 @@ class TestConsumer(
         self.assertEqual(Document.objects.count(), 2)
         self._assert_first_last_send_progress()
 
-    def testDuplicates2(self):
+    def testDuplicates2(self) -> None:
         with self.get_consumer(self.get_test_file()) as consumer:
             consumer.run()
 
@@ -501,13 +501,13 @@ class TestConsumer(
         self.assertEqual(Document.objects.count(), 2)
         self._assert_first_last_send_progress()
 
-    def testDuplicates3(self):
+    def testDuplicates3(self) -> None:
         with self.get_consumer(self.get_test_archive_file()) as consumer:
             consumer.run()
         with self.get_consumer(self.get_test_file()) as consumer:
             consumer.run()
 
-    def testDuplicateInTrash(self):
+    def testDuplicateInTrash(self) -> None:
         with self.get_consumer(self.get_test_file()) as consumer:
             consumer.run()
 
@@ -518,7 +518,7 @@ class TestConsumer(
 
         self.assertEqual(Document.objects.count(), 1)
 
-    def testAsnExists(self):
+    def testAsnExists(self) -> None:
         with self.get_consumer(
             self.get_test_file(),
             DocumentMetadataOverrides(asn=123),
@@ -532,7 +532,7 @@ class TestConsumer(
             ) as consumer:
                 consumer.run()
 
-    def testAsnExistsInTrash(self):
+    def testAsnExistsInTrash(self) -> None:
         with self.get_consumer(
             self.get_test_file(),
             DocumentMetadataOverrides(asn=123),
@@ -550,7 +550,7 @@ class TestConsumer(
                 consumer.run()
 
     @mock.patch("documents.parsers.document_consumer_declaration.send")
-    def testNoParsers(self, m):
+    def testNoParsers(self, m) -> None:
         m.return_value = []
 
         with self.assertRaisesMessage(
@@ -563,7 +563,7 @@ class TestConsumer(
         self._assert_first_last_send_progress(last_status="FAILED")
 
     @mock.patch("documents.parsers.document_consumer_declaration.send")
-    def testFaultyParser(self, m):
+    def testFaultyParser(self, m) -> None:
         m.return_value = [
             (
                 None,
@@ -585,7 +585,7 @@ class TestConsumer(
         self._assert_first_last_send_progress(last_status="FAILED")
 
     @mock.patch("documents.parsers.document_consumer_declaration.send")
-    def testGenericParserException(self, m):
+    def testGenericParserException(self, m) -> None:
         m.return_value = [
             (
                 None,
@@ -607,7 +607,7 @@ class TestConsumer(
         self._assert_first_last_send_progress(last_status="FAILED")
 
     @mock.patch("documents.consumer.ConsumerPlugin._write")
-    def testPostSaveError(self, m):
+    def testPostSaveError(self, m) -> None:
         filename = self.get_test_file()
         m.side_effect = OSError("NO.")
 
@@ -627,7 +627,7 @@ class TestConsumer(
         self.assertEqual(Document.objects.all().count(), 0)
 
     @override_settings(FILENAME_FORMAT="{correspondent}/{title}")
-    def testFilenameHandling(self):
+    def testFilenameHandling(self) -> None:
         with self.get_consumer(
             self.get_test_file(),
             DocumentMetadataOverrides(title="new docs"),
@@ -644,7 +644,7 @@ class TestConsumer(
 
     @override_settings(FILENAME_FORMAT="{correspondent}/{title}")
     @mock.patch("documents.signals.handlers.generate_unique_filename")
-    def testFilenameHandlingUnstableFormat(self, m):
+    def testFilenameHandlingUnstableFormat(self, m) -> None:
         filenames = ["this", "that", "now this", "i cannot decide"]
 
         def get_filename():
@@ -672,7 +672,7 @@ class TestConsumer(
         self._assert_first_last_send_progress()
 
     @mock.patch("documents.consumer.load_classifier")
-    def testClassifyDocument(self, m):
+    def testClassifyDocument(self, m) -> None:
         correspondent = Correspondent.objects.create(
             name="test",
             matching_algorithm=Correspondent.MATCH_AUTO,
@@ -702,7 +702,7 @@ class TestConsumer(
         self._assert_first_last_send_progress()
 
     @override_settings(CONSUMER_DELETE_DUPLICATES=True)
-    def test_delete_duplicate(self):
+    def test_delete_duplicate(self) -> None:
         dst = self.get_test_file()
         self.assertIsFile(dst)
 
@@ -733,7 +733,7 @@ class TestConsumer(
         self._assert_first_last_send_progress(last_status=ProgressStatusOptions.FAILED)
 
     @override_settings(CONSUMER_DELETE_DUPLICATES=True)
-    def test_delete_duplicate_in_trash(self):
+    def test_delete_duplicate_in_trash(self) -> None:
         dst = self.get_test_file()
         with self.get_consumer(dst) as consumer:
             consumer.run()
@@ -760,7 +760,7 @@ class TestConsumer(
         self.assertEqual(Document.objects.count(), 0)
 
     @override_settings(CONSUMER_DELETE_DUPLICATES=False)
-    def test_no_delete_duplicate(self):
+    def test_no_delete_duplicate(self) -> None:
         dst = self.get_test_file()
         self.assertIsFile(dst)
 
@@ -786,7 +786,7 @@ class TestConsumer(
 
     @override_settings(FILENAME_FORMAT="{title}")
     @mock.patch("documents.parsers.document_consumer_declaration.send")
-    def test_similar_filenames(self, m):
+    def test_similar_filenames(self, m) -> None:
         shutil.copy(
             Path(__file__).parent / "samples" / "simple.pdf",
             settings.CONSUMPTION_DIR / "simple.pdf",
@@ -837,7 +837,7 @@ class TestConsumer(
         sanity_check()
 
     @mock.patch("documents.consumer.run_subprocess")
-    def test_try_to_clean_invalid_pdf(self, m):
+    def test_try_to_clean_invalid_pdf(self, m) -> None:
         shutil.copy(
             Path(__file__).parent / "samples" / "invalid_pdf.pdf",
             settings.CONSUMPTION_DIR / "invalid_pdf.pdf",
@@ -865,7 +865,7 @@ class TestConsumer(
         mock_consumer_declaration_send: mock.Mock,
         mock_mail_parser_parse: mock.Mock,
         mock_mailrule_get: mock.Mock,
-    ):
+    ) -> None:
         """
         GIVEN:
             - A mail document from a mail rule
@@ -913,10 +913,10 @@ class TestConsumer(
 
 @mock.patch("documents.consumer.magic.from_file", fake_magic_from_file)
 class TestConsumerCreatedDate(DirectoriesMixin, GetConsumerMixin, TestCase):
-    def setUp(self):
+    def setUp(self) -> None:
         super().setUp()
 
-    def test_consume_date_from_content(self):
+    def test_consume_date_from_content(self) -> None:
         """
         GIVEN:
             - File content with date in DMY (default) format
@@ -945,7 +945,7 @@ class TestConsumerCreatedDate(DirectoriesMixin, GetConsumerMixin, TestCase):
         )
 
     @override_settings(FILENAME_DATE_ORDER="YMD")
-    def test_consume_date_from_filename(self):
+    def test_consume_date_from_filename(self) -> None:
         """
         GIVEN:
             - File content with date in DMY (default) format
@@ -974,7 +974,7 @@ class TestConsumerCreatedDate(DirectoriesMixin, GetConsumerMixin, TestCase):
             datetime.date(2022, 2, 1),
         )
 
-    def test_consume_date_filename_date_use_content(self):
+    def test_consume_date_filename_date_use_content(self) -> None:
         """
         GIVEN:
             - File content with date in DMY (default) format
@@ -1007,7 +1007,7 @@ class TestConsumerCreatedDate(DirectoriesMixin, GetConsumerMixin, TestCase):
     @override_settings(
         IGNORE_DATES=(datetime.date(2010, 12, 13), datetime.date(2011, 11, 12)),
     )
-    def test_consume_date_use_content_with_ignore(self):
+    def test_consume_date_use_content_with_ignore(self) -> None:
         """
         GIVEN:
             - File content with dates in DMY (default) format
@@ -1052,20 +1052,20 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
 
     @mock.patch("documents.consumer.run_subprocess")
     @override_settings(PRE_CONSUME_SCRIPT=None)
-    def test_no_pre_consume_script(self, m):
+    def test_no_pre_consume_script(self, m) -> None:
         with self.get_consumer(self.test_file) as c:
             c.run()
             m.assert_not_called()
 
     @mock.patch("documents.consumer.run_subprocess")
     @override_settings(PRE_CONSUME_SCRIPT="does-not-exist")
-    def test_pre_consume_script_not_found(self, m):
+    def test_pre_consume_script_not_found(self, m) -> None:
         with self.get_consumer(self.test_file) as c:
             self.assertRaises(ConsumerError, c.run)
             m.assert_not_called()
 
     @mock.patch("documents.consumer.run_subprocess")
-    def test_pre_consume_script(self, m):
+    def test_pre_consume_script(self, m) -> None:
         with tempfile.NamedTemporaryFile() as script:
             with override_settings(PRE_CONSUME_SCRIPT=script.name):
                 with self.get_consumer(self.test_file) as c:
@@ -1088,7 +1088,7 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
                     }
                     self.assertDictEqual(environment, {**environment, **subset})
 
-    def test_script_with_output(self):
+    def test_script_with_output(self) -> None:
         """
         GIVEN:
             - A script which outputs to stdout and stderr
@@ -1121,7 +1121,7 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
                         cm.output,
                     )
 
-    def test_script_exit_non_zero(self):
+    def test_script_exit_non_zero(self) -> None:
         """
         GIVEN:
             - A script which exits with a non-zero exit code
@@ -1163,7 +1163,7 @@ class PostConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
 
     @mock.patch("documents.consumer.run_subprocess")
     @override_settings(POST_CONSUME_SCRIPT=None)
-    def test_no_post_consume_script(self, m):
+    def test_no_post_consume_script(self, m) -> None:
         doc = Document.objects.create(title="Test", mime_type="application/pdf")
         tag1 = Tag.objects.create(name="a")
         tag2 = Tag.objects.create(name="b")
@@ -1175,7 +1175,7 @@ class PostConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
         m.assert_not_called()
 
     @override_settings(POST_CONSUME_SCRIPT="does-not-exist")
-    def test_post_consume_script_not_found(self):
+    def test_post_consume_script_not_found(self) -> None:
         doc = Document.objects.create(title="Test", mime_type="application/pdf")
 
         with self.get_consumer(self.test_file) as consumer:
@@ -1186,7 +1186,7 @@ class PostConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
                 consumer.run_post_consume_script(doc)
 
     @mock.patch("documents.consumer.run_subprocess")
-    def test_post_consume_script_simple(self, m):
+    def test_post_consume_script_simple(self, m) -> None:
         with tempfile.NamedTemporaryFile() as script:
             with override_settings(POST_CONSUME_SCRIPT=script.name):
                 doc = Document.objects.create(title="Test", mime_type="application/pdf")
@@ -1197,7 +1197,7 @@ class PostConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
                 m.assert_called_once()
 
     @mock.patch("documents.consumer.run_subprocess")
-    def test_post_consume_script_with_correspondent_and_type(self, m):
+    def test_post_consume_script_with_correspondent_and_type(self, m) -> None:
         with tempfile.NamedTemporaryFile() as script:
             with override_settings(POST_CONSUME_SCRIPT=script.name):
                 c = Correspondent.objects.create(name="my_bank")
@@ -1244,7 +1244,7 @@ class PostConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
 
                 self.assertDictEqual(environment, {**environment, **subset})
 
-    def test_script_exit_non_zero(self):
+    def test_script_exit_non_zero(self) -> None:
         """
         GIVEN:
             - A script which exits with a non-zero exit code