tabpy 2.10.0__tar.gz → 2.12.0__tar.gz

{tabpy-2.10.0 → tabpy-2.12.0}/.github/workflows/coverage.yml

@@ -9,7 +9,7 @@ jobs:
     
     strategy:
       matrix:
-        python-version: [3.7]
+        python-version: [3.12]
         os: [ubuntu-latest]
 
     steps:

{tabpy-2.10.0 → tabpy-2.12.0}/.github/workflows/lint.yml

@@ -9,7 +9,7 @@ jobs:
     
     strategy:
       matrix:
-        python-version: [3.7]
+        python-version: [3.12]
         os: [ubuntu-latest]
 
     steps:

{tabpy-2.10.0 → tabpy-2.12.0}/.github/workflows/pull_request.yml

@@ -9,10 +9,8 @@ jobs:
     
     strategy:
       matrix:
-        # TODO: Add 3.7 to python-versions after GitHub action regression is resolved.
-        # https://github.com/actions/setup-python/issues/682
-        # TODO: switch macos-13 to macos-latest@arm64
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+        # TODO: switch macos-13 to macos-latest
         os: [ubuntu-latest, windows-latest, macos-13]
 
     steps:

{tabpy-2.10.0 → tabpy-2.12.0}/.github/workflows/push.yml

@@ -9,10 +9,8 @@ jobs:
     
     strategy:
       matrix:
-        # TODO: Add 3.7 to python-versions after GitHub action regression is resolved.
-        # https://github.com/actions/setup-python/issues/682
-        # TODO: switch macos-13 to macos-latest@arm64
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+        # TODO: switch macos-13 to macos-latest
         os: [ubuntu-latest, windows-latest, macos-13]
   
     steps:

{tabpy-2.10.0 → tabpy-2.12.0}/.scrutinizer.yml

@@ -1,6 +1,6 @@
 build:
   environment:
-    python: 3.7.6
+    python: 3.12.5
   nodes:
     coverage:
       project_setup:

{tabpy-2.10.0 → tabpy-2.12.0}/CHANGELOG

@@ -1,5 +1,21 @@
 # Changelog
 
+## v2.12.0
+
+### Improvements
+
+- Add support for public deployed functions that will be visible to users
+  in Tableau when using the Custom Functions Explorer
+- Add functionality to allow users to update existing deployed functions
+  without needing to redeploy the function itself
+
+## v2.11.0
+
+### Improvements
+
+- Add support for Python 3.10, 3.11, and 3.12. End support Python for
+  3.7 and 3.8.
+
 ## v2.10.0
 
 ### Improvements

{tabpy-2.10.0 → tabpy-2.12.0}/CONTRIBUTING.md

@@ -30,8 +30,8 @@ and run it locally.
 These are prerequisites for an environment required for a contributor to
 be able to work on TabPy changes:
 
