tracdap-ext-http 0.10.0.dev14__py3-none-any.whl → 0.10.0.dev15__py3-none-any.whl

tracdap/ext/http/__init__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-__version__ = "0.10.0.dev14"
+__version__ = "0.10.0.dev15"

tracdap/ext/http/http_plugin.py

@@ -13,28 +13,119 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-import typing as _tp
+import http.client as _hc
 
+try:
+    import urllib3 as _ul3  # noqa
+except ModuleNotFoundError:
+    _ul3 = None
+
+import tracdap.rt.config as _cfg
+import tracdap.rt.exceptions as _ex
 import tracdap.rt.ext.external as _external
 import tracdap.rt.ext.plugins as _plugins
+import tracdap.rt.ext.util as _util
 
 
 class HttpPlugin(_external.IExternalSystem):
 
-    def __init__(self, properties: _tp.Dict[str, str]):
-        self.__properties = properties
+    HOST_KEY = "host"
+    PORT_KEY = "port"
+    TLS_KEY = "tls"
+    TIMEOUT_KEY = "timeout"
+
+    def __init__(self, resource_name: str, config: _cfg.PluginConfig):
+
+        self.__resource_name = resource_name
+
+        self.__host = _util.read_plugin_config(config, self.HOST_KEY)
+        self.__port = _util.read_plugin_config(config, self.PORT_KEY, optional=True, convert=int)
+        self.__tls = _util.read_plugin_config(config, self.TLS_KEY, default=True, convert=bool)
+        self.__timeout = _util.read_plugin_config(config, self.TIMEOUT_KEY, optional=True, convert=int)
+
+    def supported_types(self) -> list[type]:
+
+        supported_types: list[type] = list()
+
+        if _hc:
+            supported_types.append(_hc.HTTPConnection)
+            supported_types.append(_hc.HTTPSConnection)
+
+        if _ul3:
+            supported_types.append(_ul3.HTTPConnectionPool)
+            supported_types.append(_ul3.HTTPSConnectionPool)
+
+        return supported_types
+
+    def supported_args(self) -> dict[str, type] | None:
+
+        return {
+            "timeout": float
+        }
+
+    def create_client(self, client_type: type, **client_args) -> object:
+
+        if client_type == _hc.HTTPConnection:
+            if self.__tls:
+                return self._create_client_hc_https(**client_args)
+            else:
+                return self._create_client_hc_http(**client_args)
+
+        if client_type == _hc.HTTPSConnection:
+            if self.__tls:
+                return self._create_client_hc_https(**client_args)
+            else:
+                raise self._error_tls_not_enabled()
+
+        if _ul3 and client_type == _ul3.HTTPConnectionPool:
+            if self.__tls:
+                return self._create_client_ul3_https(**client_args)
+            else:
+                return self._create_client_ul3_http(**client_args)
+
+        if _ul3 and client_type == _ul3.HTTPSConnectionPool:
+            if self.__tls:
+                return self._create_client_ul3_https(**client_args)
+            else:
+                raise self._error_tls_not_enabled()
+
+        raise _ex.EPluginNotAvailable(f"Client type [{client_type.__qualname__}] is not available in {self.__class__.__name__}")
+
+    def _create_client_hc_http(self, **client_args):
+        hc_args = self._build_common_args(**client_args)
+        return _hc.HTTPSConnection(self.__host, self.__port, **hc_args)
+
+    def _create_client_hc_https(self, **client_args):
+        hc_args = self._build_common_args(**client_args)
+        return _hc.HTTPSConnection(self.__host, self.__port, **hc_args)
+
+    def _create_client_ul3_http(self, **client_args):
+        ul3_args = self._build_common_args(**client_args)
+        return _ul3.HTTPSConnectionPool(self.__host, self.__port, **ul3_args)
+
+    def _create_client_ul3_https(self, **client_args):
+        ul3_args = self._build_common_args(**client_args)
+        return _ul3.HTTPSConnectionPool(self.__host, self.__port, **ul3_args)
+
+    def _build_common_args(self, **client_args):
+
+        args = dict()
 
-    def supported_types(self) -> _tp.List[type]:
-        pass
+        if self.TIMEOUT_KEY in client_args and self.__timeout is not None:
+            args[self.TIMEOUT_KEY] = min(client_args[self.TIMEOUT_KEY], self.__timeout)
+        elif self.TIMEOUT_KEY in client_args:
+            args[self.TIMEOUT_KEY] = client_args[self.TIMEOUT_KEY]
+        elif self.__timeout is not None:
+            args[self.TIMEOUT_KEY] = self.__timeout
 
