From 8d60506884379438c983b6632192b27e06126f59 Mon Sep 17 00:00:00 2001 From: Trenton H <797416+stumpylog@users.noreply.github.com> Date: Sat, 23 Sep 2023 20:17:01 -0700 Subject: [PATCH] Standarizes the imports across all the files and modules (#4248) --- src/documents/__init__.py | 4 +- src/documents/admin.py | 20 +++--- src/documents/apps.py | 16 ++--- src/documents/consumer.py | 35 +++++------ src/documents/filters.py | 14 ++--- src/documents/serialisers.py | 27 ++++---- src/documents/tests/test_checks.py | 3 +- src/documents/tests/test_consumer.py | 3 +- src/documents/tests/test_models.py | 5 +- src/documents/views.py | 93 ++++++++++++++-------------- src/paperless/__init__.py | 8 +-- src/paperless_mail/signals.py | 2 +- src/paperless_tesseract/__init__.py | 4 +- src/paperless_tesseract/signals.py | 2 +- src/paperless_text/signals.py | 2 +- src/paperless_tika/signals.py | 2 +- 16 files changed, 117 insertions(+), 123 deletions(-) diff --git a/src/documents/__init__.py b/src/documents/__init__.py index dc94f2bdd..dd8c76d19 100644 --- a/src/documents/__init__.py +++ b/src/documents/__init__.py @@ -1,5 +1,5 @@ # this is here so that django finds the checks. -from .checks import changed_password_check -from .checks import parser_check +from documents.checks import changed_password_check +from documents.checks import parser_check __all__ = ["changed_password_check", "parser_check"] diff --git a/src/documents/admin.py b/src/documents/admin.py index 096dea528..a190f8d1e 100644 --- a/src/documents/admin.py +++ b/src/documents/admin.py @@ -1,16 +1,16 @@ from django.contrib import admin from guardian.admin import GuardedModelAdmin -from .models import Correspondent -from .models import Document -from .models import DocumentType -from .models import Note -from .models import PaperlessTask -from .models import SavedView -from .models import SavedViewFilterRule -from .models import ShareLink -from .models import StoragePath -from .models import Tag +from documents.models import Correspondent +from documents.models import Document +from documents.models import DocumentType +from documents.models import Note +from documents.models import PaperlessTask +from documents.models import SavedView +from documents.models import SavedViewFilterRule +from documents.models import ShareLink +from documents.models import StoragePath +from documents.models import Tag class CorrespondentAdmin(GuardedModelAdmin): diff --git a/src/documents/apps.py b/src/documents/apps.py index edec7246c..d681b9a87 100644 --- a/src/documents/apps.py +++ b/src/documents/apps.py @@ -8,14 +8,14 @@ class DocumentsConfig(AppConfig): verbose_name = _("Documents") def ready(self): - from .signals import document_consumption_finished - from .signals.handlers import add_inbox_tags - from .signals.handlers import add_to_index - from .signals.handlers import set_correspondent - from .signals.handlers import set_document_type - from .signals.handlers import set_log_entry - from .signals.handlers import set_storage_path - from .signals.handlers import set_tags + from documents.signals import document_consumption_finished + from documents.signals.handlers import add_inbox_tags + from documents.signals.handlers import add_to_index + from documents.signals.handlers import set_correspondent + from documents.signals.handlers import set_document_type + from documents.signals.handlers import set_log_entry + from documents.signals.handlers import set_storage_path + from documents.signals.handlers import set_tags document_consumption_finished.connect(add_inbox_tags) document_consumption_finished.connect(set_correspondent) diff --git a/src/documents/consumer.py b/src/documents/consumer.py index e618f0bb8..1c37ce1a3 100644 --- a/src/documents/consumer.py +++ b/src/documents/consumer.py @@ -20,31 +20,30 @@ from django.utils import timezone from filelock import FileLock from rest_framework.reverse import reverse +from documents.classifier import load_classifier from documents.data_models import ConsumableDocument from documents.data_models import DocumentMetadataOverrides +from documents.file_handling import create_source_path_directory +from documents.file_handling import generate_unique_filename +from documents.loggers import LoggingMixin from documents.matching import document_matches_template +from documents.models import ConsumptionTemplate +from documents.models import Correspondent +from documents.models import Document +from documents.models import DocumentType +from documents.models import FileInfo +from documents.models import StoragePath +from documents.models import Tag +from documents.parsers import DocumentParser +from documents.parsers import ParseError +from documents.parsers import get_parser_class_for_mime_type +from documents.parsers import parse_date from documents.permissions import set_permissions_for_object +from documents.signals import document_consumption_finished +from documents.signals import document_consumption_started from documents.utils import copy_basic_file_stats from documents.utils import copy_file_with_basic_stats -from .classifier import load_classifier -from .file_handling import create_source_path_directory -from .file_handling import generate_unique_filename -from .loggers import LoggingMixin -from .models import ConsumptionTemplate -from .models import Correspondent -from .models import Document -from .models import DocumentType -from .models import FileInfo -from .models import StoragePath -from .models import Tag -from .parsers import DocumentParser -from .parsers import ParseError -from .parsers import get_parser_class_for_mime_type -from .parsers import parse_date -from .signals import document_consumption_finished -from .signals import document_consumption_started - class ConsumerError(Exception): pass diff --git a/src/documents/filters.py b/src/documents/filters.py index e700ef867..2d4cdf825 100644 --- a/src/documents/filters.py +++ b/src/documents/filters.py @@ -4,13 +4,13 @@ from django_filters.rest_framework import Filter from django_filters.rest_framework import FilterSet from rest_framework_guardian.filters import ObjectPermissionsFilter -from .models import Correspondent -from .models import Document -from .models import DocumentType -from .models import Log -from .models import ShareLink -from .models import StoragePath -from .models import Tag +from documents.models import Correspondent +from documents.models import Document +from documents.models import DocumentType +from documents.models import Log +from documents.models import ShareLink +from documents.models import StoragePath +from documents.models import Tag CHAR_KWARGS = ["istartswith", "iendswith", "icontains", "iexact"] ID_KWARGS = ["in", "exact"] diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 00fc4b73b..6f20a4cf0 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -17,25 +17,24 @@ from rest_framework import fields from rest_framework import serializers from rest_framework.fields import SerializerMethodField +from documents import bulk_edit from documents.data_models import DocumentSource from documents.models import ConsumptionTemplate +from documents.models import Correspondent +from documents.models import Document +from documents.models import DocumentType +from documents.models import MatchingModel +from documents.models import PaperlessTask +from documents.models import SavedView +from documents.models import SavedViewFilterRule +from documents.models import ShareLink +from documents.models import StoragePath +from documents.models import Tag +from documents.models import UiSettings +from documents.parsers import is_mime_type_supported from documents.permissions import get_groups_with_only_permission from documents.permissions import set_permissions_for_object -from . import bulk_edit -from .models import Correspondent -from .models import Document -from .models import DocumentType -from .models import MatchingModel -from .models import PaperlessTask -from .models import SavedView -from .models import SavedViewFilterRule -from .models import ShareLink -from .models import StoragePath -from .models import Tag -from .models import UiSettings -from .parsers import is_mime_type_supported - # https://www.django-rest-framework.org/api-guide/serializers/#example class DynamicFieldsModelSerializer(serializers.ModelSerializer): diff --git a/src/documents/tests/test_checks.py b/src/documents/tests/test_checks.py index 07af596bb..321490396 100644 --- a/src/documents/tests/test_checks.py +++ b/src/documents/tests/test_checks.py @@ -8,8 +8,7 @@ from django.test import override_settings from documents.checks import changed_password_check from documents.checks import parser_check from documents.models import Document - -from .factories import DocumentFactory +from documents.tests.factories import DocumentFactory class TestDocumentChecks(TestCase): diff --git a/src/documents/tests/test_consumer.py b/src/documents/tests/test_consumer.py index 7a4515018..831dbcc3a 100644 --- a/src/documents/tests/test_consumer.py +++ b/src/documents/tests/test_consumer.py @@ -30,10 +30,9 @@ from documents.models import Tag from documents.parsers import DocumentParser from documents.parsers import ParseError from documents.tasks import sanity_check +from documents.tests.utils import DirectoriesMixin from documents.tests.utils import FileSystemAssertsMixin -from .utils import DirectoriesMixin - class TestAttributes(TestCase): TAGS = ("tag1", "tag2", "tag3") diff --git a/src/documents/tests/test_models.py b/src/documents/tests/test_models.py index f41214a65..1c99be3f7 100644 --- a/src/documents/tests/test_models.py +++ b/src/documents/tests/test_models.py @@ -2,9 +2,8 @@ from django.test import TestCase from documents.models import Correspondent from documents.models import Document - -from .factories import CorrespondentFactory -from .factories import DocumentFactory +from documents.tests.factories import CorrespondentFactory +from documents.tests.factories import DocumentFactory class CorrespondentTestCase(TestCase): diff --git a/src/documents/views.py b/src/documents/views.py index 3353a3272..e572527f6 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -58,64 +58,63 @@ from rest_framework.viewsets import ReadOnlyModelViewSet from rest_framework.viewsets import ViewSet from documents import bulk_edit +from documents.bulk_download import ArchiveOnlyStrategy +from documents.bulk_download import OriginalAndArchiveStrategy +from documents.bulk_download import OriginalsOnlyStrategy +from documents.classifier import load_classifier +from documents.data_models import ConsumableDocument +from documents.data_models import DocumentMetadataOverrides +from documents.data_models import DocumentSource +from documents.filters import CorrespondentFilterSet +from documents.filters import DocumentFilterSet +from documents.filters import DocumentTypeFilterSet from documents.filters import ObjectOwnedOrGrantedPermissionsFilter +from documents.filters import ShareLinkFilterSet +from documents.filters import StoragePathFilterSet +from documents.filters import TagFilterSet +from documents.matching import match_correspondents +from documents.matching import match_document_types +from documents.matching import match_storage_paths +from documents.matching import match_tags +from documents.models import ConsumptionTemplate +from documents.models import Correspondent +from documents.models import Document +from documents.models import DocumentType +from documents.models import Note +from documents.models import PaperlessTask +from documents.models import SavedView +from documents.models import ShareLink +from documents.models import StoragePath +from documents.models import Tag +from documents.parsers import get_parser_class_for_mime_type +from documents.parsers import parse_date_generator from documents.permissions import PaperlessAdminPermissions from documents.permissions import PaperlessObjectPermissions from documents.permissions import get_objects_for_user_owner_aware from documents.permissions import has_perms_owner_aware from documents.permissions import set_permissions_for_object +from documents.serialisers import AcknowledgeTasksViewSerializer +from documents.serialisers import BulkDownloadSerializer +from documents.serialisers import BulkEditObjectPermissionsSerializer +from documents.serialisers import BulkEditSerializer +from documents.serialisers import ConsumptionTemplateSerializer +from documents.serialisers import CorrespondentSerializer +from documents.serialisers import DocumentListSerializer +from documents.serialisers import DocumentSerializer +from documents.serialisers import DocumentTypeSerializer +from documents.serialisers import PostDocumentSerializer +from documents.serialisers import SavedViewSerializer +from documents.serialisers import ShareLinkSerializer +from documents.serialisers import StoragePathSerializer +from documents.serialisers import TagSerializer +from documents.serialisers import TagSerializerVersion1 +from documents.serialisers import TasksViewSerializer +from documents.serialisers import UiSettingsViewSerializer from documents.tasks import consume_file from paperless import version from paperless.db import GnuPG from paperless.views import StandardPagination -from .bulk_download import ArchiveOnlyStrategy -from .bulk_download import OriginalAndArchiveStrategy -from .bulk_download import OriginalsOnlyStrategy -from .classifier import load_classifier -from .data_models import ConsumableDocument -from .data_models import DocumentMetadataOverrides -from .data_models import DocumentSource -from .filters import CorrespondentFilterSet -from .filters import DocumentFilterSet -from .filters import DocumentTypeFilterSet -from .filters import ShareLinkFilterSet -from .filters import StoragePathFilterSet -from .filters import TagFilterSet -from .matching import match_correspondents -from .matching import match_document_types -from .matching import match_storage_paths -from .matching import match_tags -from .models import ConsumptionTemplate -from .models import Correspondent -from .models import Document -from .models import DocumentType -from .models import Note -from .models import PaperlessTask -from .models import SavedView -from .models import ShareLink -from .models import StoragePath -from .models import Tag -from .parsers import get_parser_class_for_mime_type -from .parsers import parse_date_generator -from .serialisers import AcknowledgeTasksViewSerializer -from .serialisers import BulkDownloadSerializer -from .serialisers import BulkEditObjectPermissionsSerializer -from .serialisers import BulkEditSerializer -from .serialisers import ConsumptionTemplateSerializer -from .serialisers import CorrespondentSerializer -from .serialisers import DocumentListSerializer -from .serialisers import DocumentSerializer -from .serialisers import DocumentTypeSerializer -from .serialisers import PostDocumentSerializer -from .serialisers import SavedViewSerializer -from .serialisers import ShareLinkSerializer -from .serialisers import StoragePathSerializer -from .serialisers import TagSerializer -from .serialisers import TagSerializerVersion1 -from .serialisers import TasksViewSerializer -from .serialisers import UiSettingsViewSerializer - logger = logging.getLogger("paperless.api") diff --git a/src/paperless/__init__.py b/src/paperless/__init__.py index 3635cbe9d..36e448bee 100644 --- a/src/paperless/__init__.py +++ b/src/paperless/__init__.py @@ -1,7 +1,7 @@ -from .celery import app as celery_app -from .checks import binaries_check -from .checks import paths_check -from .checks import settings_values_check +from paperless.celery import app as celery_app +from paperless.checks import binaries_check +from paperless.checks import paths_check +from paperless.checks import settings_values_check __all__ = [ "celery_app", diff --git a/src/paperless_mail/signals.py b/src/paperless_mail/signals.py index c870335c6..4a1d82df6 100644 --- a/src/paperless_mail/signals.py +++ b/src/paperless_mail/signals.py @@ -1,5 +1,5 @@ def get_parser(*args, **kwargs): - from .parsers import MailDocumentParser + from paperless_mail.parsers import MailDocumentParser return MailDocumentParser(*args, **kwargs) diff --git a/src/paperless_tesseract/__init__.py b/src/paperless_tesseract/__init__.py index 1e857428c..9976fb403 100644 --- a/src/paperless_tesseract/__init__.py +++ b/src/paperless_tesseract/__init__.py @@ -1,5 +1,5 @@ # this is here so that django finds the checks. -from .checks import check_default_language_available -from .checks import get_tesseract_langs +from paperless_tesseract.checks import check_default_language_available +from paperless_tesseract.checks import get_tesseract_langs __all__ = ["get_tesseract_langs", "check_default_language_available"] diff --git a/src/paperless_tesseract/signals.py b/src/paperless_tesseract/signals.py index c4fd1e039..7d6f6902f 100644 --- a/src/paperless_tesseract/signals.py +++ b/src/paperless_tesseract/signals.py @@ -1,5 +1,5 @@ def get_parser(*args, **kwargs): - from .parsers import RasterisedDocumentParser + from paperless_tesseract.parsers import RasterisedDocumentParser return RasterisedDocumentParser(*args, **kwargs) diff --git a/src/paperless_text/signals.py b/src/paperless_text/signals.py index 94d1ccc2e..05804c6d6 100644 --- a/src/paperless_text/signals.py +++ b/src/paperless_text/signals.py @@ -1,5 +1,5 @@ def get_parser(*args, **kwargs): - from .parsers import TextDocumentParser + from paperless_text.parsers import TextDocumentParser return TextDocumentParser(*args, **kwargs) diff --git a/src/paperless_tika/signals.py b/src/paperless_tika/signals.py index 39838f076..24219b80a 100644 --- a/src/paperless_tika/signals.py +++ b/src/paperless_tika/signals.py @@ -1,5 +1,5 @@ def get_parser(*args, **kwargs): - from .parsers import TikaDocumentParser + from paperless_tika.parsers import TikaDocumentParser return TikaDocumentParser(*args, **kwargs)