openapi-httpx-client 0.4.1__tar.gz → 0.4.3__tar.gz

openapi_httpx_client-0.4.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lloyd Zhou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{openapi-httpx-client-0.4.1 → openapi_httpx_client-0.4.3}/PKG-INFO

@@ -1,17 +1,28 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: openapi-httpx-client
-Version: 0.4.1
+Version: 0.4.3
 Summary: A Python client for OpenAPI specifications using httpx
 Home-page: https://github.com/lloydzhou/openapiclient
 Author: lloydzhou
 Author-email: lloydzhou@qq.com
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pyyaml>=6.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # OpenAPI Client for Python
 
@@ -47,6 +58,11 @@ async def main():
         pet = await client.getPetById(petId=1)
         print(f"Status: {pet['status']}")
         print(f"Pet data: {pet['data']}")
+
+        # Call operations directly as methods, using positional arguments, can using in path and query
+        pet = await client.getPetById(1)
+        print(f"Status: {pet['status']}")
+        print(f"Pet data: {pet['data']}")
         
         # Alternative way to call methods
         pet = await client("getPetById", petId=2)
@@ -127,5 +143,3 @@ All API responses are returned in a dictionary format with the following keys:
 lloydzhou
 
 
-
-

{openapi-httpx-client-0.4.1 → openapi_httpx_client-0.4.3}/README.md

@@ -32,6 +32,11 @@ async def main():
         pet = await client.getPetById(petId=1)
         print(f"Status: {pet['status']}")
         print(f"Pet data: {pet['data']}")
+
+        # Call operations directly as methods, using positional arguments, can using in path and query
+        pet = await client.getPetById(1)
+        print(f"Status: {pet['status']}")
+        print(f"Pet data: {pet['data']}")
         
         # Alternative way to call methods
         pet = await client("getPetById", petId=2)

{openapi-httpx-client-0.4.1 → openapi_httpx_client-0.4.3}/openapi_httpx_client.egg-info/PKG-INFO

@@ -1,17 +1,28 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: openapi-httpx-client
-Version: 0.4.1
+Version: 0.4.3
 Summary: A Python client for OpenAPI specifications using httpx
 Home-page: https://github.com/lloydzhou/openapiclient
 Author: lloydzhou
 Author-email: lloydzhou@qq.com
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pyyaml>=6.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # OpenAPI Client for Python
 
@@ -47,6 +58,11 @@ async def main():
         pet = await client.getPetById(petId=1)
         print(f"Status: {pet['status']}")
         print(f"Pet data: {pet['data']}")
+
+        # Call operations directly as methods, using positional arguments, can using in path and query
+        pet = await client.getPetById(1)
+        print(f"Status: {pet['status']}")
+        print(f"Pet data: {pet['data']}")
         
         # Alternative way to call methods
         pet = await client("getPetById", petId=2)
@@ -127,5 +143,3 @@ All API responses are returned in a dictionary format with the following keys:
 lloydzhou
 
 
-
-

{openapi-httpx-client-0.4.1 → openapi_httpx_client-0.4.3}/openapi_httpx_client.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 setup.py
 openapi_httpx_client.egg-info/PKG-INFO

{openapi-httpx-client-0.4.1 → openapi_httpx_client-0.4.3}/openapiclient/client.py

@@ -3,6 +3,8 @@ import json
 import os.path
 from urllib.parse import urljoin, urlparse
 import yaml
+import re
+
 
 # 合并DynamicClientBase和BaseClient为一个基类
 class BaseClient:
@@ -67,13 +69,13 @@ class Client(BaseClient):
     def __init__(self, api, **kwargs):
         """Initialize the sync client"""
         super().__init__(api)
-        self.session = httpx.Client(**kwargs)
+        self.session = api.httpx_client or httpx.Client(**kwargs)
 
     def __enter__(self):
         """Enter context manager and initialize the client"""
         if not self.api.definition:
             self.api._load_definition_sync()
-            
+
         self.setup_base_url()
         # Generate methods directly on this instance
         self.api._generate_client_methods(self, is_async=False)
@@ -94,7 +96,7 @@ class AsyncClient(BaseClient):
     def __init__(self, api, **kwargs):
         """Initialize the async client"""
         super().__init__(api)
-        self.session = httpx.AsyncClient(**kwargs)
+        self.session = api.httpx_async_client or httpx.AsyncClient(**kwargs)
 
     async def __aenter__(self):
         """Enter async context manager and initialize the client"""
@@ -112,6 +114,50 @@ class AsyncClient(BaseClient):
             await self.session.aclose()
 
 
