paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-11-03 03:16:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixes a minor TODO in settings, and enables flake8 for settings.py

Browse Source
This commit is contained in:
Trenton Holmes
2022-09-01 10:35:33 -07:00
parent 55d36b39b1
commit 0bf9e55ca7
4 changed files with 25 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
src/paperless/settings.py
View File

@@ -285,7 +285,7 @@ SECRET_KEY = os.getenv(
AUTH_PASSWORD_VALIDATORS = [ AUTH_PASSWORD_VALIDATORS = [
{ {
"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", # noqa: E501
}, },
{ {
"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator", "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
@@ -445,13 +445,14 @@ LOGGING = {
TASK_WORKERS = __get_int("PAPERLESS_TASK_WORKERS", 1) TASK_WORKERS = __get_int("PAPERLESS_TASK_WORKERS", 1)
PAPERLESS_WORKER_TIMEOUT: Final[int] = __get_int("PAPERLESS_WORKER_TIMEOUT", 1800) WORKER_TIMEOUT: Final[int] = __get_int("PAPERLESS_WORKER_TIMEOUT", 1800)
# Per django-q docs, timeout must be smaller than retry # Per django-q docs, timeout must be smaller than retry
# We default retry to 10s more than the timeout # We default retry to 10s more than the timeout to silence the
PAPERLESS_WORKER_RETRY: Final[int] = __get_int( # warning, as retry functionality isn't used.
WORKER_RETRY: Final[int] = __get_int(
"PAPERLESS_WORKER_RETRY", "PAPERLESS_WORKER_RETRY",
PAPERLESS_WORKER_TIMEOUT + 10, WORKER_TIMEOUT + 10,
) )
Q_CLUSTER = { Q_CLUSTER = {
@@ -459,8 +460,8 @@ Q_CLUSTER = {
"guard_cycle": 5, "guard_cycle": 5,
"catch_up": False, "catch_up": False,
"recycle": 1, "recycle": 1,
"retry": PAPERLESS_WORKER_RETRY, "retry": WORKER_RETRY,
"timeout": PAPERLESS_WORKER_TIMEOUT, "timeout": WORKER_TIMEOUT,
"workers": TASK_WORKERS, "workers": TASK_WORKERS,
"redis": os.getenv("PAPERLESS_REDIS", "redis://localhost:6379"), "redis": os.getenv("PAPERLESS_REDIS", "redis://localhost:6379"),
"log_level": "DEBUG" if DEBUG else "INFO", "log_level": "DEBUG" if DEBUG else "INFO",
@@ -507,7 +508,7 @@ CONSUMER_IGNORE_PATTERNS = list(
json.loads( json.loads(
os.getenv( os.getenv(
"PAPERLESS_CONSUMER_IGNORE_PATTERNS", "PAPERLESS_CONSUMER_IGNORE_PATTERNS",
'[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini"]', '[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini"]', # noqa: E501
), ),
), ),
) )
@@ -589,7 +590,8 @@ DATE_ORDER = os.getenv("PAPERLESS_DATE_ORDER", "DMY")
FILENAME_DATE_ORDER = os.getenv("PAPERLESS_FILENAME_DATE_ORDER") FILENAME_DATE_ORDER = os.getenv("PAPERLESS_FILENAME_DATE_ORDER")
# Maximum number of dates taken from document start to end to show as suggestions for # Maximum number of dates taken from document start to end to show as suggestions for
# `created` date in the frontend. Duplicates are removed, which can result in fewer dates shown. # `created` date in the frontend. Duplicates are removed, which can result in
# fewer dates shown.
NUMBER_OF_SUGGESTED_DATES = __get_int("PAPERLESS_NUMBER_OF_SUGGESTED_DATES", 3) NUMBER_OF_SUGGESTED_DATES = __get_int("PAPERLESS_NUMBER_OF_SUGGESTED_DATES", 3)
# Transformations applied before filename parsing # Transformations applied before filename parsing
@@ -600,7 +602,8 @@ for t in json.loads(os.getenv("PAPERLESS_FILENAME_PARSE_TRANSFORMS", "[]")):
# Specify the filename format for out files # Specify the filename format for out files
FILENAME_FORMAT = os.getenv("PAPERLESS_FILENAME_FORMAT") FILENAME_FORMAT = os.getenv("PAPERLESS_FILENAME_FORMAT")
# If this is enabled, variables in filename format will resolve to empty-string instead of 'none'. # If this is enabled, variables in filename format will resolve to
# empty-string instead of 'none'.
# Directories with 'empty names' are omitted, too. # Directories with 'empty names' are omitted, too.
FILENAME_FORMAT_REMOVE_NONE = __get_boolean( FILENAME_FORMAT_REMOVE_NONE = __get_boolean(
"PAPERLESS_FILENAME_FORMAT_REMOVE_NONE", "PAPERLESS_FILENAME_FORMAT_REMOVE_NONE",
@@ -612,16 +615,15 @@ THUMBNAIL_FONT_NAME = os.getenv(
"/usr/share/fonts/liberation/LiberationSerif-Regular.ttf", "/usr/share/fonts/liberation/LiberationSerif-Regular.ttf",
) )
# TODO: this should not have a prefix.
# Tika settings # Tika settings
PAPERLESS_TIKA_ENABLED = __get_boolean("PAPERLESS_TIKA_ENABLED", "NO") TIKA_ENABLED = __get_boolean("PAPERLESS_TIKA_ENABLED", "NO")
PAPERLESS_TIKA_ENDPOINT = os.getenv("PAPERLESS_TIKA_ENDPOINT", "http://localhost:9998") TIKA_ENDPOINT = os.getenv("PAPERLESS_TIKA_ENDPOINT", "http://localhost:9998")
PAPERLESS_TIKA_GOTENBERG_ENDPOINT = os.getenv( TIKA_GOTENBERG_ENDPOINT = os.getenv(
"PAPERLESS_TIKA_GOTENBERG_ENDPOINT", "PAPERLESS_TIKA_GOTENBERG_ENDPOINT",
"http://localhost:3000", "http://localhost:3000",
) )
if PAPERLESS_TIKA_ENABLED: if TIKA_ENABLED:
INSTALLED_APPS.append("paperless_tika.apps.PaperlessTikaConfig") INSTALLED_APPS.append("paperless_tika.apps.PaperlessTikaConfig")
@@ -634,8 +636,9 @@ def _parse_ignore_dates(
user provided string(s) into dates user provided string(s) into dates
Args: Args:
env_ignore (str): The value of the environment variable, comma seperated dates env_ignore (str): The value of the environment variable, comma separated dates
date_order (str, optional): The format of the date strings. Defaults to DATE_ORDER. date_order (str, optional): The format of the date strings.
Defaults to DATE_ORDER.
Returns: Returns:
Set[datetime.datetime]: The set of parsed date objects Set[datetime.datetime]: The set of parsed date objects

2
src/paperless_tika/apps.py
View File

@@ -9,6 +9,6 @@ class PaperlessTikaConfig(AppConfig):
def ready(self): def ready(self):
from documents.signals import document_consumer_declaration from documents.signals import document_consumer_declaration
if settings.PAPERLESS_TIKA_ENABLED: if settings.TIKA_ENABLED:
document_consumer_declaration.connect(tika_consumer_declaration) document_consumer_declaration.connect(tika_consumer_declaration)
AppConfig.ready(self) AppConfig.ready(self)

6
src/paperless_tika/parsers.py
View File

@@ -27,7 +27,7 @@ class TikaDocumentParser(DocumentParser):
) )
def extract_metadata(self, document_path, mime_type): def extract_metadata(self, document_path, mime_type):
tika_server = settings.PAPERLESS_TIKA_ENDPOINT tika_server = settings.TIKA_ENDPOINT
try: try:
parsed = parser.from_file(document_path, tika_server) parsed = parser.from_file(document_path, tika_server)
except Exception as e: except Exception as e:
@@ -49,7 +49,7 @@ class TikaDocumentParser(DocumentParser):
def parse(self, document_path, mime_type, file_name=None): def parse(self, document_path, mime_type, file_name=None):
self.log("info", f"Sending {document_path} to Tika server") self.log("info", f"Sending {document_path} to Tika server")
tika_server = settings.PAPERLESS_TIKA_ENDPOINT tika_server = settings.TIKA_ENDPOINT
try: try:
parsed = parser.from_file(document_path, tika_server) parsed = parser.from_file(document_path, tika_server)
@@ -73,7 +73,7 @@ class TikaDocumentParser(DocumentParser):
def convert_to_pdf(self, document_path, file_name): def convert_to_pdf(self, document_path, file_name):
pdf_path = os.path.join(self.tempdir, "convert.pdf") pdf_path = os.path.join(self.tempdir, "convert.pdf")
gotenberg_server = settings.PAPERLESS_TIKA_GOTENBERG_ENDPOINT gotenberg_server = settings.TIKA_GOTENBERG_ENDPOINT
url = gotenberg_server + "/forms/libreoffice/convert" url = gotenberg_server + "/forms/libreoffice/convert"
self.log("info", f"Converting {document_path} to PDF as {pdf_path}") self.log("info", f"Converting {document_path} to PDF as {pdf_path}")

2
src/setup.cfg
View File

@@ -1,5 +1,5 @@
[flake8] [flake8]
extend-exclude = */migrations/*, paperless/settings.py, */tests/* extend-exclude = */migrations/*, */tests/*
# E203 - https://www.flake8rules.com/rules/E203.html # E203 - https://www.flake8rules.com/rules/E203.html
# W503 - https://www.flake8rules.com/rules/W503.html # W503 - https://www.flake8rules.com/rules/W503.html
ignore = E203,W503 ignore = E203,W503