julee 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

julee/domain/use_cases/extract_assemble_data.py

@@ -10,8 +10,9 @@ instances following the Clean Architecture principles.
 import hashlib
 import json
 import logging
+from collections.abc import Callable
 from datetime import datetime, timezone
-from typing import Any, Callable, Dict
+from typing import Any
 
 import jsonpointer  # type: ignore
 import jsonschema
@@ -57,6 +58,7 @@ class ExtractAssembleDataUseCase:
     methods and expects them to work correctly.
 
     Architectural Notes:
+
     - This class contains pure business logic with no framework dependencies
     - Repository dependencies are injected via constructor
       (dependency inversion)
@@ -64,6 +66,7 @@ class ExtractAssembleDataUseCase:
     - The use case works with domain objects exclusively
     - Deterministic execution is guaranteed by avoiding
       non-deterministic operations
+
     """
 
     def __init__(
@@ -91,7 +94,8 @@ class ExtractAssembleDataUseCase:
                 operations
             now_fn: Function to get current time (for workflow compatibility)
 
-        Note:
+        .. note::
+
             The repositories passed here may be concrete implementations
             (for testing or direct execution) or workflow stubs (for
             Temporal workflow execution). The use case doesn't know or care
@@ -99,6 +103,7 @@ class ExtractAssembleDataUseCase:
 
             Repositories are validated at construction time to catch
             configuration errors early in the application lifecycle.
+
         """
         # Validate at construction time for early error detection
         self.document_repo = ensure_repository_protocol(
@@ -135,6 +140,7 @@ class ExtractAssembleDataUseCase:
         assembly.
 
         This method orchestrates the core assembly workflow:
+
         1. Generates a unique assembly ID
         2. Retrieves the assembly specification
         3. Stores the initial assembly in the repository
@@ -156,6 +162,7 @@ class ExtractAssembleDataUseCase:
         Raises:
             ValueError: If required entities are not found or invalid
             RuntimeError: If assembly processing fails
+
         """
         logger.debug(
             "Starting data assembly use case",
@@ -250,8 +257,8 @@ class ExtractAssembleDataUseCase:
     async def _register_document_with_services(
         self,
         document: Document,
-        queries: Dict[str, KnowledgeServiceQuery],
-    ) -> Dict[str, str]:
+        queries: dict[str, KnowledgeServiceQuery],
+    ) -> dict[str, str]:
         """
         Register the document with all knowledge services needed for assembly.
 
@@ -267,6 +274,7 @@ class ExtractAssembleDataUseCase:
 
         Raises:
             RuntimeError: If registration fails
+
         """
         registrations = {}
 
@@ -294,7 +302,7 @@ class ExtractAssembleDataUseCase:
     @try_use_case_step("queries_retrieval")
     async def _retrieve_all_queries(
         self, assembly_specification: AssemblySpecification
-    ) -> Dict[str, KnowledgeServiceQuery]:
+    ) -> dict[str, KnowledgeServiceQuery]:
         """Retrieve all knowledge service queries needed for this assembly."""
         query_ids = list(assembly_specification.knowledge_service_queries.values())
 
@@ -344,13 +352,14 @@ class ExtractAssembleDataUseCase:
         self,
         document: Document,
         assembly_specification: AssemblySpecification,
-        document_registrations: Dict[str, str],
-        queries: Dict[str, KnowledgeServiceQuery],
+        document_registrations: dict[str, str],
+        queries: dict[str, KnowledgeServiceQuery],
     ) -> str:
         """
         Perform a single assembly iteration using knowledge services.
 
         This method:
+
         1. Executes all knowledge service queries defined in the specification
         2. Stitches together the query results into a complete JSON document
         3. Creates and stores the assembled document
@@ -368,9 +377,10 @@ class ExtractAssembleDataUseCase:
         Raises:
             ValueError: If required entities are not found
             RuntimeError: If knowledge service operations fail
+
         """
         # Initialize the result data structure
-        assembled_data: Dict[str, Any] = {}
+        assembled_data: dict[str, Any] = {}
 
         # Process each knowledge service query
         # TODO: This is where we may want to fan-out/fan-in to do these
@@ -461,7 +471,7 @@ class ExtractAssembleDataUseCase:
         return document
 
     def _extract_schema_section(
-        self, jsonschema: Dict[str, Any], schema_pointer: str
+        self, jsonschema: dict[str, Any], schema_pointer: str
     ) -> Any:
         """Extract relevant section of JSON schema using JSON Pointer."""
         if not schema_pointer:
@@ -486,7 +496,7 @@ Please structure your response according to this JSON schema:
 Return only valid JSON that conforms to this schema, without any surrounding
 text or markdown formatting."""
 
-    def _parse_query_result(self, result_data: Dict[str, Any]) -> Any:
+    def _parse_query_result(self, result_data: dict[str, Any]) -> Any:
         """Parse the query result to extract the JSON response."""
         response_text = result_data.get("response", "")
         if not response_text:
@@ -505,7 +515,7 @@ text or markdown formatting."""
 
     def _store_result_in_assembled_data(
         self,
-        assembled_data: Dict[str, Any],
+        assembled_data: dict[str, Any],
         schema_pointer: str,
         result_data: Any,
     ) -> None:
@@ -563,7 +573,7 @@ text or markdown formatting."""
     @try_use_case_step("assembled_document_creation")
     async def _create_assembled_document(
         self,
-        assembled_data: Dict[str, Any],
+        assembled_data: dict[str, Any],
         assembly_specification: AssemblySpecification,
     ) -> str:
         """Create and store the assembled document."""
@@ -596,7 +606,7 @@ text or markdown formatting."""
 
     def _validate_assembled_data(
         self,
-        assembled_data: Dict[str, Any],
+        assembled_data: dict[str, Any],
         assembly_specification: AssemblySpecification,
     ) -> None:
         """Validate that the assembled data conforms to the JSON schema."""

julee/domain/use_cases/initialize_system_data.py

@@ -16,7 +16,7 @@ import hashlib
 import logging
 from datetime import datetime, timezone
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any
 
 import yaml
 
@@ -192,7 +192,7 @@ class InitializeSystemDataUseCase:
             )
             raise
 
-    def _load_fixture_configurations(self) -> List[Dict[str, Any]]:
+    def _load_fixture_configurations(self) -> list[dict[str, Any]]:
         """
         Load knowledge service configurations from the YAML fixture file.
 
@@ -217,7 +217,7 @@ class InitializeSystemDataUseCase:
             )
 
         try:
