chg: ♻️ run tests and setup through black

Author: ianardee

.github/workflows/linting.yml

@@ -22,4 +22,4 @@ jobs:
         pip install --requirement ./requirements.dev.txt
     - name: Analysing the code with Black
       run: |
-        black --check ./mindee
+        black --check .

setup.py

@@ -24,8 +24,8 @@ def make_requirements_list(file="requirements.txt", only_regular=True):
         lines = f.read().splitlines()
     if only_regular:
         regex = (
-            "\/$|^#|^$$|^git\+"
-        )  # remove line with /, starting by # or space or empty
+            "\/$|^#|^$$|^git\+"  # remove line with /, starting by # or space or empty
+        )
         return [line for line in lines if not re.findall(regex, line)]
     else:
         return lines
@@ -43,5 +43,5 @@ def make_requirements_list(file="requirements.txt", only_regular=True):
     author="Mindee",
     author_email="devrel@mindee.com",
     install_requires=make_requirements_list(),
-    include_package_data=True
+    include_package_data=True,
 )

tests/documents/test_document.py

@@ -21,38 +21,45 @@ def test_constructor():
 
 # Plate tests
 
+
 def test_responseWrapper_plate(dummy_file_input):
-    response = json.load(open('./tests/data/license_plates/v1/plate.json'))
+    response = json.load(open("./tests/data/license_plates/v1/plate.json"))
     parsed_plate = Response.format_response(response, "license_plate", dummy_file_input)
     assert parsed_plate.license_plate.license_plates[0].value == "7EQE707"
 
 
 # Invoice tests
 
+
 def test_responseWrapper_invoice(dummy_file_input):
-    response = json.load(open('./tests/data/invoices/v2/invoice.json'))
+    response = json.load(open("./tests/data/invoices/v2/invoice.json"))
     parsed_invoice = Response.format_response(response, "invoice", dummy_file_input)
-    assert parsed_invoice.invoice.invoice_date.value == '2018-09-25'
+    assert parsed_invoice.invoice.invoice_date.value == "2018-09-25"
 
 
 # Receipt tests
 
+
 def test_responseWrapper_receipt(dummy_file_input):
-    response = json.load(open('./tests/data/expense_receipts/v3/receipt.json'))
+    response = json.load(open("./tests/data/expense_receipts/v3/receipt.json"))
     parsed_receipt = Response.format_response(response, "receipt", dummy_file_input)
     assert parsed_receipt.receipt.date.value == "2016-02-26"
 
 
 # Financial document tests
 
+
 def test_responseWrapper_financial_document_with_receipt(dummy_file_input):
-    response = json.load(open('./tests/data/expense_receipts/v3/receipt.json'))
-    parsed_financial_doc = Response.format_response(response, "financial_document", dummy_file_input)
+    response = json.load(open("./tests/data/expense_receipts/v3/receipt.json"))
+    parsed_financial_doc = Response.format_response(
+        response, "financial_document", dummy_file_input
+    )
     assert parsed_financial_doc.financial_document.date.value == "2016-02-26"
 
 
 def test_responseWrapper_financial_document_with_invoice(dummy_file_input):
-    response = json.load(open('./tests/data/invoices/v2/invoice.json'))
-    parsed_financial_doc = Response.format_response(response, "financial_document", dummy_file_input)
-    assert parsed_financial_doc.financial_document.date.value == '2018-09-25'
-
+    response = json.load(open("./tests/data/invoices/v2/invoice.json"))
+    parsed_financial_doc = Response.format_response(
+        response, "financial_document", dummy_file_input
+    )
+    assert parsed_financial_doc.financial_document.date.value == "2018-09-25"

tests/documents/test_financial_doc.py

@@ -6,13 +6,19 @@
 @pytest.fixture
 def financial_doc_from_invoice_object():
     invoice_json_repsonse = json.load(open("./tests/data/invoices/v2/invoice.json"))
-    return FinancialDocument(invoice_json_repsonse["document"]["inference"]["pages"][0]["prediction"])
+    return FinancialDocument(
+        invoice_json_repsonse["document"]["inference"]["pages"][0]["prediction"]
+    )
 
 
 @pytest.fixture
 def financial_doc_from_receipt_object():
-    receipt_json_repsonse = json.load(open("./tests/data/expense_receipts/v3/receipt.json"))
-    return FinancialDocument(receipt_json_repsonse["document"]["inference"]["pages"][0]["prediction"])
+    receipt_json_repsonse = json.load(
+        open("./tests/data/expense_receipts/v3/receipt.json")
+    )
+    return FinancialDocument(
+        receipt_json_repsonse["document"]["inference"]["pages"][0]["prediction"]
+    )
 
 
 @pytest.fixture
@@ -30,30 +36,40 @@ def financial_doc_object_from_scratch():
         company_number="asdqsdae",
         orientation=0,
         total_tax=3,
-        time="12:15"
+        time="12:15",
     )
 
 
 @pytest.fixture
 def financial_doc_from_receipt_object_all_na():
-    json_repsonse = json.load(open("./tests/data/expense_receipts/v3/receipt_all_na.json"))
-    return FinancialDocument(json_repsonse["document"]["inference"]["pages"][0]["prediction"])
+    json_repsonse = json.load(
+        open("./tests/data/expense_receipts/v3/receipt_all_na.json")
+    )
+    return FinancialDocument(
+        json_repsonse["document"]["inference"]["pages"][0]["prediction"]
+    )
 
 
 @pytest.fixture
 def financial_doc_from_invoice_object_all_na():
     json_repsonse = json.load(open("./tests/data/invoices/v2/invoice_all_na.json"))
-    return FinancialDocument(json_repsonse["document"]["inference"]["pages"][0]["prediction"])
+    return FinancialDocument(
+        json_repsonse["document"]["inference"]["pages"][0]["prediction"]
+    )
 
 
 @pytest.fixture
 def receipt_pred():
-    return json.load(open("./tests/data/expense_receipts/v3/receipt_all_na.json"))["document"]["inference"]["pages"][0]["prediction"]
+    return json.load(open("./tests/data/expense_receipts/v3/receipt_all_na.json"))[
+        "document"
+    ]["inference"]["pages"][0]["prediction"]
 
 
 @pytest.fixture
 def invoice_pred():
-    return json.load(open("./tests/data/invoices/v2/invoice_all_na.json"))["document"]["inference"]["pages"][0]["prediction"]
+    return json.load(open("./tests/data/invoices/v2/invoice_all_na.json"))["document"][
+        "inference"
+    ]["pages"][0]["prediction"]
 
 
 def test_constructor_1(financial_doc_from_invoice_object):
@@ -95,15 +111,15 @@ def test__str__receipt(financial_doc_from_receipt_object):
 # Business tests from receipt
 def test__receipt_reconstruct_total_excl_from_total_and_taxes_1(receipt_pred):
     # no incl implies no reconstruct for total excl
-    receipt_pred["total_incl"] = {"value": "N/A", "probability": 0.}
+    receipt_pred["total_incl"] = {"value": "N/A", "probability": 0.0}
     receipt_pred["taxes"] = [{"rate": 20, "value": 9.5, "probability": 0.9}]
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.total_excl.value is None
 
 
 def test__receipt_reconstruct_total_excl_from_total_and_taxes_2(receipt_pred):
     # no taxes implies no reconstruct for total excl
-    receipt_pred["total_incl"] = {"value": 12.54, "probability": 0.}
+    receipt_pred["total_incl"] = {"value": 12.54, "probability": 0.0}
     receipt_pred["taxes"] = []
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.total_excl.value is None
@@ -112,8 +128,10 @@ def test__receipt_reconstruct_total_excl_from_total_and_taxes_2(receipt_pred):
 def test__receipt_reconstruct_total_excl_from_total_and_taxes_3(receipt_pred):
     # working example
     receipt_pred["total_incl"] = {"value": 12.54, "probability": 0.5}
-    receipt_pred["taxes"] = [{"rate": 20, "value": 0.5, "probability": 0.1},
-                             {"rate": 10, "value": 4.25, "probability": 0.6}]
+    receipt_pred["taxes"] = [
+        {"rate": 20, "value": 0.5, "probability": 0.1},
+        {"rate": 10, "value": 4.25, "probability": 0.6},
+    ]
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.total_excl.probability == 0.03
     assert financial_doc.total_excl.value == 7.79
@@ -128,8 +146,10 @@ def test__receipt_reconstruct_total_tax_1(receipt_pred):
 
 def test__receipt_reconstruct_total_tax_2(receipt_pred):
     # working example
-    receipt_pred["taxes"] = [{"rate": 20, "value": 10.2, "probability": 0.5},
-                             {"rate": 10, "value": 40.0, "probability": 0.1}]
+    receipt_pred["taxes"] = [
+        {"rate": 20, "value": 10.2, "probability": 0.5},
+        {"rate": 10, "value": 40.0, "probability": 0.1},
+    ]
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.total_tax.value == 50.2
     assert financial_doc.total_tax.probability == 0.05
@@ -138,44 +158,48 @@ def test__receipt_reconstruct_total_tax_2(receipt_pred):
 def test__receipt_taxes_match_total_incl_1(receipt_pred):
     # matching example
     receipt_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    receipt_pred["taxes"] = [{"rate": 20, "value": 10.99, "probability": 0.5},
-                             {"rate": 10, "value": 40.12, "probability": 0.1}]
+    receipt_pred["taxes"] = [
+        {"rate": 20, "value": 10.99, "probability": 0.5},
+        {"rate": 10, "value": 40.12, "probability": 0.1},
+    ]
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is True
-    assert financial_doc.total_incl.probability == 1.
+    assert financial_doc.total_incl.probability == 1.0
     for tax in financial_doc.taxes:
-        assert tax.probability == 1.
+        assert tax.probability == 1.0
 
 
 def test__receipt_taxes_match_total_incl_2(receipt_pred):
     # not matching example with close error
     receipt_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    receipt_pred["taxes"] = [{"rate": 20, "value": 10.9, "probability": 0.5},
-                             {"rate": 10, "value": 40.12, "probability": 0.1}]
+    receipt_pred["taxes"] = [
+        {"rate": 20, "value": 10.9, "probability": 0.5},
+        {"rate": 10, "value": 40.12, "probability": 0.1},
+    ]
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is False
 
 
 def test__receipt_taxes_match_total_incl_3(receipt_pred):
     # sanity check with null tax
     receipt_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    receipt_pred["taxes"] = [{"rate": 20, "value": 0., "probability": 0.5}]
+    receipt_pred["taxes"] = [{"rate": 20, "value": 0.0, "probability": 0.5}]
     financial_doc = FinancialDocument(receipt_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is False
 
 
 # Business tests from invoice
 def test__invoice_reconstruct_total_excl_from_total_and_taxes_1(invoice_pred):
     # no incl implies no reconstruct for total excl
-    invoice_pred["total_incl"] = {"amount": "N/A", "probability": 0.}
+    invoice_pred["total_incl"] = {"amount": "N/A", "probability": 0.0}
     invoice_pred["taxes"] = [{"rate": 20, "amount": 9.5, "probability": 0.9}]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.total_excl.value is None
 
 
 def test__invoice_reconstruct_total_excl_from_total_and_taxes_2(invoice_pred):
     # no taxes implies no reconstruct for total excl
-    invoice_pred["total_incl"] = {"amount": 12.54, "probability": 0.}
+    invoice_pred["total_incl"] = {"amount": 12.54, "probability": 0.0}
     invoice_pred["taxes"] = []
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.total_excl.value is None
@@ -184,8 +208,10 @@ def test__invoice_reconstruct_total_excl_from_total_and_taxes_2(invoice_pred):
 def test__invoice_reconstruct_total_excl_from_total_and_taxes_3(invoice_pred):
     # working example
     invoice_pred["total_incl"] = {"value": 12.54, "probability": 0.5}
-    invoice_pred["taxes"] = [{"rate": 20, "value": 0.5, "probability": 0.1},
-                             {"rate": 10, "value": 4.25, "probability": 0.6}]
+    invoice_pred["taxes"] = [
+        {"rate": 20, "value": 0.5, "probability": 0.1},
+        {"rate": 10, "value": 4.25, "probability": 0.6},
+    ]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.total_excl.probability == 0.03
     assert financial_doc.total_excl.value == 7.79
@@ -200,8 +226,10 @@ def test__invoice_reconstruct_total_tax_1(invoice_pred):
 
 def test__invoice_reconstruct_total_tax_2(invoice_pred):
     # working example
-    invoice_pred["taxes"] = [{"rate": 20, "value": 10.2, "probability": 0.5},
-                             {"rate": 10, "value": 40.0, "probability": 0.1}]
+    invoice_pred["taxes"] = [
+        {"rate": 20, "value": 10.2, "probability": 0.5},
+        {"rate": 10, "value": 40.0, "probability": 0.1},
+    ]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.total_tax.value == 50.2
     assert financial_doc.total_tax.probability == 0.05
@@ -210,59 +238,68 @@ def test__invoice_reconstruct_total_tax_2(invoice_pred):
 def test__invoice_taxes_match_total_incl_1(invoice_pred):
     # matching example
     invoice_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    invoice_pred["taxes"] = [{"rate": 20, "value": 10.99, "probability": 0.5},
-                             {"rate": 10, "value": 40.12, "probability": 0.1}]
+    invoice_pred["taxes"] = [
+        {"rate": 20, "value": 10.99, "probability": 0.5},
+        {"rate": 10, "value": 40.12, "probability": 0.1},
+    ]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is True
-    assert financial_doc.total_incl.probability == 1.
+    assert financial_doc.total_incl.probability == 1.0
     for tax in financial_doc.taxes:
-        assert tax.probability == 1.
+        assert tax.probability == 1.0
 
 
 def test__invoice_taxes_match_total_incl_2(invoice_pred):
     # not matching example with close error
     invoice_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    invoice_pred["taxes"] = [{"rate": 20, "value": 10.9, "probability": 0.5},
-                             {"rate": 10, "value": 40.12, "probability": 0.1}]
+    invoice_pred["taxes"] = [
+        {"rate": 20, "value": 10.9, "probability": 0.5},
+        {"rate": 10, "value": 40.12, "probability": 0.1},
+    ]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is False
 
 
 def test__invoice_taxes_match_total_incl_3(invoice_pred):
     # sanity check with null tax
     invoice_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    invoice_pred["taxes"] = [{"rate": 20, "value": 0., "probability": 0.5}]
+    invoice_pred["taxes"] = [{"rate": 20, "value": 0.0, "probability": 0.5}]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is False
 
 
 def test__shouldnt_raise_when_tax_rate_none(invoice_pred):
     # sanity check with null tax
     invoice_pred["total_incl"] = {"value": 507.25, "probability": 0.6}
-    invoice_pred["taxes"] = [{"rate": "N/A", "value": 0., "probability": 0.5}]
+    invoice_pred["taxes"] = [{"rate": "N/A", "value": 0.0, "probability": 0.5}]
     financial_doc = FinancialDocument(invoice_pred)
     assert financial_doc.checklist["taxes_match_total_incl"] is False
 
 
 def test_compare_1(financial_doc_from_invoice_object):
     # Compare same object must return all True
-    benchmark = FinancialDocument.compare(financial_doc_from_invoice_object, financial_doc_from_invoice_object)
+    benchmark = FinancialDocument.compare(
+        financial_doc_from_invoice_object, financial_doc_from_invoice_object
+    )
     for value in benchmark.values():
         assert value is True
 
 
-def test_compare_2(financial_doc_from_invoice_object, financial_doc_from_invoice_object_all_na):
+def test_compare_2(
+    financial_doc_from_invoice_object, financial_doc_from_invoice_object_all_na
+):
     # Compare full object and empty object
-    benchmark = FinancialDocument.compare(financial_doc_from_invoice_object, financial_doc_from_invoice_object_all_na)
+    benchmark = FinancialDocument.compare(
+        financial_doc_from_invoice_object, financial_doc_from_invoice_object_all_na
+    )
     for key in set(benchmark.keys()) - {"time"}:
         assert benchmark[key] is False
 
 
 def test_compare_3(financial_doc_object_from_scratch):
     # Compare financial doc from class
     benchmark = FinancialDocument.compare(
-        financial_doc_object_from_scratch,
-        financial_doc_object_from_scratch
+        financial_doc_object_from_scratch, financial_doc_object_from_scratch
     )
     for key in benchmark.keys():
         if "__acc__" in key:
@@ -273,8 +310,7 @@ def test_compare_4(financial_doc_object_from_scratch):
     # Compare financial doc from class with empty taxes
     financial_doc_object_from_scratch.taxes = []
     benchmark = FinancialDocument.compare(
-        financial_doc_object_from_scratch,
-        financial_doc_object_from_scratch
+        financial_doc_object_from_scratch, financial_doc_object_from_scratch
     )
     for key in benchmark.keys():
         if "__acc__" in key:
@@ -293,4 +329,6 @@ def test_invoice_or_receipt_get_same_field_types(receipt_pred, invoice_pred):
     financial_doc_from_invoice = FinancialDocument(invoice_pred)
     assert set(dir(financial_doc_from_invoice)) == set(dir(financial_doc_from_receipt))
     for key in dir(financial_doc_from_receipt):
-        assert type(getattr(financial_doc_from_receipt, key)) == type(getattr(financial_doc_from_invoice, key))
+        assert type(getattr(financial_doc_from_receipt, key)) == type(
+            getattr(financial_doc_from_invoice, key)
+        )