+def sanitize_openapi_path(path: str) -> str:
+    """
+    Convert OpenAPI path (e.g. "/v3/symbols/{symbol}/session") into a valid Python identifier.
+    """
+
+    # replace path parameters {param} with sanitized param name prefixed with "by_"
+    def repl_param(m):
+        name = m.group(1) or ""
+        # sanitize param name: replace non-alnum/_ with underscore and collapse
+        name = re.sub(r"[^0-9A-Za-z_]", "_", name)
+        name = re.sub(r"_+", "_", name).strip("_")
+        return "by_" + name
+
+    s = re.sub(r"\{([^}]*)\}", repl_param, path)
+    # replace slashes/backslashes with underscore
+    s = re.sub(r"[\\/]+", "_", s)
+    # replace any remaining non-alnum/_ with underscore
+    s = re.sub(r"[^0-9A-Za-z_]", "_", s)
+    # collapse underscores and strip edges
+    s = re.sub(r"_+", "_", s).strip("_")
+
+    return s
+
+
+def resolve_open_api_reference(dct, definition):
+    if "$ref" not in dct:
+        return dct
+    else:
+        ref_path = dct["$ref"]
+        # Only handling local references for simplicity
+        if not ref_path.startswith("#/"):
+            raise NotImplementedError(
+                "Only local references are supported in this implementation."
+            )
+
+        parts = ref_path.lstrip("#/").split("/")
+        ref = definition
+        for part in parts:
+            ref = ref.get(part)
+            if ref is None:
+                raise ValueError(f"Reference {ref_path} could not be resolved.")
+        return ref
+
+
 # Create the main OpenAPIClient class as a factory
 class OpenAPIClient:
     """
@@ -130,7 +176,7 @@ class OpenAPIClient:
             result = await client.operation_name(param1=value)
     """
 
-    def __init__(self, definition=None):
+    def __init__(self, definition=None, httpx_client=None, httpx_async_client=None):
         """
         Initialize the OpenAPI client.
 
@@ -139,8 +185,10 @@ class OpenAPIClient:
         """
         self.definition_source = definition
         self.definition = {}
-        self.base_url = ''
+        self.base_url = ""
         self.source_url = None  # Store the source URL if loaded from a URL
+        self.httpx_client = httpx_client
+        self.httpx_async_client = httpx_async_client
 
     def Client(self, **kwargs):
         """
@@ -153,7 +201,7 @@ class OpenAPIClient:
             Client: A synchronous client
         """
         return Client(self, **kwargs)
-        
+
     def AsyncClient(self, **kwargs):
         """
         Create an asynchronous client instance that can be used as a context manager.
@@ -289,38 +337,43 @@ class OpenAPIClient:
 
     def create_tool(self, operation_id, operation, all_references):
         """Create an AI tool description from operation data"""
-        # Get parameters from the request body schema only for json content
+        # Get parameters from the request body schema
         body = operation.get('requestBody', {})
-        schema = body.get('content', {}).get('application/json', {}).get('schema', {})
-        parameters = {
-            "type": "object",
-            "required": ['body'] if body.get("required", False) else [],
-            "description": body.get('description', ''),
-            "properties": {
-                "body": self.resolve_schema_ref(schema, all_references) if schema else {},
-            }
-        }
+        content = body.get('content', {})
+        schema = content.get('application/json', {}).get('schema', {}) or content.get('application/xml', {}).get('schema', {}) or content.get('application/x-www-form-urlencoded', {}).get('schema', {})
+        json_schema = self.resolve_schema_ref(schema, all_references) if schema else { "type": "object", "properties": {} }
+
+        if not json_schema.get('description'):
+            json_schema['description'] = body.get('description', '')
+
         # add parameters from path and query
-        for parameter in operation.get('parameters', []):
-            name = parameter.get('name')
-            if parameter.get('required', False):
-                parameters["required"].append(name)
-            item = {
-                "type": parameter.get('schema', {}).get('type', 'string'),
-                "description": parameter.get('description', ''),
-            }
-            # Add format, enum, and example if available
-            for key in ['format', 'enum', 'example']:
-                if parameter.get('schema', {}).get(key):
-                    item[key] = parameter.get('schema', {}).get(key)
-            parameters["properties"][name] = item
+        parameters = operation.get('parameters', [])
+        if len(parameters) > 0:
+            if not json_schema.get('required'):
+                json_schema['required'] = []
+            if not json_schema.get('properties'):
+                json_schema['properties'] = {}
+            for parameter in parameters:
+                name = parameter.get('name')
+                if parameter.get('required', False):
+                    json_schema["required"].append(name)
+
+                parameter_schema = {
+                    "type": parameter.get('schema', {}).get('type', 'string'),
+                    "description": parameter.get('description', ''),
+                }
+                # Add format, enum, and example if available
+                for key in ['format', 'enum', 'example']:
+                    if parameter.get('schema', {}).get(key):
+                        parameter_schema[key] = parameter.get('schema', {}).get(key)
+                json_schema["properties"][name] = parameter_schema
 
         return {
             "type": "function",
             "function": {
                 "name": operation_id,
                 "description": operation.get('summary', '') or operation.get('description', ''),
-                "parameters": parameters,
+                "parameters": json_schema,
             }
         }
 
@@ -348,7 +401,9 @@ class OpenAPIClient:
         for operation in self.get_operations():
             operation_id = operation.get('operationId')
             if not operation_id:
-                continue
+                operation_id = (
+                    operation["method"] + "_" + sanitize_openapi_path(operation["path"])
+                )
 
             path = operation.get('path')
             paths.append(path)
@@ -374,13 +429,14 @@ class OpenAPIClient:
         client_instance.paths = paths
         client_instance.tools = tools
 
-    def _prepare_request_params(self, path, operation, kwargs):
+    def _prepare_request_params(self, path, operation, args, kwargs):
         """
         Prepare request parameters for an API operation.
 
         Args:
             path: The path template
             operation: Operation object
