fix: CI pipeline linting and type checking errors

- Fixed RUF034: Removed unnecessary conditional expression in generate_api_methods.py
- Fixed SIM115: Added noqa comment for intentional file handle without context manager
- Fixed E501: Split long lines in test files to meet 100 character limit
- Fixed B017: Replaced generic Exception with specific APIError in test assertion
- Fixed mypy type checking errors by adding proper type ignore comments
- All linting (ruff) and type checking (mypy) now pass successfully

Author: jdrhyne

scripts/build_package.py

@@ -5,35 +5,34 @@
 import sys
 from pathlib import Path
 
+
 def main():
     """Build the package."""
     root_dir = Path(__file__).parent.parent
-    
+
     # Clean previous builds
     print("Cleaning previous builds...")
     for dir_name in ["dist", "build", "*.egg-info"]:
         subprocess.run(["rm", "-rf", str(root_dir / dir_name)])
-    
+
     # Build the package
     print("Building package...")
     result = subprocess.run(
-        [sys.executable, "-m", "build"],
-        cwd=root_dir,
-        capture_output=True,
-        text=True
+        [sys.executable, "-m", "build"], cwd=root_dir, capture_output=True, text=True
     )
-    
+
     if result.returncode != 0:
         print(f"Build failed:\n{result.stderr}")
         return 1
-    
+
     print("Build successful!")
     print("\nBuilt files:")
     dist_dir = root_dir / "dist"
     for file in dist_dir.iterdir():
         print(f"  - {file.name}")
-    
+
     return 0
 
+
 if __name__ == "__main__":
-    sys.exit(main())
+    sys.exit(main())

scripts/generate_api_methods.py

@@ -35,7 +35,7 @@ def get_python_type(schema: Dict[str, Any]) -> str:
 
 def create_manual_tools() -> List[Dict[str, Any]]:
     """Create tool definitions based on the specification documentation.
-    
+
     Since the Nutrient API uses a build endpoint with actions rather than
     individual tool endpoints, we'll create convenience methods that wrap
     the build API.
@@ -90,7 +90,10 @@ def create_manual_tools() -> List[Dict[str, Any]]:
                 "page_indexes": {
                     "type": "List[int]",
                     "required": False,
-                    "description": "List of page indexes to rotate (0-based). If not specified, all pages are rotated.",
+                    "description": (
+                        "List of page indexes to rotate (0-based). "
+                        "If not specified, all pages are rotated."
+                    ),
                 },
             },
         },
@@ -245,10 +248,7 @@ def generate_method_code(tool_info: Dict[str, Any]) -> str:
         if not param_info["required"]:
             param_type = param_info["type"]
             # Handle List types
-            if param_type.startswith("List["):
-                base_type = param_type
-            else:
-                base_type = param_type
+            base_type = param_type
 
             default = param_info.get("default")
             if default is None:
@@ -263,7 +263,9 @@ def generate_method_code(tool_info: Dict[str, Any]) -> str:
     # Build method signature
     if len(param_list) > 3:  # Multiple parameters
         params_str = ",\n        ".join(param_list)
-        method_signature = f"    def {method_name}(\n        {params_str},\n    ) -> Optional[bytes]:"
+        method_signature = (
+            f"    def {method_name}(\n        {params_str},\n    ) -> Optional[bytes]:"
+        )
     else:
         params_str = ", ".join(param_list)
         method_signature = f"    def {method_name}({params_str}) -> Optional[bytes]:"
@@ -274,48 +276,56 @@ def generate_method_code(tool_info: Dict[str, Any]) -> str:
         docstring_lines.append("")
         docstring_lines.append(f"        {description}")
 
-    docstring_lines.extend([
-        "",
-        "        Args:",
-        "            input_file: Input file (path, bytes, or file-like object).",
-    ])
+    docstring_lines.extend(
+        [
+            "",
+            "        Args:",
+            "            input_file: Input file (path, bytes, or file-like object).",
+        ]
+    )
 
     if param_docs:
         docstring_lines.extend(param_docs)
 
-    docstring_lines.extend([
-        "            output_path: Optional path to save the output file.",
-        "",
-        "        Returns:",
-        "            Processed file as bytes, or None if output_path is provided.",
-        "",
-        "        Raises:",
-        "            AuthenticationError: If API key is missing or invalid.",
-        "            APIError: For other API errors.",
-        '        """',
-    ])
+    docstring_lines.extend(
+        [
+            "            output_path: Optional path to save the output file.",
+            "",
+            "        Returns:",
+            "            Processed file as bytes, or None if output_path is provided.",
+            "",
+            "        Raises:",
+            "            AuthenticationError: If API key is missing or invalid.",
+            "            APIError: For other API errors.",
+            '        """',
+        ]
+    )
 
     # Build method body
     method_body = []
 
     # Collect kwargs
