polyapi-python 0.3.13__py3-none-any.whl → 0.3.13.dev2__py3-none-any.whl

polyapi/poly_tables.py

@@ -1,64 +1,27 @@
 import os
 import requests
 from typing_extensions import NotRequired, TypedDict
-from typing import (
-    List,
-    Union,
-    Type,
-    Dict,
-    Any,
-    Literal,
-    Tuple,
-    Optional,
-    get_args,
-    get_origin,
-)
+from typing import List, Union, Type, Dict, Any, Literal, Tuple, Optional, get_args, get_origin
 from polyapi.utils import add_import_to_init, init_the_init
 from polyapi.typedefs import TableSpecDto
 from polyapi.constants import JSONSCHEMA_TO_PYTHON_TYPE_MAP
-from polyapi.config import get_api_key_and_url
 
-TABI_MODULE_IMPORTS = "\n".join(
-    [
-        "from typing_extensions import NotRequired, TypedDict",
-        "from typing import Union, List, Dict, Any, Literal, Optional, Required, overload",
-        "from polyapi.poly_tables import execute_query, first_result, transform_query, delete_one_response",
-        "from polyapi.typedefs import Table, PolyCountResult, PolyDeleteResult, PolyDeleteResults, SortOrder, StringFilter, NullableStringFilter, NumberFilter, NullableNumberFilter, BooleanFilter, NullableBooleanFilter, NullableObjectFilter",
-    ]
-)
-
-
-def scrub(data: Any) -> Any:
-    if not data or not isinstance(data, (Dict, List)):
-        return data
+def scrub(data) -> Dict[str, Any]:
+    if (not data or not isinstance(data, (Dict, List))): return data
     if isinstance(data, List):
         return [scrub(item) for item in data]
     else:
         temp = {}
-        secrets = [
-            "x_api_key",
-            "x-api-key",
-            "access_token",
-            "access-token",
-            "authorization",
-            "api_key",
-            "api-key",
-            "apikey",
-            "accesstoken",
-            "token",
-            "password",
-            "key",
-        ]
+        secrets = ["x_api_key", "x-api-key", "access_token", "access-token", "authorization", "api_key", "api-key", "apikey", "accesstoken", "token", "password", "key"]
         for key, value in data.items():
             if isinstance(value, (Dict, List)):
                 temp[key] = scrub(data[key])
             elif key.lower() in secrets:
-                temp[key] = "********"
+                temp[key] = '********'
             else:
                 temp[key] = data[key]
         return temp
 
