vantage-python 0.2.0__tar.gz → 0.3.1__tar.gz

vantage_python-0.3.1/.github/workflows/pypi-publish.yml

@@ -0,0 +1,54 @@
+name: Publish Package
+
+on:
+    push:
+        branches:
+            - main
+
+permissions:
+    id-token: write
+    contents: write
+
+jobs:
+    check-if-tag:
+        name: Check if Tag is Present
+        runs-on: ubuntu-22.04
+        outputs:
+            TAG_NOT_PRESENT: ${{ steps.get-tag.outputs.TAG_NOT_PRESENT }}
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+            - name: Get the tag from Python and check if it's present
+              id: get-tag
+              run: |
+                pip install toml
+                VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
+                if git tag -l "v$VERSION" | grep -q .; then
+                    echo "Tag v$VERSION is present"
+                    echo "TAG_NOT_PRESENT=false" >> $GITHUB_OUTPUT
+                else
+                    echo "Tag v$VERSION is not present"
+                    echo "TAG_NOT_PRESENT=true" >> $GITHUB_OUTPUT
+
+                    git tag "v$VERSION"
+                    git config user.name "github-actions[bot]"
+                    git config user.email "github-actions[bot]@users.noreply.github.com"
+                    git push origin "v$VERSION"
+                fi
+
+    publish:
+        name: Publish Package to PyPI
+        runs-on: ubuntu-22.04
+        needs: check-if-tag
+        if: needs.check-if-tag.outputs.TAG_NOT_PRESENT == 'true'
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-python@v5
+              with:
+                  python-version: "3.14"
+            - run: pip install build twine
+            - run: pip install -e ".[dev]"
+            - run: python -m build
+            - name: Publish release distributions to PyPI
+              uses: pypa/gh-action-pypi-publish@v1.13.0

{vantage_python-0.2.0 → vantage_python-0.3.1}/.github/workflows/test.yml

@@ -14,7 +14,6 @@ jobs:
               with:
                   python-version: ${{ matrix.python-version }}
             - run: pip install -e ".[dev]"
-            - run: python autogen.py
             - run: pytest tests/test_e2e.py
               env:
                   VANTAGE_API_TOKEN: ${{ secrets.VANTAGE_API_TOKEN }}
@@ -32,5 +31,15 @@ jobs:
               with:
                   python-version: ${{ matrix.python-version }}
             - run: pip install -e ".[dev]"
-            - run: python autogen.py
             - run: python -c "from vantage import Client, AsyncClient"
+
+    compare-to-api:
+        name: Compare to API
+        runs-on: ubuntu-22.04
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-python@v5
+              with:
+                  python-version: "3.14"
+            - run: pip install -e ".[dev]"
+            - run: make diff

vantage_python-0.3.1/.gitignore

@@ -0,0 +1,7 @@
+# Python specific
+__pycache__/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.venv/

{vantage_python-0.2.0 → vantage_python-0.3.1}/Makefile

@@ -1,10 +1,14 @@
-.PHONY: install publish
+.PHONY: install generate diff publish
 
 install:
-	python3 autogen.py
 	python3 -m pip install -e ".[dev]"
 
-publish:
+generate:
 	python3 autogen.py
+
+diff: generate
+	git diff --exit-code src/vantage
+
+publish:
 	python3 -m build
 	twine upload dist/*

{vantage_python-0.2.0 → vantage_python-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vantage-python
-Version: 0.2.0
+Version: 0.3.1
 Summary: Python SDK for the Vantage API
 Project-URL: Homepage, https://github.com/vantage-sh/vantage-python
 Project-URL: Repository, https://github.com/vantage-sh/vantage-python
@@ -96,7 +96,7 @@ except VantageAPIError as e:
 make install
 ```
 
-This fetches the latest OpenAPI schema from the Vantage API and generates Pydantic models, sync client, and async client. Your pip version will need to be up to date for this.
+This generates Pydantic models, sync client, and the async client. Your pip version will need to be up to date for this. If you wish to generate the client first, you should use `make generate`.
 
 ### Testing
 

{vantage_python-0.2.0 → vantage_python-0.3.1}/README.md

@@ -75,7 +75,7 @@ except VantageAPIError as e:
 make install
 ```
 
-This fetches the latest OpenAPI schema from the Vantage API and generates Pydantic models, sync client, and async client. Your pip version will need to be up to date for this.
+This generates Pydantic models, sync client, and the async client. Your pip version will need to be up to date for this. If you wish to generate the client first, you should use `make generate`.
 
 ### Testing
 

{vantage_python-0.2.0 → vantage_python-0.3.1}/autogen.py

@@ -248,7 +248,7 @@ def extract_response_type(
     responses: dict[str, Any], schemas: dict[str, Any]
 ) -> str | None:
     """Extract successful response type."""
-    for code in ["200", "201", "202", "204"]:
+    for code in ["200", "201", "202", "203"]:
         if code not in responses:
             continue
         response = responses[code]
@@ -373,6 +373,70 @@ def generate_method_name(endpoint: Endpoint, resource_name: str) -> str:
     return to_snake_case(op_id)
 
 
+def _extract_inner_type(type_hint: str, generic_prefix: str) -> str | None:
+    """Extract inner type from simple generic forms like Prefix[Inner]."""
+    if not type_hint.startswith(generic_prefix) or not type_hint.endswith("]"):
+        return None
+    return type_hint[len(generic_prefix):-1].strip()
+
+
+def _extract_dict_value_type(type_hint: str) -> str | None:
+    """Extract value type from Dict[str, ValueType]."""
+    if not type_hint.startswith("Dict[") or not type_hint.endswith("]"):
+        return None
+    inner = type_hint[len("Dict["):-1].strip()
+    key_and_value = inner.split(",", 1)
+    if len(key_and_value) != 2:
+        return None
+    key_type = key_and_value[0].strip()
+    value_type = key_and_value[1].strip()
+    if key_type not in {"str", "Optional[str]"}:
+        return None
+    return value_type
+
+
+def _is_model_type(type_hint: str) -> bool:
+    """Return True for generated Pydantic model type names."""
+    return bool(re.match(r"^[A-Z][A-Za-z0-9_]*$", type_hint))
+
+
+def _append_response_mapping(lines: list[str], return_type: str, data_var: str) -> None:
+    """Append generated code that coerces dict payloads into typed models."""
+    type_hint = return_type.strip()
+
+    optional_inner = _extract_inner_type(type_hint, "Optional[")
+    if optional_inner:
+        type_hint = optional_inner
+
+    list_inner = _extract_inner_type(type_hint, "List[")
+    if list_inner and _is_model_type(list_inner):
+        lines.extend(
+            [
+                f"        if isinstance({data_var}, list):",
+                f"            return [{list_inner}.model_validate(item) if isinstance(item, dict) else item for item in {data_var}]",
+            ]
+        )
+        return
+
+    dict_inner = _extract_dict_value_type(type_hint)
+    if dict_inner and _is_model_type(dict_inner):
+        lines.extend(
+            [
+                f"        if isinstance({data_var}, dict):",
+                f"            return {{k: {dict_inner}.model_validate(v) if isinstance(v, dict) else v for k, v in {data_var}.items()}}",
+            ]
+        )
+        return
+
+    if _is_model_type(type_hint):
+        lines.extend(
+            [
+                f"        if isinstance({data_var}, dict):",
+                f"            return {type_hint}.model_validate({data_var})",
+            ]
+        )
+
+
 def generate_pydantic_models(schema: dict[str, Any]) -> str:
     """Generate Pydantic models from OpenAPI schemas."""
     schemas = schema.get("components", {}).get("schemas", {})
@@ -675,10 +739,12 @@ def generate_sync_method(endpoint: Endpoint, method_name: str) -> list[str]:
     else:
         lines.append("        body_data = None")
 
-    # Make request
+    # Make request and coerce response payload into typed models where possible
     lines.append(
-        f'        return self._client.request("{endpoint.method}", path, params=params, body=body_data)'
+        f'        data = self._client.request("{endpoint.method}", path, params=params, body=body_data)'
     )
+    _append_response_mapping(lines, return_type, "data")
+    lines.append("        return data")
 
     return lines
 
@@ -899,10 +965,12 @@ def generate_async_method(endpoint: Endpoint, method_name: str) -> list[str]:
     else:
         lines.append("        body_data = None")
 
-    # Make request
+    # Make request and coerce response payload into typed models where possible
     lines.append(
-        f'        return await self._client.request("{endpoint.method}", path, params=params, body=body_data)'
+        f'        data = await self._client.request("{endpoint.method}", path, params=params, body=body_data)'
     )
+    _append_response_mapping(lines, return_type, "data")
+    lines.append("        return data")
 
     return lines
 

{vantage_python-0.2.0 → vantage_python-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "vantage-python"
-version = "0.2.0"
+version = "0.3.1"
 description = "Python SDK for the Vantage API"
 readme = "README.md"
 license = "MIT"