Better uniformity with python arguments and typescript arguments, adding the update_one and delete_one tabi methods as well

Author: aarongoin

polyapi/cli.py

@@ -58,7 +58,7 @@ def setup(args):
             initialize_config(force=True)
             # setup command should have default cache values
             from .config import cache_generate_args
-            cache_generate_args(contexts=None, names=None, function_ids=None, no_types=False)
+            cache_generate_args(contexts=None, names=None, ids=None, no_types=False)
             generate()
 
     setup_parser.set_defaults(command=setup)
@@ -70,7 +70,7 @@ def setup(args):
     generate_parser.add_argument("--no-types", action="store_true", help="Generate SDK without type definitions")
     generate_parser.add_argument("--contexts", type=str, required=False, help="Contexts to generate")
     generate_parser.add_argument("--names", type=str, required=False, help="Resource names to generate (comma-separated)")
-    generate_parser.add_argument("--function-ids", type=str, required=False, help="Function IDs to generate (comma-separated)")
+    generate_parser.add_argument("--ids", "--function-ids", type=str, required=False, help="Resource IDs to generate (comma-separated)")
 
     def generate_command(args):
         from .config import cache_generate_args
@@ -79,24 +79,24 @@ def generate_command(args):
 
         contexts = args.contexts.split(",") if args.contexts else None
         names = args.names.split(",") if args.names else None
-        function_ids = args.function_ids.split(",") if args.function_ids else None
+        ids = args.ids.split(",") if args.ids else None
         no_types = args.no_types
 
         # overwrite all cached values with the values passed in from the command line
         final_contexts = contexts
         final_names = names
-        final_function_ids = function_ids
+        final_ids = ids
         final_no_types = no_types
 
         # cache the values used for this explicit generate command
         cache_generate_args(
             contexts=final_contexts,
             names=final_names, 
-            function_ids=final_function_ids,
+            ids=ids,
             no_types=final_no_types
         )
 
-        generate(contexts=final_contexts, names=final_names, function_ids=final_function_ids, no_types=final_no_types)
+        generate(contexts=final_contexts, names=final_names, ids=ids, no_types=final_no_types)
 
     generate_parser.set_defaults(command=generate_command)
 

polyapi/config.py

@@ -14,7 +14,7 @@
 MTLS_CA_PATH = None
 LAST_GENERATE_CONTEXTS = None
 LAST_GENERATE_NAMES = None
-LAST_GENERATE_FUNCTION_IDS = None
+LAST_GENERATE_IDS = None
 LAST_GENERATE_NO_TYPES = None
 
 
@@ -61,13 +61,13 @@ def get_api_key_and_url() -> Tuple[str | None, str | None]:
         MTLS_CA_PATH = config.get("polyapi", "mtls_ca_path", fallback=None)
 
         # Read and cache generate command arguments
-        global LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_FUNCTION_IDS, LAST_GENERATE_NO_TYPES
+        global LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_IDS, LAST_GENERATE_NO_TYPES
         contexts_str = config.get("polyapi", "last_generate_contexts_used", fallback=None)
         LAST_GENERATE_CONTEXTS = contexts_str.split(",") if contexts_str else None
         names_str = config.get("polyapi", "last_generate_names_used", fallback=None)
         LAST_GENERATE_NAMES = names_str.split(",") if names_str else None
-        function_ids_str = config.get("polyapi", "last_generate_function_ids_used", fallback=None)
-        LAST_GENERATE_FUNCTION_IDS = function_ids_str.split(",") if function_ids_str else None
+        ids_str = config.get("polyapi", "last_generate_ids_used", fallback=None)
+        LAST_GENERATE_IDS = ids_str.split(",") if ids_str else None
         LAST_GENERATE_NO_TYPES = config.get("polyapi", "last_generate_no_types_used", fallback="false").lower() == "true"
 
     return key, url
@@ -152,14 +152,14 @@ def get_direct_execute_config() -> bool:
 
 def get_cached_generate_args() -> Tuple[list | None, list | None, list | None, bool]:
     """Return cached generate command arguments"""
-    global LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_FUNCTION_IDS, LAST_GENERATE_NO_TYPES
-    if LAST_GENERATE_CONTEXTS is None and LAST_GENERATE_NAMES is None and LAST_GENERATE_FUNCTION_IDS is None and LAST_GENERATE_NO_TYPES is None:
+    global LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_IDS, LAST_GENERATE_NO_TYPES
+    if LAST_GENERATE_CONTEXTS is None and LAST_GENERATE_NAMES is None and LAST_GENERATE_IDS is None and LAST_GENERATE_NO_TYPES is None:
         # Force a config read if values aren't cached
         get_api_key_and_url()
-    return LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_FUNCTION_IDS, bool(LAST_GENERATE_NO_TYPES)
+    return LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_IDS, bool(LAST_GENERATE_NO_TYPES)
 
 
-def cache_generate_args(contexts: list | None = None, names: list | None = None, function_ids: list | None = None, no_types: bool = False):
+def cache_generate_args(contexts: list | None = None, names: list | None = None, ids: list | None = None, no_types: bool = False):
     """Cache generate command arguments to config file"""
     from typing import List
 
@@ -176,10 +176,10 @@ def cache_generate_args(contexts: list | None = None, names: list | None = None,
         config["polyapi"] = {}
 
     # Update cached values
-    global LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_FUNCTION_IDS, LAST_GENERATE_NO_TYPES
+    global LAST_GENERATE_CONTEXTS, LAST_GENERATE_NAMES, LAST_GENERATE_IDS, LAST_GENERATE_NO_TYPES
     LAST_GENERATE_CONTEXTS = contexts
     LAST_GENERATE_NAMES = names
-    LAST_GENERATE_FUNCTION_IDS = function_ids
+    LAST_GENERATE_IDS = ids
     LAST_GENERATE_NO_TYPES = no_types
 
     # Write values to config
@@ -193,10 +193,10 @@ def cache_generate_args(contexts: list | None = None, names: list | None = None,
     elif config.has_option("polyapi", "last_generate_names_used"):
         config.remove_option("polyapi", "last_generate_names_used")
 
-    if function_ids is not None:
-        config.set("polyapi", "last_generate_function_ids_used", ",".join(function_ids))
-    elif config.has_option("polyapi", "last_generate_function_ids_used"):
-        config.remove_option("polyapi", "last_generate_function_ids_used")
+    if ids is not None:
+        config.set("polyapi", "last_generate_ids_used", ",".join(ids))
+    elif config.has_option("polyapi", "last_generate_ids_used"):
+        config.remove_option("polyapi", "last_generate_ids_used")
 
     config.set("polyapi", "last_generate_no_types_used", str(no_types).lower())
 

polyapi/generate.py

@@ -42,7 +42,7 @@
   path:'''
 
 
-def get_specs(contexts: Optional[List[str]] = None, names: Optional[List[str]] = None, function_ids: Optional[List[str]] = None, no_types: bool = False) -> List:
+def get_specs(contexts: Optional[List[str]] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, no_types: bool = False) -> List:
     api_key, api_url = get_api_key_and_url()
     assert api_key
     headers = get_auth_headers(api_key)
@@ -55,8 +55,8 @@ def get_specs(contexts: Optional[List[str]] = None, names: Optional[List[str]] =
     if names:
         params["names"] = names
 
-    if function_ids:
-        params["functionIds"] = function_ids
+    if ids:
+        params["ids"] = ids
 
     # Add apiFunctionDirectExecute parameter if direct execute is enabled
     if get_direct_execute_config():
@@ -297,12 +297,12 @@ def generate_from_cache() -> None:
     """
     Generate using cached values after non-explicit call.
     """
-    cached_contexts, cached_names, cached_function_ids, cached_no_types = get_cached_generate_args()
+    cached_contexts, cached_names, cached_ids, cached_no_types = get_cached_generate_args()
 
     generate(
         contexts=cached_contexts, 
         names=cached_names, 
-        function_ids=cached_function_ids, 
+        ids=cached_ids, 
         no_types=cached_no_types
     )
 
@@ -338,12 +338,12 @@ def normalize_args_schema(
     return spec
 
 
-def generate(contexts: Optional[List[str]] = None, names: Optional[List[str]] = None, function_ids: Optional[List[str]] = None, no_types: bool = False) -> None:
+def generate(contexts: Optional[List[str]] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, no_types: bool = False) -> None:
     generate_msg = f"Generating Poly Python SDK for contexts ${contexts}..." if contexts else "Generating Poly Python SDK..."
     print(generate_msg, end="", flush=True)
     remove_old_library()
 
-    specs = get_specs(contexts=contexts, names=names, function_ids=function_ids, no_types=no_types)
+    specs = get_specs(contexts=contexts, names=names, ids=ids, no_types=no_types)
     cache_specs(specs)
 
     limit_ids: List[str] = []  # useful for narrowing down generation to a single function to debug

polyapi/poly_tables.py

@@ -55,6 +55,10 @@ def first_result(rsp):
         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 }
 
 _key_transform_map = {
     "not_": "not",
@@ -301,6 +305,30 @@ def update_many(*args, **kwargs) -> {table_name}QueryResults:
             query = kwargs
         return execute_query({table_name}.table_id, "update", transform_query(query))
 
+    @overload
+    @staticmethod
+    def update_one(id: str, query: {table_name}UpdateManyQuery) -> {table_name}Row: ...
+    @overload
+    @staticmethod
+    def update_one(*, id: str, where: Optional[{table_name}WhereFilter], data: {table_name}Subset) -> {table_name}Row: ...
+
+    @staticmethod
+    def update_one(*args, **kwargs) -> {table_name}Row:
+        if args:
+            if len(args) != 2 or or not isinstance(args[0], str) not isinstance(args[1], dict):
+                raise TypeError("Expected id and query as arguments or as kwargs")
+            query = args[1]
+            if not isinstance(query["where"], dict):
+                query["where"] = {{}}
+            query["where"]["id"] = args[0]
+        else:
+            query = kwargs
+            if not isinstance(query["where"], dict):
+                query["where"] = {{}}
+            query["where"]["id"] = kwargs["id"]
+            query.pop("id", None)
+        return first_result(execute_query({table_name}.table_id, "update", transform_query(query)))
+
     @overload
     @staticmethod
     def delete_many(query: {table_name}DeleteQuery) -> PolyDeleteResults: ...
@@ -316,7 +344,31 @@ def delete_many(*args, **kwargs) -> PolyDeleteResults:
             query = args[0]
         else:
             query = kwargs
-        return execute_query({table_name}.table_id, "delete", query)
+        return execute_query({table_name}.table_id, "delete", transform_query(query))
+
+    @overload
+    @staticmethod
+    def delete_one(query: {table_name}DeleteQuery) -> PolyDeleteResult: ...
+    @overload
+    @staticmethod
+    def delete_one(*, where: Optional[{table_name}WhereFilter]) -> PolyDeleteResult: ...
+
+    @staticmethod
+    def delete_one(*args, **kwargs) -> PolyDeleteResult:
+        if args:
+            if len(args) != 2 or or not isinstance(args[0], str) not isinstance(args[1], dict):
+                raise TypeError("Expected id and query as arguments or as kwargs")
+            query = args[1]
+            if not isinstance(query["where"], dict):
+                query["where"] = {{}}
+            query["where"]["id"] = args[0]
+        else:
+            query = kwargs
+            if not isinstance(query["where"], dict):
+                query["where"] = {{}}
+            query["where"]["id"] = kwargs["id"]
+            query.pop("id", None)
+        return delete_one_response(execute_query({table_name}.table_id, "delete", transform_query(query)))
 '''
 
 

polyapi/typedefs.py

@@ -118,6 +118,10 @@ class PolyDeleteResults(TypedDict):
     deleted: int
 
 
+class PolyDeleteResult(TypedDict):
+    deleted: bool
+
+
 
 QueryMode = Literal["default", "insensitive"]
 

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.2", "wheel"]
 
 [project]
 name = "polyapi-python"
-version = "0.3.11.dev3"
+version = "0.3.11.dev4"
 description = "The Python Client for PolyAPI, the IPaaS by Developers for Developers"
 authors = [{ name = "Dan Fellin", email = "[email protected]" }]
 dependencies = [

tests/test_tabi.py

@@ -285,6 +285,30 @@ def update_many(*args, **kwargs) -> MyTableQueryResults:
             query = kwargs
         return execute_query(MyTable.table_id, "update", transform_query(query))
 
+    @overload
+    @staticmethod
+    def update_one(id: str, query: MyTableUpdateManyQuery) -> MyTableRow: ...
+    @overload
+    @staticmethod
+    def update_one(*, id: str, where: Optional[MyTableWhereFilter], data: MyTableSubset) -> MyTableRow: ...
+
+    @staticmethod
+    def update_one(*args, **kwargs) -> MyTableRow:
+        if args:
+            if len(args) != 2 or or not isinstance(args[0], str) not isinstance(args[1], dict):
+                raise TypeError("Expected id and query as arguments or as kwargs")
+            query = args[1]
+            if not isinstance(query["where"], dict):
+                query["where"] = {}
+            query["where"]["id"] = args[0]
+        else:
+            query = kwargs
+            if not isinstance(query["where"], dict):
+                query["where"] = {}
+            query["where"]["id"] = kwargs["id"]
+            query.pop("id", None)
+        return first_result(execute_query(MyTable.table_id, "update", transform_query(query)))
+
     @overload
     @staticmethod
     def delete_many(query: MyTableDeleteQuery) -> PolyDeleteResults: ...
@@ -300,7 +324,31 @@ def delete_many(*args, **kwargs) -> PolyDeleteResults:
             query = args[0]
         else:
             query = kwargs
-        return execute_query(MyTable.table_id, "delete", query)
+        return execute_query(MyTable.table_id, "delete", transform_query(query))
+
+    @overload
+    @staticmethod
+    def delete_one(query: MyTableDeleteQuery) -> PolyDeleteResult: ...
+    @overload
+    @staticmethod
+    def delete_one(*, where: Optional[MyTableWhereFilter]) -> PolyDeleteResult: ...
+
+    @staticmethod
+    def delete_one(*args, **kwargs) -> PolyDeleteResult:
+        if args:
+            if len(args) != 2 or or not isinstance(args[0], str) not isinstance(args[1], dict):
+                raise TypeError("Expected id and query as arguments or as kwargs")
+            query = args[1]
+            if not isinstance(query["where"], dict):
+                query["where"] = {}
+            query["where"]["id"] = args[0]
+        else:
+            query = kwargs
+            if not isinstance(query["where"], dict):
+                query["where"] = {}
+            query["where"]["id"] = kwargs["id"]
+            query.pop("id", None)
+        return delete_one_response(execute_query(MyTable.table_id, "delete", transform_query(query)))
 '''
 
 TABLE_SPEC_COMPLEX = {