Add black code formatter

2025-08-08 03:08:29 +02:00 · 2024-01-27 11:29:16 +01:00
parent 6775633be5
commit 98b9a9c1a0
128 changed files with 7181 additions and 4264 deletions
--- a/bookmarks/tests/test_website_loader.py
+++ b/bookmarks/tests/test_website_loader.py
@@ -8,11 +8,11 @@ class MockStreamingResponse:
    def __init__(self, num_chunks, chunk_size, insert_head_after_chunk=None):
        self.chunks = []
        for index in range(num_chunks):
-            chunk = ''.zfill(chunk_size)
-            self.chunks.append(chunk.encode('utf-8'))
+            chunk = "".zfill(chunk_size)
+            self.chunks.append(chunk.encode("utf-8"))

            if index == insert_head_after_chunk:
-                self.chunks.append('</head>'.encode('utf-8'))
+                self.chunks.append("</head>".encode("utf-8"))

    def iter_content(self, **kwargs):
        return self.chunks
@@ -29,10 +29,16 @@ class WebsiteLoaderTestCase(TestCase):
        # clear cached metadata before test run
        website_loader.load_website_metadata.cache_clear()

-    def render_html_document(self, title, description='', og_description=''):
-        meta_description = f'<meta name="description" content="{description}">' if description else ''
-        meta_og_description = f'<meta property="og:description" content="{og_description}">' if og_description else ''
-        return f'''
+    def render_html_document(self, title, description="", og_description=""):
+        meta_description = (
+            f'<meta name="description" content="{description}">' if description else ""
+        )
+        meta_og_description = (
+            f'<meta property="og:description" content="{og_description}">'
+            if og_description
+            else ""
+        )
+        return f"""
        <!DOCTYPE html>
        <html lang="en">
        <head>
@@ -43,73 +49,92 @@ class WebsiteLoaderTestCase(TestCase):
        </head>
        <body></body>
        </html>
-        '''
+        """

    def test_load_page_returns_content(self):
-        with mock.patch('requests.get') as mock_get:
-            mock_get.return_value = MockStreamingResponse(num_chunks=10, chunk_size=1024)
-            content = website_loader.load_page('https://example.com')
+        with mock.patch("requests.get") as mock_get:
+            mock_get.return_value = MockStreamingResponse(
+                num_chunks=10, chunk_size=1024
+            )
+            content = website_loader.load_page("https://example.com")

            expected_content_size = 10 * 1024
            self.assertEqual(expected_content_size, len(content))

    def test_load_page_limits_large_documents(self):
-        with mock.patch('requests.get') as mock_get:
-            mock_get.return_value = MockStreamingResponse(num_chunks=10, chunk_size=1024 * 1000)
-            content = website_loader.load_page('https://example.com')
+        with mock.patch("requests.get") as mock_get:
+            mock_get.return_value = MockStreamingResponse(
+                num_chunks=10, chunk_size=1024 * 1000
+            )
+            content = website_loader.load_page("https://example.com")

            # Should have read six chunks, after which content exceeds the max of 5MB
            expected_content_size = 6 * 1024 * 1000
            self.assertEqual(expected_content_size, len(content))

    def test_load_page_stops_reading_at_end_of_head(self):
-        with mock.patch('requests.get') as mock_get:
-            mock_get.return_value = MockStreamingResponse(num_chunks=10, chunk_size=1024 * 1000,
-                                                          insert_head_after_chunk=0)
-            content = website_loader.load_page('https://example.com')
+        with mock.patch("requests.get") as mock_get:
+            mock_get.return_value = MockStreamingResponse(
+                num_chunks=10, chunk_size=1024 * 1000, insert_head_after_chunk=0
+            )
+            content = website_loader.load_page("https://example.com")

            # Should have read first chunk, and second chunk containing closing head tag
-            expected_content_size = 1 * 1024 * 1000 + len('</head>')
+            expected_content_size = 1 * 1024 * 1000 + len("</head>")
            self.assertEqual(expected_content_size, len(content))

    def test_load_page_removes_bytes_after_end_of_head(self):
-        with mock.patch('requests.get') as mock_get:
+        with mock.patch("requests.get") as mock_get:
            mock_response = MockStreamingResponse(num_chunks=1, chunk_size=0)
-            mock_response.chunks[0] = '<head>人</head>'.encode('utf-8')
+            mock_response.chunks[0] = "<head>人</head>".encode("utf-8")
            # add a single byte that can't be decoded to utf-8
-            mock_response.chunks[0] += 0xff.to_bytes(1, 'big')
+            mock_response.chunks[0] += 0xFF.to_bytes(1, "big")
            mock_get.return_value = mock_response
-            content = website_loader.load_page('https://example.com')
+            content = website_loader.load_page("https://example.com")

            # verify that byte after head was removed, content parsed as utf-8
-            self.assertEqual(content, '<head>人</head>')
+            self.assertEqual(content, "<head>人</head>")

    def test_load_website_metadata(self):
-        with mock.patch('bookmarks.services.website_loader.load_page') as mock_load_page:
-            mock_load_page.return_value = self.render_html_document('test title', 'test description')
-            metadata = website_loader.load_website_metadata('https://example.com')
-            self.assertEqual('test title', metadata.title)
-            self.assertEqual('test description', metadata.description)
+        with mock.patch(
+            "bookmarks.services.website_loader.load_page"
+        ) as mock_load_page:
+            mock_load_page.return_value = self.render_html_document(
+                "test title", "test description"
+            )
+            metadata = website_loader.load_website_metadata("https://example.com")
+            self.assertEqual("test title", metadata.title)
+            self.assertEqual("test description", metadata.description)

    def test_load_website_metadata_trims_title_and_description(self):
-        with mock.patch('bookmarks.services.website_loader.load_page') as mock_load_page:
-            mock_load_page.return_value = self.render_html_document('  test title  ', '  test description  ')
-            metadata = website_loader.load_website_metadata('https://example.com')
-            self.assertEqual('test title', metadata.title)
-            self.assertEqual('test description', metadata.description)
+        with mock.patch(
+            "bookmarks.services.website_loader.load_page"
+        ) as mock_load_page:
+            mock_load_page.return_value = self.render_html_document(
+                "  test title  ", "  test description  "
+            )
+            metadata = website_loader.load_website_metadata("https://example.com")
+            self.assertEqual("test title", metadata.title)
+            self.assertEqual("test description", metadata.description)

    def test_load_website_metadata_using_og_description(self):
-        with mock.patch('bookmarks.services.website_loader.load_page') as mock_load_page:
-            mock_load_page.return_value = self.render_html_document('test title', '',
-                                                                    og_description='test og description')
-            metadata = website_loader.load_website_metadata('https://example.com')
-            self.assertEqual('test title', metadata.title)
-            self.assertEqual('test og description', metadata.description)
+        with mock.patch(
+            "bookmarks.services.website_loader.load_page"
+        ) as mock_load_page:
+            mock_load_page.return_value = self.render_html_document(
+                "test title", "", og_description="test og description"
+            )
+            metadata = website_loader.load_website_metadata("https://example.com")
+            self.assertEqual("test title", metadata.title)
+            self.assertEqual("test og description", metadata.description)

    def test_load_website_metadata_prefers_description_over_og_description(self):
-        with mock.patch('bookmarks.services.website_loader.load_page') as mock_load_page:
-            mock_load_page.return_value = self.render_html_document('test title', 'test description',
-                                                                    og_description='test og description')
-            metadata = website_loader.load_website_metadata('https://example.com')
-            self.assertEqual('test title', metadata.title)
-            self.assertEqual('test description', metadata.description)
+        with mock.patch(
+            "bookmarks.services.website_loader.load_page"
+        ) as mock_load_page:
+            mock_load_page.return_value = self.render_html_document(
+                "test title", "test description", og_description="test og description"
+            )
+            metadata = website_loader.load_website_metadata("https://example.com")
+            self.assertEqual("test title", metadata.title)
+            self.assertEqual("test description", metadata.description)