polyapi-python 0.3.3.dev4__py3-none-any.whl → 0.3.3.dev5__py3-none-any.whl

polyapi/api.py

@@ -42,6 +42,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}': {rewrite_arg_name(arg)}" for arg in arg_names]) + "}"
 
     api_response_type = f"{function_name}Response"

polyapi/generate.py

@@ -2,7 +2,7 @@ import json
 import requests
 import os
 import shutil
-from typing import List, cast
+from typing import List, Tuple, cast
 
 from .auth import render_auth_function
 from .client import render_client_function
@@ -177,10 +177,10 @@ def generate() -> None:
     print("Generating Poly Python SDK...", end="", flush=True)
     remove_old_library()
 
-    limit_ids: List[str] = []  # useful for narrowing down generation to a single function to debug
-
     specs = get_specs()
     cache_specs(specs)
+
+    limit_ids: List[str] = []  # useful for narrowing down generation to a single function to debug
     functions = parse_function_specs(specs, limit_ids=limit_ids)
 
     schemas = get_schemas()
@@ -222,7 +222,7 @@ def clear() -> None:
     print("Cleared!")
 
 
-def render_spec(spec: SpecificationDto):
+def render_spec(spec: SpecificationDto) -> Tuple[str, str]:
     function_type = spec["type"]
     function_description = spec["description"]
     function_name = spec["name"]

polyapi/parser.py

@@ -158,6 +158,7 @@ def _parse_google_docstring(docstring: str) -> Dict[str, Any]:
 
     return parsed
 
+
 def _get_schemas(code: str) -> List[Dict]:
     schemas = []
     user_code = types.SimpleNamespace()

polyapi/poly_schemas.py

@@ -2,7 +2,7 @@ import os
 from typing import Any, Dict, List, Tuple
 
 from polyapi.schema import wrapped_generate_schema_types
-from polyapi.utils import add_import_to_init, init_the_init
+from polyapi.utils import add_import_to_init, init_the_init, to_func_namespace
 
 from .typedefs import SchemaSpecDto
 
@@ -23,23 +23,57 @@ def generate_schemas(specs: List[SchemaSpecDto]):
         create_schema(spec)
 
 
-def create_schema(spec: SchemaSpecDto) -> None:
-    folders = ["schemas"]
-    if spec["context"]:
-        folders += [s for s in spec["context"].split(".")]
+def add_schema_file(
+    full_path: str,
+    schema_name: str,
+    spec: SchemaSpecDto,
+):
+    # first lets add the import to the __init__
+    init_the_init(full_path, SCHEMA_CODE_IMPORTS)
 
-    # build up the full_path by adding all the folders
-    full_path = os.path.join(os.path.dirname(os.path.abspath(__file__)))
+    if not spec["definition"].get("title"):
+        # very empty schemas like mews.Unit are possible
+        # add a title here to be sure they render
+        spec["definition"]["title"] = schema_name
 
+    schema_defs = render_poly_schema(spec)
+
+    if schema_defs:
+        # add function to init
+        init_path = os.path.join(full_path, "__init__.py")
+        with open(init_path, "a") as f:
+            f.write(f"\n\nfrom ._{to_func_namespace(schema_name)} import {schema_name}")
+
+        # add type_defs to underscore file
+        file_path = os.path.join(full_path, f"_{to_func_namespace(schema_name)}.py")
+        with open(file_path, "w") as f:
+            f.write(schema_defs)
+
+
+def create_schema(
+    spec: SchemaSpecDto
+) -> None:
+    full_path = os.path.dirname(os.path.abspath(__file__))
+    folders = f"schemas.{spec['context']}.{spec['name']}".split(".")
     for idx, folder in enumerate(folders):
-        full_path = os.path.join(full_path, folder)
-        if not os.path.exists(full_path):
-            os.makedirs(full_path)
-        next = folders[idx + 1] if idx + 1 < len(folders) else None
-        if next:
-            add_import_to_init(full_path, next, code_imports=SCHEMA_CODE_IMPORTS)
-
-    add_schema_to_init(full_path, spec)
+        if idx + 1 == len(folders):
+            # special handling for final level
+            add_schema_file(
+                full_path,
+                folder,
+                spec,
+            )
+        else:
+            full_path = os.path.join(full_path, folder)
+            if not os.path.exists(full_path):
+                os.makedirs(full_path)
+
+            # append to __init__.py file if nested folders
+            next = folders[idx + 1] if idx + 2 < len(folders) else ""
+            if next:
+                init_the_init(full_path, SCHEMA_CODE_IMPORTS)
+                add_import_to_init(full_path, next)
+
 
 
 def add_schema_to_init(full_path: str, spec: SchemaSpecDto):

polyapi/schema.py

@@ -1,9 +1,8 @@
 """ NOTE: this file represents the schema parsing logic for jsonschema_gentypes
 """
-import random
-import string
 import logging
 import contextlib
+import re
 from typing import Dict
 from jsonschema_gentypes.cli import process_config
 from jsonschema_gentypes import configuration
@@ -48,10 +47,8 @@ def wrapped_generate_schema_types(type_spec: dict, root, fallback_type):
             # lets name the root after the reference for some level of visibility
             root += pascalCase(type_spec["x-poly-ref"]["path"].replace(".", " "))
         else:
-            # add three random letters for uniqueness
-            root += random.choice(string.ascii_letters).upper()
-            root += random.choice(string.ascii_letters).upper()
-            root += random.choice(string.ascii_letters).upper()
+            # if we have no root, just add "My"
+            root = "My" + root
 
     root = clean_title(root)
 
@@ -99,9 +96,23 @@ def generate_schema_types(input_data: Dict, root=None):
     with open(tmp_output) as f:
         output = f.read()
 
+    output = clean_malformed_examples(output)
+
     return output
 
 
+# Regex to match everything between "# example: {\n" and "^}$"
+MALFORMED_EXAMPLES_PATTERN = re.compile(r"# example: \{\n.*?^\}$", flags=re.DOTALL | re.MULTILINE)
+
+
+def clean_malformed_examples(example: str) -> str:
+    """ there is a bug in the `jsonschmea_gentypes` library where if an example from a jsonchema is an object,
+    it will break the code because the object won't be properly commented out
+    """
+    cleaned_example = MALFORMED_EXAMPLES_PATTERN.sub("", example)
+    return cleaned_example
+
+
 def clean_title(title: str) -> str:
     """ used by library generation, sometimes functions can be added with spaces in the title
     or other nonsense. fix them!

polyapi/server.py

@@ -1,7 +1,7 @@
-from typing import Any, Dict, List, Tuple
+from typing import Any, Dict, List, Tuple, cast
 
-from polyapi.typedefs import PropertySpecification
-from polyapi.utils import add_type_import_path, parse_arguments, get_type_and_def, rewrite_arg_name
+from polyapi.typedefs import PropertySpecification, PropertyType
+from polyapi.utils import add_type_import_path, parse_arguments, get_type_and_def, return_type_already_defined_in_args, rewrite_arg_name
 
 SERVER_DEFS_TEMPLATE = """
 from typing import List, Dict, Any, TypedDict, Callable
@@ -21,7 +21,7 @@ def {function_name}(
     try:
         return {return_action}
     except:
-        return resp.text
+        return resp.text  # type: ignore # fallback for debugging
 
 
 """
@@ -37,7 +37,11 @@ def render_server_function(
 ) -> Tuple[str, str]:
     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
+    return_type_name, return_type_def = get_type_and_def(cast(PropertyType, return_type), "ReturnType")
+
+    if return_type_def and return_type_already_defined_in_args(return_type_name, args_def):
+        return_type_def = ""
+
     data = "{" + ", ".join([f"'{arg}': {rewrite_arg_name(arg)}" for arg in arg_names]) + "}"
     func_type_defs = SERVER_DEFS_TEMPLATE.format(
         args_def=args_def,

polyapi/utils.py

@@ -6,7 +6,11 @@ from typing import Tuple, List
 from colorama import Fore, Style
 from polyapi.constants import BASIC_PYTHON_TYPES
 from polyapi.typedefs import PropertySpecification, PropertyType
-from polyapi.schema import wrapped_generate_schema_types, clean_title, map_primitive_types
+from polyapi.schema import (
+    wrapped_generate_schema_types,
+    clean_title,
+    map_primitive_types,
+)
 
 
 # this string should be in every __init__ file.
@@ -42,7 +46,7 @@ def camelCase(s: str) -> str:
     s = s.strip()
     if " " in s or "-" in s:
         s = re.sub(r"(_|-)+", " ", s).title().replace(" ", "")
-        return ''.join([s[0].lower(), s[1:]])
+        return "".join([s[0].lower(), s[1:]])
     else:
         # s is already in camelcase as best as we can tell, just move on!
         return s
@@ -65,8 +69,7 @@ def print_red(s: str):
 
 
 def add_type_import_path(function_name: str, arg: str) -> str:
-    """ if not basic type, coerce to camelCase and add the import path
-    """
+    """if not basic type, coerce to camelCase and add the import path"""
     # for now, just treat Callables as basic types
     if arg.startswith("Callable"):
         return arg
@@ -83,12 +86,16 @@ def add_type_import_path(function_name: str, arg: str) -> str:
                 sub = sub.replace('"', "")
                 return f'List["{to_func_namespace(function_name)}.{camelCase(sub)}"]'
             else:
-                return f'List[{to_func_namespace(function_name)}.{camelCase(sub)}]'
+                return f"List[{to_func_namespace(function_name)}.{camelCase(sub)}]"
 
-    return f'{to_func_namespace(function_name)}.{camelCase(arg)}'
+    return f"{to_func_namespace(function_name)}.{camelCase(arg)}"
 
 
-def get_type_and_def(type_spec: PropertyType) -> Tuple[str, str]:
+def get_type_and_def(
+    type_spec: PropertyType, title_fallback: str = ""
+) -> Tuple[str, str]:
+    """ returns type and type definition for a given PropertyType
+    """
     if type_spec["kind"] == "plain":
         value = type_spec["value"]
         if value.endswith("[]"):
@@ -115,15 +122,19 @@ def get_type_and_def(type_spec: PropertyType) -> Tuple[str, str]:
     elif type_spec["kind"] == "object":
         if type_spec.get("schema"):
             schema = type_spec["schema"]
-            title = schema.get("title", schema.get("name", ""))
-            if title:
+            title = schema.get("title", schema.get("name", title_fallback))
+            if title and schema.get("type") == "array":
+                # TODO fix me
+                # we don't use ReturnType as name for the list type here, we use _ReturnTypeItem
+                return "List", ""
+            elif title:
                 assert isinstance(title, str)
                 return wrapped_generate_schema_types(schema, title, "Dict")  # type: ignore
-            elif schema.get("allOf") and len(schema['allOf']):
+            elif schema.get("allOf") and len(schema["allOf"]):
                 # we are in a case of a single allOf, lets strip off the allOf and move on!
                 # our library doesn't handle allOf well yet
-                allOf = schema['allOf'][0]
-                title = allOf.get("title", allOf.get("name", ""))
+                allOf = schema["allOf"][0]
+                title = allOf.get("title", allOf.get("name", title_fallback))
                 return wrapped_generate_schema_types(allOf, title, "Dict")
             elif schema.get("items"):
                 # fallback to schema $ref name if no explicit title
@@ -131,7 +142,7 @@ def get_type_and_def(type_spec: PropertyType) -> Tuple[str, str]:
                 title = items.get("title")  # type: ignore
                 if not title:
                     # title is actually a reference to another schema
-                    title = items.get("$ref", "")  # type: ignore
+                    title = items.get("$ref", title_fallback)  # type: ignore
 
                 title = title.rsplit("/", 1)[-1]
                 if not title:
@@ -153,12 +164,18 @@ def get_type_and_def(type_spec: PropertyType) -> Tuple[str, str]:
                 return_type = "Any"
 
             for argument in type_spec["spec"]["arguments"]:
+                # do NOT add this fallback here
+                # callable arguments don't understand the imports yet
+                # if it's not a basic type here, we'll just do Any
+                # _maybe_add_fallback_schema_name(argument)
                 arg_type, arg_def = get_type_and_def(argument["type"])
                 arg_types.append(arg_type)
                 if arg_def:
                     arg_defs.append(arg_def)
 
-            final_arg_type = "Callable[[{}], {}]".format(", ".join(arg_types), return_type)
+            final_arg_type = "Callable[[{}], {}]".format(
+                ", ".join(arg_types), return_type
+            )
             return final_arg_type, "\n".join(arg_defs)
         else:
             return "Callable", ""
@@ -168,15 +185,27 @@ def get_type_and_def(type_spec: PropertyType) -> Tuple[str, str]:
         return "Any", ""
 
 
-def parse_arguments(function_name: str, arguments: List[PropertySpecification]) -> Tuple[str, str]:
+def _maybe_add_fallback_schema_name(a: PropertySpecification):
+    if a["type"]["kind"] == "object" and a["type"].get("schema"):
+        schema = a["type"].get("schema", {})
+        if not schema.get("title") and not schema.get("name") and a["name"]:
+            schema["title"] = a["name"].title()
+
+
+def parse_arguments(
+    function_name: str, arguments: List[PropertySpecification]
+) -> Tuple[str, str]:
     args_def = []
     arg_string = ""
     for idx, a in enumerate(arguments):
+        _maybe_add_fallback_schema_name(a)
         arg_type, arg_def = get_type_and_def(a["type"])
         if arg_def:
             args_def.append(arg_def)
         a["name"] = rewrite_arg_name(a["name"])
-        arg_string += f"    {a['name']}: {add_type_import_path(function_name, arg_type)}"
+        arg_string += (
+            f"    {a['name']}: {add_type_import_path(function_name, arg_type)}"
+        )
         description = a.get("description", "")
         description = description.replace("\n", " ")
         if description:
@@ -202,7 +231,7 @@ RESERVED_WORDS = {"List", "Dict", "Any", "Optional", "Callable"} | set(keyword.k
 
 
 def to_func_namespace(s: str) -> str:
-    """ convert a function name to some function namespace
+    """convert a function name to some function namespace
     by default it is
     """
     rv = s[0].upper() + s[1:]
@@ -221,6 +250,10 @@ def rewrite_arg_name(s: str):
     return rewrite_reserved(camelCase(s))
 
 
+# def get_return_type_name(function_name: str) -> str:
+#     return function_name[0].upper() + function_name[1:] + "ReturnType"
+
+
 valid_subdomains = ["na[1-2]", "eu[1-2]", "dev"]
 
 
@@ -238,3 +271,21 @@ def is_valid_uuid(uuid_string, version=4):
         return False
 
     return str(uuid_obj) == uuid_string
+
+
+def return_type_already_defined_in_args(return_type_name: str, args_def: str) -> bool:
+    """
+    Checks if the return_type_name preceded optionally by 'class ' and followed by ' =' exists in args_def.
+
+    Args:
+        return_type_name (str): The name of the return type to check.
+        args_def (str): The string containing argument definitions.
+
+    Returns:
+        bool: True if the pattern exists, False otherwise.
+    """
+    basic_pattern = rf"^{re.escape(return_type_name)}\s="
+    basic_match = bool(re.search(basic_pattern, args_def, re.MULTILINE))
+    class_pattern = rf"^class {re.escape(return_type_name)}\(TypedDict"
+    class_match = bool(re.search(class_pattern, args_def, re.MULTILINE))
+    return basic_match or class_match

{polyapi_python-0.3.3.dev4.dist-info → polyapi_python-0.3.3.dev5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polyapi-python
-Version: 0.3.3.dev4
+Version: 0.3.3.dev5
 Summary: The Python Client for PolyAPI, the IPaaS by Developers for Developers
 Author-email: Dan Fellin <dan@polyapi.io>
 License: MIT License
@@ -193,6 +193,16 @@ When hacking on this library, please enable flake8 and add this line to your fla
 --config=.flake8
 ```
 
+## Mypy Type Improvements
+
+This script is handy for checking for any mypy types:
+
+```bash
+./check_mypy.sh
+```
+
+Please ignore \[name-defined\] errors for now. This is a known bug we are working to fix!
+
 ## Support
 
 If you run into any issues or want help getting started with this project, please contact support@polyapi.io

{polyapi_python-0.3.3.dev4.dist-info → polyapi_python-0.3.3.dev5.dist-info}/RECORD

@@ -1,6 +1,6 @@
 polyapi/__init__.py,sha256=a1Poy1kaTncYnUg6nWRcTjVm-R1CUQk12UX7VYQ9d5k,616
 polyapi/__main__.py,sha256=V4zhAh_YGxno5f_KSrlkELxcuDh9bR3WSd0n-2r-qQQ,93
-polyapi/api.py,sha256=8gXypLOgySjg3fWD_K192idYWPNLBU09c9N35b8irxA,1878
+polyapi/api.py,sha256=f1037HFJF7DtQSSypM4PE5AmmxWxjd0JiW6ARZqrgac,1879
 polyapi/auth.py,sha256=zrIGatjba5GwUTNjKj1GHQWTEDP9B-HrSzCKbLFoqvc,5336
 polyapi/cli.py,sha256=AKsWVHZPKGnypOdnzIpoZOsTuwcAuDGQajXhLe9OQKI,8239
 polyapi/client.py,sha256=CoFDYvyKsqL4wPQbUDIr0Qb8Q5eD92xN4OEEcJEVuGQ,1296
@@ -11,21 +11,21 @@ polyapi/error_handler.py,sha256=I_e0iz6VM23FLVQWJljxs2NGcl_OODbi43OcbnqBlp8,2398
 polyapi/exceptions.py,sha256=Zh7i7eCUhDuXEdUYjatkLFTeZkrx1BJ1P5ePgbJ9eIY,89
 polyapi/execute.py,sha256=kXnvlNQ7nz9cRlV2_5gXH09UCmyiDP5zi3wiAw0uDuk,1943
 polyapi/function_cli.py,sha256=htgmcx_dPmw4_5NKRgIivcwS7D8bkOsxCTOrJhzV3pU,3989
-polyapi/generate.py,sha256=FEw0cNdv8bwvNf21qGElQrFqEfdLhlQ-bmvQdTzKp4U,10447
-polyapi/parser.py,sha256=Dqkg7cy9yae9HP4WcPtNzyZxrUrtDsGshFYW-vPvTzE,20263
-polyapi/poly_schemas.py,sha256=malK9s0DB_am0tMOZ0bwyjXZmABAQ1WnZpP-IJhpb2g,1845
+polyapi/generate.py,sha256=IIbU4Kc8Ut-N3cPI1qzgV3M4r_GHi39dgU0ngpUY86Q,10473
+polyapi/parser.py,sha256=eI_FnLY45m0d7caXyWfzrgw9Oh6JgpooJheorTQ4KDE,20264
+polyapi/poly_schemas.py,sha256=vHHRUJUycYk4uKmjiWG6fpVQllaRw8yVUt4X_Hmoqk8,2921
 polyapi/prepare.py,sha256=Q8CWV4kmZ2dbXYVsud34AgJkj5ymcQ_IcYhLuikc9yk,6659
 polyapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 polyapi/rendered_spec.py,sha256=uaNzBhP4cX7iGfKwzZv0dxMagWzsGeDr0cQYx_AyIhQ,2153
-polyapi/schema.py,sha256=urHve8yg_xrtBRSa3rFxlQpVEz_B-_Xo4MHeJSIIDA4,4247
-polyapi/server.py,sha256=NzQCZFSAJK7XiRw1kiU_i9uMvgYK7i8qh7UX2xjytJU,1908
+polyapi/schema.py,sha256=ZSzeUjpqigLvE4tFKB7y4AaZG-W5N5Z9wMH-F-vjMBU,4616
+polyapi/server.py,sha256=YXWxhYBx-hluwDQ8Jvfpy2s8ogz0GsNTMcZVNcP5ca8,2147
 polyapi/sync.py,sha256=PGdC0feBBjEVrF3d9EluW_OAxbWuzSrfh84czma8kWg,6476
 polyapi/typedefs.py,sha256=KniVl7vwcDOhgAJmHSgTJKkP0rKWvSLIPOGsWuf9jRU,2239
-polyapi/utils.py,sha256=Y2qMy3mf-1FNif2_IHV-ZD00OZlNmKhHN_7aPyqeWP0,8296
+polyapi/utils.py,sha256=9OKwhte_YdnkDectgnjSkVmcxazd8FyfoiKCQtlD63o,10194
 polyapi/variables.py,sha256=d36-trnfTL_8m2NkorMiImb4O3UrJbiFV38CHxV5i0A,4200
 polyapi/webhook.py,sha256=LWv28c2MLz_OKBI_Nn7WR4C-gs1SWgbdXsoxIIf-9UI,4886
-polyapi_python-0.3.3.dev4.dist-info/licenses/LICENSE,sha256=Hi0kDr56Dsy0uYIwNt4r9G7tI8x8miXRTlyvbeplCP8,1068
-polyapi_python-0.3.3.dev4.dist-info/METADATA,sha256=2fZGhUNKe3n3RPaeEz6YU_RWmD3DYXnzFMvcNmk6mXk,5580
-polyapi_python-0.3.3.dev4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-polyapi_python-0.3.3.dev4.dist-info/top_level.txt,sha256=CEFllOnzowci_50RYJac-M54KD2IdAptFsayVVF_f04,8
-polyapi_python-0.3.3.dev4.dist-info/RECORD,,
+polyapi_python-0.3.3.dev5.dist-info/licenses/LICENSE,sha256=Hi0kDr56Dsy0uYIwNt4r9G7tI8x8miXRTlyvbeplCP8,1068
+polyapi_python-0.3.3.dev5.dist-info/METADATA,sha256=zbtIdrk07PowN5ClzpSvR9qyOsHi3WW7NDSh0IBYaJI,5782
+polyapi_python-0.3.3.dev5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+polyapi_python-0.3.3.dev5.dist-info/top_level.txt,sha256=CEFllOnzowci_50RYJac-M54KD2IdAptFsayVVF_f04,8
+polyapi_python-0.3.3.dev5.dist-info/RECORD,,