From 838ed91c5f21f1df94d046dbb7486079f4e670b6 Mon Sep 17 00:00:00 2001 From: Ari Sosnovsky Date: Fri, 30 Oct 2020 14:14:39 -0400 Subject: [PATCH] unhiding vscode --- .gitignore | 2 +- .vscode/settings.json | 15 +++++++++++++++ pdfmajor/document/catalog.py | 2 +- pdfmajor/document/metadata.py | 2 +- pdfmajor/healthlog.py | 16 ++++++++++++++++ pdfmajor/streambuffer.py | 3 ++- setup.py | 1 + 7 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 .vscode/settings.json create mode 100644 pdfmajor/healthlog.py diff --git a/.gitignore b/.gitignore index 44dfa8f..cd95ae4 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,6 @@ docs/_build tests/*.xml tests/*.txt .idea/ -.vscode tests/samples/output ./samples **__pycache**\ @@ -16,3 +15,4 @@ tests/samples/output .ipynb_checkpoints venv oldpdfmajor +.tmp* diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..0b2c8af --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "python.pythonPath": "venv/bin/python", + "python.formatting.provider": "black", + "editor.tabSize": 2, + "python.testing.unittestArgs": [ + "-v", + "-s", + "./tests", + "-p", + "test_*.py" + ], + "python.testing.pytestEnabled": false, + "python.testing.nosetestsEnabled": false, + "python.testing.unittestEnabled": true +} diff --git a/pdfmajor/document/catalog.py b/pdfmajor/document/catalog.py index d532a8e..45f86fa 100644 --- a/pdfmajor/document/catalog.py +++ b/pdfmajor/document/catalog.py @@ -1,8 +1,8 @@ from datetime import datetime -from pdfmajor.lexer.token import TokenComment from typing import Any, Dict, NamedTuple, Optional, Tuple from pdfmajor.lexer import iter_tokens +from pdfmajor.lexer.token import TokenComment from pdfmajor.streambuffer import BufferStream diff --git a/pdfmajor/document/metadata.py b/pdfmajor/document/metadata.py index ba4e3b2..a0e36c6 100644 --- a/pdfmajor/document/metadata.py +++ b/pdfmajor/document/metadata.py @@ -1,8 +1,8 @@ from datetime import datetime -from pdfmajor.lexer.token import TokenComment from typing import Any, Dict, NamedTuple, Optional, Tuple from pdfmajor.lexer import iter_tokens +from pdfmajor.lexer.token import TokenComment from pdfmajor.streambuffer import BufferStream diff --git a/pdfmajor/healthlog.py b/pdfmajor/healthlog.py new file mode 100644 index 0000000..3fe9c9e --- /dev/null +++ b/pdfmajor/healthlog.py @@ -0,0 +1,16 @@ +from dataclasses import dataclass +from typing import List, NamedTuple + + +class PDFHealthLog(NamedTuple): + """A log of for an issue that the pdf file contains""" + + issue_name: str + additional_info: str + + +class PDFHealthReport(List[PDFHealthLog]): + """a list of all issues that occured during the parsing of the document""" + + def write(self, issue_name: str, additional_info: str): + self.append(PDFHealthLog(issue_name, additional_info)) diff --git a/pdfmajor/streambuffer.py b/pdfmajor/streambuffer.py index bd08945..6e64e5f 100644 --- a/pdfmajor/streambuffer.py +++ b/pdfmajor/streambuffer.py @@ -1,6 +1,7 @@ import io -from typing import Iterator, NamedTuple, Optional from contextlib import contextmanager +from typing import Iterator, NamedTuple, Optional + from pdfmajor.exceptions import PDFMajorException diff --git a/setup.py b/setup.py index 36a5c48..19e8b31 100644 --- a/setup.py +++ b/setup.py @@ -20,6 +20,7 @@ with open("README.md") as readme_file: "mypy==0.790", "black==20.8b1", "bandit==1.6.2", + "isort==5.6.4", ] }, "description": "PDF parser",