-
 def scrub_keys(e: Exception) -> Dict[str, Any]:
     """
     Scrub the keys of an exception to remove sensitive information.
@@ -68,26 +31,18 @@ def scrub_keys(e: Exception) -> Dict[str, Any]:
         "error": str(e),
         "type": type(e).__name__,
         "message": str(e),
-        "args": scrub(getattr(e, "args", None)),
+        "args": scrub(getattr(e, 'args', None))
     }
 
 
 def execute_query(table_id, method, query):
     from polyapi import polyCustom
     from polyapi.poly.client_id import client_id
-
     try:
-        api_key, base_url = get_api_key_and_url()
-        if not base_url:
-            raise ValueError(
-                "PolyAPI Instance URL is not configured, run `python -m polyapi setup`."
-            )
-
-        auth_key = polyCustom.get("executionApiKey") or api_key
-        url = f"{base_url.rstrip('/')}/tables/{table_id}/{method}?clientId={client_id}"
-        headers = {"x-poly-execution-id": polyCustom.get("executionId")}
-        if auth_key:
-            headers["Authorization"] = f"Bearer {auth_key}"
+        url = f"/tables/{table_id}/{method}?clientId={client_id}"
+        headers = {{
+            'x-poly-execution-id': polyCustom.get('executionId')
+        }}
         response = requests.post(url, json=query, headers=headers)
         response.raise_for_status()
         return response.json()
@@ -96,16 +51,14 @@ def execute_query(table_id, method, query):
 
 
 def first_result(rsp):
-    if isinstance(rsp, dict) and isinstance(rsp.get("results"), list):
-        return rsp["results"][0] if rsp["results"] else None
+    if isinstance(rsp, dict) and isinstance(rsp.get('results'), list):
+        return rsp['results'][0] if rsp['results'] else None
     return rsp
 
-
 def delete_one_response(rsp):
-    if isinstance(rsp, dict) and isinstance(rsp.get("deleted"), int):
-        return {"deleted": bool(rsp.get("deleted"))}
-    return {"deleted": False}
-
+    if isinstance(rsp, dict) and isinstance(rsp.get('deleted'), int):
+        return { 'deleted': bool(rsp.get('deleted')) }
+    return { 'deleted': false }
 
 _key_transform_map = {
     "not_": "not",
@@ -119,7 +72,8 @@ _key_transform_map = {
 def _transform_keys(obj: Any) -> Any:
     if isinstance(obj, dict):
         return {
-            _key_transform_map.get(k, k): _transform_keys(v) for k, v in obj.items()
+            _key_transform_map.get(k, k): _transform_keys(v)
+            for k, v in obj.items()
         }
 
     elif isinstance(obj, list):
@@ -134,13 +88,13 @@ def transform_query(query: dict) -> dict:
         return {
             **query,
             "where": _transform_keys(query["where"]) if query["where"] else None,
-            "orderBy": query["order_by"] if query["order_by"] else None,
+            "orderBy": query["order_by"] if query["order_by"] else None
         }
 
     return query
 
 
-TABI_TABLE_TEMPLATE = """
+TABI_TABLE_TEMPLATE = '''
 {table_name}Columns = Literal[{table_columns}]
 
 
@@ -415,7 +369,7 @@ class {table_name}:{table_description}
             query["where"]["id"] = kwargs["id"]
             query.pop("id", None)
         return delete_one_response(execute_query({table_name}.table_id, "delete", transform_query(query)))
-"""
+'''
 
 
 def _get_column_type_str(name: str, schema: Dict[str, Any], is_required: bool) -> str:
@@ -423,17 +377,11 @@ def _get_column_type_str(name: str, schema: Dict[str, Any], is_required: bool) -
 
     col_type = schema.get("type", "object")
     if isinstance(col_type, list):
-        subtypes = [
-            _get_column_type_str(name, {**schema, "type": t}, is_required)
-            for t in col_type
-        ]
+        subtypes = [_get_column_type_str(name, { **schema, "type": t }, is_required) for t in col_type]
         result = f"Union[{', '.join(subtypes)}]"
     elif col_type == "array":
         if isinstance(schema["items"], list):
-            subtypes = [
-                _get_column_type_str(f"{name}{i}", s, True)
-                for i, s in enumerate(schema["items"])
-            ]
+            subtypes = [_get_column_type_str(f"{name}{i}", s, True) for i, s in enumerate(schema["items"])]
             result = f"Tuple[{', '.join(subtypes)}]"
         elif isinstance(schema["items"], dict):
             result = f"List[{_get_column_type_str(name, schema['items'], True)}]"
@@ -443,10 +391,7 @@ def _get_column_type_str(name: str, schema: Dict[str, Any], is_required: bool) -
         if isinstance(schema.get("patternProperties"), dict):
             # TODO: Handle multiple pattern properties
             result = f"Dict[str, {_get_column_type_str(f'{name}_', schema['patternProperties'], True)}]"
-        elif (
-            isinstance(schema.get("properties"), dict)
-            and len(schema["properties"].values()) > 0
-        ):
+        elif isinstance(schema.get("properties"), dict) and len(schema["properties"].values()) > 0:
             # TODO: Handle x-poly-refs
             result = f'"{name}"'
         else:
@@ -468,32 +413,24 @@ def _render_table_row_classes(table_name: str, schema: Dict[str, Any]) -> str:
     return output[1].split("\n", 1)[1].strip()
 
 
