Use dataclasses to group data about barcodes in documents

src/documents/tests/test_barcodes.py

@@ -191,26 +191,26 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "patch-code-t.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [0])
 
     def test_scan_file_for_separating_barcodes_none_present(self):
         test_file = os.path.join(self.SAMPLE_DIR, "simple.pdf")
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [])
 
     def test_scan_file_for_separating_barcodes3(self):
@@ -218,14 +218,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "patch-code-t-middle.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [1])
 
     def test_scan_file_for_separating_barcodes4(self):
@@ -233,14 +233,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "several-patcht-codes.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [2, 5])
 
     def test_scan_file_for_separating_barcodes_upsidedown(self):
@@ -248,14 +248,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "patch-code-t-middle_reverse.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [1])
 
     def test_scan_file_for_barcodes_pillow_transcode_error(self):
@@ -312,7 +312,7 @@ class TestBarcode(DirectoriesMixin, TestCase):
             with mock.patch("documents.barcodes.barcode_reader") as reader:
                 reader.return_value = list()
 
-                _, _ = barcodes.scan_file_for_barcodes(
+                _ = barcodes.scan_file_for_barcodes(
                     str(device_n_pdf.name),
                 )
 
@@ -331,14 +331,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-fax-image.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [1])
 
     def test_scan_file_for_separating_qr_barcodes(self):
@@ -346,14 +346,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "patch-code-t-qr.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [0])
 
     @override_settings(CONSUMER_BARCODE_STRING="CUSTOM BARCODE")
@@ -362,14 +362,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-39-custom.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [0])
 
     @override_settings(CONSUMER_BARCODE_STRING="CUSTOM BARCODE")
@@ -378,14 +378,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-qr-custom.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [0])
 
     @override_settings(CONSUMER_BARCODE_STRING="CUSTOM BARCODE")
@@ -394,14 +394,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-128-custom.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [0])
 
     def test_scan_file_for_separating_wrong_qr_barcodes(self):
@@ -409,14 +409,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-39-custom.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [])
 
     def test_separate_pages(self):
@@ -507,14 +507,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
         )
         tempdir = tempfile.mkdtemp(prefix="paperless-", dir=settings.SCRATCH_DIR)
 
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(test_file, pdf_file)
+        self.assertEqual(test_file, doc_barcode_info.pdf_path)
         self.assertTrue(len(separator_page_numbers) > 0)
 
         document_list = barcodes.separate_pages(test_file, separator_page_numbers)
@@ -622,14 +622,14 @@ class TestBarcode(DirectoriesMixin, TestCase):
             - Scanning handle the exception without exception
         """
         test_file = os.path.join(self.SAMPLE_DIR, "password-is-test.pdf")
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
         separator_page_numbers = barcodes.get_separating_barcodes(
-            parsed_barcodes,
+            doc_barcode_info.barcodes,
         )
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertListEqual(separator_page_numbers, [])
 
     def test_scan_file_for_asn_barcode(self):
@@ -637,12 +637,12 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-39-asn-123.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
-        asn = barcodes.get_asn_from_barcodes(parsed_barcodes)
+        asn = barcodes.get_asn_from_barcodes(doc_barcode_info.barcodes)
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertEqual(asn, 123)
 
     def test_scan_file_for_asn_not_existing(self):
@@ -650,12 +650,12 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "patch-code-t.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
-        asn = barcodes.get_asn_from_barcodes(parsed_barcodes)
+        asn = barcodes.get_asn_from_barcodes(doc_barcode_info.barcodes)
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertEqual(asn, None)
 
     def test_scan_file_for_asn_barcode_invalid(self):
@@ -663,13 +663,13 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-39-asn-invalid.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
 
-        asn = barcodes.get_asn_from_barcodes(parsed_barcodes)
+        asn = barcodes.get_asn_from_barcodes(doc_barcode_info.barcodes)
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertEqual(asn, None)
 
     @override_settings(CONSUMER_ASN_BARCODE_PREFIX="CUSTOM-PREFIX-")
@@ -678,10 +678,10 @@ class TestBarcode(DirectoriesMixin, TestCase):
             self.BARCODE_SAMPLE_DIR,
             "barcode-39-asn-custom-prefix.pdf",
         )
-        pdf_file, parsed_barcodes = barcodes.scan_file_for_barcodes(
+        doc_barcode_info = barcodes.scan_file_for_barcodes(
             test_file,
         )
-        asn = barcodes.get_asn_from_barcodes(parsed_barcodes)
+        asn = barcodes.get_asn_from_barcodes(doc_barcode_info.barcodes)
 
-        self.assertEqual(pdf_file, test_file)
+        self.assertEqual(doc_barcode_info.pdf_path, test_file)
         self.assertEqual(asn, 123)