fix: resolve CI failures

- Update pytest coverage to use nutrient_dws instead of nutrient
- Fix ruff configuration deprecation warnings in pyproject.toml
- Apply ruff formatting to all Python files
- Fix mypy type checking errors in DirectAPIMixin
- Add Protocol typing to resolve circular import issues
- Use cast for type checking in methods that use build() and _http_client

The CI should now pass with all tests, linting, and type checking.

Author: jdrhyne

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
       run: mypy src tests
 
     - name: Run tests with pytest
-      run: pytest -v --cov=nutrient --cov-report=xml --cov-report=term
+      run: pytest -v --cov=nutrient_dws --cov-report=xml --cov-report=term
 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4

pyproject.toml

@@ -64,6 +64,8 @@ nutrient_dws = ["py.typed"]
 [tool.ruff]
 target-version = "py38"
 line-length = 100
+
+[tool.ruff.lint]
 select = [
     "E",    # pycodestyle errors
     "W",    # pycodestyle warnings
@@ -84,10 +86,10 @@ ignore = [
     "D107",  # Missing docstring in __init__
 ]
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/*" = ["D", "S101"]  # Don't require docstrings in tests, allow asserts
 
 [tool.mypy]

src/nutrient_dws/api/direct.py

@@ -4,26 +4,40 @@
 for supported document processing operations.
 """
 
-from typing import TYPE_CHECKING, Any, List, Optional
+from typing import TYPE_CHECKING, Any, List, Optional, Protocol, cast
 
 from nutrient_dws.file_handler import FileInput
 
 if TYPE_CHECKING:
-    from nutrient_dws.client import NutrientClient
+    from nutrient_dws.builder import BuildAPIWrapper
+    from nutrient_dws.http_client import HTTPClient
+
+
+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."""
+        ...
 
 
 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.
-    
+
     Note: The API automatically converts supported document formats
     (DOCX, XLSX, PPTX) to PDF when processing.
     """
 
     def _process_file(
-        self: "NutrientClient",
+        self,
         tool: str,
         input_file: FileInput,
         output_path: Optional[str] = None,
@@ -40,7 +54,7 @@ def convert_to_pdf(
         """Convert a document to PDF.
 
         Converts Office documents (DOCX, XLSX, PPTX) to PDF format.
-        This uses the API's implicit conversion - simply uploading a 
+        This uses the API's implicit conversion - simply uploading a
         non-PDF document returns it as a PDF.
 
         Args:
@@ -53,12 +67,14 @@ def convert_to_pdf(
         Raises:
             AuthenticationError: If API key is missing or invalid.
             APIError: For other API errors (e.g., unsupported format).
-            
+
         Note:
             HTML files are not currently supported by the API.
         """
         # Use builder with no actions - implicit conversion happens
-        return self.build(input_file).execute(output_path)  # type: ignore
+        if TYPE_CHECKING:
+            self = cast(HasBuildMethod, self)
+        return self.build(input_file).execute(output_path)
 
     def flatten_annotations(
         self, input_file: FileInput, output_path: Optional[str] = None
@@ -120,7 +136,7 @@ def ocr_pdf(
         """Apply OCR to a PDF to make it searchable.
 
         Performs optical character recognition on the PDF to extract text
-        and make it searchable. If input is an Office document, it will 
+        and make it searchable. If input is an Office document, it will
         be converted to PDF first.
 
         Args:
@@ -199,7 +215,7 @@ def apply_redactions(
         """Apply redaction annotations to permanently remove content.
 
         Applies any redaction annotations in the PDF to permanently remove
-        the underlying content. If input is an Office document, it will 
+        the underlying content. If input is an Office document, it will
         be converted to PDF first.
 
         Args:
@@ -216,14 +232,14 @@ def apply_redactions(
         return self._process_file("apply-redactions", input_file, output_path)
 
     def merge_pdfs(
-        self: "NutrientClient",
+        self,
         input_files: List[FileInput],
         output_path: Optional[str] = None,
     ) -> Optional[bytes]:
         """Merge multiple PDF files into one.
 
         Combines multiple files into a single PDF in the order provided.
-        Office documents (DOCX, XLSX, PPTX) will be automatically converted 
+        Office documents (DOCX, XLSX, PPTX) will be automatically converted
         to PDF before merging.
 
         Args:
@@ -237,7 +253,7 @@ def merge_pdfs(
             AuthenticationError: If API key is missing or invalid.
             APIError: For other API errors.
             ValueError: If less than 2 files provided.
-            
+
         Example:
             # Merge PDFs and Office documents
             client.merge_pdfs([
@@ -262,12 +278,11 @@ def merge_pdfs(
             parts.append({"file": field_name})
 
         # Build instructions for merge (no actions needed)
-        instructions = {
-            "parts": parts,
-            "actions": []
-        }
+        instructions = {"parts": parts, "actions": []}
 
         # Make API request
+        if TYPE_CHECKING:
+            self = cast(HasBuildMethod, self)
         result = self._http_client.post(
             "/build",
             files=files,

src/nutrient_dws/builder.py

@@ -21,7 +21,7 @@ class BuildAPIWrapper:
 
     def __init__(self, client: Any, input_file: FileInput) -> None:
         """Initialize builder with client and input file.
-        
+
         Args:
             client: NutrientClient instance.
             input_file: Input file to process.
@@ -35,7 +35,7 @@ def __init__(self, client: Any, input_file: FileInput) -> None:
 
     def _add_file_part(self, file: FileInput, name: str) -> None:
         """Add an additional file part for operations like merge.
-        
+
         Args:
             file: File to add.
             name: Name for the file part.
@@ -52,7 +52,7 @@ def add_step(self, tool: str, options: Optional[Dict[str, Any]] = None) -> "Buil
 
         Returns:
             Self for method chaining.
-            
+
         Example:
             >>> builder.add_step(tool="rotate-pages", options={"degrees": 180})
         """
@@ -62,13 +62,13 @@ def add_step(self, tool: str, options: Optional[Dict[str, Any]] = None) -> "Buil
 
     def set_output_options(self, **options: Any) -> "BuildAPIWrapper":
         """Set output options for the final document.
-        
+
         Args:
             **options: Output options (e.g., metadata, optimization).
-            
+
         Returns:
             Self for method chaining.
-            
+
         Example:
             >>> builder.set_output_options(
         ...     metadata={"title": "My Document", "author": "John Doe"},
@@ -86,7 +86,7 @@ def execute(self, output_path: Optional[str] = None) -> Optional[bytes]:
 
         Returns:
             Processed file bytes, or None if output_path is provided.
-            
+
         Raises:
             AuthenticationError: If API key is missing or invalid.
             APIError: For other API errors.
@@ -116,7 +116,7 @@ def execute(self, output_path: Optional[str] = None) -> Optional[bytes]:
 
     def _build_instructions(self) -> Dict[str, Any]:
         """Build the instructions payload for the API.
-        
+
         Returns:
             Instructions dictionary for the Build API.
         """
@@ -133,11 +133,11 @@ def _build_instructions(self) -> Dict[str, Any]:
 
     def _map_tool_to_action(self, tool: str, options: Dict[str, Any]) -> Dict[str, Any]:
         """Map tool name and options to Build API action format.
-        
+
         Args:
             tool: Tool identifier.
             options: Tool options.
-            
+
         Returns:
             Action dictionary for the Build API.
         """

src/nutrient_dws/client.py

@@ -59,7 +59,7 @@ def build(self, input_file: FileInput) -> BuildAPIWrapper:
 
         Returns:
             BuildAPIWrapper instance for chaining operations.
-            
+
         Example:
             >>> builder = client.build(input_file="document.pdf")
             >>> builder.add_step(tool="rotate-pages", options={"degrees": 90})
@@ -75,19 +75,19 @@ def _process_file(
         **options: Any,
     ) -> Optional[bytes]:
         """Process a file using the Direct API.
-        
+
         This is the internal method used by all Direct API methods.
         It internally uses the Build API with a single action.
-        
+
         Args:
             tool: The tool identifier from the API.
             input_file: Input file to process.
             output_path: Optional path to save the output.
             **options: Tool-specific options.
-            
+
         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.

src/nutrient_dws/exceptions.py

@@ -11,7 +11,7 @@ class NutrientError(Exception):
 
 class AuthenticationError(NutrientError):
     """Raised when authentication fails (401/403 errors).
-    
+
     This typically indicates:
     - Missing API key
     - Invalid API key

src/nutrient_dws/http_client.py

@@ -18,7 +18,7 @@ class HTTPClient:
 
     def __init__(self, api_key: Optional[str], timeout: int = 300) -> None:
         """Initialize HTTP client with authentication.
-        
+
         Args:
             api_key: API key for authentication.
             timeout: Request timeout in seconds.
@@ -61,13 +61,13 @@ def _create_session(self) -> requests.Session:
 
     def _handle_response(self, response: requests.Response) -> bytes:
         """Handle API response and raise appropriate exceptions.
-        
+
         Args:
             response: Response from the API.
-            
+
         Returns:
             Response content as bytes.
-            
+
         Raises:
             AuthenticationError: For 401/403 responses.
             ValidationError: For 422 responses.
@@ -129,7 +129,7 @@ def post(
 
         Returns:
             Response content as bytes.
-            
+
         Raises:
             AuthenticationError: If API key is missing or invalid.
             TimeoutError: If request times out.

tests/integration/conftest.py

@@ -31,11 +31,11 @@ def pytest_addoption(parser):
         "--unit-only",
         action="store_true",
         default=False,
-        help="Run only unit tests, skip integration tests"
+        help="Run only unit tests, skip integration tests",
     )
     parser.addoption(
         "--integration-only",
         action="store_true",
         default=False,
-        help="Run only integration tests, skip unit tests"
-    )
+        help="Run only integration tests, skip unit tests",
+    )