-            with open(fixture_path, "r", encoding="utf-8") as f:
+            with open(fixture_path, encoding="utf-8") as f:
                 fixture_data = yaml.safe_load(f)
 
             if not fixture_data or "knowledge_services" not in fixture_data:
@@ -240,7 +240,7 @@ class InitializeSystemDataUseCase:
             raise yaml.YAMLError(f"Invalid YAML in fixture file: {e}")
 
     def _create_config_from_fixture_data(
-        self, config_data: Dict[str, Any]
+        self, config_data: dict[str, Any]
     ) -> KnowledgeServiceConfig:
         """
         Create a KnowledgeServiceConfig from fixture data.
@@ -363,7 +363,7 @@ class InitializeSystemDataUseCase:
             )
             raise
 
-    def _load_fixture_queries(self) -> List[Dict[str, Any]]:
+    def _load_fixture_queries(self) -> list[dict[str, Any]]:
         """
         Load knowledge service queries from the YAML fixture file.
 
@@ -388,7 +388,7 @@ class InitializeSystemDataUseCase:
             )
 
         try:
-            with open(fixture_path, "r", encoding="utf-8") as f:
+            with open(fixture_path, encoding="utf-8") as f:
                 fixture_data = yaml.safe_load(f)
 
             if not fixture_data or "knowledge_service_queries" not in fixture_data:
@@ -413,7 +413,7 @@ class InitializeSystemDataUseCase:
             raise yaml.YAMLError(f"Invalid YAML in queries fixture file: {e}")
 
     def _create_query_from_fixture_data(
-        self, query_data: Dict[str, Any]
+        self, query_data: dict[str, Any]
     ) -> KnowledgeServiceQuery:
         """
         Create a KnowledgeServiceQuery from fixture data.
@@ -533,7 +533,7 @@ class InitializeSystemDataUseCase:
             )
             raise
 
-    def _load_fixture_assembly_specifications(self) -> List[Dict[str, Any]]:
+    def _load_fixture_assembly_specifications(self) -> list[dict[str, Any]]:
         """
         Load assembly specifications from the YAML fixture file.
 
