amorfo77/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2026-08-02 17:12:18 +00:00
Code Issues 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 08:44:12 -08: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
src/documents/tests/test_tasks.py
+20 -20
View File
@@ -23,7 +23,7 @@ from documents.tests.utils import FileSystemAssertsMixin
class TestIndexReindex(DirectoriesMixin, TestCase):
def test_index_reindex(self):
def test_index_reindex(self) -> None:
Document.objects.create(
title="test",
content="my document",
@@ -35,7 +35,7 @@ class TestIndexReindex(DirectoriesMixin, TestCase):
tasks.index_reindex()
def test_index_optimize(self):
def test_index_optimize(self) -> None:
Document.objects.create(
title="test",
content="my document",
@@ -50,12 +50,12 @@ class TestIndexReindex(DirectoriesMixin, TestCase):
class TestClassifier(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
@mock.patch("documents.tasks.load_classifier")
def test_train_classifier_no_auto_matching(self, load_classifier):
def test_train_classifier_no_auto_matching(self, load_classifier) -> None:
tasks.train_classifier()
load_classifier.assert_not_called()
@mock.patch("documents.tasks.load_classifier")
def test_train_classifier_with_auto_tag(self, load_classifier):
def test_train_classifier_with_auto_tag(self, load_classifier) -> None:
load_classifier.return_value = None
Tag.objects.create(matching_algorithm=Tag.MATCH_AUTO, name="test")
tasks.train_classifier()
@@ -63,7 +63,7 @@ class TestClassifier(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
self.assertIsNotFile(settings.MODEL_FILE)
@mock.patch("documents.tasks.load_classifier")
def test_train_classifier_with_auto_type(self, load_classifier):
def test_train_classifier_with_auto_type(self, load_classifier) -> None:
load_classifier.return_value = None
DocumentType.objects.create(matching_algorithm=Tag.MATCH_AUTO, name="test")
tasks.train_classifier()
@@ -71,14 +71,14 @@ class TestClassifier(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
self.assertIsNotFile(settings.MODEL_FILE)
@mock.patch("documents.tasks.load_classifier")
def test_train_classifier_with_auto_correspondent(self, load_classifier):
def test_train_classifier_with_auto_correspondent(self, load_classifier) -> None:
load_classifier.return_value = None
Correspondent.objects.create(matching_algorithm=Tag.MATCH_AUTO, name="test")
tasks.train_classifier()
load_classifier.assert_called_once()
self.assertIsNotFile(settings.MODEL_FILE)
def test_train_classifier(self):
def test_train_classifier(self) -> None:
c = Correspondent.objects.create(matching_algorithm=Tag.MATCH_AUTO, name="test")
doc = Document.objects.create(correspondent=c, content="test", title="test")
self.assertIsNotFile(settings.MODEL_FILE)
@@ -107,13 +107,13 @@ class TestClassifier(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
class TestSanityCheck(DirectoriesMixin, TestCase):
@mock.patch("documents.tasks.sanity_checker.check_sanity")
def test_sanity_check_success(self, m):
def test_sanity_check_success(self, m) -> None:
m.return_value = SanityCheckMessages()
self.assertEqual(tasks.sanity_check(), "No issues detected.")
m.assert_called_once()
@mock.patch("documents.tasks.sanity_checker.check_sanity")
def test_sanity_check_error(self, m):
def test_sanity_check_error(self, m) -> None:
messages = SanityCheckMessages()
messages.error(None, "Some error")
m.return_value = messages
@@ -121,7 +121,7 @@ class TestSanityCheck(DirectoriesMixin, TestCase):
m.assert_called_once()
@mock.patch("documents.tasks.sanity_checker.check_sanity")
def test_sanity_check_error_no_raise(self, m):
def test_sanity_check_error_no_raise(self, m) -> None:
messages = SanityCheckMessages()
messages.error(None, "Some error")
m.return_value = messages
@@ -134,7 +134,7 @@ class TestSanityCheck(DirectoriesMixin, TestCase):
m.assert_called_once()
@mock.patch("documents.tasks.sanity_checker.check_sanity")
def test_sanity_check_warning(self, m):
def test_sanity_check_warning(self, m) -> None:
messages = SanityCheckMessages()
messages.warning(None, "Some warning")
m.return_value = messages
@@ -145,7 +145,7 @@ class TestSanityCheck(DirectoriesMixin, TestCase):
m.assert_called_once()
@mock.patch("documents.tasks.sanity_checker.check_sanity")
def test_sanity_check_info(self, m):
def test_sanity_check_info(self, m) -> None:
messages = SanityCheckMessages()
messages.info(None, "Some info")
m.return_value = messages
@@ -157,7 +157,7 @@ class TestSanityCheck(DirectoriesMixin, TestCase):
class TestBulkUpdate(DirectoriesMixin, TestCase):
def test_bulk_update_documents(self):
def test_bulk_update_documents(self) -> None:
doc1 = Document.objects.create(
title="test",
content="my document",
@@ -180,7 +180,7 @@ class TestEmptyTrashTask(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
- Document is only deleted if it has been in trash for more than delay (default 30 days)
"""
def test_empty_trash(self):
def test_empty_trash(self) -> None:
doc = Document.objects.create(
title="test",
content="my document",
@@ -204,7 +204,7 @@ class TestEmptyTrashTask(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
class TestUpdateContent(DirectoriesMixin, TestCase):
def test_update_content_maybe_archive_file(self):
def test_update_content_maybe_archive_file(self) -> None:
"""
GIVEN:
- Existing document with archive file
@@ -245,7 +245,7 @@ class TestUpdateContent(DirectoriesMixin, TestCase):
self.assertNotEqual(Document.objects.get(pk=doc.pk).content, "test")
self.assertNotEqual(Document.objects.get(pk=doc.pk).archive_checksum, "wow")
def test_update_content_maybe_archive_file_no_archive(self):
def test_update_content_maybe_archive_file_no_archive(self) -> None:
"""
GIVEN:
- Existing document without archive file
@@ -280,7 +280,7 @@ class TestAIIndex(DirectoriesMixin, TestCase):
AI_ENABLED=True,
LLM_EMBEDDING_BACKEND="huggingface",
)
def test_ai_index_success(self):
def test_ai_index_success(self) -> None:
"""
GIVEN:
- Document exists, AI is enabled, llm index backend is set
@@ -309,7 +309,7 @@ class TestAIIndex(DirectoriesMixin, TestCase):
AI_ENABLED=True,
LLM_EMBEDDING_BACKEND="huggingface",
)
def test_ai_index_failure(self):
def test_ai_index_failure(self) -> None:
"""
GIVEN:
- Document exists, AI is enabled, llm index backend is set
@@ -334,7 +334,7 @@ class TestAIIndex(DirectoriesMixin, TestCase):
self.assertEqual(task.status, states.FAILURE)
self.assertIn("LLM index update failed.", task.result)
def test_update_document_in_llm_index(self):
def test_update_document_in_llm_index(self) -> None:
"""
GIVEN:
- Nothing
@@ -354,7 +354,7 @@ class TestAIIndex(DirectoriesMixin, TestCase):
tasks.update_document_in_llm_index(doc)
llm_index_add_or_update_document.assert_called_once_with(doc)
def test_remove_document_from_llm_index(self):
def test_remove_document_from_llm_index(self) -> None:
"""
GIVEN:
- Nothing