-- Python 3.7, 3.8 or 3.9:
-  - To see which version of Python you have installed, run `python --version`.
+- Supported 64-bit Python version (see
+[README](https://github.com/tableau/TabPy) for a list of compatible versions).
 - git
 - Node.js for npm packages - install from <https://nodejs.org>.
 - NPM packages - install all with

{tabpy-2.10.0 → tabpy-2.12.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Tableau Software, LLC
+Copyright (c) 2024 Salesforce, 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

{tabpy-2.10.0 → tabpy-2.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tabpy
-Version: 2.10.0
+Version: 2.12.0
 Summary: Web server Tableau uses to run Python scripts.
 Home-page: https://github.com/tableau/TabPy
 Download-URL: https://pypi.org/project/tabpy
@@ -21,9 +21,10 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Operating System :: Microsoft :: Windows
@@ -66,6 +67,22 @@ scripts and saved functions via Tableau's table calculations.
 
 # Changelog
 
+## v2.12.0
+
+### Improvements
+
+- Add support for public deployed functions that will be visible to users
+  in Tableau when using the Custom Functions Explorer
+- Add functionality to allow users to update existing deployed functions
+  without needing to redeploy the function itself
+
+## v2.11.0
+
+### Improvements
+
+- Add support for Python 3.10, 3.11, and 3.12. End support Python for
+  3.7 and 3.8.
+
 ## v2.10.0
 
 ### Improvements

{tabpy-2.10.0 → tabpy-2.12.0}/README.md

@@ -6,7 +6,6 @@
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/tableau/tabpy/Test%20Run%20on%20Push)](https://github.com/tableau/TabPy/actions?query=workflow%3A%22Test+Run+on+Push%22)
 [![Coverage Status](https://coveralls.io/repos/github/tableau/TabPy/badge.svg?branch=master)](https://coveralls.io/github/tableau/TabPy?branch=master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tableau/TabPy/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tableau/TabPy/?branch=master)
-[![Requirements Status](https://requires.io/github/tableau/TabPy/requirements.svg?branch=master)](https://requires.io/github/tableau/TabPy/requirements/?branch=master)
 
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tabpy?label=PyPI%20Python%20versions)
 [![PyPI version](https://badge.fury.io/py/tabpy.svg)](https://pypi.python.org/pypi/tabpy/)

{tabpy-2.10.0 → tabpy-2.12.0}/docs/server-install.md

@@ -15,13 +15,9 @@ These instructions explain how to install and start up TabPy Server.
 
 ## TabPy Installation
 
-### Prerequisites
-
-- TabPy only supports Python versions 3.7, 3.8, 3.9, and 3.10
-- TabPy 2.7.0 added support for data streaming via
-Apache Arrow Flight (`pyarrow`). When using TabPy >= 2.7.0, we
-recommend using a Python 64-bit installer to avoid incompatibility issues
-related to `pyarrow`.
+First, ensure that you are using a supported 64-bit Python version.
+Refer to the [README](https://github.com/tableau/TabPy) for a list
+of compatible versions.
 
 ### Installation
 

{tabpy-2.10.0 → tabpy-2.12.0}/docs/tabpy-tools.md

@@ -71,6 +71,14 @@ def add(x,y):
 client.deploy('add', add, 'Adds two numbers x and y')
 ```
 
+If you would like your function to be visible in Tableau using the Custom Functions
+Explorer, you will need to deploy setting the optional `is_public` parameter to True.
+Functions that have `is_public` set to False, or unset will not be visible.
+
+```python
+client.deploy('add', add, 'Adds two numbers x and y', is_public=True)
+```
+
 The next example is more complex, using scikit-learn's clustering API:
 
 ```python
@@ -100,16 +108,6 @@ endpoint named `clustering`.
 It is now reachable as a [REST API](server-rest.md#httppost-queryendpoint), as
 well as through the TabPy tools - for details see the next section.
 
-You can re-deploy a function (for example, after you modified its code) by setting
-the `override` parameter to `True`:
-
-```python
-client.deploy('add', add, 'Adds two numbers x and y', override=True)
-```
-
-Each re-deployment of an endpoint will increment its version number, which is also
-returned as part of the query result.
-
 When deploying endpoints which rely on supervised learning models, you may want to
 load a saved model instead of training on-the-fly for performance reasons.
 
@@ -158,9 +156,62 @@ The endpoints that are no longer needed can be removed the following way:
 ```python
 
 client.remove('WillItDefault')
+```
+
+## Updating Existing Functions
+
+You can re-deploy a function (for example, after you modified its code) by setting
+the `override` parameter to `True`:
 
+```python
+client.deploy('add', add, 'Adds two numbers x and y', override=True)
 ```
 
+Each re-deployment of an endpoint will increment its version number, which is also
+returned as part of the query result.
+
+If you do not want to modify the code of a function, you have the option to
+update using `update_endpoint_info`. This allows users to update the
+description, schema, or whether a function is public using just the function
+name.
+
+To update the description of an existing function:
+
+```python
+client.update_endpoint_info('add', description = 'Updated description for add')
+```
+
+To update whether an existing function is public:
+
+```python
+client.update_endpoint_info('add', is_public=True)
+```
+
+To update the schema associated with an existing function:
+
+```python
+updatedSchema = generate_schema(
+  input={'x': 3, 'y': 2},
+  output=5,
+  input_description={'x': 'first value',
+                     'y': 'second value'},
+  output_description='the sum of x and y')
+
+
+client.update_endpoint_info('add', schema=updatedSchema)
+```
+
+To update `description`, `is_public`, and `schema` all at once:
+
+```python
+client.update_endpoint_info('add',
+                            is_public=True,
+                            description='Updated description for add',
+                            schema=updatedSchema)
+```
+
+Updating endpoints via `update_endpoint_info` will NOT increment version number
+
 ## Predeployed Functions
 
 ### Deploying Models Shipped With TabPy

{tabpy-2.10.0 → tabpy-2.12.0}/docs/tabpy-virtualenv.md

@@ -86,7 +86,7 @@ Linux and Mac run shell.
 3. Create the virtual Anaconda environment
 
     ```sh
-    conda create --name my-tabpy-env python=3.7
+    conda create --name my-tabpy-env python=3.12
     ```
 
 4. Activate your virtual environment

{tabpy-2.10.0 → tabpy-2.12.0}/setup.py

@@ -39,9 +39,10 @@ def setup_package():
             "Intended Audience :: Developers",
             "Intended Audience :: Science/Research",
             "License :: OSI Approved :: MIT License",
-            "Programming Language :: Python :: 3.7",
-            "Programming Language :: Python :: 3.8",
             "Programming Language :: Python :: 3.9",
+            "Programming Language :: Python :: 3.10",
+            "Programming Language :: Python :: 3.11",
+            "Programming Language :: Python :: 3.12",
             "Topic :: Scientific/Engineering",
             "Topic :: Scientific/Engineering :: Information Analysis",
             "Operating System :: Microsoft :: Windows",

tabpy-2.12.0/tabpy/VERSION

@@ -0,0 +1 @@
+2.12.0

{tabpy-2.10.0 → tabpy-2.12.0}/tabpy/tabpy_server/handlers/endpoint_handler.py

@@ -71,10 +71,12 @@ class EndpointHandler(ManagementHandler):
                 self.finish()
                 return
 
-            new_version = int(endpoints[name]["version"]) + 1
+            version_after_update = int(endpoints[name]["version"])
+            if request_data.get('should_update_version'):
+                version_after_update += 1
             self.logger.log(logging.INFO, f"Endpoint info: {request_data}")
             err_msg = yield self._add_or_update_endpoint(
-                "update", name, new_version, request_data
+                "update", name, version_after_update, request_data
             )
             if err_msg:
                 self.error_out(400, err_msg)

{tabpy-2.10.0 → tabpy-2.12.0}/tabpy/tabpy_server/handlers/management_handler.py

@@ -84,6 +84,7 @@ class ManagementHandler(BaseHandler):
             target = request_data.get("target", None)
             schema = request_data.get("schema", None)
             src_path = request_data.get("src_path", None)
+            is_public = request_data.get("is_public", None)
             target_path = get_query_object_path(
                 self.settings[SettingsParameters.StateFilePath], name, version
             )
@@ -117,6 +118,7 @@ class ManagementHandler(BaseHandler):
                         dependencies=dependencies,
                         target=target,
                         schema=schema,
+                        is_public=is_public,
                     )
                 else:
                     self.tabpy_state.update_endpoint(
@@ -129,6 +131,7 @@ class ManagementHandler(BaseHandler):
                         target=target,
                         schema=schema,
                         version=version,
+                        is_public=is_public,
                     )
 
             except Exception as e:

{tabpy-2.10.0 → tabpy-2.12.0}/tabpy/tabpy_server/management/state.py

@@ -187,6 +187,12 @@ class TabPyState:
 
         return dependencies
 
+    def _check_and_set_is_public(self, is_public, defaultValue):
+        if is_public is None:
+            return defaultValue
+
+        return is_public
+
     @state_lock
     def add_endpoint(
         self,
@@ -198,6 +204,7 @@ class TabPyState:
         target=None,
         dependencies=None,
         schema=None,
+        is_public=None,
     ):
         """
         Add a new endpoint to the TabPy.
@@ -231,6 +238,7 @@ class TabPyState:
                 docstring, "-- no docstring found in query function --")
             endpoint_type = self._check_and_set_endpoint_type(endpoint_type, None)
             dependencies = self._check_and_set_dependencies(dependencies, [])
+            is_public = self._check_and_set_is_public(is_public, False)
 
             self._check_target(target)
             if target and target not in endpoints:
@@ -246,6 +254,7 @@ class TabPyState:
                 "creation_time": int(time()),
                 "last_modified_time": int(time()),
                 "schema": schema,
+                "is_public": is_public,
             }
 
             endpoints[name] = endpoint_info
@@ -289,6 +298,7 @@ class TabPyState:
         target=None,
         dependencies=None,
         schema=None,
+        is_public=None,
     ):
         """
         Update an existing endpoint on the TabPy.
@@ -330,6 +340,7 @@ class TabPyState:
                 endpoint_type, endpoint_info["type"])
             dependencies = self._check_and_set_dependencies(
                 dependencies, endpoint_info.get("dependencies", []))
+            is_public = self._check_and_set_is_public(is_public, endpoint_info["is_public"])
 
             self._check_target(target)
             if target and target not in endpoints:
@@ -352,6 +363,7 @@ class TabPyState:
                 "creation_time": endpoint_info["creation_time"],
                 "last_modified_time": int(time()),
                 "schema": schema,
+                "is_public": is_public,
             }
 
             endpoints[name] = endpoint_info

{tabpy-2.10.0 → tabpy-2.12.0}/tabpy/tabpy_tools/client.py

@@ -173,7 +173,8 @@ class Client:
                "dependencies": [],
                "last_modified_time": 1469511182,
                "type": "model",
-               "target": null},
+               "target": null,
+               "is_public": True}
             "add": {
               "description": "",
               "docstring": "-- no docstring found in query function --",
@@ -182,7 +183,8 @@ class Client:
               "dependencies": [],
               "last_modified_time": 1469505967,
               "type": "model",
-              "target": null}
+              "target": null,
+              "is_public": False}
             }
         """
         return self._service.get_endpoints(type)
@@ -191,7 +193,7 @@ class Client:
         """Returns the endpoint upload destination."""
         return self._service.get_endpoint_upload_destination()["path"]
 
-    def deploy(self, name, obj, description="", schema=None, override=False):
+    def deploy(self, name, obj, description="", schema=None, override=False, is_public=False):
         """Deploys a Python function as an endpoint in the server.
 
         Parameters
@@ -220,6 +222,12 @@ class Client:
             RuntimeError. If True and there is already an endpoint with that
             name, it will deploy a new version on top of it.
 
+        is_public : bool, optional
+            Whether a function should be public for viewing from within tableau. If
+            False, function will not appear in the custom functions explorer within
+            Tableau. If True, function will be visible ta anyone on a site with this
+            analytics extension configured
+
         See Also
         --------
         remove, get_endpoints
@@ -236,14 +244,14 @@ class Client:
 
             version = endpoint.version + 1
 
-        obj = self._gen_endpoint(name, obj, description, version, schema)
+        obj = self._gen_endpoint(name, obj, description, version, schema, is_public)
 
         self._upload_endpoint(obj)
 
         if version == 1:
             self._service.add_endpoint(Endpoint(**obj))
         else:
-            self._service.set_endpoint(Endpoint(**obj))
+            self._service.set_endpoint(Endpoint(**obj), should_update_version=True)
 
         self._wait_for_endpoint_deployment(obj["name"], obj["version"])
 
@@ -256,7 +264,68 @@ class Client:
             Endpoint name to remove'''
         self._service.remove_endpoint(name)
 
-    def _gen_endpoint(self, name, obj, description, version=1, schema=None):
+    def update_endpoint_info(self, name, description=None, schema=None, is_public=None):
+        '''Updates description, schema, or is public for an existing endpoint
+
+        Parameters
+        ----------
+        name : str
+            Name of the endpoint that to be updated. If endpoint does not exist
+            runtime error will be thrown
+
+        description : str, optional
+            The description for the endpoint. This string will be returned by
+            the ``endpoints`` API.
+
+        schema : dict, optional
+            The schema of the function, containing information about input and
+            output parameters, and respective examples. Providing a schema for
+            a deployed function lets other users of the service discover how to
+            use it. Refer to schema.generate_schema for more information on
+            how to generate the schema.
+
+        is_public : bool, optional
+            Whether a function should be public for viewing from within tableau. If
+            False, function will not appear in the custom functions explorer within
+            Tableau. If True, function will be visible to anyone on a site with this
+            analytics extension configured
+        '''
+
+        endpoint = self.get_endpoints().get(name)
+
+        if not endpoint:
+            raise RuntimeError(
+                f"No endpoint with that name ({name}) exists"
+                " Please select an existing endpoint to update"
+            )
+
+        if description is not None:
+            if type(description) is not str:
+                raise RuntimeError(
+                    f"Type of description must be string"
+                )
+            endpoint.description = description
+        if schema is not None:
+            if type(schema) is not dict:
+                raise RuntimeError(
+                    f"Type of schema must be dictionary"
+                )
+            endpoint.schema = schema
+        if is_public is not None:
+            if type(is_public) is not bool:
+                raise RuntimeError(
+                    f"Type of is_public must be bool"
+                )
+            endpoint.is_public = is_public
+
+        dest_path = self._get_endpoint_upload_destination()
+
+        endpoint.src_path = os.path.join(
+            dest_path, "endpoints", endpoint.name, str(endpoint.version)
+        )
+        self._service.set_endpoint(endpoint, should_update_version=False)
+
+    def _gen_endpoint(self, name, obj, description, version=1, schema=None, is_public=False):
         """Generates an endpoint dict.
 
         Parameters
@@ -274,6 +343,10 @@ class Client:
         version : int
             The version. Defaults to 1.
 
+        is_public : bool
+            True if function should be visible in the custom functions explorer
+            within Tableau
+
         Returns
         -------
         dict
@@ -318,6 +391,7 @@ class Client:
             "required_files": [],
             "required_packages": [],
             "schema": copy.copy(schema),
+            "is_public": is_public,
         }
 
     def _upload_endpoint(self, obj):

{tabpy-2.10.0 → tabpy-2.12.0}/tabpy/tabpy_tools/rest_client.py

@@ -47,6 +47,7 @@ class Endpoint(RESTObject):
     evaluator = RESTProperty(str)
     schema_version = RESTProperty(int)
     schema = RESTProperty(str)
+    is_public = RESTProperty(bool)
 
     def __new__(cls, **kwargs):
         """Dispatch to the appropriate class."""
@@ -67,6 +68,7 @@ class Endpoint(RESTObject):
             and self.evaluator == other.evaluator
             and self.schema_version == other.schema_version
             and self.schema == other.schema
+            and self.is_public == other.is_public
         )
 
 
@@ -202,7 +204,7 @@ class RESTServiceClient:
         """
         return self.service_client.POST("endpoints", endpoint.to_json())
 
-    def set_endpoint(self, endpoint):
+    def set_endpoint(self, endpoint, should_update_version=True):
         """Updates an endpoint through the management API.
 
         Parameters
@@ -211,8 +213,16 @@ class RESTServiceClient:
         endpoint : Endpoint
 
             The endpoint to update.
+
+        should_update_version : bool
+
+            Whether this update should increment the version.
+            False if this is called from update_endpoint_info
+            True if called from deploy
         """
-        return self.service_client.PUT("endpoints/" + endpoint.name, endpoint.to_json())
+        request_body = endpoint.to_json()
+        request_body["should_update_version"] = should_update_version
+        return self.service_client.PUT("endpoints/" + endpoint.name, request_body)
 
     def remove_endpoint(self, endpoint_name):
         """Deletes an endpoint through the management API.

{tabpy-2.10.0 → tabpy-2.12.0}/tabpy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tabpy
-Version: 2.10.0
+Version: 2.12.0
 Summary: Web server Tableau uses to run Python scripts.
 Home-page: https://github.com/tableau/TabPy
 Download-URL: https://pypi.org/project/tabpy
@@ -21,9 +21,10 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Operating System :: Microsoft :: Windows
@@ -66,6 +67,22 @@ scripts and saved functions via Tableau's table calculations.
 
 # Changelog
 
+## v2.12.0
+
+### Improvements
+
+- Add support for public deployed functions that will be visible to users
+  in Tableau when using the Custom Functions Explorer
+- Add functionality to allow users to update existing deployed functions
+  without needing to redeploy the function itself
+
+## v2.11.0
+
+### Improvements
+
+- Add support for Python 3.10, 3.11, and 3.12. End support Python for
+  3.7 and 3.8.
+
 ## v2.10.0
 
 ### Improvements

tabpy-2.10.0/tabpy/VERSION

@@ -1 +0,0 @@
-2.10.0