paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

added ASN to filename format #519

Browse Source
This commit is contained in:
jonaswinkler 2021-02-09 23:03:07 +01:00
parent 8d6071e977
commit 1d002149dc
3 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/advanced_usage.rst
View File

@ -217,6 +217,7 @@ will create a directory structure as follows:
Paperless provides the following placeholders withing filenames: Paperless provides the following placeholders withing filenames:
* ``{asn}``: The archive serial number of the document, or "none".
* ``{correspondent}``: The name of the correspondent, or "none". * ``{correspondent}``: The name of the correspondent, or "none".
* ``{document_type}``: The name of the document type, or "none". * ``{document_type}``: The name of the document type, or "none".
* ``{tag_list}``: A comma separated list of all tags assigned to the document. * ``{tag_list}``: A comma separated list of all tags assigned to the document.

6
src/documents/file_handling.py
View File

@ -131,6 +131,11 @@ def generate_filename(doc, counter=0, append_gpg=True, archive_filename=False):
else: else:
document_type = "none" document_type = "none"
if doc.archive_serial_number:
asn = str(doc.archive_serial_number)
else:
asn = "none"
path = settings.PAPERLESS_FILENAME_FORMAT.format( path = settings.PAPERLESS_FILENAME_FORMAT.format(
title=pathvalidate.sanitize_filename( title=pathvalidate.sanitize_filename(
doc.title, replacement_text="-"), doc.title, replacement_text="-"),
@ -144,6 +149,7 @@ def generate_filename(doc, counter=0, append_gpg=True, archive_filename=False):
added_year=doc.added.year if doc.added else "none", added_year=doc.added.year if doc.added else "none",
added_month=f"{doc.added.month:02}" if doc.added else "none", added_month=f"{doc.added.month:02}" if doc.added else "none",
added_day=f"{doc.added.day:02}" if doc.added else "none", added_day=f"{doc.added.day:02}" if doc.added else "none",
asn=asn,
tags=tags, tags=tags,
tag_list=tag_list tag_list=tag_list
).strip() ).strip()

7
src/documents/tests/test_file_handling.py
View File

@ -201,6 +201,13 @@ class TestFileHandling(DirectoriesMixin, TestCase):
self.assertEqual(generate_filename(d), "my_doc_type - the_doc.pdf") self.assertEqual(generate_filename(d), "my_doc_type - the_doc.pdf")
@override_settings(PAPERLESS_FILENAME_FORMAT="{asn} - {title}")
def test_asn(self):
d1 = Document.objects.create(title="the_doc", mime_type="application/pdf", archive_serial_number=652, checksum="A")
d2 = Document.objects.create(title="the_doc", mime_type="application/pdf", archive_serial_number=None, checksum="B")
self.assertEqual(generate_filename(d1), "652 - the_doc.pdf")
self.assertEqual(generate_filename(d2), "none - the_doc.pdf")
@override_settings(PAPERLESS_FILENAME_FORMAT="{tags[type]}") @override_settings(PAPERLESS_FILENAME_FORMAT="{tags[type]}")
def test_tags_with_underscore(self): def test_tags_with_underscore(self):
document = Document() document = Document()