polyapi-python 0.2.7.dev3__tar.gz → 0.2.8__tar.gz

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyapi-python
-Version: 0.2.7.dev3
+Version: 0.2.8
 Summary: The Python Client for PolyAPI, the IPaaS by Developers for Developers
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 Project-URL: Homepage, https://github.com/polyapi/polyapi-python
-Requires-Python: >=3.10
+Requires-Python: <=3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests==2.31.0
@@ -109,6 +109,24 @@ def bar():
     return "Hello World"
 ```
 
+## See Server Function Logs
+
+In order to see function logs, please first set `logsEnabled` to `true` in Canopy for the function.
+
+https://na1.polyapi.io/canopy/polyui/collections/server-functions
+
+Then in your code, get the poly logger and log with it like so:
+
+```python
+logger = logging.getLogger("poly")
+def bar():
+    logger.warning("I AM THE LOG")
+    return "Hello World"
+```
+
+Finally, click the "Show Logs" button to see your server function logs in Canopy!
+
+
 ## Complex Types In Server Functions
 
 You can define arbitrarily complex argument and return types using TypedDicts.

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/README.md

@@ -70,6 +70,24 @@ def bar():
     return "Hello World"
 ```
 
+## See Server Function Logs
+
+In order to see function logs, please first set `logsEnabled` to `true` in Canopy for the function.
+
+https://na1.polyapi.io/canopy/polyui/collections/server-functions
+
+Then in your code, get the poly logger and log with it like so:
+
+```python
+logger = logging.getLogger("poly")
+def bar():
+    logger.warning("I AM THE LOG")
+    return "Hello World"
+```
+
+Finally, click the "Show Logs" button to see your server function logs in Canopy!
+
+
 ## Complex Types In Server Functions
 
 You can define arbitrarily complex argument and return types using TypedDicts.

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/polyapi/api.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Tuple
 
 from polyapi.typedefs import PropertySpecification
-from polyapi.utils import add_type_import_path, camelCase, parse_arguments, get_type_and_def
+from polyapi.utils import add_type_import_path, parse_arguments, get_type_and_def, rewrite_arg_name
 
 
 API_DEFS_TEMPLATE = """
@@ -41,7 +41,7 @@ def render_api_function(
     arg_names = [a["name"] for a in arguments]
     args, args_def = parse_arguments(function_name, arguments)
     return_type_name, return_type_def = get_type_and_def(return_type)  # type: ignore
-    data = "{" + ", ".join([f"'{arg}': {camelCase(arg)}" for arg in arg_names]) + "}"
+    data = "{" + ", ".join([f"'{arg}': {rewrite_arg_name(arg)}" for arg in arg_names]) + "}"
 
     api_response_type = f"{function_name}Response"
     func_type_defs = API_DEFS_TEMPLATE.format(

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/polyapi/client.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Tuple
 
 from polyapi.typedefs import PropertySpecification
-from polyapi.utils import camelCase, add_type_import_path, parse_arguments, get_type_and_def
+from polyapi.utils import parse_arguments, get_type_and_def
 
 DEFS_TEMPLATE = """
 from typing import List, Dict, Any, TypedDict

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/polyapi/server.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Tuple
 
 from polyapi.typedefs import PropertySpecification
-from polyapi.utils import camelCase, add_type_import_path, parse_arguments, get_type_and_def
+from polyapi.utils import add_type_import_path, parse_arguments, get_type_and_def, rewrite_arg_name
 
 SERVER_DEFS_TEMPLATE = """
 from typing import List, Dict, Any, TypedDict, Callable
@@ -38,7 +38,7 @@ def render_server_function(
     arg_names = [a["name"] for a in arguments]
     args, args_def = parse_arguments(function_name, arguments)
     return_type_name, return_type_def = get_type_and_def(return_type)  # type: ignore
-    data = "{" + ", ".join([f"'{arg}': {camelCase(arg)}" for arg in arg_names]) + "}"
+    data = "{" + ", ".join([f"'{arg}': {rewrite_arg_name(arg)}" for arg in arg_names]) + "}"
     func_type_defs = SERVER_DEFS_TEMPLATE.format(
         args_def=args_def,
         return_type_def=return_type_def,

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/polyapi/utils.py

@@ -1,3 +1,4 @@
+import keyword
 import re
 import os
 from typing import Tuple, List
@@ -164,9 +165,10 @@ def parse_arguments(function_name: str, arguments: List[PropertySpecification])
         arg_type, arg_def = get_type_and_def(a["type"])
         if arg_def:
             args_def.append(arg_def)
-        a["name"] = camelCase(a["name"])
+        a["name"] = rewrite_arg_name(a["name"])
         arg_string += f"    {a['name']}: {add_type_import_path(function_name, arg_type)}"
         description = a.get("description", "")
+        description = description.replace("\n", " ")
         if description:
             if idx == len(arguments) - 1:
                 arg_string += f"  # {description}\n"
@@ -186,7 +188,7 @@ def poly_full_path(context, name) -> str:
     return f"poly.{path}"
 
 
-RESERVED_TYPES = {"List", "Dict", "Any", "Optional", "Callable"}
+RESERVED_WORDS = {"List", "Dict", "Any", "Optional", "Callable"} | set(keyword.kwlist)
 
 
 def to_func_namespace(s: str) -> str:
@@ -194,7 +196,16 @@ def to_func_namespace(s: str) -> str:
     by default it is
     """
     rv = s[0].upper() + s[1:]