@@ -558,7 +558,7 @@ class InitializeSystemDataUseCase:
             )
 
         try:
-            with open(fixture_path, "r", encoding="utf-8") as f:
+            with open(fixture_path, encoding="utf-8") as f:
                 fixture_data = yaml.safe_load(f)
 
             if not fixture_data or "assembly_specifications" not in fixture_data:
@@ -586,7 +586,7 @@ class InitializeSystemDataUseCase:
             )
 
     def _create_assembly_spec_from_fixture_data(
-        self, spec_data: Dict[str, Any]
+        self, spec_data: dict[str, Any]
     ) -> AssemblySpecification:
         """
         Create an AssemblySpecification from fixture data.
@@ -719,7 +719,7 @@ class InitializeSystemDataUseCase:
             )
             raise
 
-    def _load_fixture_documents(self) -> List[Dict[str, Any]]:
+    def _load_fixture_documents(self) -> list[dict[str, Any]]:
         """
         Load documents from the YAML fixture file.
 
@@ -742,7 +742,7 @@ class InitializeSystemDataUseCase:
             raise FileNotFoundError(f"Documents fixture file not found: {fixture_path}")
 
         try:
-            with open(fixture_path, "r", encoding="utf-8") as f:
+            with open(fixture_path, encoding="utf-8") as f:
                 fixture_data = yaml.safe_load(f)
 
             if not fixture_data or "documents" not in fixture_data:
@@ -764,7 +764,7 @@ class InitializeSystemDataUseCase:
         except yaml.YAMLError as e:
             raise yaml.YAMLError(f"Invalid YAML in documents fixture file: {e}")
 
-    def _create_document_from_fixture_data(self, doc_data: Dict[str, Any]) -> Document:
+    def _create_document_from_fixture_data(self, doc_data: dict[str, Any]) -> Document:
         """
         Create a Document from fixture data.
 

julee/domain/use_cases/tests/test_extract_assemble_data.py

@@ -8,35 +8,35 @@ following the Clean Architecture principles.
 
 import io
 import json
-import pytest
-
-from unittest.mock import AsyncMock
 from datetime import datetime, timezone
+from unittest.mock import AsyncMock
+
+import pytest
 
-from julee.domain.use_cases import ExtractAssembleDataUseCase
 from julee.domain.models import (
     Assembly,
+    AssemblySpecification,
+    AssemblySpecificationStatus,
     AssemblyStatus,
+    ContentStream,
     Document,
     DocumentStatus,
-    ContentStream,
-    AssemblySpecification,
-    AssemblySpecificationStatus,
-    KnowledgeServiceQuery,
     KnowledgeServiceConfig,
+    KnowledgeServiceQuery,
 )
 from julee.domain.models.knowledge_service_config import ServiceApi
+from julee.domain.use_cases import ExtractAssembleDataUseCase
 from julee.repositories.memory import (
-    MemoryDocumentRepository,
     MemoryAssemblyRepository,
     MemoryAssemblySpecificationRepository,
+    MemoryDocumentRepository,
     MemoryKnowledgeServiceConfigRepository,
     MemoryKnowledgeServiceQueryRepository,
 )
+from julee.services.knowledge_service import QueryResult
 from julee.services.knowledge_service.memory import (
     MemoryKnowledgeService,
 )
-from julee.services.knowledge_service import QueryResult
 
 
 class TestExtractAssembleDataUseCase:

julee/domain/use_cases/tests/test_initialize_system_data.py

@@ -86,7 +86,7 @@ def fixture_configs() -> list[dict]:
 
     assert fixture_path.exists(), f"Fixture file not found: {fixture_path}"
 
-    with open(fixture_path, "r", encoding="utf-8") as f:
+    with open(fixture_path, encoding="utf-8") as f:
         fixture_data = yaml.safe_load(f)
 
     assert "knowledge_services" in fixture_data
@@ -320,7 +320,7 @@ class TestYamlFixtureIntegration:
         assert fixture_path.exists(), f"Fixture file not found: {fixture_path}"
 
         # Verify file can be parsed
-        with open(fixture_path, "r", encoding="utf-8") as f:
+        with open(fixture_path, encoding="utf-8") as f:
             fixture_data = yaml.safe_load(f)
 
         # Verify structure

julee/domain/use_cases/tests/test_validate_document.py

@@ -7,38 +7,38 @@ following the Clean Architecture principles.
 """
 
 import io