+            args: Positional arguments passed to the operation
             kwargs: Keyword arguments passed to the operation
 
         Returns:
@@ -393,10 +449,13 @@ class OpenAPIClient:
         # Extract parameters from operation definition
         parameters = operation.get('parameters', [])
         for param in parameters:
+            param = resolve_open_api_reference(param, self.definition)
             if param.get('in') == 'path':
                 name = param.get('name')
                 if name in kwargs:
                     path_params[name] = kwargs.pop(name)
+                elif len(args) > 0:
+                    path_params[name] = args.pop(0)  # Pop the first positional argument
 
         # Replace path parameters in the URL
         for name, value in path_params.items():
@@ -408,10 +467,13 @@ class OpenAPIClient:
         # Handle query parameters
         query_params = {}
         for param in parameters:
+            param = resolve_open_api_reference(param, self.definition)
             if param.get('in') == 'query':
                 name = param.get('name')
                 if name in kwargs:
                     query_params[name] = kwargs.pop(name)
+                elif len(args) > 0:
+                    query_params[name] = args.pop(0)  # Pop the first positional argument
 
         # Handle headers
         headers = kwargs.pop('headers', {})
@@ -419,7 +481,7 @@ class OpenAPIClient:
         # Handle request body
         body = kwargs.pop('data', None) or kwargs.pop('body', None)
         # json body
-        if not body and len(kwargs) > 0 and operation.get('requestBody', {}).get('content', {}).get('application/json'):
+        if not body and len(kwargs) > 0 and operation.get('requestBody', {}).get('content', {}):
             body = kwargs.copy()
             kwargs.clear()  # Clear the kwargs after using them as body
 
@@ -466,17 +528,17 @@ class OpenAPIClient:
             async def operation_method(*args, **kwargs):
                 # Prepare request parameters
                 full_url, query_params, body, headers, remaining_kwargs = self._prepare_request_params(
-                    path, operation, kwargs.copy()
+                    path, operation, list(args), kwargs.copy()
                 )
 
                 # Make the async request
                 response = await client_instance.session.request(
                     method,
                     full_url,
-                    params=query_params, 
-                    json=body, 
-                    headers=headers,
-                    **remaining_kwargs
+                    params=query_params,
+                    json=body,
+                    headers=dict(client_instance.session.headers) | headers,
+                    **remaining_kwargs,
                 )
 
                 # Process the response
@@ -485,17 +547,17 @@ class OpenAPIClient:
             def operation_method(*args, **kwargs):
                 # Prepare request parameters
                 full_url, query_params, body, headers, remaining_kwargs = self._prepare_request_params(
-                    path, operation, kwargs.copy()
+                    path, operation, list(args), kwargs.copy()
                 )
 
                 # Make the sync request
                 response = client_instance.session.request(
                     method,
                     full_url,
-                    params=query_params, 
-                    json=body, 
-                    headers=headers,
-                    **remaining_kwargs
+                    params=query_params,
+                    json=body,
+                    headers=dict(client_instance.session.headers) | headers,
+                    **remaining_kwargs,
                 )
 
                 # Process the response

{openapi-httpx-client-0.4.1 → openapi_httpx_client-0.4.3}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="openapi-httpx-client",
-    version="0.4.1",
+    version="0.4.3",
     author="lloydzhou",
     author_email="lloydzhou@qq.com",
     description="A Python client for OpenAPI specifications using httpx",