-def _render_table_subset_class(
-    table_name: str, columns: List[Tuple[str, Dict[str, Any]]], required: List[str]
-) -> str:
+def _render_table_subset_class(table_name: str, columns: List[Tuple[str, Dict[str, Any]]], required: List[str]) -> str:
     # Generate class which can match any subset of a table row
     lines = [f"class {table_name}Subset(TypedDict):"]
 
     for name, schema in columns:
-        type_str = _get_column_type_str(
-            f"_{table_name}Row{name}", schema, name in required
-        )
+        type_str = _get_column_type_str(f"_{table_name}Row{name}", schema, name in required)
         lines.append(f"    {name}: NotRequired[{type_str}]")
 
     return "\n".join(lines)
 
 
-def _render_table_where_class(
-    table_name: str, columns: List[Tuple[str, Dict[str, Any]]], required: List[str]
-) -> str:
+def _render_table_where_class(table_name: str, columns: List[Tuple[str, Dict[str, Any]]], required: List[str]) -> str:
     # Generate class for the 'where' part of the query
     lines = [f"class {table_name}WhereFilter(TypedDict):"]
 
     for name, schema in columns:
         ftype_str = ""
-        type_str = _get_column_type_str(
-            f"_{table_name}Row{name}", schema, True
-        )  # force required to avoid wrapping type in Optional[]
+        type_str = _get_column_type_str(f"_{table_name}Row{name}", schema, True) # force required to avoid wrapping type in Optional[]
         is_required = name in required
         if type_str == "bool":
             ftype_str = "BooleanFilter" if is_required else "NullableBooleanFilter"
