unitysvc-services 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

unitysvc_services/models/base.py

@@ -38,12 +38,13 @@ class DocumentContextEnum(StrEnum):
 class DocumentCategoryEnum(StrEnum):
     getting_started = "getting_started"
     api_reference = "api_reference"
-    tutorials = "tutorials"
-    code_examples = "code_examples"
-    use_cases = "use_cases"
+    tutorial = "tutorial"
+    code_example = "code_example"
+    code_example_output = "code_example_output"
+    use_case = "use_case"
     troubleshooting = "troubleshooting"
     changelog = "changelog"
-    best_practices = "best_practices"
+    best_practice = "best_practice"
     specification = "specification"
     service_level_agreement = "service_level_agreement"
     terms_of_service = "terms_of_service"
@@ -255,18 +256,6 @@ class Document(BaseModel):
         default=False,
         description="Whether document is publicly accessible without authentication",
     )
-    requirements: list[str] | None = Field(
-        default=None,
-        description="Required packages/modules for running this code example (e.g., ['openai', 'httpx'])",
-    )
-    expect: str | None = Field(
-        default=None,
-        max_length=500,
-        description=(
-            "Expected output substring for code example validation. "
-            "If specified, test passes only if stdout contains this string."
-        ),
-    )
 
 
 class RateLimit(BaseModel):

unitysvc_services/publisher.py

@@ -67,6 +67,7 @@ class ServiceDataPublisher(UnitySvcAPI):
         offering: dict[str, Any] | None = None,
         provider: dict[str, Any] | None = None,
         seller: dict[str, Any] | None = None,
+        listing_filename: str | None = None,
     ) -> dict[str, Any]:
         """Recursively resolve file references and include content in data.
 
@@ -80,6 +81,7 @@ class ServiceDataPublisher(UnitySvcAPI):
             offering: Offering data for template rendering (optional)
             provider: Provider data for template rendering (optional)
             seller: Seller data for template rendering (optional)
+            listing_filename: Listing filename for constructing output filenames (optional)
 
         Returns:
             Data with file references resolved and content loaded
@@ -90,14 +92,26 @@ class ServiceDataPublisher(UnitySvcAPI):
             if isinstance(value, dict):
                 # Recursively process nested dictionaries
                 result[key] = self.resolve_file_references(
-                    value, base_path, listing=listing, offering=offering, provider=provider, seller=seller
+                    value,
+                    base_path,
+                    listing=listing,
+                    offering=offering,
+                    provider=provider,
+                    seller=seller,
+                    listing_filename=listing_filename,
                 )
             elif isinstance(value, list):
                 # Process lists
                 result[key] = [
                     (
                         self.resolve_file_references(
-                            item, base_path, listing=listing, offering=offering, provider=provider, seller=seller
+                            item,
+                            base_path,
+                            listing=listing,
+                            offering=offering,
+                            provider=provider,
+                            seller=seller,
+                            listing_filename=listing_filename,
                         )
                         if isinstance(item, dict)
                         else item
@@ -135,6 +149,41 @@ class ServiceDataPublisher(UnitySvcAPI):
             else:
                 result[key] = value
 
+        # After processing all fields, check if this is a code_examples document
+        # If so, try to load corresponding .out file and add to meta.output
+        if result.get("category") == "code_examples" and result.get("file_content") and listing_filename:
+            # Get the actual filename (after .j2 stripping if applicable)
+            # If file_path was updated (e.g., from "test.py.j2" to "test.py"), use that
+            # Otherwise, extract basename from original file_path
+            output_base_filename: str | None = None
+
+            # Check if file_path was modified (original might have had .j2)
+            file_path_value = result.get("file_path", "")
+            if file_path_value:
+                output_base_filename = Path(file_path_value).name
+
+            if output_base_filename:
+                # Construct output filename: {listing_stem}_{output_base_filename}.out
+                # e.g., "svclisting_test.py.out" for svclisting.json and test.py
+                listing_stem = Path(listing_filename).stem
+                output_filename = f"{listing_stem}_{output_base_filename}.out"
+
+                # Try to find the .out file in base_path (listing directory)
+                output_path = base_path / output_filename
+
+                if output_path.exists():
+                    try:
+                        with open(output_path, encoding="utf-8") as f:
+                            output_content = f.read()
+
+                        # Add output to meta field
+                        if "meta" not in result or result["meta"] is None:
+                            result["meta"] = {}
+                        result["meta"]["output"] = output_content
+                    except Exception:
+                        # Don't fail if output file can't be read, just skip it
+                        pass
+
         return result
 
     async def post(  # type: ignore[override]
@@ -401,6 +450,7 @@ class ServiceDataPublisher(UnitySvcAPI):
             offering=service_data,
             provider=provider_data,
             seller=seller_data,
+            listing_filename=listing_file.name,
         )
 
         # Post to the endpoint using retry helper

unitysvc_services/test.py

@@ -70,15 +70,18 @@ def extract_code_examples_from_listing(listing_data: dict[str, Any], listing_fil
         documents = interface.get("documents", [])
 
         for doc in documents:
-            # Match both "code_example" and "code_examples"
+            # Check if this is a code example document
             category = doc.get("category", "")
-            if category == DocumentCategoryEnum.code_examples:
+            if category == DocumentCategoryEnum.code_example:
                 # Resolve file path relative to listing file
                 file_path = doc.get("file_path")
                 if file_path:
                     # Resolve relative path
                     absolute_path = (listing_file.parent / file_path).resolve()
 
+                    # Extract meta fields for code examples (expect, requirements, etc.)
+                    meta = doc.get("meta", {}) or {}
+
                     code_example = {
                         "service_name": service_name,
                         "title": doc.get("title", "Untitled"),
@@ -86,7 +89,8 @@ def extract_code_examples_from_listing(listing_data: dict[str, Any], listing_fil
                         "file_path": str(absolute_path),
                         "listing_data": listing_data,  # Full listing data for templates
                         "listing_file": listing_file,  # Path to listing file for loading related data
-                        "expect": doc.get("expect"),  # Expected output substring for validation
+                        "expect": meta.get("expect"),  # Expected output substring for validation (from meta)
+                        "requirements": meta.get("requirements"),  # Required packages (from meta)
                     }
                     code_examples.append(code_example)
 
@@ -200,6 +204,8 @@ def execute_code_example(code_example: dict[str, Any], credentials: dict[str, st
         "stderr": None,
         "rendered_content": None,
         "file_suffix": None,
+        "listing_file": None,
+        "actual_filename": None,
     }
 
     file_path = code_example.get("file_path")
@@ -237,6 +243,8 @@ def execute_code_example(code_example: dict[str, Any], credentials: dict[str, st
         # Store rendered content and file suffix for later use (e.g., writing failed tests)
         result["rendered_content"] = file_content
         result["file_suffix"] = file_suffix
+        result["listing_file"] = listing_file
+        result["actual_filename"] = actual_filename
 
         # Determine interpreter to use
         lines = file_content.split("\n")
@@ -686,6 +694,27 @@ def run(
             console.print(f"  [green]✓ Success[/green] (exit code: {result['exit_code']})")
             if verbose and result["stdout"]:
                 console.print(f"  [dim]stdout:[/dim] {result['stdout'][:200]}")
+
+            # Save successful test output to .out file
+            if result.get("stdout") and result.get("listing_file") and result.get("actual_filename"):
+                listing_file = Path(result["listing_file"])
+                actual_filename = result["actual_filename"]
+
+                # Create filename: {listing_stem}_{actual_filename}.out
+                # e.g., "svclisting_test.py.out" for svclisting.json and test.py
+                listing_stem = listing_file.stem
+                output_filename = f"{listing_stem}_{actual_filename}.out"
+
+                # Save to listing directory
+                output_path = listing_file.parent / output_filename
+
+                # Write stdout to .out file
+                try:
+                    with open(output_path, "w", encoding="utf-8") as f:
+                        f.write(result["stdout"])
+                    console.print(f"  [dim]→ Output saved to:[/dim] {output_path}")
+                except Exception as e:
+                    console.print(f"  [yellow]⚠ Failed to save output: {e}[/yellow]")
         else:
             console.print(f"  [red]✗ Failed[/red] - {result['error']}")
             if verbose:
@@ -695,15 +724,13 @@ def run(
                     console.print(f"  [dim]stderr:[/dim] {result['stderr'][:200]}")
 
             # Write failed test content to current directory
-            if result.get("rendered_content"):
-                # Create safe filename: failed_<service_name>_<title><ext>
-                # Sanitize service name and title for filename
-                safe_service = service_name.replace("/", "_").replace(" ", "_")
-                safe_title = title.replace("/", "_").replace(" ", "_")
-                file_suffix = result.get("file_suffix", ".txt")
-
-                # Create filename
-                failed_filename = f"failed_{safe_service}_{safe_title}{file_suffix}"
+            if result.get("rendered_content") and result.get("listing_file") and result.get("actual_filename"):
+                listing_file = Path(result["listing_file"])
+                actual_filename = result["actual_filename"]
+                listing_stem = listing_file.stem
+
+                # Create filename: failed_{listing_stem}_{actual_filename}
+                failed_filename = f"failed_{listing_stem}_{actual_filename}"
 
                 # Prepare content with environment variables as header comments
                 content_with_env = result["rendered_content"]

unitysvc_services/utils.py

@@ -10,10 +10,47 @@ import tomli_w
 from jinja2 import Template
 
 
+def deep_merge_dicts(base: dict[str, Any], override: dict[str, Any]) -> dict[str, Any]:
+    """
+    Deep merge two dictionaries, with override values taking precedence.
+
+    For nested dictionaries, performs recursive merge. For all other types
+    (lists, primitives), the override value completely replaces the base value.
+
+    Args:
+        base: Base dictionary
+        override: Override dictionary (values take precedence)
+
+    Returns:
+        Merged dictionary
+    """
+    result = base.copy()
+
+    for key, value in override.items():
+        if key in result and isinstance(result[key], dict) and isinstance(value, dict):
+            # Recursively merge nested dictionaries
+            result[key] = deep_merge_dicts(result[key], value)
+        else:
+            # For all other types (lists, primitives, etc.), override completely
+            result[key] = value
+
+    return result
+
+
 def load_data_file(file_path: Path) -> tuple[dict[str, Any], str]:
     """
     Load a data file (JSON or TOML) and return (data, format).
 
