Marty/papis-extract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
papis-extract/tests/test_formatting.py

86 lines
2.2 KiB
Python
Raw Permalink Normal View History

test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
from papis.document import Document
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
from papis_extract.annotation import Annotation
Add formatting style Markdown
2023-08-31 19:32:24 +00:00
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
from papis_extract.formatter import (
format_count,
format_csv,
format_markdown,
format_markdown_atx,
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
format_markdown_setext,
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
)
refactor: Move templating to separate file
2023-09-19 15:35:39 +00:00
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
document = Document(data={"author": "document-author", "title": "document-title"})
annotations = [
fix: Fix test fixtures for new annotation structure
2024-01-24 10:14:45 +00:00
Annotation("myfile.pdf", content="my lovely text"),
Annotation("myfile.pdf", content="my second text", note="with note"),
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
]
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
md_default_output = """============== ---------------
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
document-title - document-author
============== ---------------
> my lovely text
> my second text
NOTE: with note"""
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
def test_markdown_default():
fmt = format_markdown
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert fmt(document, annotations) == md_default_output
refactor: Move templating to separate file
2023-09-19 15:35:39 +00:00
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
def test_markdown_atx():
fmt = format_markdown_atx
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert fmt(document, annotations) == (
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
"""# document-title - document-author
> my lovely text
> my second text
NOTE: with note"""
refactor: Move templating to separate file
2023-09-19 15:35:39 +00:00
)
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
def test_markdown_setext():
fmt = format_markdown_setext
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert fmt(document, annotations) == md_default_output
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
def test_count_default():
fmt = format_count
feat: Change count display to lead with count The actual count is now the first item on each line, to make it easier to sort, strip, delete and compare afterwards.
2024-06-12 09:06:27 +00:00
assert fmt(document, annotations) == ("""2 document-author: document-title""")
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
def test_csv_default():
fmt = format_csv
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert fmt(document, annotations) == (
feat: Notify formatters if formatting first entry This allows headers to be created by a formatter, which will *only* be added to the very first entry created and not to each entry. Currently for example this is used to create a csv header but not for each document in turn.
2024-06-12 09:45:35 +00:00
'Highlight,,0,"my lovely text","","document-author",'
'"document-title","","myfile.pdf"\n'
'Highlight,,0,"my second text","with note","document-author",'
'"document-title","","myfile.pdf"'
)
chore: Black formatting
2024-06-12 09:46:39 +00:00
feat: Notify formatters if formatting first entry This allows headers to be created by a formatter, which will *only* be added to the very first entry created and not to each entry. Currently for example this is used to create a csv header but not for each document in turn.
2024-06-12 09:45:35 +00:00
def test_csv_with_header():
fmt = format_csv
assert fmt(document, annotations, first=True) == (
test: Fix formatting and annotation tests
2023-09-22 18:04:39 +00:00
"type,tag,page,quote,note,author,title,ref,file\n"
'Highlight,,0,"my lovely text","","document-author",'
'"document-title","","myfile.pdf"\n'
'Highlight,,0,"my second text","with note","document-author",'
'"document-title","","myfile.pdf"'
)
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
# sadpath - no annotations contained for each format
def test_markdown_no_annotations():
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert format_markdown(document, []) == ""
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
def test_count_no_annotations():
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert format_count(document, []) == ""
test: Add tests for formatter sad paths
2023-10-12 17:27:16 +00:00
def test_csv_no_annotations():
refactor: Remove AnnotatedDocument class The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
2024-01-20 15:34:10 +00:00
assert format_csv(document, []) == ""
Reference in a new issue Copy permalink