-import pytest
-from unittest.mock import AsyncMock
 from datetime import datetime, timezone
-from pydantic import ValidationError
+from unittest.mock import AsyncMock
 
-from julee.domain.use_cases import ValidateDocumentUseCase
+import pytest
+from pydantic import ValidationError
 
 from julee.domain.models import (
+    ContentStream,
     Document,
     DocumentStatus,
-    ContentStream,
     KnowledgeServiceConfig,
     KnowledgeServiceQuery,
 )
+from julee.domain.models.knowledge_service_config import ServiceApi
 from julee.domain.models.policy import (
-    Policy,
-    PolicyStatus,
     DocumentPolicyValidation,
     DocumentPolicyValidationStatus,
+    Policy,
+    PolicyStatus,
 )
-from julee.domain.models.knowledge_service_config import ServiceApi
+from julee.domain.use_cases import ValidateDocumentUseCase
 from julee.repositories.memory import (
+    MemoryDocumentPolicyValidationRepository,
     MemoryDocumentRepository,
-    MemoryKnowledgeServiceQueryRepository,
     MemoryKnowledgeServiceConfigRepository,
+    MemoryKnowledgeServiceQueryRepository,
     MemoryPolicyRepository,
-    MemoryDocumentPolicyValidationRepository,
 )
+from julee.services.knowledge_service import QueryResult
 from julee.services.knowledge_service.memory import (
     MemoryKnowledgeService,
 )
-from julee.services.knowledge_service import QueryResult
 
 
 class TestValidateDocumentUseCase:

julee/domain/use_cases/validate_document.py

@@ -11,8 +11,8 @@ import hashlib
 import io
 import json
 import logging
+from collections.abc import Callable
 from datetime import datetime
-from typing import Callable, Dict, List, Tuple
 
 import multihash
 
@@ -58,6 +58,7 @@ class ValidateDocumentUseCase:
     methods and expects them to work correctly.
 
     Architectural Notes:
+
     - This class contains pure business logic with no framework dependencies
     - Repository dependencies are injected via constructor
       (dependency inversion)
@@ -65,6 +66,7 @@ class ValidateDocumentUseCase:
     - The use case works with domain objects exclusively
     - Deterministic execution is guaranteed by avoiding
       non-deterministic operations