+    Automatically checks for and merges override files with the pattern:
+    <base_name>.override.<extension>
+
+    For example:
+    - service.json -> service.override.json
+    - provider.toml -> provider.override.toml
+
+    If an override file exists, it will be deep-merged with the base file,
+    with override values taking precedence.
+
     Args:
         file_path: Path to the data file
 
@@ -23,15 +60,41 @@ def load_data_file(file_path: Path) -> tuple[dict[str, Any], str]:
     Raises:
         ValueError: If file format is not supported
     """
+    # Load the base file
     if file_path.suffix == ".json":
         with open(file_path, encoding="utf-8") as f:
-            return json.load(f), "json"
+            data = json.load(f)
+        file_format = "json"
     elif file_path.suffix == ".toml":
         with open(file_path, "rb") as f:
-            return tomllib.load(f), "toml"
+            data = tomllib.load(f)
+        file_format = "toml"
     else:
         raise ValueError(f"Unsupported file format: {file_path.suffix}")
 
+    # Check for override file
+    # Pattern: <stem>.override.<suffix>
+    # Example: service.json -> service.override.json
+    override_path = file_path.with_stem(f"{file_path.stem}.override")
+
+    if override_path.exists():
+        # Load the override file (same format as base file)
+        if override_path.suffix == ".json":
+            with open(override_path, encoding="utf-8") as f:
+                override_data = json.load(f)
+        elif override_path.suffix == ".toml":
+            with open(override_path, "rb") as f:
+                override_data = tomllib.load(f)
+        else:
+            # This shouldn't happen since we're using the same suffix as base
+            # But handle it gracefully
+            override_data = {}
+
+        # Deep merge the override data into the base data
+        data = deep_merge_dicts(data, override_data)
+
+    return data, file_format
+
 
 def write_data_file(file_path: Path, data: dict[str, Any], format: str) -> None:
     """