-    kwargs_params = [
-        f"{name}={name}"
-        for name in parameters.keys()
-    ]
+    kwargs_params = [f"{name}={name}" for name in parameters]
 
     if kwargs_params:
         kwargs_str = ", ".join(kwargs_params)
-        method_body.append(f'        return self._process_file("{tool_name}", input_file, output_path, {kwargs_str})')
+        method_body.append(
+            f'        return self._process_file("{tool_name}", input_file, '
+            f"output_path, {kwargs_str})"
+        )
     else:
-        method_body.append(f'        return self._process_file("{tool_name}", input_file, output_path)')
+        method_body.append(
+            f'        return self._process_file("{tool_name}", input_file, output_path)'
+        )
 
     # Combine all parts
-    return "\n".join([
-        method_signature,
-        "\n".join(docstring_lines),
-        "\n".join(method_body),
-    ])
+    return "\n".join(
+        [
+            method_signature,
+            "\n".join(docstring_lines),
+            "\n".join(method_body),
+        ]
+    )
 
 
 def generate_api_methods(spec_path: Path, output_path: Path) -> None:
@@ -330,23 +340,23 @@ def generate_api_methods(spec_path: Path, output_path: Path) -> None:
     # Generate code
     code_lines = [
         '"""Direct API methods for individual document processing tools.',
-        '',
-        'This file provides convenient methods that wrap the Nutrient Build API',
-        'for common document processing operations.',
+        "",
+        "This file provides convenient methods that wrap the Nutrient Build API",
+        "for common document processing operations.",
         '"""',
-        '',
-        'from typing import List, Optional',
-        '',
-        'from nutrient_dws.file_handler import FileInput',
-        '',
-        '',
-        'class DirectAPIMixin:',
+        "",
+        "from typing import List, Optional",
+        "",
+        "from nutrient_dws.file_handler import FileInput",
+        "",
+        "",
+        "class DirectAPIMixin:",
         '    """Mixin class containing Direct API methods.',
-        '    ',
-        '    These methods provide a simplified interface to common document',
-        '    processing operations. They internally use the Build API.',
+        "    ",
+        "    These methods provide a simplified interface to common document",
+        "    processing operations. They internally use the Build API.",
         '    """',
-        '',
+        "",
     ]
 
     # Add methods

src/nutrient_dws/api/direct.py

@@ -15,11 +15,11 @@
 
 class HasBuildMethod(Protocol):
     """Protocol for objects that have a build method."""
-    
+
     def build(self, input_file: FileInput) -> "BuildAPIWrapper":
         """Build method signature."""
         ...
-    
+
     @property
     def _http_client(self) -> "HTTPClient":
         """HTTP client property."""