+
     """
 
     def __init__(
@@ -93,7 +95,8 @@ class ValidateDocumentUseCase:
             now_fn: Function to get current time (e.g., workflow.now for
                 Temporal workflows)
 
-        Note:
+        .. note::
+
             The repositories passed here may be concrete implementations
             (for testing or direct execution) or workflow stubs (for
             Temporal workflow execution). The use case doesn't know or care
@@ -101,6 +104,7 @@ class ValidateDocumentUseCase:
 
             Repositories are validated at construction time to catch
             configuration errors early in the application lifecycle.
+
         """
         # Validate at construction time for early error detection
         self.document_repo = ensure_repository_protocol(
@@ -133,6 +137,7 @@ class ValidateDocumentUseCase:
         Validate a document against a policy and return the validation result.
 
         This method orchestrates the core validation workflow:
+
         1. Generates a unique validation ID
         2. Retrieves the document and policy
         3. Creates and stores the initial validation record
@@ -152,6 +157,7 @@ class ValidateDocumentUseCase:
         Raises:
             ValueError: If required entities are not found or invalid
             RuntimeError: If validation processing fails
+
         """
         logger.debug(
             "Starting document validation use case",
@@ -391,13 +397,13 @@ class ValidateDocumentUseCase:
     @try_use_case_step("all_queries_retrieval")
     async def _retrieve_all_queries(
         self, policy: Policy
-    ) -> Dict[str, KnowledgeServiceQuery]:
+    ) -> dict[str, KnowledgeServiceQuery]:
         """Retrieve all knowledge service queries needed for validation and
         transformation."""
         all_queries = {}
 
         # Get validation queries
-        for query_id, required_score in policy.validation_scores:
+        for query_id, _required_score in policy.validation_scores:
             query = await self.knowledge_service_query_repo.get(query_id)
             if not query:
                 raise ValueError(f"Validation query not found: {query_id}")
@@ -417,8 +423,8 @@ class ValidateDocumentUseCase:
     async def _register_document_with_services(
         self,
         document: Document,
-        queries: Dict[str, KnowledgeServiceQuery],
-    ) -> Dict[str, str]:
+        queries: dict[str, KnowledgeServiceQuery],
+    ) -> dict[str, str]:
         """
         Register the document with all knowledge services needed for
         validation.
@@ -429,6 +435,7 @@ class ValidateDocumentUseCase:
 
         Returns:
             Dict mapping knowledge_service_id to service_file_id
+
         """
         registrations = {}
         required_service_ids = {
@@ -457,9 +464,9 @@ class ValidateDocumentUseCase:
         self,
         document: Document,
         policy: Policy,
-        document_registrations: Dict[str, str],
-        queries: Dict[str, KnowledgeServiceQuery],
-    ) -> List[Tuple[str, int]]:
+        document_registrations: dict[str, str],
+        queries: dict[str, KnowledgeServiceQuery],
+    ) -> list[tuple[str, int]]:
         """
         Execute all validation queries and return the actual scores achieved.
 
@@ -471,6 +478,7 @@ class ValidateDocumentUseCase:
 
         Returns:
             List of (query_id, actual_score) tuples
+
         """
         validation_scores = []
 
@@ -520,7 +528,7 @@ class ValidateDocumentUseCase:
 
         return validation_scores
 
-    def _extract_score_from_result(self, result_data: Dict) -> int:
+    def _extract_score_from_result(self, result_data: dict) -> int:
         """
         Extract a numeric score from the knowledge service query result.
 
@@ -543,8 +551,8 @@ class ValidateDocumentUseCase:
 
     def _determine_validation_result(
         self,
-        actual_scores: List[Tuple[str, int]],
-        required_scores: List[Tuple[str, int]],
+        actual_scores: list[tuple[str, int]],
+        required_scores: list[tuple[str, int]],
     ) -> bool:
         """
         Determine if validation passed based on actual vs required scores.
@@ -556,6 +564,7 @@ class ValidateDocumentUseCase:
 
         Returns:
             True if all required scores were met or exceeded, False otherwise
+
         """
         # Convert to dictionaries for easier lookup
         actual_scores_dict = dict(actual_scores)
@@ -582,8 +591,8 @@ class ValidateDocumentUseCase:
         self,
         document: Document,
         policy: Policy,
-        all_queries: Dict[str, KnowledgeServiceQuery],
-        document_registrations: Dict[str, str],
+        all_queries: dict[str, KnowledgeServiceQuery],
+        document_registrations: dict[str, str],
     ) -> Document:
         """
         Apply transformation queries to a document and return the
@@ -601,6 +610,7 @@ class ValidateDocumentUseCase:
         Raises:
             ValueError: If transformation queries are not found or fail
             RuntimeError: If document transformation fails
+
         """
         if not policy.transformation_queries:
             raise ValueError("No transformation queries provided")
@@ -704,7 +714,7 @@ class ValidateDocumentUseCase:
 
         return transformed_document
 
-    def _extract_transformed_content(self, result_data: Dict) -> str:
+    def _extract_transformed_content(self, result_data: dict) -> str:
         """
         Extract transformed document content from knowledge service result.
 
@@ -717,6 +727,7 @@ class ValidateDocumentUseCase:
 
         Raises:
             ValueError: If no valid JSON content can be extracted from result
+
         """
         response_text = result_data.get("response", "")
         if not response_text:

julee/maintenance/__init__.py

@@ -0,0 +1 @@
+"""Maintenance utilities for julee and julee-based solutions."""