{unitysvc_services-0.1.5.dist-info → unitysvc_services-0.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.1.5
+Version: 0.1.7
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>

{unitysvc_services-0.1.5.dist-info → unitysvc_services-0.1.7.dist-info}/RECORD

@@ -4,23 +4,23 @@ unitysvc_services/cli.py,sha256=omHzrWk8iZJUjZTE5KCmEK1wnRGGnQk_BNV-hKqucnA,725
 unitysvc_services/format_data.py,sha256=Jl9Vj3fRX852fHSUa5DzO-oiFQwuQHC3WMCDNIlo1Lc,5460
 unitysvc_services/list.py,sha256=QDp9BByaoeFeJxXJN9RQ-jU99mH9Guq9ampfXCbpZmI,7033
 unitysvc_services/populate.py,sha256=jiqS2D3_widV6siPe3OBvw7ZdG9MuddEIOuTUCtMM5c,7605
-unitysvc_services/publisher.py,sha256=mKlY7-zEP8dtldcO8DJtbXVrdOACZCYsu49yP2iSD4w,53855
+unitysvc_services/publisher.py,sha256=_r6wqJJkC-9RtyKcxiegPoSRDi2-nRL16M8OJ-vi7eE,56237
 unitysvc_services/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 unitysvc_services/query.py,sha256=q0_g5YAl9cPlHpW7k7Y6A-t4fQSdI-_4Jl6g2KgkEm0,24049
 unitysvc_services/scaffold.py,sha256=Y73IX8vskImxSvxDgR0mvEFuAMYnBKfttn3bjcz3jmQ,40331
-unitysvc_services/test.py,sha256=ZwWr2WCfzRBY39tuijK5P2v0VZ7PXwg3tFtJkTOsGrU,28341
+unitysvc_services/test.py,sha256=nZp6O_j2Y-gNPNWJ55QG4kI50BsbS_faUFGupWK1VMI,29734
 unitysvc_services/update.py,sha256=K9swocTUnqqiSgARo6GmuzTzUySSpyqqPPW4xF7ZU-g,9659
-unitysvc_services/utils.py,sha256=9htuxyzEjjbbAi704td9mOrtPzSOJzY46ALuup6bJW0,13093
+unitysvc_services/utils.py,sha256=4tEBdO90XpkS6j73ZXnz5dNLVXJaPUILWMwzk5_fUQ4,15276
 unitysvc_services/validator.py,sha256=sasMpdDhoWZJZ-unrnDhaJfyxHSm3IgQjEdmPvXrFEE,29525
 unitysvc_services/models/__init__.py,sha256=hJCc2KSZmIHlKWKE6GpLGdeVB6LIpyVUKiOKnwmKvCs,200
-unitysvc_services/models/base.py,sha256=cSxOYs_YSrqkQLBKIGVZmK627MyMft7cDn0WnrQlzPM,18736
+unitysvc_services/models/base.py,sha256=ofdxWkzSxCB3JqMCnNHL83KfWlXZ9A4HbNRtKG6jcMQ,18333
 unitysvc_services/models/listing_v1.py,sha256=PPb9hIdWQp80AWKLxFXYBDcWXzNcDrO4v6rqt5_i2qo,3083
 unitysvc_services/models/provider_v1.py,sha256=76EK1i0hVtdx_awb00-ZMtSj4Oc9Zp4xZ-DeXmG3iTY,2701
 unitysvc_services/models/seller_v1.py,sha256=oll2ZZBPBDX8wslHrbsCKf_jIqHNte2VEj5RJ9bawR4,3520
 unitysvc_services/models/service_v1.py,sha256=Xpk-K-95M1LRqYM8nNJcll8t-lsW9Xdi2_bVbYNs8-M,3019
-unitysvc_services-0.1.5.dist-info/licenses/LICENSE,sha256=_p8V6A8OMPu2HIztn3O01v0-urZFwk0Dd3Yk_PTIlL8,1065
-unitysvc_services-0.1.5.dist-info/METADATA,sha256=LZrIRYvKsl0t2mptoidJVkjOeNJFbx_a-QgUxEJLsgY,7234
-unitysvc_services-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-unitysvc_services-0.1.5.dist-info/entry_points.txt,sha256=RBhVHKky3rsOly4jVa29c7UAw5ZwNNWnttmtzozr5O0,97
-unitysvc_services-0.1.5.dist-info/top_level.txt,sha256=GIotQj-Ro2ruR7eupM1r58PWqIHTAq647ORL7E2kneo,18
-unitysvc_services-0.1.5.dist-info/RECORD,,
+unitysvc_services-0.1.7.dist-info/licenses/LICENSE,sha256=_p8V6A8OMPu2HIztn3O01v0-urZFwk0Dd3Yk_PTIlL8,1065
+unitysvc_services-0.1.7.dist-info/METADATA,sha256=WrTTofhHZReTM3ArgJ8E76Cb-tgJpJikNfL8bBg58Go,7234
+unitysvc_services-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+unitysvc_services-0.1.7.dist-info/entry_points.txt,sha256=RBhVHKky3rsOly4jVa29c7UAw5ZwNNWnttmtzozr5O0,97
+unitysvc_services-0.1.7.dist-info/top_level.txt,sha256=GIotQj-Ro2ruR7eupM1r58PWqIHTAq647ORL7E2kneo,18
+unitysvc_services-0.1.7.dist-info/RECORD,,