-    if rv in RESERVED_TYPES:
-        return "_" + rv
+    rv = rewrite_reserved(rv)
+    return rv
+
+
+def rewrite_reserved(s: str) -> str:
+    if s in RESERVED_WORDS:
+        return "_" + s
     else:
-        return rv
+        return s
+
+
+def rewrite_arg_name(s: str):
+    return rewrite_reserved(camelCase(s))

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/polyapi_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: polyapi-python
-Version: 0.2.7.dev3
+Version: 0.2.8
 Summary: The Python Client for PolyAPI, the IPaaS by Developers for Developers
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 Project-URL: Homepage, https://github.com/polyapi/polyapi-python
-Requires-Python: >=3.10
+Requires-Python: <=3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests==2.31.0
@@ -109,6 +109,24 @@ def bar():
     return "Hello World"
 ```
 
+## See Server Function Logs
+
+In order to see function logs, please first set `logsEnabled` to `true` in Canopy for the function.
+
+https://na1.polyapi.io/canopy/polyui/collections/server-functions
+
+Then in your code, get the poly logger and log with it like so:
+
+```python
+logger = logging.getLogger("poly")
+def bar():
+    logger.warning("I AM THE LOG")
+    return "Hello World"
+```
+
+Finally, click the "Show Logs" button to see your server function logs in Canopy!
+
+
 ## Complex Types In Server Functions
 
 You can define arbitrarily complex argument and return types using TypedDicts.

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.2", "wheel"]
 
 [project]
 name = "polyapi-python"
-version = "0.2.7.dev3"
+version = "0.2.8"
 description = "The Python Client for PolyAPI, the IPaaS by Developers for Developers"
 authors = [{ name = "Dan Fellin", email = "dan@polyapi.io" }]
 dependencies = [
@@ -18,7 +18,7 @@ dependencies = [
 ]
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.10"
+requires-python = ">=3.10,<=3.12"
 
 [project.urls]
 Homepage = "https://github.com/polyapi/polyapi-python"

{polyapi_python-0.2.7.dev3 → polyapi_python-0.2.8}/tests/test_utils.py

@@ -1,5 +1,5 @@
 import unittest
-from polyapi.utils import get_type_and_def
+from polyapi.utils import get_type_and_def, rewrite_reserved
 
 OPENAPI_FUNCTION = {'kind': 'function', 'spec': {'arguments': [{'name': 'event', 'required': False, 'type': {'kind': 'object', 'schema': {'$schema': 'http://json-schema.org/draft-06/schema#', 'type': 'array', 'items': {'$ref': '#/definitions/WebhookEventTypeElement'}, 'definitions': {'WebhookEventTypeElement': {'type': 'object', 'additionalProperties': False, 'properties': {'title': {'type': 'string'}, 'manufacturerName': {'type': 'string'}, 'carType': {'type': 'string'}, 'id': {'type': 'integer'}}, 'required': ['carType', 'id', 'manufacturerName', 'title'], 'title': 'WebhookEventTypeElement'}}}}}, {'name': 'headers', 'required': False, 'type': {'kind': 'object', 'typeName': 'Record<string, any>'}}, {'name': 'params', 'required': False, 'type': {'kind': 'object', 'typeName': 'Record<string, any>'}}, {'name': 'polyCustom', 'required': False, 'type': {'kind': 'object', 'properties': [{'name': 'responseStatusCode', 'type': {'type': 'number', 'kind': 'primitive'}, 'required': True}, {'name': 'responseContentType', 'type': {'type': 'string', 'kind': 'primitive'}, 'required': True, 'nullable': True}]}}], 'returnType': {'kind': 'void'}, 'synchronous': True}}
 
@@ -8,3 +8,7 @@ class T(unittest.TestCase):
     def test_get_type_and_def(self):
         arg_type, arg_def = get_type_and_def(OPENAPI_FUNCTION)
         self.assertEqual(arg_type, "Callable[[List[WebhookEventTypeElement], Dict, Dict, Dict], None]")
+
+    def test_rewrite_reserved(self):
+        rv = rewrite_reserved("from")
+        self.assertEqual(rv, "_from")