-    def supported_args(self) -> _tp.Optional[_tp.Dict[str, type]]:
-        pass
+        return args
 
-    def create_client(self, client_type: type, **client_args) -> _tp.Any:
-        pass
+    def _error_tls_not_enabled(self):
+        detail = f"The resource [{self.__resource_name }] does not have TLS enabled"
+        return _ex.ERuntimeValidation(f"Cannot create HTTPS connection: {detail}")
 
-    def close_client(self, client: _tp.Any):
-        pass
+    def close_client(self, client: object):
+        client.close()  # noqa
 
 
 _plugins.PluginManager.register_plugin(

tracdap_ext_http-0.10.0.dev15.dist-info/METADATA

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: tracdap-ext-http
+Version: 0.10.0.dev15
+Summary: An extension for TRAC D.A.P. that lets models connect to HTTP endpoints
+Author-email: Martin Traverse <martin@fintrac.co.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://tracdap.finos.org/
+Project-URL: Documentation, https://tracdap.readthedocs.io/
+Project-URL: Source Code, https://github.com/finos/tracdap
+Project-URL: Issue Tracker, https://github.com/finos/tracdap/issues
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tracdap-runtime>=0.10.0-dev.15
+Dynamic: license-file
+
+<h1 align="center">
+
+![tracdap](https://github.com/finos/tracdap/raw/main/doc/_images/tracmmp_horizontal_400.png)
+
+</h1>
+
+<p align="center">
+  <a href="https://pypi.org/project/tracdap-ext-http"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/tracdap-ext-http.svg?maxAge=86400" /></a>
+  <a href="https://pypi.org/project/tracdap-ext-http"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/tracdap-ext-http.svg?maxAge=86400" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/packaging.yaml?query=branch%3Amain"><img alt="Packaging status" src="https://github.com/finos/tracdap/actions/workflows/packaging.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://github.com/finos/tracdap/actions/workflows/compliance.yaml?query=branch%3Amain"><img alt="Compliance status" src="https://github.com/finos/tracdap/actions/workflows/compliance.yaml/badge.svg?branch:main&workflow:CI" /></a>
+  <a href="https://community.finos.org/docs/governance/software-projects/stages/incubating/"><img alt="FINOS - Incubating" src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg" /></a>
+</p>
+
+
+# HTTP Extension for the TRAC Model Runtime
+
+This extension allows TRAC models to make calls to external systems using HTTP and HTTPS.
+
+- Make HTTP endpoints available to models, to use directly in model code
+- Connection settings managed by TRAC for both local and deployed models
+- Supports http.client and urllib3
+- Supports
+
+Models that make external calls are not considered repeatable,
+and will be flagged as non-repeatable when they run on the TRAC platform.
+
+This extension is a pre-release and will be finalized inTRAC 0.10.
+
+
+## Installing
+
+The HTTP extension can be installed with [pip](https://pip.pypa.io):
+
+```shell
+$ pip install tracdap-ext-http
+```
+
+The package has the following dependencies:
+
+- tracdap-runtime (version 0.10.0-beta1 or later)
+- urllib3 (optional, version 2.x)
+
+
+## Using the http.client API
+
+Here is a minimum working example of a TRAC model using the http.client API:
+
+```python
+import tracdap.rt.api as trac
+import http.client as hc
+
+class TestModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "github": trac.define_external_system("http", hc.HTTPSConnection)
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("github", hc.HTTPSConnection) as github:
+
+            github.connect()
+            github.request("GET", "finos/tracdap/refs/heads/main/README.md")
+
+            response = github.getresponse()
+            response_text = response.read().decode("utf-8")
+            first_line = response_text.splitlines()[0]
+
+            ctx.log.info(first_line)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(TestModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+To make this example work, you will need to add ``github`` as a resource in the system config file:
+
+```yaml
+resources:
+
+  github:
+    resourceType: EXTERNAL_SYSTEM
+    protocol: http
+    properties:
+      host: raw.githubusercontent.com
+      port: 443
+      tls: true
+```
+
+The following configuration properties are supported:
+
+- host, string, required
+- port, int, optional
+- tls, bool, default = true
+- timeout, float, optional
+
+Models using the client type ``HTTPSConnection`` will only work if tls = true is set in the configuration.
+Models requesting ``HTTPConnection`` will work with tls = true or tls = false,
+and will receive an ``HTTPSConnection`` if tls = true.
+
+
+## Using the urllib3 API
+
+Here is a minimum working example of a TRAC model using the urllib3 API.
+In order to use this API, the urllib3 package must be installed.
+
+```python
+import tracdap.rt.api as trac
+import urllib3
+
+class TestModel(trac.TracModel):
+
+    # ... define parameters, inputs and outputs
+
+    def define_resources(self):
+
+        return {
+            "github": trac.define_external_system("http", urllib3.HTTPSConnectionPool)
+        }
+
+    def run_model(self, ctx: trac.TracContext):
+
+        with ctx.get_external_system("github", urllib3.HTTPSConnectionPool, timeout=10.0) as github:
+
+            response = github.request("GET", "/finos/tracdap/refs/heads/main/README.md")
+
+            response_text = response.data.decode("utf-8")
+            first_line = response_text.splitlines()[0]
+
+            ctx.log.info(first_line)
+
+if __name__ == '__main__':
+    import tracdap.rt.launch as launch
+    launch.launch_model(TestModel, "config/job_config.yaml", "config/sys_config.yaml")
+```
+
+The resource configuration for the urllib3 API is identical to the http.client API.

tracdap_ext_http-0.10.0.dev15.dist-info/RECORD

@@ -0,0 +1,7 @@
+tracdap/ext/http/__init__.py,sha256=Lqktwp14D9743PLhaZ90bcmoT5SKO3XW7cexWxthRLE,825
+tracdap/ext/http/http_plugin.py,sha256=YxPxtZbu2Xwz5nVjAA2FdRlcTzrmzwyYMMD4lCSnplQ,4955
+tracdap_ext_http-0.10.0.dev15.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+tracdap_ext_http-0.10.0.dev15.dist-info/METADATA,sha256=hjdN5JNRaGB3SoZwWZrzcQDIJrAv7tSWdy9VgP4cI68,6086
+tracdap_ext_http-0.10.0.dev15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+tracdap_ext_http-0.10.0.dev15.dist-info/top_level.txt,sha256=Uv0JfaE1Lp4JnCzqW8lqXNJAEcsAFpAUGOghJolVNdM,8
+tracdap_ext_http-0.10.0.dev15.dist-info/RECORD,,

tracdap_ext_http-0.10.0.dev14.dist-info/METADATA

@@ -1,37 +0,0 @@
-Metadata-Version: 2.4
-Name: tracdap-ext-http
-Version: 0.10.0.dev14
-Summary: An extension for TRAC D.A.P. that lets models connect to HTTP endpoints
-Author-email: Martin Traverse <martin@fintrac.co.uk>
-License-Expression: Apache-2.0
-Project-URL: Homepage, https://tracdap.finos.org/
-Project-URL: Documentation, https://tracdap.readthedocs.io/
-Project-URL: Source Code, https://github.com/martin-traverse/tracdap
-Project-URL: Issue Tracker, https://github.com/martin-traverse/tracdap/issues
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-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: Programming Language :: Python :: 3.13
-Classifier: Framework :: Trac
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Financial and Insurance Industry
-Classifier: Topic :: Office/Business
-Classifier: Topic :: Office/Business :: Financial
-Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
-
-# HTTP Extension for the TRAC Model Runtime
-
-An extension for TRAC D.A.P. that lets models connect to HTTP endpoints.
-The extension depends on the tracdap-runtime package with the same version.
-
-This extension is a pre-release, full documentation will be provided TRAC 0.10.

tracdap_ext_http-0.10.0.dev14.dist-info/RECORD

@@ -1,7 +0,0 @@
-tracdap/ext/http/__init__.py,sha256=g9nFNk6JqQjYEFNgAR_7VaQelKzCcypHGGitTl38WLs,825
-tracdap/ext/http/http_plugin.py,sha256=apXj_bPk4NTneZ2cx3-1ERVpfvIKOxSvqhG2aL9A2YA,1456
-tracdap_ext_http-0.10.0.dev14.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-tracdap_ext_http-0.10.0.dev14.dist-info/METADATA,sha256=Ssfozq4s1wxQHUiSGnxhnrdtEhVzzrdj2JvXYzi4lcw,1695
-tracdap_ext_http-0.10.0.dev14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-tracdap_ext_http-0.10.0.dev14.dist-info/top_level.txt,sha256=Uv0JfaE1Lp4JnCzqW8lqXNJAEcsAFpAUGOghJolVNdM,8
-tracdap_ext_http-0.10.0.dev14.dist-info/RECORD,,