mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-05-24 02:02:23 -04:00
55e81ca4bb
I've broken out the OCR-specific code from the consumers and dumped it
all into its own app, `paperless_tesseract`. This new app should serve
as a sample of how to create one's own consumer for different file
types.
Documentation for how to do this isn't ready yet, but for the impatient:
* Create a new app
* containing a `parsers.py` for your parser modelled after
`paperless_tesseract.parsers.RasterisedDocumentParser`
* containing a `signals.py` with a handler moddelled after
`paperless_tesseract.signals.ConsumerDeclaration`
* connect the signal handler to
`documents.signals.document_consumer_declaration` in
`your_app.apps`
* Install the app into Paperless by declaring
`PAPERLESS_INSTALLED_APPS=your_app`. Additional apps should be
separated with commas.
* Restart the consumer
306 lines
11 KiB
Python
306 lines
11 KiB
Python
from django.test import TestCase
|
||
|
||
from ..models import FileInfo
|
||
|
||
|
||
class TestAttributes(TestCase):
|
||
|
||
TAGS = ("tag1", "tag2", "tag3")
|
||
EXTENSIONS = (
|
||
"pdf", "png", "jpg", "jpeg", "gif",
|
||
"PDF", "PNG", "JPG", "JPEG", "GIF",
|
||
"PdF", "PnG", "JpG", "JPeG", "GiF",
|
||
)
|
||
|
||
def _test_guess_attributes_from_name(self, path, sender, title, tags):
|
||
|
||
for extension in self.EXTENSIONS:
|
||
|
||
f = path.format(extension)
|
||
file_info = FileInfo.from_path(f)
|
||
|
||
if sender:
|
||
self.assertEqual(file_info.correspondent.name, sender, f)
|
||
else:
|
||
self.assertIsNone(file_info.correspondent, f)
|
||
|
||
self.assertEqual(file_info.title, title, f)
|
||
|
||
self.assertEqual(tuple([t.slug for t in file_info.tags]), tags, f)
|
||
if extension.lower() == "jpeg":
|
||
self.assertEqual(file_info.extension, "jpg", f)
|
||
else:
|
||
self.assertEqual(file_info.extension, extension.lower(), f)
|
||
|
||
def test_guess_attributes_from_name0(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Sender - Title.{}", "Sender", "Title", ())
|
||
|
||
def test_guess_attributes_from_name1(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Spaced Sender - Title.{}", "Spaced Sender", "Title", ())
|
||
|
||
def test_guess_attributes_from_name2(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Sender - Spaced Title.{}", "Sender", "Spaced Title", ())
|
||
|
||
def test_guess_attributes_from_name3(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Dashed-Sender - Title.{}", "Dashed-Sender", "Title", ())
|
||
|
||
def test_guess_attributes_from_name4(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Sender - Dashed-Title.{}", "Sender", "Dashed-Title", ())
|
||
|
||
def test_guess_attributes_from_name5(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Sender - Title - tag1,tag2,tag3.{}",
|
||
"Sender",
|
||
"Title",
|
||
self.TAGS
|
||
)
|
||
|
||
def test_guess_attributes_from_name6(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Spaced Sender - Title - tag1,tag2,tag3.{}",
|
||
"Spaced Sender",
|
||
"Title",
|
||
self.TAGS
|
||
)
|
||
|
||
def test_guess_attributes_from_name7(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Sender - Spaced Title - tag1,tag2,tag3.{}",
|
||
"Sender",
|
||
"Spaced Title",
|
||
self.TAGS
|
||
)
|
||
|
||
def test_guess_attributes_from_name8(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Dashed-Sender - Title - tag1,tag2,tag3.{}",
|
||
"Dashed-Sender",
|
||
"Title",
|
||
self.TAGS
|
||
)
|
||
|
||
def test_guess_attributes_from_name9(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Sender - Dashed-Title - tag1,tag2,tag3.{}",
|
||
"Sender",
|
||
"Dashed-Title",
|
||
self.TAGS
|
||
)
|
||
|
||
def test_guess_attributes_from_name10(self):
|
||
self._test_guess_attributes_from_name(
|
||
"/path/to/Σενδερ - Τιτλε - tag1,tag2,tag3.{}",
|
||
"Σενδερ",
|
||
"Τιτλε",
|
||
self.TAGS
|
||
)
|
||
|
||
def test_guess_attributes_from_name_when_correspondent_empty(self):
|
||
self._test_guess_attributes_from_name(
|
||
'/path/to/ - weird empty correspondent but should not break.{}',
|
||
None,
|
||
'weird empty correspondent but should not break',
|
||
()
|
||
)
|
||
|
||
def test_guess_attributes_from_name_when_title_starts_with_dash(self):
|
||
self._test_guess_attributes_from_name(
|
||
'/path/to/- weird but should not break.{}',
|
||
None,
|
||
'- weird but should not break',
|
||
()
|
||
)
|
||
|
||
def test_guess_attributes_from_name_when_title_ends_with_dash(self):
|
||
self._test_guess_attributes_from_name(
|
||
'/path/to/weird but should not break -.{}',
|
||
None,
|
||
'weird but should not break -',
|
||
()
|
||
)
|
||
|
||
def test_guess_attributes_from_name_when_title_is_empty(self):
|
||
self._test_guess_attributes_from_name(
|
||
'/path/to/weird correspondent but should not break - .{}',
|
||
'weird correspondent but should not break',
|
||
'',
|
||
()
|
||
)
|
||
|
||
|
||
class TestFieldPermutations(TestCase):
|
||
|
||
valid_dates = (
|
||
"20150102030405Z",
|
||
"20150102Z",
|
||
)
|
||
valid_correspondents = [
|
||
"timmy",
|
||
"Dr. McWheelie",
|
||
"Dash Gor-don",
|
||
"ο Θερμαστής",
|
||
""
|
||
]
|
||
valid_titles = ["title", "Title w Spaces", "Title a-dash", "Τίτλος", ""]
|
||
valid_tags = ["tag", "tig,tag", "tag1,tag2,tag-3"]
|
||
valid_extensions = ["pdf", "png", "jpg", "jpeg", "gif"]
|
||
|
||
def _test_guessed_attributes(self, filename, created=None,
|
||
correspondent=None, title=None,
|
||
extension=None, tags=None):
|
||
|
||
info = FileInfo.from_path(filename)
|
||
|
||
# Created
|
||
if created is None:
|
||
self.assertIsNone(info.created, filename)
|
||
else:
|
||
self.assertEqual(info.created.year, int(created[:4]), filename)
|
||
self.assertEqual(info.created.month, int(created[4:6]), filename)
|
||
self.assertEqual(info.created.day, int(created[6:8]), filename)
|
||
|
||
# Correspondent
|
||
if correspondent:
|
||
self.assertEqual(info.correspondent.name, correspondent, filename)
|
||
else:
|
||
self.assertEqual(info.correspondent, None, filename)
|
||
|
||
# Title
|
||
self.assertEqual(info.title, title, filename)
|
||
|
||
# Tags
|
||
if tags is None:
|
||
self.assertEqual(info.tags, (), filename)
|
||
else:
|
||
self.assertEqual(
|
||
[t.slug for t in info.tags], tags.split(','),
|
||
filename
|
||
)
|
||
|
||
# Extension
|
||
if extension == 'jpeg':
|
||
extension = 'jpg'
|
||
self.assertEqual(info.extension, extension, filename)
|
||
|
||
def test_just_title(self):
|
||
template = '/path/to/{title}.{extension}'
|
||
for title in self.valid_titles:
|
||
for extension in self.valid_extensions:
|
||
spec = dict(title=title, extension=extension)
|
||
filename = template.format(**spec)
|
||
self._test_guessed_attributes(filename, **spec)
|
||
|
||
def test_title_and_correspondent(self):
|
||
template = '/path/to/{correspondent} - {title}.{extension}'
|
||
for correspondent in self.valid_correspondents:
|
||
for title in self.valid_titles:
|
||
for extension in self.valid_extensions:
|
||
spec = dict(correspondent=correspondent, title=title,
|
||
extension=extension)
|
||
filename = template.format(**spec)
|
||
self._test_guessed_attributes(filename, **spec)
|
||
|
||
def test_title_and_correspondent_and_tags(self):
|
||
template = '/path/to/{correspondent} - {title} - {tags}.{extension}'
|
||
for correspondent in self.valid_correspondents:
|
||
for title in self.valid_titles:
|
||
for tags in self.valid_tags:
|
||
for extension in self.valid_extensions:
|
||
spec = dict(correspondent=correspondent, title=title,
|
||
tags=tags, extension=extension)
|
||
filename = template.format(**spec)
|
||
self._test_guessed_attributes(filename, **spec)
|
||
|
||
def test_created_and_correspondent_and_title_and_tags(self):
|
||
|
||
template = ("/path/to/{created} - "
|
||
"{correspondent} - "
|
||
"{title} - "
|
||
"{tags}"
|
||
".{extension}")
|
||
|
||
for created in self.valid_dates:
|
||
for correspondent in self.valid_correspondents:
|
||
for title in self.valid_titles:
|
||
for tags in self.valid_tags:
|
||
for extension in self.valid_extensions:
|
||
spec = {
|
||
"created": created,
|
||
"correspondent": correspondent,
|
||
"title": title,
|
||
"tags": tags,
|
||
"extension": extension
|
||
}
|
||
self._test_guessed_attributes(
|
||
template.format(**spec), **spec)
|
||
|
||
def test_created_and_correspondent_and_title(self):
|
||
|
||
template = ("/path/to/{created} - "
|
||
"{correspondent} - "
|
||
"{title}"
|
||
".{extension}")
|
||
|
||
for created in self.valid_dates:
|
||
for correspondent in self.valid_correspondents:
|
||
for title in self.valid_titles:
|
||
|
||
# Skip cases where title looks like a tag as we can't
|
||
# accommodate such cases.
|
||
if title.lower() == title:
|
||
continue
|
||
|
||
for extension in self.valid_extensions:
|
||
spec = {
|
||
"created": created,
|
||
"correspondent": correspondent,
|
||
"title": title,
|
||
"extension": extension
|
||
}
|
||
self._test_guessed_attributes(
|
||
template.format(**spec), **spec)
|
||
|
||
def test_created_and_title(self):
|
||
|
||
template = ("/path/to/{created} - "
|
||
"{title}"
|
||
".{extension}")
|
||
|
||
for created in self.valid_dates:
|
||
for title in self.valid_titles:
|
||
for extension in self.valid_extensions:
|
||
spec = {
|
||
"created": created,
|
||
"title": title,
|
||
"extension": extension
|
||
}
|
||
self._test_guessed_attributes(
|
||
template.format(**spec), **spec)
|
||
|
||
def test_created_and_title_and_tags(self):
|
||
|
||
template = ("/path/to/{created} - "
|
||
"{title} - "
|
||
"{tags}"
|
||
".{extension}")
|
||
|
||
for created in self.valid_dates:
|
||
for title in self.valid_titles:
|
||
for tags in self.valid_tags:
|
||
for extension in self.valid_extensions:
|
||
spec = {
|
||
"created": created,
|
||
"title": title,
|
||
"tags": tags,
|
||
"extension": extension
|
||
}
|
||
self._test_guessed_attributes(
|
||
template.format(**spec), **spec)
|
||
|
||
|