polyapi-python 0.0.30__tar.gz → 0.1.0.dev0__tar.gz

{polyapi-python-0.0.30/polyapi_python.egg-info → polyapi-python-0.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyapi-python
-Version: 0.0.30
+Version: 0.1.0.dev0
 Summary: The PolyAPI Python Client
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -126,12 +126,20 @@ def bar(n: int) -> Foobar:
 
 ## Upgrade
 
-To upgrade your library to the latest version, pass the upgrade flag.:
+To upgrade your library to the latest version, pass the upgrade flag.
 
 ```bash
 pip install polyapi-python --upgrade
 ```
 
+## Pre-Release
+
+To upgrade your library to the latest dev version, pass the `--pre` flag.
+
+```bash
+pip install polyapi-python --pre --upgrade
+```
+
 ## Unit Tests
 
 To run this library's unit tests, please clone the repo then run:

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0}/README.md

@@ -90,12 +90,20 @@ def bar(n: int) -> Foobar:
 
 ## Upgrade
 
-To upgrade your library to the latest version, pass the upgrade flag.:
+To upgrade your library to the latest version, pass the upgrade flag.
 
 ```bash
 pip install polyapi-python --upgrade
 ```
 
+## Pre-Release
+
+To upgrade your library to the latest dev version, pass the `--pre` flag.
+
+```bash
+pip install polyapi-python --pre --upgrade
+```
+
 ## Unit Tests
 
 To run this library's unit tests, please clone the repo then run:

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0}/polyapi/api.py

@@ -15,16 +15,15 @@ TEMPLATE_FUNCTION_TYPE_MAP = {
 SERVER_TEMPLATE = """
 import requests
 from typing import List, Dict, Any
-from polyapi.config import get_api_key_and_url
+from polyapi.execute import execute
 from polyapi.exceptions import PolyApiException
 {args_def}
 {return_type_def}
-def {function_name}({args}) -> {return_type_name}:
-    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"
-    data = {data}
-    resp = requests.post(url, json=data, headers=headers)
+def {function_name}(
+{args}
+) -> {return_type_name}:
+    "{function_description}"
+    resp = execute("{function_type}", "{function_id}", {data})
     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}}")
@@ -35,7 +34,7 @@ def {function_name}({args}) -> {return_type_name}:
 API_TEMPLATE = """
 import requests
 from typing import List, Dict, Any, TypedDict
-from polyapi.config import get_api_key_and_url
+from polyapi.execute import execute
 from polyapi.exceptions import PolyApiException
 {args_def}
 {return_type_def}
@@ -45,12 +44,11 @@ class ApiFunctionResponse(TypedDict):
     data: {return_type_name}
 
 
-def {function_name}({args}) -> ApiFunctionResponse:
-    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"
-    data = {data}
-    resp = requests.post(url, json=data, headers=headers)
+def {function_name}(
+{args}
+) -> ApiFunctionResponse:
+    "{function_description}"
+    resp = execute("{function_type}", "{function_id}", {data})
     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}}")
@@ -108,7 +106,7 @@ def _get_type(type_spec: PropertyType) -> Tuple[str, str]:
                 if not title:
                     return "List", ""
 
-                title = f'List[{title}]'
+                title = f"List[{title}]"
                 return title, generate_schema_types(schema, root=title)
             else:
                 return "Any", ""
@@ -122,20 +120,29 @@ def _get_type(type_spec: PropertyType) -> Tuple[str, str]:
 
 def _parse_arguments(arguments: List[PropertySpecification]) -> Tuple[str, str]:
     args_def = []
-    arg_strings = []
-    for a in arguments:
+    arg_string = ""
+    for idx, a in enumerate(arguments):
         arg_type, arg_def = _get_type(a["type"])
         if arg_def:
             args_def.append(arg_def)
-        a['name'] = camelCase(a["name"])
-        arg_strings.append(f"{a['name']}: {arg_type}")
-    return ", ".join(arg_strings), "\n\n".join(args_def)
+        a["name"] = camelCase(a["name"])
+        arg_string += f"    {a['name']}: {arg_type}"
+        description = a.get("description", "")
+        if description:
+            if idx == len(arguments) - 1:
+                arg_string += f"  # {description}\n"
+            else:
+                arg_string += f",  # {description}\n"
+        else:
+            arg_string += ",\n"
+    return arg_string.rstrip("\n"), "\n\n".join(args_def)
 
 
 def render_function(
     function_type: str,
     function_name: str,
     function_id: str,
+    function_description: str,
     arguments: List[PropertySpecification],
     return_type: Dict[str, Any],
 ) -> str:
