queueflow 0.1.0__py3-none-any.whl

queueflow/rest.py

@@ -0,0 +1,257 @@
+# coding: utf-8
+
+"""
+    QueueFlow API
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from queueflow.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

queueflow-0.1.0.dist-info/METADATA

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: queueflow
+Version: 0.1.0
+Summary: QueueFlow API
+Home-page: https://github.com/queueflow/queueflow-sdk-python
+Author: QueueFlow
+Author-email: team@queueflow.dev
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,QueueFlow API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+    REST API for QueueFlow, a PostgreSQL-native distributed job queue and workflow engine.
+    

queueflow-0.1.0.dist-info/RECORD

@@ -0,0 +1,62 @@
+queueflow/__init__.py,sha256=oj5IED3dwgyKiwZsJ7DBQjRaONciCB5KjZhcqkYTKUg,3758
+queueflow/api_client.py,sha256=n3tEbKgQXt2uqbqqL-Jh67jT7_ySSJ4SQdpnKfJNpq0,27423
+queueflow/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+queueflow/configuration.py,sha256=RhEjrEPC4hpz9dUmATLt0b9Jr9l54hofNJmoW3eiLcA,18057
+queueflow/exceptions.py,sha256=gYMwIB4L1CmjProtkG9BumRPkYwletpAC5QMWPG9AN0,5958
+queueflow/facade.py,sha256=omS4wKfBStlKJx0LQiKrp81GfXr6FKiO5YITRQ4yD0s,9889
+queueflow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+queueflow/rest.py,sha256=7Ms20RQWA3fVHuQMLx7Npw99eZp5qPHq6DIWo5oI6KA,9393
+queueflow/api/__init__.py,sha256=tM-5KblwDhrv1Kn3M3Ty4x-_bLQrUJciEEyFL88KXTs,369
+queueflow/api/cron_api.py,sha256=mfz_ONRNNt-B40w55jq2krDjq4Js_eUHduU2eMYQQFs,71627
+queueflow/api/dlq_api.py,sha256=XhrPV9wYWyX7MkrKHAhrKeidNny9pJOdHmaAJF4jD_A,41573
+queueflow/api/health_api.py,sha256=D-fSj6AcxpMv0-cSbz3QlJdRfCr2TuLOYPzw26zDljs,19376
+queueflow/api/jobs_api.py,sha256=FEIHcmB1BoglYBTwXguRPMzASHLlivlUdyUwYgOeBlM,74337
+queueflow/api/system_api.py,sha256=YURq_bokMRlFQkeGZ7imtvHKbPHln5ABJbXOqtVolJo,19268
+queueflow/api/worker_api.py,sha256=zqgxoFHCJ7huwTk0-9Ni9_MU9lG3lo3yc7sAErYKzkg,46010
+queueflow/api/workflows_api.py,sha256=LdNSbvW8hfOHuEXKn_c1W34xMWTjj3sWJFvQslaFDRo,72257
+queueflow/models/__init__.py,sha256=lzpi5DbZcTbL9j6Nyo_jjWFjNspoGj1pQfflnGwVtuw,2938
+queueflow/models/backoff_strategy.py,sha256=lvKHe-dQBW4HgHNuzOoFQ8Vje1TUJkf2wCpktO5wzZk,798
+queueflow/models/complete_job_request.py,sha256=a6b67PucHywZsIZb1cPizQXgKxUX_6zA0sWZ71F4GAE,2806
+queueflow/models/create_batch_jobs_request.py,sha256=kABWHFd_fQaMF0gQW5uYBIrImFMVEYRFNaN287jEivU,2951
+queueflow/models/create_batch_jobs_response.py,sha256=P2JReuy6hb7DRvqrX8kAh7PQc_Lb5DVuU6bXcN_FNLw,2659
+queueflow/models/create_cron_request.py,sha256=jidXOwvCjztrPCQ5kJj8Tgo10a0q3LpT5jfVakq-f_s,3773
+queueflow/models/create_cron_response.py,sha256=WSwWaisFdz3K1NuRufoLLfntA-thFkrx3Y87CfTQPCU,2486
+queueflow/models/create_job_request.py,sha256=mCKX2CrPp77T98OwIK8j5snCM1XR8RyXImQFGnmH0BE,3808
+queueflow/models/create_job_response.py,sha256=W68mYk9VXJ7AUBMbgFoXWW-KLDXou3FVKY1UprYS9WQ,2478
+queueflow/models/create_workflow_request.py,sha256=HHYLccPZCk8ZMRDzod_fzbL4N3AeKKEEOuMtwDe8qOw,3327
+queueflow/models/create_workflow_response.py,sha256=s4QuTyC43IoRybob-IRgm7m_W-lmcogYwunI3TXb7dE,2518
+queueflow/models/cron_schedule.py,sha256=jxTej_w-kKhwtbEQfOyF3ZYa7cWdPi9vFabmDYMQtIk,5142
+queueflow/models/dead_letter.py,sha256=rcZh_SMYGAcIQTj2rIALB_o_qOqWp1gvIUu5M8msWwY,5229
+queueflow/models/error_body.py,sha256=E2C-vOu_mjqUywCeP4ZoAP_YqOT_Q1gzMuV-BezXWyQ,2556
+queueflow/models/fail_job_request.py,sha256=xY9_8RzYggf_s9mxUNAHDRx5mdUdjtsYwU1JllPqFcc,2998
+queueflow/models/health_status.py,sha256=gK4iDvb35h2uwYX2XAvadvOrQEzvzULq66s8uq3Gtng,2649
+queueflow/models/heartbeat_request.py,sha256=W-nZLKCG7dpcAJrUo6kCuTAx2y-BQi36R-fp-94BRZM,2844
+queueflow/models/heartbeat_response.py,sha256=WLaWKjYvN2yNTvgLNTtvgGtfdrhsyVjnb5BSQHeTFqQ,2755
+queueflow/models/job.py,sha256=fc9Fbk06iGe95ZJkP5uSYlKsGBOR9yc_-RlZJx68mNQ,7546
+queueflow/models/job_config.py,sha256=mrarvPRCfWGXmPZnY1kIOWdVb5IBfM2wUKESGVrmnkc,4550
+queueflow/models/job_config_request.py,sha256=GHysVx-3ng98Jep-d6jUy6lZbky7nnt1pvUdG5IwzEQ,6000
+queueflow/models/job_status.py,sha256=UANbCg9bjCI7p9LrAFZvhuuJSHB2S4cyWlLKg_F1Rhk,857
+queueflow/models/lease_jobs_request.py,sha256=Ao7VA41410YXPQ3L0bvDkDbJ9rZH0UlxznQsPByF3kw,3821
+queueflow/models/lease_jobs_response.py,sha256=ZZqYfqsMMdARg6uOT4AZMAVHVa8yG70nGWzY4Ukgtbk,2902
+queueflow/models/leased_job.py,sha256=oauCp5M0M_cVVOH1PuhwmQbJhOCx2MicOemTL04Ke4k,3083
+queueflow/models/list_crons_response.py,sha256=3OgFNNE6dEkWv7YUlCRYFeqUq_ynNoa450oz5EdPRuE,4111
+queueflow/models/list_dead_letters_response.py,sha256=Arv2JiDuHvZ9l0-eWCMryheUlF42Mb0PBRbi6AHqu-A,4211
+queueflow/models/list_jobs_response.py,sha256=T27wLAkZrH9q_UXhZTXlVO_uK1HtkJZBUd1_SoSfyjI,4146
+queueflow/models/list_workflows_response.py,sha256=lLgKFRosvv35BDFmfWCi4oQr-OGBJBY0Jj6T4mrmeSE,4158
+queueflow/models/on_failure.py,sha256=Vddg4RFnbZNNSttIaCB1gPg05aDzcKOM5pBRgEWkHlY,786
+queueflow/models/on_success.py,sha256=TGwLUuWJn_Kw3SrSjQo1VzqfWxzU3xlqu1suajTOYk4,766
+queueflow/models/ready_status.py,sha256=Tcb2deIWEhsrff_ANFqrq9PI4c8VrQnS2pg5PyviW7Y,2454
+queueflow/models/replay_dead_letter_response.py,sha256=6EHZwOHTd9tNORJhTM9VayiE1Q3MdCgdEle0pUd6gnc,2586
+queueflow/models/stats_snapshot.py,sha256=g2WF927iSNJiR0OwNoNBHKxLnnjfnfjXt43_rzXRR_o,3562
+queueflow/models/step_status.py,sha256=1VHvqYgwsbem-33To4ojxxR46uWznYA8Z_VFMQLmrx4,867
+queueflow/models/tasks_response.py,sha256=bsm1AQKV4OemP9CK4NqwhDQf-EbL40VZkKXJDlYadpo,2464
+queueflow/models/workflow.py,sha256=nF8MvYeZkEVNK_O1lrl1HSc_Hr3CfCBwbY4NTLNMGRY,4654
+queueflow/models/workflow_diagram_response.py,sha256=j9R7XFXYH1mh3j2SzUhsRfK0SAbWM27WEICyD_INNL4,2722
+queueflow/models/workflow_status.py,sha256=dz2kUq7prbslisrqXzUapkOkXFss0vSsFNnSoIDl11M,890
+queueflow/models/workflow_step.py,sha256=Gb7mGRPe0Xvo70n4SJ0c3eHJGJFJMJZVqMULj1SmoUk,3860
+queueflow/models/workflow_step_state.py,sha256=UhlzhRs_p81AJ0X4WLGsEzJYYFmi8uxRrky-e54zhX4,3116
+queueflow/models/workflow_step_states_response.py,sha256=vxD3PWqNmKE_hCsc1q8kid6QFvrUA-PrmLTDZB-YEQg,3055
+queueflow-0.1.0.dist-info/METADATA,sha256=pP4IJJh6qxgL6me5Htb-Rxwdk3MU3zL-Ixv2qOYPE6k,718
+queueflow-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+queueflow-0.1.0.dist-info/top_level.txt,sha256=J9jGksZj4ffWlkAOswE7Z989FNzjVI8lY858M7UIMrk,10
+queueflow-0.1.0.dist-info/RECORD,,

queueflow-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

queueflow-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+queueflow