@@ -508,34 +445,24 @@ def _render_table_where_class(
         if ftype_str:
             lines.append(f"    {name}: NotRequired[Union[{type_str}, {ftype_str}]]")
 
-    lines.append(
-        f'    AND: NotRequired[Union["{table_name}WhereFilter", List["{table_name}WhereFilter"]]]'
-    )
+    lines.append(f'    AND: NotRequired[Union["{table_name}WhereFilter", List["{table_name}WhereFilter"]]]')
     lines.append(f'    OR: NotRequired[List["{table_name}WhereFilter"]]')
-    lines.append(
-        f'    NOT: NotRequired[Union["{table_name}WhereFilter", List["{table_name}WhereFilter"]]]'
-    )
+    lines.append(f'    NOT: NotRequired[Union["{table_name}WhereFilter", List["{table_name}WhereFilter"]]]')
 
     return "\n".join(lines)
 
 
 def _render_table(table: TableSpecDto) -> str:
     columns = list(table["schema"]["properties"].items())
-    required_columns = table["schema"].get("required", [])
+    required_colunms = table["schema"].get("required", [])
 
-    table_columns = ",".join([f'"{k}"' for k, _ in columns])
+    table_columns = ",".join([ f'"{k}"' for k,_ in columns])
     table_row_classes = _render_table_row_classes(table["name"], table["schema"])
-    table_row_subset_class = _render_table_subset_class(
-        table["name"], columns, required_columns
-    )
-    table_where_class = _render_table_where_class(
-        table["name"], columns, required_columns
-    )
+    table_row_subset_class = _render_table_subset_class(table["name"], columns, required_colunms)
+    table_where_class = _render_table_where_class(table["name"], columns, required_colunms)
     if table.get("description", ""):
-        table_description = '\n    """'
-        table_description += "\n       ".join(
-            table["description"].replace('"', "'").split("\n")
-        )
+        table_description =  '\n    """'
+        table_description += '\n       '.join(table["description"].replace('"', "'").split("\n"))
         table_description += '\n    """'
     else:
         table_description = ""
@@ -575,7 +502,12 @@ def _create_table(table: TableSpecDto) -> None:
 
     init_path = os.path.join(full_path, "__init__.py")
 
-    imports = TABI_MODULE_IMPORTS
+    imports = "\n".join([
+        "from typing_extensions import NotRequired, TypedDict",
+        "from typing import Union, List, Dict, Any, Literal, Optional, Required, overload",
+        "from polyapi.poly_tables import execute_query, first_result, transform_query",
+        "from polyapi.typedefs import Table, PolyCountResult, PolyDeleteResults, SortOrder, StringFilter, NullableStringFilter, NumberFilter, NullableNumberFilter, BooleanFilter, NullableBooleanFilter, NullableObjectFilter",
+    ])
     table_contents = _render_table(table)
 
     file_contents = ""

{polyapi_python-0.3.13.dist-info → polyapi_python-0.3.13.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polyapi-python
-Version: 0.3.13
+Version: 0.3.13.dev2
 Summary: The Python Client for PolyAPI, the IPaaS by Developers for Developers
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -185,14 +185,6 @@ 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.dist-info → polyapi_python-0.3.13.dev2.dist-info}/RECORD

@@ -14,7 +14,7 @@ polyapi/function_cli.py,sha256=W30yL2i152iZCr6zAU1CHKlDp_tt7kB2cGIXIxmWumk,4302
 polyapi/generate.py,sha256=0zVDEnKVZnbMNZ6O0SWAuDLHrBrkW01vFkjpf9wrQZo,21046
 polyapi/parser.py,sha256=pAkeuwp1Kn6bHXiIoj-DuXQ518PztQThIa8vztgsKLQ,21525
 polyapi/poly_schemas.py,sha256=fZ6AGvHcOKQJtlrzSuzeBNed5DxPMA2dJGdJvuFCHWM,9066
-polyapi/poly_tables.py,sha256=jwJpd_QBoIaFPcQRpCaxdwr82fIPHnTjj2-a9knNmJs,19709
+polyapi/poly_tables.py,sha256=SrByuusS1aL7L7R8o28TEr4A-8AfMGGHCKLg-9vmnxc,18783
 polyapi/prepare.py,sha256=NQzpMIoakNovStvOGOmqSYIpTwiWXaweNSE9se10A2E,7420
 polyapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 polyapi/rendered_spec.py,sha256=nJEj2vRgG3N20fU4s-ThRtOIwAuTzXwXuOBIkXljDVc,2240
@@ -25,8 +25,8 @@ polyapi/typedefs.py,sha256=mfll-KrngOW0wzbvDNiIDaDkFMwbsT-MY5y5hzWj9RE,5642
 polyapi/utils.py,sha256=CZdGusrLOA-e4zb9aZ4aI-UkDPBoyu0-euWj7EE0Vk8,13323
 polyapi/variables.py,sha256=SJv106ePpQP5mx7Iiafl_shtFlE8FoaO9Q8lvw-3IRg,7270
 polyapi/webhook.py,sha256=0ceLwHNjNd2Yx_8MX5jOIxiQ5Lwhy2pe81ProAuKon0,5108
-polyapi_python-0.3.13.dist-info/licenses/LICENSE,sha256=6b_I7aPVp8JXhqQwdw7_B84Ca0S4JGjHj0sr_1VOdB4,1068
-polyapi_python-0.3.13.dist-info/METADATA,sha256=N1mm1PBVLueOCP9I-I7IhobuwDtXgED8jEJ20Etaz0g,5879
-polyapi_python-0.3.13.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-polyapi_python-0.3.13.dist-info/top_level.txt,sha256=CEFllOnzowci_50RYJac-M54KD2IdAptFsayVVF_f04,8
-polyapi_python-0.3.13.dist-info/RECORD,,
+polyapi_python-0.3.13.dev2.dist-info/licenses/LICENSE,sha256=6b_I7aPVp8JXhqQwdw7_B84Ca0S4JGjHj0sr_1VOdB4,1068
+polyapi_python-0.3.13.dev2.dist-info/METADATA,sha256=V7aP-XoLF773lEJkHtTwvl0yGWFpzuFkpQEHhKO-C10,5318
+polyapi_python-0.3.13.dev2.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+polyapi_python-0.3.13.dev2.dist-info/top_level.txt,sha256=CEFllOnzowci_50RYJac-M54KD2IdAptFsayVVF_f04,8
+polyapi_python-0.3.13.dev2.dist-info/RECORD,,