polyapi-python 0.3.13.dev3__tar.gz → 0.3.14__tar.gz

{polyapi_python-0.3.13.dev3/polyapi_python.egg-info → polyapi_python-0.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polyapi-python
-Version: 0.3.13.dev3
+Version: 0.3.14
 Summary: The Python Client for PolyAPI, the IPaaS by Developers for Developers
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -30,12 +30,13 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.32.3
 Requires-Dist: typing_extensions>=4.12.2
-Requires-Dist: jsonschema-gentypes==2.6.0
-Requires-Dist: pydantic>=2.8.0
-Requires-Dist: stdlib_list>=0.10.0
+Requires-Dist: jsonschema-gentypes==2.10.0
+Requires-Dist: pydantic<3.0.0,>=2.8.0
+Requires-Dist: stdlib_list<1.0.0,>=0.10.0
 Requires-Dist: colorama==0.4.4
 Requires-Dist: python-socketio[asyncio_client]==5.11.1
 Requires-Dist: truststore>=0.8.0
+Requires-Dist: httpx>=0.28.1
 Dynamic: license-file
 
 # PolyAPI Python Library
@@ -185,6 +186,14 @@ This script is handy for checking for any mypy types:
 
 Please ignore \[name-defined\] errors for now. This is a known bug we are working to fix!
 
+## Strategies for QA'ing Changes To Generate Or Other Core Functionality
+
+Our https://na1.polyapi.io has a large OOB catalog (as does eu1/na2). We also have several big internal PolyAPI projects with Python (message @eupharis if you need a pointer to which ones).
+
+Running `python -m polyapi generate` in all these projects and then checking the flake8 and check_mypy steps above is a great way to build confidence that the `generate` changes has no gotchas.
+
+Of course all this is in addition to the changes passing through normal unittests and integration tests!
+
 ## Support
 
 If you run into any issues or want help getting started with this project, please contact support@polyapi.io

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/README.md

@@ -145,6 +145,14 @@ This script is handy for checking for any mypy types:
 
 Please ignore \[name-defined\] errors for now. This is a known bug we are working to fix!
 
+## Strategies for QA'ing Changes To Generate Or Other Core Functionality
+
+Our https://na1.polyapi.io has a large OOB catalog (as does eu1/na2). We also have several big internal PolyAPI projects with Python (message @eupharis if you need a pointer to which ones).
+
+Running `python -m polyapi generate` in all these projects and then checking the flake8 and check_mypy steps above is a great way to build confidence that the `generate` changes has no gotchas.
+
+Of course all this is in addition to the changes passing through normal unittests and integration tests!
+
 ## Support
 
 If you run into any issues or want help getting started with this project, please contact support@polyapi.io

polyapi_python-0.3.14/polyapi/__init__.py

@@ -0,0 +1,163 @@
+import copy
+import os
+import sys
+from contextvars import ContextVar, Token
+from dataclasses import dataclass
+from typing import Any, Dict, Literal, Optional, overload
+
+import truststore
+from typing_extensions import TypedDict
+
+from .cli_constants import CLI_COMMANDS
+
+truststore.inject_into_ssl()
+
+__all__ = ["poly"]
+
+
+if len(sys.argv) > 1 and sys.argv[1] not in CLI_COMMANDS:
+    currdir = os.path.dirname(os.path.abspath(__file__))
+    if not os.path.isdir(os.path.join(currdir, "poly")):
+        print("No 'poly' found. Please run 'python3 -m polyapi generate' to generate the 'poly' library for your tenant.")
+        sys.exit(1)
+
+
+class PolyCustomDict(TypedDict, total=False):
+    """Type definition for polyCustom dictionary."""
+
+    executionId: Optional[str]  # Read-only unless explicitly unlocked
+    executionApiKey: Optional[str]
+    userSessionId: Optional[str]
+    responseStatusCode: Optional[int]
+    responseContentType: Optional[str]
+    responseHeaders: Dict[str, Any]
+
+
+@dataclass
+class _PolyCustomState:
+    internal_store: Dict[str, Any]
+    execution_id_locked: bool = False
+
+
+class PolyCustom:
+    def __init__(self) -> None:
+        object.__setattr__(
+            self,
+            "_default_store",
+            {
+                "executionId": None,
+                "executionApiKey": None,
+                "userSessionId": None,
+                "responseStatusCode": 200,
+                "responseContentType": None,
+                "responseHeaders": {},
+            },
+        )
+        object.__setattr__(self, "_state_var", ContextVar("_poly_custom_state", default=None))
+
+    def _make_state(self) -> _PolyCustomState:
+        return _PolyCustomState(internal_store=copy.deepcopy(self._default_store))
+
+    def _get_state(self) -> _PolyCustomState:
+        state = self._state_var.get()
+        if state is None:
+            state = self._make_state()
+            self._state_var.set(state)
+        return state
+
+    def push_scope(self, initial_values: Optional[Dict[str, Any]] = None) -> Token:
+        state = self._make_state()
+        if initial_values:
+            state.internal_store.update(copy.deepcopy(initial_values))
+            if state.internal_store.get("executionId") is not None:
+                state.execution_id_locked = True
+        return self._state_var.set(state)
+
+    def pop_scope(self, token: Token) -> None:
+        self._state_var.reset(token)
+
+    def set_once(self, key: str, value: Any) -> None:
+        state = self._get_state()
+        if key == "executionId" and state.execution_id_locked:
+            return
+        state.internal_store[key] = value
+        if key == "executionId":
+            state.execution_id_locked = True
+
+    def get(self, key: str, default: Any = None) -> Any:
+        return self._get_state().internal_store.get(key, default)
+
+    def lock_execution_id(self) -> None:
+        self._get_state().execution_id_locked = True
+
+    def unlock_execution_id(self) -> None:
+        self._get_state().execution_id_locked = False
+
+    @overload
+    def __getitem__(self, key: Literal["executionId"]) -> Optional[str]: ...
+
+    @overload
+    def __getitem__(self, key: Literal["executionApiKey"]) -> Optional[str]: ...
+
+    @overload
+    def __getitem__(self, key: Literal["userSessionId"]) -> Optional[str]: ...
+
+    @overload
+    def __getitem__(self, key: Literal["responseStatusCode"]) -> Optional[int]: ...
+
+    @overload
+    def __getitem__(self, key: Literal["responseContentType"]) -> Optional[str]: ...
+
+    @overload
+    def __getitem__(self, key: Literal["responseHeaders"]) -> Dict[str, Any]: ...
+
+    def __getitem__(self, key: str) -> Any:
+        return self.get(key)
+
+    @overload
+    def __setitem__(self, key: Literal["executionApiKey"], value: Optional[str]) -> None: ...
+
+    @overload
+    def __setitem__(self, key: Literal["userSessionId"], value: Optional[str]) -> None: ...
+
+    @overload
+    def __setitem__(self, key: Literal["responseStatusCode"], value: Optional[int]) -> None: ...
+
+    @overload
+    def __setitem__(self, key: Literal["responseContentType"], value: Optional[str]) -> None: ...
+
+    @overload
+    def __setitem__(self, key: Literal["responseHeaders"], value: Dict[str, Any]) -> None: ...
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.set_once(key, value)
+
+    def __getattr__(self, key: str) -> Any:
+        if key in self._default_store:
+            return self.get(key)
+        raise AttributeError(f"{type(self).__name__!r} object has no attribute {key!r}")
+
+    def __setattr__(self, key: str, value: Any) -> None:
+        if key.startswith("_"):
+            object.__setattr__(self, key, value)
+            return
+        self.set_once(key, value)
+
+    def __repr__(self) -> str:
+        return f"PolyCustom({self._get_state().internal_store})"
+
+    def copy(self) -> "PolyCustom":
+        new = PolyCustom()
+        state = self._get_state()
+        new._state_var.set(
+            _PolyCustomState(
+                internal_store=copy.deepcopy(state.internal_store),
+                execution_id_locked=state.execution_id_locked,
+            )
+        )
+        return new
+
+
+_PolyCustom = PolyCustom
+
+polyCustom: PolyCustom = PolyCustom()

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/polyapi/api.py

@@ -35,6 +35,25 @@ def {function_name}(
         return {api_response_type}(resp.json())  # type: ignore
 
 
+async def {function_name}_async(
+{args}
+) -> {api_response_type}:
+    \"""{function_description}
+
+    Function ID: {function_id}
+    \"""
+    if get_direct_execute_config():
+        resp = await direct_execute_async("{function_type}", "{function_id}", {data})
+        return {api_response_type}({{
+            "status": resp.status_code,
+            "headers": dict(resp.headers),
+            "data": resp.json()
+        }})  # type: ignore
+    else:
+        resp = await execute_async("{function_type}", "{function_id}", {data})
+        return {api_response_type}(resp.json())  # type: ignore
+
+
 """
 
 

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/polyapi/auth.py

@@ -117,6 +117,16 @@ def introspectToken(token: str) -> AuthFunctionResponse:
     url = "/auth-providers/{function_id}/introspect"
     resp = execute_post(url, {{"token": token}})
     return resp.json()
+
+
+async def introspectToken_async(token: str) -> AuthFunctionResponse:
+    \"""{description}
+
+    Function ID: {function_id}
+    \"""
+    url = "/auth-providers/{function_id}/introspect"
+    resp = await execute_post_async(url, {{"token": token}})
+    return resp.json()
 """
 
 REFRESH_TOKEN_TEMPLATE = """
@@ -128,6 +138,16 @@ def refreshToken(token: str) -> AuthFunctionResponse:
     url = "/auth-providers/{function_id}/refresh"
     resp = execute_post(url, {{"token": token}})
     return resp.json()
+
+
+async def refreshToken_async(token: str) -> AuthFunctionResponse:
+    \"""{description}
+
+    Function ID: {function_id}
+    \"""
+    url = "/auth-providers/{function_id}/refresh"
+    resp = await execute_post_async(url, {{"token": token}})
+    return resp.json()
 """
 
 REVOKE_TOKEN_TEMPLATE = """
@@ -142,6 +162,19 @@ def revokeToken(token: str) -> Optional[AuthFunctionResponse]:
         return resp.json()
     except:
         return None
+
+
+async def revokeToken_async(token: str) -> Optional[AuthFunctionResponse]:
+    \"""{description}
+
+    Function ID: {function_id}
+    \"""
+    url = "/auth-providers/{function_id}/revoke"
+    resp = await execute_post_async(url, {{"token": token}})
+    try:
+        return resp.json()
+    except:
+        return None
 """
 
 

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/polyapi/cli.py

@@ -3,6 +3,7 @@ import argparse
 
 from polyapi.utils import print_green, print_red
 
+from .cli_constants import CLI_COMMANDS
 from .config import initialize_config, set_api_key_and_url
 from .generate import generate, clear
 from .function_cli import function_add_or_update, function_execute
@@ -11,9 +12,6 @@ from .prepare import prepare_deployables
 from .sync import sync_deployables
 
 
-CLI_COMMANDS = ["setup", "generate", "function", "clear", "help", "update_rendered_spec"]
-
-
 def _get_version_string():
     """Get the version string for the package."""
     try:

polyapi_python-0.3.14/polyapi/cli_constants.py

@@ -0,0 +1,10 @@
+CLI_COMMANDS = (
+    "setup",
+    "generate",
+    "function",
+    "clear",
+    "help",
+    "update_rendered_spec",
+    "prepare",
+    "sync",
+)

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/polyapi/constants.py

@@ -3,8 +3,8 @@ JSONSCHEMA_TO_PYTHON_TYPE_MAP = {
     "number": "float",
     "string": "str",
     "boolean": "bool",
-    "array": "List",
-    "object": "Dict",
+    "array": "list",
+    "object": "dict",
     "function": "Callable",
     "void": "None",
 }
@@ -15,10 +15,13 @@ PYTHON_TO_JSONSCHEMA_TYPE_MAP = {
     "float": "number",
     "str": "string",
     "bool": "boolean",
-    "List": "array",
-    "Dict": "object",
+    "list": "array",
+    "dict": "object",
     "Callable": "function",
     "None": "void",
+    # Keep uppercase aliases for backwards compatibility
+    "List": "array",
+    "Dict": "object",
 }
 
 BASIC_PYTHON_TYPES = set(PYTHON_TO_JSONSCHEMA_TYPE_MAP.keys())

polyapi_python-0.3.14/polyapi/execute.py

@@ -0,0 +1,224 @@
+import httpx
+import os
+import logging
+from polyapi.config import get_api_key_and_url, get_mtls_config
+from polyapi.exceptions import PolyApiException
+from polyapi import http_client
+
+logger = logging.getLogger("poly")
+
+def _check_response_error(resp, function_type, function_id, data):
+    if resp.status_code < 200 or resp.status_code >= 300:
+        error_content = resp.content.decode("utf-8", errors="ignore")
+        if function_type == 'api' and os.getenv("LOGS_ENABLED"):
+            logger.error(f"Error executing api function with id: {function_id}. Status code: {resp.status_code}. Request data: {data}, Response: {error_content}")
+        elif function_type != 'api':
+            raise PolyApiException(f"{resp.status_code}: {error_content}")
+
+
+def _check_endpoint_error(resp, function_type, function_id, data):
+    if resp.status_code < 200 or resp.status_code >= 300:
+        error_content = resp.content.decode("utf-8", errors="ignore")
+        if function_type == 'api' and os.getenv("LOGS_ENABLED"):
+            raise PolyApiException(f"Error executing api function with id: {function_id}. Status code: {resp.status_code}. Request data: {data}, Response: {error_content}")
+        elif function_type != 'api':
+            raise PolyApiException(f"{resp.status_code}: {error_content}")
+
+
+def _build_direct_execute_params(endpoint_info_data):
+    request_params = endpoint_info_data.copy()
+    request_params.pop("url", None)
+    if "maxRedirects" in request_params:
+        request_params["follow_redirects"] = request_params.pop("maxRedirects") > 0
+    return request_params
+
+
+def _sync_direct_execute(function_type, function_id, data) -> httpx.Response:
+    api_key, api_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{api_url}/functions/{function_type}/{function_id}/direct-execute"
+
+    endpoint_info = http_client.post(url, json=data, headers=headers)
+    _check_endpoint_error(endpoint_info, function_type, function_id, data)
+
+    endpoint_info_data = endpoint_info.json()
+    request_params = _build_direct_execute_params(endpoint_info_data)
+
+    has_mtls, cert_path, key_path, ca_path = get_mtls_config()
+
+    # Direct-execute hits URL that may need custom TLS
+    # settings (mTLS certs or disabled verification). httpx Client.request()
+    # doesn't accept per-request transport kwargs, so use one-off calls.
+    if has_mtls:
+        resp = httpx.request(
+            url=endpoint_info_data["url"],
+            cert=(cert_path, key_path),
+            verify=ca_path,
+            timeout=None,
+            **request_params
+        )
+    else:
+        resp = httpx.request(
+            url=endpoint_info_data["url"],
+            verify=False,
+            timeout=None,
+            **request_params
+        )
+
+    _check_response_error(resp, function_type, function_id, data)
+    return resp
+
+
+async def _async_direct_execute(function_type, function_id, data) -> httpx.Response:
+    api_key, api_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{api_url}/functions/{function_type}/{function_id}/direct-execute"
+
+    endpoint_info = await http_client.async_post(url, json=data, headers=headers)
+    _check_endpoint_error(endpoint_info, function_type, function_id, data)
+
+    endpoint_info_data = endpoint_info.json()
+    request_params = _build_direct_execute_params(endpoint_info_data)
+
+    has_mtls, cert_path, key_path, ca_path = get_mtls_config()
+
+    # One-off async client for custom TLS settings on external URLs.
+    if has_mtls:
+        async with httpx.AsyncClient(
+            cert=(cert_path, key_path), verify=ca_path, timeout=None
+        ) as client:
+            resp = await client.request(
+                url=endpoint_info_data["url"], **request_params
+            )
+    else:
+        async with httpx.AsyncClient(verify=False, timeout=None) as client:
+            resp = await client.request(
+                url=endpoint_info_data["url"], **request_params
+            )
+
+    _check_response_error(resp, function_type, function_id, data)
+    return resp
+
+
+def direct_execute(function_type, function_id, data) -> httpx.Response:
+    """ execute a specific function id/type (sync)
+    """
+    return _sync_direct_execute(function_type, function_id, data)
+
+
+async def direct_execute_async(function_type, function_id, data) -> httpx.Response:
+    """ execute a specific function id/type (async)
+    """
+    return await _async_direct_execute(function_type, function_id, data)
+
+
+def _sync_execute(function_type, function_id, data) -> httpx.Response:
+    api_key, api_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{api_url}/functions/{function_type}/{function_id}/execute"
+
+    resp = http_client.post(url, json=data, headers=headers)
+    _check_response_error(resp, function_type, function_id, data)
+    return resp
+
+
+async def _async_execute(function_type, function_id, data) -> httpx.Response:
+    api_key, api_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{api_url}/functions/{function_type}/{function_id}/execute"
+
+    resp = await http_client.async_post(url, json=data, headers=headers)
+    _check_response_error(resp, function_type, function_id, data)
+    return resp
+
+
+def execute(function_type, function_id, data) -> httpx.Response:
+    """ execute a specific function id/type (sync)
+    """
+    return _sync_execute(function_type, function_id, data)
+
+
+async def execute_async(function_type, function_id, data) -> httpx.Response:
+    """ execute a specific function id/type (async)
+    """
+    return await _async_execute(function_type, function_id, data)
+
+
+def _sync_execute_post(path, data):
+    api_key, api_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    return http_client.post(api_url + path, json=data, headers=headers)
+
+
+async def _async_execute_post(path, data):
+    api_key, api_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    return await http_client.async_post(api_url + path, json=data, headers=headers)
+
+
+def execute_post(path, data):
+    return _sync_execute_post(path, data)
+
+
+async def execute_post_async(path, data):
+    return await _async_execute_post(path, data)
+
+
+def _sync_variable_get(variable_id: str) -> httpx.Response:
+    api_key, base_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{base_url}/variables/{variable_id}/value"
+    resp = http_client.get(url, headers=headers)
+    if resp.status_code != 200 and resp.status_code != 201:
+        error_content = resp.content.decode("utf-8", errors="ignore")
+        raise PolyApiException(f"{resp.status_code}: {error_content}")
+    return resp
+
+
+async def _async_variable_get(variable_id: str) -> httpx.Response:
+    api_key, base_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{base_url}/variables/{variable_id}/value"
+    resp = await http_client.async_get(url, headers=headers)
+    if resp.status_code != 200 and resp.status_code != 201:
+        error_content = resp.content.decode("utf-8", errors="ignore")
+        raise PolyApiException(f"{resp.status_code}: {error_content}")
+    return resp
+
+
+def variable_get(variable_id: str) -> httpx.Response:
+    return _sync_variable_get(variable_id)
+
+
+async def variable_get_async(variable_id: str) -> httpx.Response:
+    return await _async_variable_get(variable_id)
+
+
+def _sync_variable_update(variable_id: str, value) -> httpx.Response:
+    api_key, base_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{base_url}/variables/{variable_id}"
+    resp = http_client.patch(url, data={"value": value}, headers=headers)
+    if resp.status_code != 200 and resp.status_code != 201:
+        error_content = resp.content.decode("utf-8", errors="ignore")
+        raise PolyApiException(f"{resp.status_code}: {error_content}")
+    return resp
+
+
+async def _async_variable_update(variable_id: str, value) -> httpx.Response:
+    api_key, base_url = get_api_key_and_url()
+    headers = {"Authorization": f"Bearer {api_key}"}
+    url = f"{base_url}/variables/{variable_id}"
+    resp = await http_client.async_patch(url, data={"value": value}, headers=headers)
+    if resp.status_code != 200 and resp.status_code != 201:
+        error_content = resp.content.decode("utf-8", errors="ignore")
+        raise PolyApiException(f"{resp.status_code}: {error_content}")
+    return resp
+
+
+def variable_update(variable_id: str, value) -> httpx.Response:
+    return _sync_variable_update(variable_id, value)
+
+
+async def variable_update_async(variable_id: str, value) -> httpx.Response:
+    return await _async_variable_update(variable_id, value)

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/polyapi/function_cli.py

@@ -1,7 +1,6 @@
 import sys
 from typing import Any, List, Optional
-import requests
-
+from polyapi import http_client
 from polyapi.config import get_api_key_and_url
 from polyapi.utils import get_auth_headers, print_green, print_red, print_yellow
 from polyapi.parser import parse_function_code, get_jsonschema_type
@@ -87,7 +86,7 @@ def function_add_or_update(
         sys.exit(1)
 
     headers = get_auth_headers(api_key)
-    resp = requests.post(url, headers=headers, json=data)
+    resp = http_client.post(url, headers=headers, json=data)
     if resp.status_code in [200, 201]:
         print_green("DEPLOYED")
         function_id = resp.json()["id"]
@@ -126,5 +125,5 @@ def spec_delete(function_type: str, function_id: str):
         print(f"Unknown function type: {function_type}")
         sys.exit(1)
     headers = get_auth_headers(api_key)
-    resp = requests.delete(url, headers=headers)
+    resp = http_client.delete(url, headers=headers)
     return resp

{polyapi_python-0.3.13.dev3 → polyapi_python-0.3.14}/polyapi/generate.py

@@ -1,5 +1,4 @@
 import json
-import requests
 import os
 import uuid
 import shutil
@@ -20,6 +19,7 @@ from .server import render_server_function
 from .utils import add_import_to_init, get_auth_headers, init_the_init, print_green, to_func_namespace
 from .variables import generate_variables
 from .poly_tables import generate_tables
+from . import http_client
 from .config import get_api_key_and_url, get_direct_execute_config, get_cached_generate_args
 
 SUPPORTED_FUNCTION_TYPES = {
@@ -62,7 +62,7 @@ def get_specs(contexts: Optional[List[str]] = None, names: Optional[List[str]] =
     if get_direct_execute_config():
         params["apiFunctionDirectExecute"] = "true"
 
-    resp = requests.get(url, headers=headers, params=params)
+    resp = http_client.get(url, headers=headers, params=params)
     if resp.status_code == 200:
         return resp.json()
     else: