From a5d2ae258807f4c0f338efc13937f5cd8f3bf3dc Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 01/11] feat(parsers): add generator for date parsing --- src/documents/parsers.py | 53 ++++++++++++++++++++-------------------- src/documents/views.py | 14 ++++++++--- 2 files changed, 36 insertions(+), 31 deletions(-) diff --git a/src/documents/parsers.py b/src/documents/parsers.py index 721346fb0..26a4e11c6 100644 --- a/src/documents/parsers.py +++ b/src/documents/parsers.py @@ -6,6 +6,7 @@ import re import shutil import subprocess import tempfile +from typing import Iterator from typing import Optional from typing import Set @@ -216,6 +217,10 @@ def make_thumbnail_from_pdf(in_path, temp_dir, logging_group=None) -> str: def parse_date(filename, text) -> Optional[datetime.datetime]: + return next(parse_date_generator(filename, text), None) + + +def parse_date_generator(filename, text) -> Iterator[datetime.datetime]: """ Returns the date of the document. """ @@ -246,38 +251,32 @@ def parse_date(filename, text) -> Optional[datetime.datetime]: return date return None - date = None + def __process_match( + match: re.Match[str], + date_order: str, + ) -> Optional[datetime.datetime]: + date_string = match.group(0) + + try: + date = __parser(date_string, date_order) + except (TypeError, ValueError): + # Skip all matches that do not parse to a proper date + date = None + + return __filter(date) + + def __process_content(content: str, date_order: str) -> Iterator[datetime.datetime]: + for m in re.finditer(DATE_REGEX, content): + date = __process_match(m, date_order) + if date is not None: + yield date # if filename date parsing is enabled, search there first: if settings.FILENAME_DATE_ORDER: - for m in re.finditer(DATE_REGEX, filename): - date_string = m.group(0) - - try: - date = __parser(date_string, settings.FILENAME_DATE_ORDER) - except (TypeError, ValueError): - # Skip all matches that do not parse to a proper date - continue - - date = __filter(date) - if date is not None: - return date + yield from __process_content(filename, settings.FILENAME_DATE_ORDER) # Iterate through all regex matches in text and try to parse the date - for m in re.finditer(DATE_REGEX, text): - date_string = m.group(0) - - try: - date = __parser(date_string, settings.DATE_ORDER) - except (TypeError, ValueError): - # Skip all matches that do not parse to a proper date - continue - - date = __filter(date) - if date is not None: - return date - - return date + yield from __process_content(text, settings.DATE_ORDER) class ParseError(Exception): diff --git a/src/documents/views.py b/src/documents/views.py index 84fc38a38..f0061cf2b 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -1,3 +1,4 @@ +import itertools import json import logging import os @@ -21,6 +22,7 @@ from django.db.models.functions import Lower from django.http import Http404 from django.http import HttpResponse from django.http import HttpResponseBadRequest +from django.shortcuts import get_object_or_404 from django.utils.decorators import method_decorator from django.utils.translation import get_language from django.views.decorators.cache import cache_control @@ -70,6 +72,7 @@ from .models import SavedView 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 BulkEditSerializer @@ -329,13 +332,13 @@ class DocumentViewSet( @action(methods=["get"], detail=True) def suggestions(self, request, pk=None): - try: - doc = Document.objects.get(pk=pk) - except Document.DoesNotExist: - raise Http404() + doc = get_object_or_404(Document, pk=pk) classifier = load_classifier() + gen = parse_date_generator(doc.filename, doc.content) + dates = {i for i in itertools.islice(gen, 5)} + return Response( { "correspondents": [c.id for c in match_correspondents(doc, classifier)], @@ -344,6 +347,9 @@ class DocumentViewSet( dt.id for dt in match_document_types(doc, classifier) ], "storage_paths": [dt.id for dt in match_storage_paths(doc, classifier)], + "dates": [ + date.strftime("%Y-%m-%d") for date in dates if date is not None + ], }, ) From a754c6047de0a97eb5dabb43529fa7eb0136ff77 Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 02/11] test(test-api): update existing tests for suggestions --- src/documents/tests/test_api.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index 38fe6f07b..bf3061520 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -1107,6 +1107,7 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): "tags": [], "document_types": [], "storage_paths": [], + "dates": [], }, ) @@ -1128,7 +1129,7 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): doc = Document.objects.create( title="test", mime_type="application/pdf", - content="this is an invoice!", + content="this is an invoice from 12.04.2022!", ) match_correspondents.return_value = [Correspondent(id=88), Correspondent(id=2)] @@ -1144,6 +1145,7 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): "tags": [56, 123], "document_types": [23], "storage_paths": [99, 77], + "dates": ["2022-04-12"], }, ) From f6e4339069dd8cfc1b2444f349a976e84e532bb7 Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 03/11] test(test-date-parsing): test parsing of multiple dates --- src/documents/tests/test_date_parsing.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/documents/tests/test_date_parsing.py b/src/documents/tests/test_date_parsing.py index 1019c572f..5deb5e7ef 100644 --- a/src/documents/tests/test_date_parsing.py +++ b/src/documents/tests/test_date_parsing.py @@ -8,6 +8,7 @@ from django.conf import settings from django.test import override_settings from django.test import TestCase from documents.parsers import parse_date +from documents.parsers import parse_date_generator from paperless.settings import DATE_ORDER @@ -161,6 +162,18 @@ class TestDate(TestCase): def test_crazy_date_with_spaces(self, *args): self.assertIsNone(parse_date("", "20 408000l 2475")) + def test_multiple_dates(self): + text = "This text has multiple dates. For example the 02.02.2018 or the 2022/08/22." + dates = list(parse_date_generator("", text)) + self.assertEqual( + dates[0], + datetime.datetime(2018, 2, 2, 0, 0, tzinfo=tz.gettz(settings.TIME_ZONE)), + ) + self.assertEqual( + dates[1], + datetime.datetime(2022, 8, 22, 0, 0, tzinfo=tz.gettz(settings.TIME_ZONE)), + ) + @override_settings(FILENAME_DATE_ORDER="YMD") def test_filename_date_parse_valid_ymd(self, *args): """ From f1084cbdcfb625fb4359200638f3135f2cca3ce1 Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 04/11] feat(settings): add setting to set number of suggested dates --- paperless.conf.example | 1 + src/documents/views.py | 4 +++- src/paperless/settings.py | 5 +++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/paperless.conf.example b/paperless.conf.example index bb2449e05..3c6566325 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -69,6 +69,7 @@ #PAPERLESS_POST_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh #PAPERLESS_FILENAME_DATE_ORDER=YMD #PAPERLESS_FILENAME_PARSE_TRANSFORMS=[] +#PAPERLESS_NUMBER_OF_SUGGESTION_DATES=5 #PAPERLESS_THUMBNAIL_FONT_NAME= #PAPERLESS_IGNORE_DATES= #PAPERLESS_ENABLE_UPDATE_CHECK= diff --git a/src/documents/views.py b/src/documents/views.py index f0061cf2b..8500bf372 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -337,7 +337,9 @@ class DocumentViewSet( classifier = load_classifier() gen = parse_date_generator(doc.filename, doc.content) - dates = {i for i in itertools.islice(gen, 5)} + dates = sorted( + {i for i in itertools.islice(gen, settings.NUMBER_OF_SUGGESTED_DATES)}, + ) return Response( { diff --git a/src/paperless/settings.py b/src/paperless/settings.py index 2ce99ac0e..f0c24feea 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -588,6 +588,11 @@ POST_CONSUME_SCRIPT = os.getenv("PAPERLESS_POST_CONSUME_SCRIPT") DATE_ORDER = os.getenv("PAPERLESS_DATE_ORDER", "DMY") FILENAME_DATE_ORDER = os.getenv("PAPERLESS_FILENAME_DATE_ORDER") +# Number of dates used as suggestions in the frontend +# The number counter from top to bottom. +# Duplicates will be removed, which will result in less shown suggestion dates. +NUMBER_OF_SUGGESTED_DATES = __get_int("PAPERLESS_NUMBER_OF_SUGGESTED_DATES", 0) + # Transformations applied before filename parsing FILENAME_PARSE_TRANSFORMS = [] for t in json.loads(os.getenv("PAPERLESS_FILENAME_PARSE_TRANSFORMS", "[]")): From a037e562b211c8d2a0d3dc79435509e6385f8b96 Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 05/11] test(test-date-parsing): test parsing of multiple dates --- src/documents/tests/test_date_parsing.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/documents/tests/test_date_parsing.py b/src/documents/tests/test_date_parsing.py index 5deb5e7ef..b9151a6f7 100644 --- a/src/documents/tests/test_date_parsing.py +++ b/src/documents/tests/test_date_parsing.py @@ -163,15 +163,22 @@ class TestDate(TestCase): self.assertIsNone(parse_date("", "20 408000l 2475")) def test_multiple_dates(self): - text = "This text has multiple dates. For example the 02.02.2018 or the 2022/08/22." + text = """This text has multiple dates. + For example 02.02.2018, 22 July 2022 and Dezember 2021. + But not 24-12-9999 because its in the future...""" dates = list(parse_date_generator("", text)) + self.assertEqual(len(dates), 3) self.assertEqual( dates[0], datetime.datetime(2018, 2, 2, 0, 0, tzinfo=tz.gettz(settings.TIME_ZONE)), ) self.assertEqual( dates[1], - datetime.datetime(2022, 8, 22, 0, 0, tzinfo=tz.gettz(settings.TIME_ZONE)), + datetime.datetime(2022, 7, 22, 0, 0, tzinfo=tz.gettz(settings.TIME_ZONE)), + ) + self.assertEqual( + dates[2], + datetime.datetime(2021, 12, 1, 0, 0, tzinfo=tz.gettz(settings.TIME_ZONE)), ) @override_settings(FILENAME_DATE_ORDER="YMD") From e0f341938a195118953eb96635fe9d025a5abf1f Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 06/11] docs(configuration.rst): add doc for NUMBER_OF_SUGGESTED_DATES --- docs/configuration.rst | 14 ++++++++++++++ paperless.conf.example | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index dce6b3a83..f9714379c 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -741,6 +741,20 @@ PAPERLESS_FILENAME_DATE_ORDER= Defaults to none, which disables this feature. +PAPERLESS_NUMBER_OF_SUGGESTED_DATES= + Paperless will search the entire document for any date. The first date found will + be used as a default value for the created date. With this setting in place, + paperless will suggestion other dates found in the document. + + Regarding the size of the document, the task to find all dates can consuming much time. + Therefore the number of found dates can be limited with this setting. + + If 10 dates should be suggested, paperless will grab every date from the top of the + document to the bottom until it has reached 10 dates. After this, duplicates will + be removed, which can lead to less than 10 dates displayed in the frontend. + + Set the number to 0 to disable this feature (default) + PAPERLESS_THUMBNAIL_FONT_NAME= Paperless creates thumbnails for plain text files by rendering the content of the file on an image and uses a predefined font for that. This diff --git a/paperless.conf.example b/paperless.conf.example index 3c6566325..cdf148ea1 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -69,7 +69,7 @@ #PAPERLESS_POST_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh #PAPERLESS_FILENAME_DATE_ORDER=YMD #PAPERLESS_FILENAME_PARSE_TRANSFORMS=[] -#PAPERLESS_NUMBER_OF_SUGGESTION_DATES=5 +#PAPERLESS_NUMBER_OF_SUGGESTED_DATES=5 #PAPERLESS_THUMBNAIL_FONT_NAME= #PAPERLESS_IGNORE_DATES= #PAPERLESS_ENABLE_UPDATE_CHECK= From c52d18da1f590864f6ef83375635da0820637b20 Mon Sep 17 00:00:00 2001 From: Matthias Eck Date: Sat, 6 Aug 2022 13:02:08 +0200 Subject: [PATCH 07/11] feat(date.component): adding suggestions to frontend --- .../common/input/date/date.component.html | 6 +++ .../common/input/date/date.component.ts | 42 +++++++++++++++++-- .../document-detail.component.html | 3 +- .../data/paperless-document-suggestions.ts | 2 + 4 files changed, 49 insertions(+), 4 deletions(-) diff --git a/src-ui/src/app/components/common/input/date/date.component.html b/src-ui/src/app/components/common/input/date/date.component.html index e742ead9b..926429a8d 100644 --- a/src-ui/src/app/components/common/input/date/date.component.html +++ b/src-ui/src/app/components/common/input/date/date.component.html @@ -12,4 +12,10 @@
Invalid date.
{{hint}} + + Suggestions:  + + {{s}}  + + diff --git a/src-ui/src/app/components/common/input/date/date.component.ts b/src-ui/src/app/components/common/input/date/date.component.ts index 44e7c7513..cf475df5e 100644 --- a/src-ui/src/app/components/common/input/date/date.component.ts +++ b/src-ui/src/app/components/common/input/date/date.component.ts @@ -1,8 +1,10 @@ -import { Component, forwardRef, OnInit } from '@angular/core' +import { Component, forwardRef, Input, OnInit } from '@angular/core' import { NG_VALUE_ACCESSOR } from '@angular/forms' -import { NgbDateParserFormatter } from '@ng-bootstrap/ng-bootstrap' +import { + NgbDateParserFormatter, + NgbDateStruct, +} from '@ng-bootstrap/ng-bootstrap' import { SettingsService } from 'src/app/services/settings.service' -import { LocalizedDateParserFormatter } from 'src/app/utils/ngb-date-parser-formatter' import { AbstractInputComponent } from '../abstract-input' @Component({ @@ -28,6 +30,40 @@ export class DateComponent super() } + @Input() + suggestions: Date[] + + getSuggestions() { + if (this.suggestions == null) return [] + + return this.suggestions + .map((s) => new Date(s)) // required to call the date functions below + .filter( + (d) => + this.value === null || // if value is not set, take all suggestions + d.toISOString().slice(0, 10) != this.value // otherwise filter out the current value + ) + .map((s) => + this.ngbDateParserFormatter.format({ + year: s.getFullYear(), + month: s.getMonth() + 1, // month of Date is zero based + day: s.getDate(), + }) + ) + } + + onSuggestionClick(dateString: string) { + const parsedNgDate = this.ngbDateParserFormatter.parse(dateString) + this.writeValue(this.formatDateAsYYYYMMDD(parsedNgDate)) + this.onChange(this.value) + } + + formatDateAsYYYYMMDD(date: NgbDateStruct) { + const monthPrefix = date.month > 9 ? '' : '0' + const dayPrefix = date.day > 9 ? '' : '0' + return `${date.year}-${monthPrefix}${date.month}-${dayPrefix}${date.day}` + } + ngOnInit(): void { super.ngOnInit() this.placeholder = this.settings.getLocalizedDateInputFormat() diff --git a/src-ui/src/app/components/document-detail/document-detail.component.html b/src-ui/src/app/components/document-detail/document-detail.component.html index 6c8fc463f..ea191e55c 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.html +++ b/src-ui/src/app/components/document-detail/document-detail.component.html @@ -74,7 +74,8 @@ - + Date: Sat, 6 Aug 2022 17:17:59 +0000 Subject: [PATCH 08/11] fix(parsers|test_api): fix failed tests --- src/documents/parsers.py | 3 ++- src/documents/tests/test_api.py | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/documents/parsers.py b/src/documents/parsers.py index 26a4e11c6..f62199677 100644 --- a/src/documents/parsers.py +++ b/src/documents/parsers.py @@ -7,6 +7,7 @@ import shutil import subprocess import tempfile from typing import Iterator +from typing import Match from typing import Optional from typing import Set @@ -252,7 +253,7 @@ def parse_date_generator(filename, text) -> Iterator[datetime.datetime]: return None def __process_match( - match: re.Match[str], + match: Match[str], date_order: str, ) -> Optional[datetime.datetime]: date_string = match.group(0) diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index bf3061520..b6fa69699 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -1119,6 +1119,7 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): @mock.patch("documents.views.match_document_types") @mock.patch("documents.views.match_tags") @mock.patch("documents.views.match_correspondents") + @override_settings(NUMBER_OF_SUGGESTED_DATES=10) def test_get_suggestions( self, match_correspondents, From 7396e4c32666ad2acfcfb1343672b988741249ab Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 6 Aug 2022 21:19:06 -0700 Subject: [PATCH 09/11] simplify date value format --- .../app/components/common/input/date/date.component.ts | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/src-ui/src/app/components/common/input/date/date.component.ts b/src-ui/src/app/components/common/input/date/date.component.ts index cf475df5e..63a15709b 100644 --- a/src-ui/src/app/components/common/input/date/date.component.ts +++ b/src-ui/src/app/components/common/input/date/date.component.ts @@ -53,17 +53,11 @@ export class DateComponent } onSuggestionClick(dateString: string) { - const parsedNgDate = this.ngbDateParserFormatter.parse(dateString) - this.writeValue(this.formatDateAsYYYYMMDD(parsedNgDate)) + const parsedDate = this.ngbDateParserFormatter.parse(dateString) + this.writeValue(`${parsedDate.year}-${parsedDate.month}-${parsedDate.day}`) this.onChange(this.value) } - formatDateAsYYYYMMDD(date: NgbDateStruct) { - const monthPrefix = date.month > 9 ? '' : '0' - const dayPrefix = date.day > 9 ? '' : '0' - return `${date.year}-${monthPrefix}${date.month}-${dayPrefix}${date.day}` - } - ngOnInit(): void { super.ngOnInit() this.placeholder = this.settings.getLocalizedDateInputFormat() From 7e2c693c8afe9e133b7be28d1b500e1ad8ce20f6 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 7 Aug 2022 08:37:18 -0700 Subject: [PATCH 10/11] Make date suggestions timezone-unaware --- .../common/input/date/date.component.ts | 35 ++++++++----------- .../data/paperless-document-suggestions.ts | 2 +- 2 files changed, 16 insertions(+), 21 deletions(-) diff --git a/src-ui/src/app/components/common/input/date/date.component.ts b/src-ui/src/app/components/common/input/date/date.component.ts index 63a15709b..76bfd08d0 100644 --- a/src-ui/src/app/components/common/input/date/date.component.ts +++ b/src-ui/src/app/components/common/input/date/date.component.ts @@ -1,8 +1,8 @@ import { Component, forwardRef, Input, OnInit } from '@angular/core' import { NG_VALUE_ACCESSOR } from '@angular/forms' import { + NgbDateAdapter, NgbDateParserFormatter, - NgbDateStruct, } from '@ng-bootstrap/ng-bootstrap' import { SettingsService } from 'src/app/services/settings.service' import { AbstractInputComponent } from '../abstract-input' @@ -25,36 +25,31 @@ export class DateComponent { constructor( private settings: SettingsService, - private ngbDateParserFormatter: NgbDateParserFormatter + private ngbDateParserFormatter: NgbDateParserFormatter, + private isoDateAdapter: NgbDateAdapter ) { super() } @Input() - suggestions: Date[] + suggestions: string[] getSuggestions() { - if (this.suggestions == null) return [] - - return this.suggestions - .map((s) => new Date(s)) // required to call the date functions below - .filter( - (d) => - this.value === null || // if value is not set, take all suggestions - d.toISOString().slice(0, 10) != this.value // otherwise filter out the current value - ) - .map((s) => - this.ngbDateParserFormatter.format({ - year: s.getFullYear(), - month: s.getMonth() + 1, // month of Date is zero based - day: s.getDate(), - }) - ) + return this.suggestions == null + ? [] + : this.suggestions + .map((s) => this.ngbDateParserFormatter.parse(s)) + .filter( + (d) => + this.value === null || // if value is not set, take all suggestions + this.value != this.isoDateAdapter.toModel(d) // otherwise filter out current date + ) + .map((s) => this.ngbDateParserFormatter.format(s)) } onSuggestionClick(dateString: string) { const parsedDate = this.ngbDateParserFormatter.parse(dateString) - this.writeValue(`${parsedDate.year}-${parsedDate.month}-${parsedDate.day}`) + this.writeValue(this.isoDateAdapter.toModel(parsedDate)) this.onChange(this.value) } diff --git a/src-ui/src/app/data/paperless-document-suggestions.ts b/src-ui/src/app/data/paperless-document-suggestions.ts index 9f976d71b..295a1ab0e 100644 --- a/src-ui/src/app/data/paperless-document-suggestions.ts +++ b/src-ui/src/app/data/paperless-document-suggestions.ts @@ -7,5 +7,5 @@ export interface PaperlessDocumentSuggestions { storage_paths?: number[] - dates?: Date[] + dates?: string[] // ISO-formatted date string e.g. 2022-11-03 } From 858ae909e8960af9fb52f3b866003c645b34708d Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 25 Aug 2022 08:03:38 -0700 Subject: [PATCH 11/11] Default PAPERLESS_NUMBER_OF_SUGGESTED_DATES to 3 --- docs/configuration.rst | 19 +++++++++---------- src/paperless/settings.py | 7 +++---- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index f9714379c..1c1c54806 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -742,18 +742,17 @@ PAPERLESS_FILENAME_DATE_ORDER= Defaults to none, which disables this feature. PAPERLESS_NUMBER_OF_SUGGESTED_DATES= - Paperless will search the entire document for any date. The first date found will - be used as a default value for the created date. With this setting in place, - paperless will suggestion other dates found in the document. + Paperless searches an entire document for dates. The first date found will + be used as the initial value for the created date. When this variable is + greater than 0 (or left to it's default value), paperless will also suggest + other dates found in the document, up to a maximum of this setting. Note that + duplicates will be removed, which can result in fewer dates displayed in the + frontend than this setting value. - Regarding the size of the document, the task to find all dates can consuming much time. - Therefore the number of found dates can be limited with this setting. + The task to find all dates can be time-consuming and increases with a higher + (maximum) number of suggested dates and slower hardware. - If 10 dates should be suggested, paperless will grab every date from the top of the - document to the bottom until it has reached 10 dates. After this, duplicates will - be removed, which can lead to less than 10 dates displayed in the frontend. - - Set the number to 0 to disable this feature (default) + Defaults to 3. Set to 0 to disable this feature. PAPERLESS_THUMBNAIL_FONT_NAME= Paperless creates thumbnails for plain text files by rendering the content diff --git a/src/paperless/settings.py b/src/paperless/settings.py index f0c24feea..7ec260b1a 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -588,10 +588,9 @@ POST_CONSUME_SCRIPT = os.getenv("PAPERLESS_POST_CONSUME_SCRIPT") DATE_ORDER = os.getenv("PAPERLESS_DATE_ORDER", "DMY") FILENAME_DATE_ORDER = os.getenv("PAPERLESS_FILENAME_DATE_ORDER") -# Number of dates used as suggestions in the frontend -# The number counter from top to bottom. -# Duplicates will be removed, which will result in less shown suggestion dates. -NUMBER_OF_SUGGESTED_DATES = __get_int("PAPERLESS_NUMBER_OF_SUGGESTED_DATES", 0) +# 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. +NUMBER_OF_SUGGESTED_DATES = __get_int("PAPERLESS_NUMBER_OF_SUGGESTED_DATES", 3) # Transformations applied before filename parsing FILENAME_PARSE_TRANSFORMS = []