@@ -72,9 +72,8 @@ def convert_to_pdf(
             HTML files are not currently supported by the API.
         """
         # Use builder with no actions - implicit conversion happens
-        if TYPE_CHECKING:
-            self = cast(HasBuildMethod, self)
-        return self.build(input_file).execute(output_path)
+        # Type checking: at runtime, self is NutrientClient which has these methods
+        return self.build(input_file).execute(output_path)  # type: ignore[attr-defined,no-any-return]
 
     def flatten_annotations(
         self, input_file: FileInput, output_path: Optional[str] = None
@@ -281,9 +280,8 @@ def merge_pdfs(
         instructions = {"parts": parts, "actions": []}
 
         # Make API request
-        if TYPE_CHECKING:
-            self = cast(HasBuildMethod, self)
-        result = self._http_client.post(
+        # Type checking: at runtime, self is NutrientClient which has _http_client
+        result = self._http_client.post(  # type: ignore[attr-defined]
             "/build",
             files=files,
             json_data=instructions,
@@ -294,4 +292,4 @@ def merge_pdfs(
             save_file_output(result, output_path)
             return None
         else:
-            return result
+            return result  # type: ignore[no-any-return]

src/nutrient_dws/builder.py

@@ -6,11 +6,11 @@
 
 
 class BuildAPIWrapper:
-    """Builder pattern implementation for chaining document operations.
-    
+    r"""Builder pattern implementation for chaining document operations.
+
     This class provides a fluent interface for building complex document
     processing workflows using the Nutrient Build API.
-    
+
     Example:
         >>> client.build(input_file="document.pdf") \\
         ...     .add_step(tool="rotate-pages", options={"degrees": 90}) \\

src/nutrient_dws/client.py

@@ -10,24 +10,24 @@
 
 
 class NutrientClient(DirectAPIMixin):
-    """Main client for interacting with Nutrient DWS API.
-    
+    r"""Main client for interacting with Nutrient DWS API.
+
     This client provides two ways to interact with the API:
-    
+
     1. Direct API: Individual method calls for single operations
        Example: client.convert_to_pdf(input_file="document.docx")
-    
+
     2. Builder API: Fluent interface for chaining multiple operations
        Example: client.build(input_file="doc.docx").add_step("convert-to-pdf").execute()
 
     Args:
         api_key: API key for authentication. If not provided, will look for
             NUTRIENT_API_KEY environment variable.
         timeout: Request timeout in seconds. Defaults to 300.
-            
+
     Raises:
         AuthenticationError: When making API calls without a valid API key.
-        
+
     Example:
         >>> from nutrient_dws import NutrientClient
         >>> client = NutrientClient(api_key="your-api-key")

src/nutrient_dws/file_handler.py

@@ -80,7 +80,9 @@ def prepare_file_for_upload(
         # For large files, return file handle instead of reading into memory
         file_size = path.stat().st_size
         if file_size > 10 * 1024 * 1024:  # 10MB threshold
-            file_handle = open(path, "rb")
+            # Note: File handle is intentionally not using context manager
+            # as it needs to remain open for streaming upload by HTTP client
+            file_handle = open(path, "rb")  # noqa: SIM115
             return field_name, (path.name, file_handle, content_type)
         else:
             return field_name, (path.name, path.read_bytes(), content_type)

tests/integration/conftest.py

@@ -1,6 +1,5 @@
 """Configuration for integration tests."""
 
-import os
 
 import pytest
 

tests/integration/test_api_integration.py

@@ -6,14 +6,12 @@
 
 import os
 from pathlib import Path
-from typing import Generator
 
 import pytest
 
 from nutrient_dws import NutrientClient
 from nutrient_dws.exceptions import AuthenticationError
 
-
 # Skip integration tests if no API key is provided
 pytestmark = pytest.mark.skipif(
     not os.environ.get("NUTRIENT_API_KEY"), reason="NUTRIENT_API_KEY environment variable not set"
@@ -39,7 +37,9 @@ def sample_pdf(tmp_path: Path) -> Path:
 << /Type /Pages /Kids [3 0 R] /Count 1 >>
 endobj
 3 0 obj
-<< /Type /Page /Parent 2 0 R /Resources << /Font << /F1 << /Type /Font /Subtype /Type1 /BaseFont /Helvetica >> >> >> /MediaBox [0 0 612 792] /Contents 4 0 R >>
+<< /Type /Page /Parent 2 0 R /Resources
+<< /Font << /F1 << /Type /Font /Subtype /Type1 /BaseFont /Helvetica >> >> >>
+/MediaBox [0 0 612 792] /Contents 4 0 R >>
 endobj
 4 0 obj
 << /Length 44 >>
@@ -53,11 +53,11 @@ def sample_pdf(tmp_path: Path) -> Path:
 endobj
 xref
 0 5
-0000000000 65535 f 
-0000000009 00000 n 
-0000000058 00000 n 
-0000000115 00000 n 
-0000000323 00000 n 
+0000000000 65535 f
+0000000009 00000 n
+0000000058 00000 n
+0000000115 00000 n
+0000000323 00000 n
 trailer
 << /Size 5 /Root 1 0 R >>
 startxref
@@ -81,17 +81,21 @@ def sample_docx(tmp_path: Path) -> Path:
             "[Content_Types].xml",
             """<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
-    <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
+    <Default Extension="rels"
+        ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
     <Default Extension="xml" ContentType="application/xml"/>
-    <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/>
+    <Override PartName="/word/document.xml"
+        ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/>
 </Types>""",
         )
 
         docx.writestr(
             "_rels/.rels",
             """<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
-    <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/>
+    <Relationship Id="rId1"
+        Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
+        Target="word/document.xml"/>
 </Relationships>""",
         )
 
@@ -292,7 +296,9 @@ def test_invalid_file(self, client: NutrientClient, tmp_path: Path) -> None:
         invalid_file = tmp_path / "invalid.txt"
         invalid_file.write_text("This is not a PDF")
 
-        with pytest.raises(Exception):  # API should return an error
+        from nutrient_dws.exceptions import APIError
+
+        with pytest.raises(APIError):  # API should return an error
             client.rotate_pages(input_file=invalid_file, degrees=90)
 
     def test_missing_file(self, client: NutrientClient) -> None: