R22 (#40)

* # Feature (2970): Update python client to support setup command (#22)

* # Feature (2970): Update python client to support setup command
- Function add command now support --execution-api-key
- Extra Old Function call removed

* improve polyapi-python setup (#24)

* improve polyapi-python setup

* # Feature (3019): improve polyapi-python setup (#25)

* # Feature (3019): improve polyapi-python setup

* # Feature (3019): improve polyapi-python setup
- UUID Validation check added

---------

Co-authored-by: Sudipta at TechJays <sudipta.kumar@techjays.com>

* # Feature (3007): Update python -m polyapi function add --logs options (#23)

* # Feature (3007): Update python -m polyapi function add --logs options
- if  --logs added, then value must enabled or disabled
- If Nothing passed the value is default disabled
- pyproject.toml version updated

* Project Glide + Refactor main command line args parsing (#26)

* Refactor main command line args parsing, adding prepare and sync commands to enable project glide workflows for python

* improved tests

* updating version

* fix for poly cache directory path construction

* one more adjustment to the deployables cache directory so there can't be any conflict with any custom namespace

* this better?

* verbose logging on upload code to see what's failing in CI/CD

* bumpity

* whoops

* so close

* better?

* okay this should be the fix

* is it this?

* maybe

* oh for the love of pete

* whatever. might be a pypi issue

* removing verbose logging

* fixing bugs in sync command to use correct api urls

* update logging

* lint

* improved auth

* last fix for function sync

* fix bug when comment arguments don't align with the function

* try forcing the poly directory to exist

* test logging

* remove debug logging

* fixing project glide deployable types and bumping the version

* fixing missing arguments in python client function upload

* fixing return type for trained functions

* fix bug preventing use of poly sync command locally

* next version of client!

* EN #3183 allow null logs flag for python client (#28)

* let the typing_extensions versions increase to support latest openai pypi package version

* update dependency in one more place

* Some bug fixes for python client (#29)

* fixed bug with parsing python functions without any types, and bug where functions with multiple deployment receipts were getting mangled

* whoops. uncommenting tests

* last test fix

* 0.3.2

* add poly schemas support (#31)

* onward

* adding schemas for Pythonland!

* onward

* next

* next

* next

* next

* test

* next

* next

* next

* little tweak for A-Aron

* fix

* next

* update to v4

* v4 everywhere

* bump version

* add new version

* remove warning, just go with any type for now

* better generate printed messages, fix generate bug after function add

* Update python version (#32)

* Update python image (#33)

* Update python version

* Updated version

* Rollback version

* onward (#34)

* woot! we have some better return types

* toward working tests - except parser/deployables

* more

* getting there

* next

* onawrd

* next

* next

* next

* next

* next (#35)

* improve intellisense detection of schemas

* release 0.3.3.dev8, fix misleading generate after setup

* 0.3.3.dev9 - add support for optional arguments (#36)

* next

* release 0.3.3.dev10

* EN #3943 update to support SFX serverSideAsync True by setting correct return type (#39)

* deploying version 0.3.3 for R22

---------

Co-authored-by: Sudipta at TechJays <sudipta.kumar@techjays.com>
Co-authored-by: Dan Fellin <dan@polyapi.io>
Co-authored-by: Aaron Goin <aarongoin@users.noreply.github.com>
Co-authored-by: Dan Fellin <dan@highwaterlabs.com>
Co-authored-by: Eric Neumann <eneumann@users.noreply.github.com>
Co-authored-by: Don Chiniquy <drchiniquy@gmail.com>

Author: 6 people

.flake8

@@ -1,4 +1,4 @@
 [flake8]
-extend-ignore = E203,E303,E402,E501,E722,W391,F401,W292
+ignore = E203,E303,E402,E501,E722,W391,F401,W292,F811
 max-line-length = 150
-max-complexity = 20
+max-complexity = 22

.github/workflows/polyapi-update-python-package.yml

@@ -1,4 +1,4 @@
-name: Update python pip package 
+name: Update python pip package
 on:
   push:
     paths:
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.ref == 'refs/heads/develop' }}
     environment: dev
-    
+
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
@@ -31,7 +31,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -44,27 +44,27 @@ jobs:
     needs: develop-build
     environment:
       name: dev
-      url: https://pypi.org/p/polyapi-python 
+      url: https://pypi.org/p/polyapi-python
 
     permissions:
-      id-token: write 
+      id-token: write
     steps:
 
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
     - name: Publish distribution 📦 to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
 
-          
+
   main-build:
     name: Build distribution 📦
     runs-on: ubuntu-latest
     if: ${{ github.ref == 'refs/heads/main' }}
     environment: main
-    
+
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
@@ -81,7 +81,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
@@ -90,20 +90,20 @@ jobs:
   main-publish-to-pypi:
     name: >-
       Publish Python 🐍 distribution 📦 to PyPI
-    if: ${{ github.ref == 'refs/heads/main' }} 
+    if: ${{ github.ref == 'refs/heads/main' }}
     needs:
     - main-build
     runs-on: ubuntu-latest
     environment:
       name: main
-      url: https://pypi.org/p/polyapi-python 
+      url: https://pypi.org/p/polyapi-python
     permissions:
-      id-token: write 
+      id-token: write
 
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/

.gitignore

@@ -34,5 +34,6 @@ __pycache__
 .polyapi-python
 function_add_test.py
 lib_test*.py
-polyapi/poly/
-polyapi/vari/
+polyapi/poly
+polyapi/vari
+polyapi/schemas

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 PolyAPI Inc.
+Copyright (c) 2025 PolyAPI Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -143,6 +143,26 @@ To run this library's unit tests, please clone the repo then run:
 python -m unittest discover
 ```
 
+## Linting
+
+The flake8 config is at the root of this repo at `.flake8`.
+
+When hacking on this library, please enable flake8 and add this line to your flake8 args (e.g., in your VSCode Workspace Settings):
+
+```
+--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

check_mypy.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+mypy polyapi/poly 
+mypy polyapi/vari 
+mypy polyapi/schemas

polyapi/api.py

@@ -8,6 +8,7 @@
 from typing import List, Dict, Any, TypedDict
 {args_def}
 {return_type_def}
+
 class {api_response_type}(TypedDict):
     status: int
     headers: Dict
@@ -41,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/cli.py

@@ -13,6 +13,7 @@
 
 CLI_COMMANDS = ["setup", "generate", "function", "clear", "help", "update_rendered_spec"]
 
+
 def execute_from_cli():
     # First we setup all our argument parsing logic
     # Then we parse the arguments (waaay at the bottom)
@@ -46,9 +47,7 @@ def setup(args):
 
     def generate_command(args):
         initialize_config()
-        print("Generating Poly functions...", end="")
         generate()
-        print_green("DONE")
 
     generate_parser.set_defaults(command=generate_command)
 

polyapi/config.py

@@ -55,6 +55,10 @@ def set_api_key_and_url(key: str, url: str):
     config.set("polyapi", "poly_api_base_url", url)
     with open(get_config_file_path(), "w") as f:
         config.write(f)
+    global API_KEY
+    global API_URL
+    API_KEY = key
+    API_URL = url
 
 
 def initialize_config(force=False):
@@ -81,7 +85,7 @@ def initialize_config(force=False):
                 sys.exit(1)
 
             set_api_key_and_url(key, url)
-            print_green(f"Poly setup complete.")
+            print_green("Poly setup complete.")
 
     if not key or not url:
         print_yellow("Poly API Key and Poly API Base URL are required.")

polyapi/execute.py

@@ -1,3 +1,4 @@
+from typing import Dict
 import requests
 from requests import Response
 from polyapi.config import get_api_key_and_url
@@ -7,10 +8,14 @@
 def execute(function_type, function_id, data) -> Response:
     """ execute a specific function id/type
     """
+    data_without_None = data
+    if isinstance(data, Dict):
+        data_without_None = {k: v for k, v in data.items() if v is not None}
+
     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)
+    resp = requests.post(url, json=data_without_None, headers=headers)
     # print(resp.status_code)
     # print(resp.headers["content-type"])
     if resp.status_code < 200 or resp.status_code >= 300: