remove test, fix ruff

Author: HungKNguyen

.pre-commit-config.yaml

@@ -12,6 +12,14 @@ repos:
       - id: debug-statements
       - id: mixed-line-ending
 
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.8
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.17.1
     hooks:

tests/integration/__init__.py renamed to LLM_DOC.md

@@ -72,7 +72,7 @@ dws-add-windsurf-rule = "scripts.add_windsurf_rule:main"
 
 [tool.ruff]
 target-version = "py310"
-line-length = 100
+
 
 [tool.ruff.lint]
 select = [
@@ -90,10 +90,21 @@ select = [
     "RUF",  # Ruff-specific rules
 ]
 ignore = [
+    "E501",  # Line too long
+    "B904",  # Within an `except` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling
     "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "D103",  # Missing docstring in public function
     "D104",  # Missing docstring in public package
     "D107",  # Missing docstring in __init__
+    "D205",  # 1 blank line required between summary line and description
+    "UP007", # Use `X | Y` for type annotations
     "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)` - not supported in Python 3.10 runtime
+    "UP045", # Use `X | None` for type annotations
+    "N802",  # Function name should be lowercase
+    "N803",  # Argument name should be lowercase
+    "N815",  # Variable in class scope should not be mixedCase
+    "N811",  # Constant imported as non-constant
 ]
 
 [tool.ruff.lint.pydocstyle]

tests/integration/py.typed renamed to METHODS.md

@@ -2,8 +2,7 @@
 
 from __future__ import annotations
 
-from collections.abc import Callable
-from typing import Literal, TypeGuard, cast
+from typing import TYPE_CHECKING, Literal, TypeGuard, cast
 
 from nutrient_dws.builder.base_builder import BaseBuilder
 from nutrient_dws.builder.constant import ActionWithFileInput, BuildOutputs
@@ -21,36 +20,44 @@
     WorkflowWithPartsStage,
 )
 from nutrient_dws.errors import ValidationError
-from nutrient_dws.http import AnalyzeBuildRequestData, BuildRequestData, NutrientClientOptions
+from nutrient_dws.http import (
+    AnalyzeBuildRequestData,
+    BuildRequestData,
+    NutrientClientOptions,
+)
 from nutrient_dws.inputs import (
     FileInput,
     NormalizedFileData,
     is_remote_file_input,
     process_file_input,
     validate_file_input,
 )
-from nutrient_dws.types.build_actions import BuildAction
-from nutrient_dws.types.build_instruction import BuildInstructions
-from nutrient_dws.types.build_output import (
-    BuildOutput,
-    ImageOutputOptions,
-    JSONContentOutputOptions,
-    PDFAOutputOptions,
-    PDFOutput,
-    PDFOutputOptions,
-    PDFUAOutputOptions,
-)
 from nutrient_dws.types.file_handle import FileHandle, RemoteFileHandle
-from nutrient_dws.types.input_parts import (
-    DocumentPart,
-    DocumentPartOptions,
-    FilePart,
-    FilePartOptions,
-    HTMLPart,
-    HTMLPartOptions,
-    NewPagePart,
-    NewPagePartOptions,
-)
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from nutrient_dws.types.build_actions import BuildAction
+    from nutrient_dws.types.build_instruction import BuildInstructions
+    from nutrient_dws.types.build_output import (
+        BuildOutput,
+        ImageOutputOptions,
+        JSONContentOutputOptions,
+        PDFAOutputOptions,
+        PDFOutput,
+        PDFOutputOptions,
+        PDFUAOutputOptions,
+    )
+    from nutrient_dws.types.input_parts import (
+        DocumentPart,
+        DocumentPartOptions,
+        FilePart,
+        FilePartOptions,
+        HTMLPart,
+        HTMLPartOptions,
+        NewPagePart,
+        NewPagePartOptions,
+    )
 
 
 class StagedWorkflowBuilder(
@@ -85,7 +92,9 @@ def _register_asset(self, asset: FileInput) -> str:
             The asset key that can be used in BuildActions
         """
         if not validate_file_input(asset):
-            raise ValidationError("Invalid file input provided to workflow", {"asset": asset})
+            raise ValidationError(
+                "Invalid file input provided to workflow", {"asset": asset}
+            )
 
         if is_remote_file_input(asset):
             raise ValidationError(
@@ -256,7 +265,9 @@ def add_html_part(
             assets_field = []
             for asset in assets:
                 if is_remote_file_input(asset):
-                    raise ValidationError("Assets file input cannot be a URL", {"input": asset})
+                    raise ValidationError(
+                        "Assets file input cannot be a URL", {"input": asset}
+                    )
                 asset_key = self._register_asset(asset)
                 assets_field.append(asset_key)
 
@@ -369,7 +380,9 @@ def add_document_part(
 
     # Action methods (WorkflowWithPartsStage)
 
-    def apply_actions(self, actions: list[ApplicableAction]) -> WorkflowWithActionsStage:
+    def apply_actions(
+        self, actions: list[ApplicableAction]
+    ) -> WorkflowWithActionsStage:
         """Apply multiple actions to the workflow.
 
         Args:
@@ -503,13 +516,17 @@ async def execute(
             # Step 1: Validate
             self.current_step = 1
             if options and options.get("onProgress"):
-                cast("Callable[[int, int], None]", options["onProgress"])(self.current_step, 3)
+                cast("Callable[[int, int], None]", options["onProgress"])(
+                    self.current_step, 3
+                )
             self._validate()
 
             # Step 2: Prepare files
             self.current_step = 2
             if options and options.get("onProgress"):
-                cast("Callable[[int, int], None]", options["onProgress"])(self.current_step, 3)
+                cast("Callable[[int, int], None]", options["onProgress"])(
+                    self.current_step, 3
+                )
 
             output_config = self.build_instructions.get("output")
             if not output_config:
@@ -526,7 +543,9 @@ async def execute(
             # Step 3: Process response
             self.current_step = 3
             if options and options.get("onProgress"):
-                cast("Callable[[int, int], None]", options["onProgress"])(self.current_step, 3)
+                cast("Callable[[int, int], None]", options["onProgress"])(
+                    self.current_step, 3
+                )
 
             if output_config["type"] == "json-content":
                 result["success"] = True
@@ -554,7 +573,9 @@ async def execute(
 
             workflow_error: WorkflowError = {
                 "step": self.current_step,
-                "error": error if isinstance(error, Exception) else Exception(str(error)),
+                "error": error
+                if isinstance(error, Exception)
+                else Exception(str(error)),
             }
             cast("list[WorkflowError]", result["errors"]).append(workflow_error)
 
@@ -582,7 +603,8 @@ async def dry_run(self) -> WorkflowDryRunResult:
             self._validate()
 
             response = await self._send_request(
-                "/analyze_build", AnalyzeBuildRequestData(instructions=self.build_instructions)
+                "/analyze_build",
+                AnalyzeBuildRequestData(instructions=self.build_instructions),
             )
 
             result["success"] = True
@@ -594,7 +616,9 @@ async def dry_run(self) -> WorkflowDryRunResult:
 
             workflow_error: WorkflowError = {
                 "step": 0,
-                "error": error if isinstance(error, Exception) else Exception(str(error)),
+                "error": error
+                if isinstance(error, Exception)
+                else Exception(str(error)),
             }
             cast("list[WorkflowError]", result["errors"]).append(workflow_error)