fix: resolve CI linting and type checking issues

- Fix line length violations in test files
- Apply ruff formatting to maintain consistent code style
- Add type annotations to test helper functions
- Update error message assertions to avoid line length issues

Author: jdrhyne

src/nutrient_dws/api/direct.py

@@ -217,13 +217,10 @@ def watermark_pdf(
                 "height": height,
                 "opacity": opacity,
                 "position": position,
-                "image": "watermark"  # Reference to the uploaded image file
+                "image": "watermark",  # Reference to the uploaded image file
             }
 
-            instructions = {
-                "parts": [{"file": "file"}],
-                "actions": [action]
-            }
+            instructions = {"parts": [{"file": "file"}], "actions": [action]}
 
             # Make API request
             # Type checking: at runtime, self is NutrientClient which has _http_client

tests/integration/test_watermark_image_file_integration.py

@@ -1,7 +1,8 @@
 """Integration tests for image file watermark functionality."""
 
 import os
-from typing import Optional
+from pathlib import Path
+from typing import Optional, Union
 
 import pytest
 
@@ -19,7 +20,7 @@
     TIMEOUT = 60
 
 
-def assert_is_pdf(file_path_or_bytes):
+def assert_is_pdf(file_path_or_bytes: Union[str, bytes]) -> None:
     """Assert that a file or bytes is a valid PDF."""
     if isinstance(file_path_or_bytes, str):
         with open(file_path_or_bytes, "rb") as f:
@@ -32,13 +33,13 @@ def assert_is_pdf(file_path_or_bytes):
     )
 
 
-def create_test_image(tmp_path, filename="watermark.png"):
+def create_test_image(tmp_path: Path, filename: str = "watermark.png") -> str:
     """Create a simple test PNG image."""
     # PNG header for a 1x1 transparent pixel
     png_data = (
-        b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01'
-        b'\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\rIDATx\x9cc\xf8\x0f'
-        b'\x00\x00\x01\x01\x00\x00\xcb\xd6\x8e\n\x00\x00\x00\x00IEND\xaeB`\x82'
+        b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01"
+        b"\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\rIDATx\x9cc\xf8\x0f"
+        b"\x00\x00\x01\x01\x00\x00\xcb\xd6\x8e\n\x00\x00\x00\x00IEND\xaeB`\x82"
     )
 
     image_path = tmp_path / filename
@@ -73,7 +74,7 @@ def test_watermark_pdf_with_image_file_path(self, client, sample_pdf_path, tmp_p
             width=100,
             height=50,
             opacity=0.5,
-            position="bottom-right"
+            position="bottom-right",
         )
 
         assert isinstance(result, bytes)
@@ -84,9 +85,9 @@ def test_watermark_pdf_with_image_bytes(self, client, sample_pdf_path):
         """Test watermark_pdf with image as bytes."""
         # PNG header for a 1x1 transparent pixel
         png_bytes = (
-            b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01'
-            b'\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\rIDATx\x9cc\xf8\x0f'
-            b'\x00\x00\x01\x01\x00\x00\xcb\xd6\x8e\n\x00\x00\x00\x00IEND\xaeB`\x82'
+            b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01"
+            b"\x08\x06\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\rIDATx\x9cc\xf8\x0f"
+            b"\x00\x00\x01\x01\x00\x00\xcb\xd6\x8e\n\x00\x00\x00\x00IEND\xaeB`\x82"
         )
 
         result = client.watermark_pdf(
@@ -95,7 +96,7 @@ def test_watermark_pdf_with_image_bytes(self, client, sample_pdf_path):
             width=150,
             height=75,
             opacity=0.8,
-            position="top-left"
+            position="top-left",
         )
 
         assert isinstance(result, bytes)
@@ -115,7 +116,7 @@ def test_watermark_pdf_with_image_file_output_path(self, client, sample_pdf_path
             height=100,
             opacity=0.7,
             position="center",
-            output_path=output_path
+            output_path=output_path,
         )
 
         assert result is None
@@ -136,7 +137,7 @@ def test_watermark_pdf_with_file_like_object(self, client, sample_pdf_path, tmp_
                 width=120,
                 height=60,
                 opacity=0.6,
-                position="top-center"
+                position="top-center",
             )
 
         assert isinstance(result, bytes)
@@ -151,13 +152,16 @@ def test_builder_api_with_image_file_watermark(self, client, sample_pdf_path, tm
         # Use builder API
         result = (
             client.build(sample_pdf_path)
-            .add_step("watermark-pdf", options={
-                "image_file": image_path,
-                "width": 180,
-                "height": 90,
-                "opacity": 0.4,
-                "position": "bottom-left"
-            })
+            .add_step(
+                "watermark-pdf",
+                options={
+                    "image_file": image_path,
+                    "width": 180,
+                    "height": 90,
+                    "opacity": 0.4,
+                    "position": "bottom-left",
+                },
+            )
             .execute()
         )
 
@@ -173,24 +177,29 @@ def test_multiple_watermarks_with_image_files(self, client, sample_pdf_path, tmp
         # Chain multiple watermark operations
         result = (
             client.build(sample_pdf_path)
-            .add_step("watermark-pdf", options={
-                "text": "DRAFT",
-                "width": 200,
-                "height": 100,
-                "opacity": 0.3,
-                "position": "center"
-            })
-            .add_step("watermark-pdf", options={
-                "image_file": image1_path,
-                "width": 100,
-                "height": 50,
-                "opacity": 0.5,
-                "position": "top-right"
-            })
+            .add_step(
+                "watermark-pdf",
+                options={
+                    "text": "DRAFT",
+                    "width": 200,
+                    "height": 100,
+                    "opacity": 0.3,
+                    "position": "center",
+                },
+            )
+            .add_step(
+                "watermark-pdf",
+                options={
+                    "image_file": image1_path,
+                    "width": 100,
+                    "height": 50,
+                    "opacity": 0.5,
+                    "position": "top-right",
+                },
+            )
             .execute()
         )
 
         assert isinstance(result, bytes)
         assert len(result) > 0
         assert_is_pdf(result)
-

tests/unit/test_direct_api.py

@@ -162,7 +162,8 @@ def test_watermark_pdf_with_image_url(self, mock_process):
 
     def test_watermark_pdf_no_text_or_image_raises_error(self):
         """Test watermark_pdf raises ValueError when neither text nor image_url provided."""
-        with pytest.raises(ValueError, match="Either text, image_url, or image_file must be provided"):
+        err_msg = "Either text, image_url, or image_file must be provided"
+        with pytest.raises(ValueError, match=err_msg):
             self.client.watermark_pdf("test.pdf")
 
     @patch("nutrient_dws.client.NutrientClient._process_file")
@@ -314,16 +315,18 @@ def setup_method(self):
 
     def test_watermark_pdf_validation_error(self):
         """Test watermark_pdf parameter validation."""
+        err_msg = "Either text, image_url, or image_file must be provided"
+
         # Test missing text, image_url, and image_file
-        with pytest.raises(ValueError, match="Either text, image_url, or image_file must be provided"):
+        with pytest.raises(ValueError, match=err_msg):
             self.client.watermark_pdf("test.pdf")
 
         # Test empty text and no image_url or image_file
-        with pytest.raises(ValueError, match="Either text, image_url, or image_file must be provided"):
+        with pytest.raises(ValueError, match=err_msg):
             self.client.watermark_pdf("test.pdf", text="")
 
         # Test None text and no image_url or image_file
-        with pytest.raises(ValueError, match="Either text, image_url, or image_file must be provided"):
+        with pytest.raises(ValueError, match=err_msg):
             self.client.watermark_pdf("test.pdf", text=None)
 
     def test_merge_pdfs_validation_error(self):

tests/unit/test_watermark_image_file.py

@@ -35,7 +35,7 @@ def test_watermark_pdf_with_image_file_bytes(self, client, mock_http_client):
             width=150,
             height=75,
             opacity=0.8,
-            position="top-right"
+            position="top-right",
         )
 
         assert result == b"PDF content"
@@ -70,12 +70,7 @@ def test_watermark_pdf_with_image_file_object(self, client, mock_http_client):
         pdf_file = BytesIO(b"PDF file content")
         image_file = BytesIO(b"PNG image data")
 
-        result = client.watermark_pdf(
-            pdf_file,
-            image_file=image_file,
-            width=200,
-            height=100
-        )
+        result = client.watermark_pdf(pdf_file, image_file=image_file, width=200, height=100)
 
         assert result == b"PDF content"
 
@@ -91,9 +86,7 @@ def test_watermark_pdf_with_output_path(self, client, mock_http_client):
 
         with patch("nutrient_dws.file_handler.save_file_output") as mock_save:
             result = client.watermark_pdf(
-                pdf_bytes,
-                image_file=image_bytes,
-                output_path="output.pdf"
+                pdf_bytes, image_file=image_bytes, output_path="output.pdf"
             )
 
             assert result is None
@@ -110,10 +103,7 @@ def test_watermark_pdf_text_still_works(self, client, mock_http_client):
         # Mock _process_file method
         with patch.object(client, "_process_file", return_value=b"PDF content") as mock_process:
             result = client.watermark_pdf(
-                b"PDF content",
-                text="CONFIDENTIAL",
-                width=200,
-                height=100
+                b"PDF content", text="CONFIDENTIAL", width=200, height=100
             )
 
             assert result == b"PDF content"
@@ -125,18 +115,15 @@ def test_watermark_pdf_text_still_works(self, client, mock_http_client):
                 height=100,
                 opacity=1.0,
                 position="center",
-                text="CONFIDENTIAL"
+                text="CONFIDENTIAL",
             )
 
     def test_watermark_pdf_url_still_works(self, client, mock_http_client):
         """Test that URL watermarks still work with new implementation."""
         # Mock _process_file method
         with patch.object(client, "_process_file", return_value=b"PDF content") as mock_process:
             result = client.watermark_pdf(
-                b"PDF content",
-                image_url="https://example.com/logo.png",
-                width=200,
-                height=100
+                b"PDF content", image_url="https://example.com/logo.png", width=200, height=100
             )
 
             assert result == b"PDF content"
@@ -148,7 +135,7 @@ def test_watermark_pdf_url_still_works(self, client, mock_http_client):
                 height=100,
                 opacity=1.0,
                 position="center",
-                image_url="https://example.com/logo.png"
+                image_url="https://example.com/logo.png",
             )
 
     def test_builder_api_with_image_file(self, client, mock_http_client):
@@ -157,13 +144,16 @@ def test_builder_api_with_image_file(self, client, mock_http_client):
         image_bytes = b"PNG image data"
 
         builder = client.build(pdf_bytes)
-        builder.add_step("watermark-pdf", options={
-            "image_file": image_bytes,
-            "width": 150,
-            "height": 75,
-            "opacity": 0.5,
-            "position": "bottom-right"
-        })
+        builder.add_step(
+            "watermark-pdf",
+            options={
+                "image_file": image_bytes,
+                "width": 150,
+                "height": 75,
+                "opacity": 0.5,
+                "position": "bottom-right",
+            },
+        )
 
         result = builder.execute()
 
@@ -197,16 +187,10 @@ def test_watermark_pdf_precedence(self, client, mock_http_client):
         # But for clarity, let's test that providing text uses text watermark
         with patch.object(client, "_process_file", return_value=b"PDF content") as mock_process:
             # Test with text - should use _process_file
-            client.watermark_pdf(
-                b"PDF content",
-                text="TEXT",
-                width=100,
-                height=50
-            )
+            client.watermark_pdf(b"PDF content", text="TEXT", width=100, height=50)
 
             # Should use text path
             mock_process.assert_called_once()
             call_args = mock_process.call_args[1]
             assert "text" in call_args
             assert call_args["text"] == "TEXT"
-