@@ -148,6 +155,7 @@ def render_function(
             function_type=TEMPLATE_FUNCTION_TYPE_MAP[function_type],
             function_name=function_name,
             function_id=function_id,
+            function_description=function_description.replace('"', "'"),
             args=args,
             args_def=args_def,
             return_type_name=return_type_name,
@@ -155,22 +163,12 @@ def render_function(
             data=data,
         )
     else:
-        if return_type_name == "str":
-            return_action = "resp.text"
-        elif return_type_name == "Any":
-            return_action = "resp.text"
-        elif return_type_name == "int":
-            return_action = "int(resp.text.replace('(int) ', ''))"
-        elif return_type_name == "float":
-            return_action = "float(resp.text.replace('(float) ', ''))"
-        elif return_type_name == "bool":
-            return_action = "False if resp.text == 'False' else True"
-        else:
-            return_action = "resp.json()"
+        return_action = _get_server_return_action(return_type_name)
         rendered = SERVER_TEMPLATE.format(
             function_type=TEMPLATE_FUNCTION_TYPE_MAP[function_type],
             function_name=function_name,
             function_id=function_id,
+            function_description=function_description.replace('"', "'"),
             args=args,
             args_def=args_def,
             return_type_name=return_type_name,
@@ -181,11 +179,28 @@ def render_function(
     return rendered
 
 
+def _get_server_return_action(return_type_name: str) -> str:
+    if return_type_name == "str":
+        return_action = "resp.text"
+    elif return_type_name == "Any":
+        return_action = "resp.text"
+    elif return_type_name == "int":
+        return_action = "int(resp.text.replace('(int) ', ''))"
+    elif return_type_name == "float":
+        return_action = "float(resp.text.replace('(float) ', ''))"
+    elif return_type_name == "bool":
+        return_action = "False if resp.text == 'False' else True"
+    else:
+        return_action = "resp.json()"
+    return return_action
+
+
 def add_function_file(
     function_type: str,
     full_path: str,
     function_name: str,
     function_id: str,
+    function_description: str,
     arguments: List[PropertySpecification],
     return_type: Dict[str, Any],
 ):
@@ -199,7 +214,12 @@ def add_function_file(
     with open(file_path, "w") as f:
         f.write(
             render_function(
-                function_type, function_name, function_id, arguments, return_type
+                function_type,
+                function_name,
+                function_id,
+                function_description,
+                arguments,
+                return_type,
             )
         )
 
@@ -208,6 +228,7 @@ def create_function(
     function_type: str,
     path: str,
     function_id: str,
+    function_description: str,
     arguments: List[PropertySpecification],
     return_type: Dict[str, Any],
 ) -> None:
@@ -218,7 +239,13 @@ def create_function(
         if idx + 1 == len(folders):
             # special handling for final level
             add_function_file(
-                function_type, full_path, folder, function_id, arguments, return_type
+                function_type,
+                full_path,
+                folder,
+                function_id,
+                function_description,
+                arguments,
+                return_type,
             )
         else:
             full_path = os.path.join(full_path, folder)

polyapi-python-0.1.0.dev0/polyapi/execute.py

@@ -0,0 +1,16 @@
+import requests
+from requests import Response
+from polyapi.config import get_api_key_and_url
+from polyapi.exceptions import PolyApiException
+
+
+# TODO use this to cleanup generated code
+def execute(function_type, function_id, data) -> 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 = requests.post(url, json=data, 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

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0}/polyapi/generate.py

@@ -1,4 +1,4 @@
-import sys
+import json
 import requests
 import os
 import shutil
@@ -25,9 +25,16 @@ def get_specs() -> List:
 
 def parse_specs(
     specs: List,
-) -> List[Tuple[str, str, str, List[PropertySpecification], Dict[str, Any]]]:
+) -> List[Tuple[str, str, str, str, List[PropertySpecification], Dict[str, Any]]]:
+    # optional array of ids to include in the generated library
+    # currently just used for testing/development purposes
+    allowed_ids: List[str] = []
+
     api_functions = []
     for spec in specs:
+        if allowed_ids and spec["id"] not in allowed_ids:
+            continue
+
         if spec["type"] != "apiFunction" and spec["type"] != "serverFunction":
             # for now we only support api and server functions
             continue
@@ -43,6 +50,7 @@ def parse_specs(
                 function_type,
                 function_name,
                 function_id,
+                spec["description"],
                 arguments,
                 spec["function"]["returnType"],
             )
@@ -50,10 +58,27 @@ def parse_specs(
     return api_functions
 
 
-def get_specs_and_parse():
+def cache_specs(specs):
+    supported = []
+    for spec in specs:
+        # this needs to stay in sync with logic in parse_specs
+        if spec["type"] == "apiFunction" or spec["type"] == "serverFunction":
+            supported.append(spec)
+
+    full_path = os.path.dirname(os.path.abspath(__file__))
+    full_path = os.path.join(full_path, "poly")
+    if not os.path.exists(full_path):
+        os.makedirs(full_path)
+
+    with open(os.path.join(full_path, "specs.json"), "w") as f:
+        f.write(json.dumps(supported))
+
+
+def get_functions_and_parse():
     specs = get_specs()
-    api_functions = parse_specs(specs)
-    return api_functions
+    cache_specs(specs)
+    functions = parse_specs(specs)
+    return functions
 
 
 def get_variables_and_parse() -> List[Tuple[str, str, bool]]:
@@ -97,14 +122,10 @@ def generate() -> None:
 
     remove_old_library()
 
-    functions = get_specs_and_parse()
+    functions = get_functions_and_parse()
     if functions:
         generate_api(functions)
     else:
-        full_path = os.path.dirname(os.path.abspath(__file__))
-        full_path = os.path.join(full_path, "poly")
-        if not os.path.exists(full_path):
-            os.makedirs(full_path)
         print(
             "No functions exist yet in this tenant! Empty library initialized. Let's add some functions!"
         )

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0/polyapi_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyapi-python
-Version: 0.0.30
+Version: 0.1.0.dev0
 Summary: The PolyAPI Python Client
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -126,12 +126,20 @@ def bar(n: int) -> Foobar:
 
 ## Upgrade
 
-To upgrade your library to the latest version, pass the upgrade flag.:
+To upgrade your library to the latest version, pass the upgrade flag.
 
 ```bash
 pip install polyapi-python --upgrade
 ```
 
+## Pre-Release
+
+To upgrade your library to the latest dev version, pass the `--pre` flag.
+
+```bash
+pip install polyapi-python --pre --upgrade
+```
+
 ## Unit Tests
 
 To run this library's unit tests, please clone the repo then run:

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0}/polyapi_python.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ polyapi/cli.py
 polyapi/config.py
 polyapi/constants.py
 polyapi/exceptions.py
+polyapi/execute.py
 polyapi/function_cli.py
 polyapi/generate.py
 polyapi/py.typed

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.2", "wheel"]
 
 [project]
 name = "polyapi-python"
-version = "0.0.30"
+version = "0.1.0.dev0"
 description = "The PolyAPI Python Client"
 authors = [{ name = "Dan Fellin", email = "dan@polyapi.io" }]
 dependencies = ["requests", "typing_extensions", "jsonschema-gentypes", "pydantic>=2.5.3", "stdlib_list"]
@@ -19,4 +19,4 @@ packages = ["polyapi"]
 
 [tools.setuptools.packages.find]
 include = ["polyapi"]
-exclude = ["polyapi/poly*", "polyapi/vari*"]  # exclude the generated libraries from builds
+exclude = ["polyapi/poly*", "polyapi/vari*", "polyapi/.config.env"]  # exclude the generated libraries from builds

{polyapi-python-0.0.30 → polyapi-python-0.1.0.dev0}/tests/test_generate.py

@@ -159,6 +159,7 @@ class T(unittest.TestCase):
             ACCUWEATHER["type"],
             ACCUWEATHER["name"],
             ACCUWEATHER["id"],
+            ACCUWEATHER["description"],
             ACCUWEATHER["function"]["arguments"],
             ACCUWEATHER["function"]["returnType"],
         )
@@ -171,6 +172,7 @@ class T(unittest.TestCase):
             ZILLOW["type"],
             ZILLOW["name"],
             ZILLOW["id"],
+            ZILLOW["description"],
             ZILLOW["function"]["arguments"],
             ZILLOW["function"]["returnType"],
         )
@@ -183,6 +185,7 @@ class T(unittest.TestCase):
             TWILIO["type"],
             TWILIO["name"],
             TWILIO["id"],
+            TWILIO["description"],
             TWILIO["function"]["arguments"],
             TWILIO["function"]["returnType"],
         )
@@ -197,6 +200,7 @@ class T(unittest.TestCase):
             "serverFunction",
             TWILIO["name"],
             TWILIO["id"],
+            TWILIO["description"],
             TWILIO["function"]["arguments"],
             TWILIO["function"]["returnType"],
         )
@@ -211,6 +215,7 @@ class T(unittest.TestCase):
             GET_PRODUCTS_COUNT["type"],
             GET_PRODUCTS_COUNT["name"],
             GET_PRODUCTS_COUNT["id"],
+            GET_PRODUCTS_COUNT["description"],
             GET_PRODUCTS_COUNT["function"]["arguments"],
             return_type,
         )