crate 1.0.0.dev1__py3-none-any.whl → 1.0.1__py3-none-any.whl

crate/testing/__init__.py

@@ -1 +0,0 @@
-# package

crate/testing/layer.py

@@ -19,38 +19,44 @@
 # with Crate these terms will supersede the license and you may use the
 # software solely pursuant to the terms of the relevant commercial agreement.
 
+# ruff: noqa: S603  # `subprocess` call: check for execution of untrusted input
+# ruff: noqa: S202  # Uses of `tarfile.extractall()`
+
+import io
+import json
+import logging
 import os
 import re
-import sys
-import time
-import json
-import urllib3
-import tempfile
 import shutil
 import subprocess
+import sys
 import tarfile
-import io
+import tempfile
 import threading
-import logging
+import time
+
+import urllib3
 
 try:
     from urllib.request import urlopen
 except ImportError:
-    from urllib import urlopen
+    from urllib import urlopen  # type: ignore[attr-defined,no-redef]
 
 
 log = logging.getLogger(__name__)
 
 
-CRATE_CONFIG_ERROR = 'crate_config must point to a folder or to a file named "crate.yml"'
+CRATE_CONFIG_ERROR = (
+    'crate_config must point to a folder or to a file named "crate.yml"'
+)
 HTTP_ADDRESS_RE = re.compile(
-    r'.*\[(http|.*HttpServer.*)\s*] \[.*\] .*'
-    'publish_address {'
-    r'(?:inet\[[\w\d\.-]*/|\[)?'
-    r'(?:[\w\d\.-]+/)?'
-    r'(?P<addr>[\d\.:]+)'
-    r'(?:\])?'
-    '}'
+    r".*\[(http|.*HttpServer.*)\s*] \[.*\] .*"
+    "publish_address {"
+    r"(?:inet\[[\w\d\.-]*/|\[)?"
+    r"(?:[\w\d\.-]+/)?"
+    r"(?P<addr>[\d\.:]+)"
+    r"(?:\])?"
+    "}"
 )
 
 
@@ -61,18 +67,22 @@ def http_url_from_host_port(host, port):
                 port = int(port)
             except ValueError:
                 return None
-        return '{}:{}'.format(prepend_http(host), port)
+        return "{}:{}".format(prepend_http(host), port)
     return None
 
 
 def prepend_http(host):
-    if not re.match(r'^https?\:\/\/.*', host):
-        return 'http://{}'.format(host)
+    if not re.match(r"^https?\:\/\/.*", host):
+        return "http://{}".format(host)
     return host
 
 
 def _download_and_extract(uri, directory):
-    sys.stderr.write("\nINFO:    Downloading CrateDB archive from {} into {}".format(uri, directory))
+    sys.stderr.write(
+        "\nINFO:    Downloading CrateDB archive from {} into {}".format(
+            uri, directory
+        )
+    )
     sys.stderr.flush()
     with io.BytesIO(urlopen(uri).read()) as tmpfile:
         with tarfile.open(fileobj=tmpfile) as t:
@@ -82,19 +92,18 @@ def _download_and_extract(uri, directory):
 def wait_for_http_url(log, timeout=30, verbose=False):
     start = time.monotonic()
     while True:
-        line = log.readline().decode('utf-8').strip()
+        line = log.readline().decode("utf-8").strip()
         elapsed = time.monotonic() - start
         if verbose:
-            sys.stderr.write('[{:>4.1f}s]{}\n'.format(elapsed, line))
+            sys.stderr.write("[{:>4.1f}s]{}\n".format(elapsed, line))
         m = HTTP_ADDRESS_RE.match(line)
         if m:
-            return prepend_http(m.group('addr'))
+            return prepend_http(m.group("addr"))
         elif elapsed > timeout:
             return None
 
 
 class OutputMonitor:
-
     def __init__(self):
         self.consumers = []
 
@@ -105,7 +114,9 @@ class OutputMonitor:
 
     def start(self, proc):
         self._stop_out_thread = threading.Event()
-        self._out_thread = threading.Thread(target=self.consume, args=(proc.stdout,))
+        self._out_thread = threading.Thread(
+            target=self.consume, args=(proc.stdout,)
+        )
         self._out_thread.daemon = True
         self._out_thread.start()
 
@@ -116,7 +127,6 @@ class OutputMonitor:
 
 
 class LineBuffer:
-
     def __init__(self):
         self.lines = []
 
@@ -124,7 +134,7 @@ class LineBuffer:
         self.lines.append(line.strip())
 
 
-class CrateLayer(object):
+class CrateLayer:
     """
     This layer starts a Crate server.
     """
@@ -135,14 +145,16 @@ class CrateLayer(object):
     wait_interval = 0.2
 
     @staticmethod
-    def from_uri(uri,
-                 name,
-                 http_port='4200-4299',
-                 transport_port='4300-4399',
-                 settings=None,
-                 directory=None,
-                 cleanup=True,
-                 verbose=False):
+    def from_uri(
+        uri,
+        name,
+        http_port="4200-4299",
+        transport_port="4300-4399",
+        settings=None,
+        directory=None,
+        cleanup=True,
+        verbose=False,
+    ):
         """Download the Crate tarball from a URI and create a CrateLayer
 
         :param uri: The uri that points to the Crate tarball
@@ -158,11 +170,14 @@ class CrateLayer(object):
         """
         directory = directory or tempfile.mkdtemp()
         filename = os.path.basename(uri)
-        crate_dir = re.sub(r'\.tar(\.gz)?$', '', filename)
+        crate_dir = re.sub(r"\.tar(\.gz)?$", "", filename)
         crate_home = os.path.join(directory, crate_dir)
 
         if os.path.exists(crate_home):
-            sys.stderr.write("\nWARNING: Not extracting Crate tarball because folder already exists")
+            sys.stderr.write(
+                "\nWARNING: Not extracting CrateDB tarball"
+                " because folder already exists"
+            )
             sys.stderr.flush()
         else:
             _download_and_extract(uri, directory)
@@ -173,29 +188,33 @@ class CrateLayer(object):
             port=http_port,
             transport_port=transport_port,
             settings=settings,
-            verbose=verbose)
+            verbose=verbose,
+        )
         if cleanup:
             tearDown = layer.tearDown
 
             def new_teardown(*args, **kws):
                 shutil.rmtree(directory)
                 tearDown(*args, **kws)
-            layer.tearDown = new_teardown
+
+            layer.tearDown = new_teardown  # type: ignore[method-assign]
         return layer
 
-    def __init__(self,
-                 name,
-                 crate_home,
-                 crate_config=None,
-                 port=None,
-                 keepRunning=False,
-                 transport_port=None,
-                 crate_exec=None,
-                 cluster_name=None,
-                 host="127.0.0.1",
-                 settings=None,
-                 verbose=False,
-                 env=None):
+    def __init__(
+        self,
+        name,
+        crate_home,
+        crate_config=None,
+        port=None,
+        keepRunning=False,
+        transport_port=None,
+        crate_exec=None,
+        cluster_name=None,
+        host="127.0.0.1",
+        settings=None,
+        verbose=False,
+        env=None,
+    ):
         """
         :param name: layer name, is also used as the cluser name
         :param crate_home: path to home directory of the crate installation
@@ -216,52 +235,69 @@ class CrateLayer(object):
         self.__name__ = name
         if settings and isinstance(settings, dict):
             # extra settings may override host/port specification!
-            self.http_url = http_url_from_host_port(settings.get('network.host', host),
-                                                    settings.get('http.port', port))
+            self.http_url = http_url_from_host_port(
+                settings.get("network.host", host),
+                settings.get("http.port", port),
+            )
         else:
             self.http_url = http_url_from_host_port(host, port)
 
         self.process = None
         self.verbose = verbose
         self.env = env or {}
-        self.env.setdefault('CRATE_USE_IPV4', 'true')
-        self.env.setdefault('JAVA_HOME', os.environ.get('JAVA_HOME', ''))
+        self.env.setdefault("CRATE_USE_IPV4", "true")
+        self.env.setdefault("JAVA_HOME", os.environ.get("JAVA_HOME", ""))
         self._stdout_consumers = []
         self.conn_pool = urllib3.PoolManager(num_pools=1)
 
         crate_home = os.path.abspath(crate_home)
         if crate_exec is None:
-            start_script = 'crate.bat' if sys.platform == 'win32' else 'crate'
-            crate_exec = os.path.join(crate_home, 'bin', start_script)
+            start_script = "crate.bat" if sys.platform == "win32" else "crate"
+            crate_exec = os.path.join(crate_home, "bin", start_script)
         if crate_config is None:
-            crate_config = os.path.join(crate_home, 'config', 'crate.yml')
-        elif (os.path.isfile(crate_config) and
-              os.path.basename(crate_config) != 'crate.yml'):
+            crate_config = os.path.join(crate_home, "config", "crate.yml")
+        elif (
+            os.path.isfile(crate_config)
+            and os.path.basename(crate_config) != "crate.yml"
+        ):
             raise ValueError(CRATE_CONFIG_ERROR)
         if cluster_name is None:
-            cluster_name = "Testing{0}".format(port or 'Dynamic')
-        settings = self.create_settings(crate_config,
-                                        cluster_name,
-                                        name,
-                                        host,
-                                        port or '4200-4299',
-                                        transport_port or '4300-4399',
-                                        settings)
+            cluster_name = "Testing{0}".format(port or "Dynamic")
+        settings = self.create_settings(
+            crate_config,
+            cluster_name,
+            name,
+            host,
+            port or "4200-4299",
+            transport_port or "4300-4399",
+            settings,
+        )
         # ES 5 cannot parse 'True'/'False' as booleans so convert to lowercase
-        start_cmd = (crate_exec, ) + tuple(["-C%s=%s" % ((key, str(value).lower()) if isinstance(value, bool) else (key, value))
-                                            for key, value in settings.items()])
-
-        self._wd = wd = os.path.join(CrateLayer.tmpdir, 'crate_layer', name)
-        self.start_cmd = start_cmd + ('-Cpath.data=%s' % wd,)
-
-    def create_settings(self,
-                        crate_config,
-                        cluster_name,
-                        node_name,
-                        host,
-                        http_port,
-                        transport_port,
-                        further_settings=None):
+        start_cmd = (crate_exec,) + tuple(
+            [
+                "-C%s=%s"
+                % (
+                    (key, str(value).lower())
+                    if isinstance(value, bool)
+                    else (key, value)
+                )
+                for key, value in settings.items()
+            ]
+        )
+
+        self._wd = wd = os.path.join(CrateLayer.tmpdir, "crate_layer", name)
+        self.start_cmd = start_cmd + ("-Cpath.data=%s" % wd,)
+
+    def create_settings(
+        self,
+        crate_config,
+        cluster_name,
+        node_name,
+        host,
+        http_port,
+        transport_port,
+        further_settings=None,
+    ):
         settings = {
             "discovery.type": "zen",
             "discovery.initial_state_timeout": 0,
@@ -294,20 +330,23 @@ class CrateLayer(object):
 
     def start(self):
         self._clean()
-        self.process = subprocess.Popen(self.start_cmd,
-                                        env=self.env,
-                                        stdout=subprocess.PIPE)
+        self.process = subprocess.Popen(
+            self.start_cmd, env=self.env, stdout=subprocess.PIPE
+        )
         returncode = self.process.poll()
         if returncode is not None:
             raise SystemError(
-                'Failed to start server rc={0} cmd={1}'.format(returncode,
-                                                               self.start_cmd)
+                "Failed to start server rc={0} cmd={1}".format(
+                    returncode, self.start_cmd
+                )
             )
 
         if not self.http_url:
             # try to read http_url from startup logs
             # this is necessary if no static port is assigned
-            self.http_url = wait_for_http_url(self.process.stdout, verbose=self.verbose)
+            self.http_url = wait_for_http_url(
+                self.process.stdout, verbose=self.verbose
+            )
 
         self.monitor = OutputMonitor()
         self.monitor.start(self.process)
@@ -315,10 +354,10 @@ class CrateLayer(object):
         if not self.http_url:
             self.stop()
         else:
-            sys.stderr.write('HTTP: {}\n'.format(self.http_url))
+            sys.stderr.write("HTTP: {}\n".format(self.http_url))
             self._wait_for_start()
             self._wait_for_master()
-            sys.stderr.write('\nCrate instance ready.\n')
+            sys.stderr.write("\nCrate instance ready.\n")
 
     def stop(self):
         self.conn_pool.clear()
@@ -352,10 +391,9 @@ class CrateLayer(object):
                 for line in line_buf.lines:
                     log.error(line)
                 self.stop()
-                raise SystemError('Failed to start Crate instance in time.')
-            else:
-                sys.stderr.write('.')
-                time.sleep(self.wait_interval)
+                raise SystemError("Failed to start Crate instance in time.")
+            sys.stderr.write(".")
+            time.sleep(self.wait_interval)
 
         self.monitor.consumers.remove(line_buf)
 
@@ -367,7 +405,7 @@ class CrateLayer(object):
         # after the layer starts don't result in 503
         def validator():
             try:
-                resp = self.conn_pool.request('HEAD', self.http_url)
+                resp = self.conn_pool.request("HEAD", self.http_url)
                 return resp.status == 200
             except Exception:
                 return False
@@ -379,12 +417,12 @@ class CrateLayer(object):
 
         def validator():
             resp = self.conn_pool.urlopen(
-                'POST',
-                '{server}/_sql'.format(server=self.http_url),
-                headers={'Content-Type': 'application/json'},
-                body='{"stmt": "select master_node from sys.cluster"}'
+                "POST",
+                "{server}/_sql".format(server=self.http_url),
+                headers={"Content-Type": "application/json"},
+                body='{"stmt": "select master_node from sys.cluster"}',
             )
-            data = json.loads(resp.data.decode('utf-8'))
-            return resp.status == 200 and data['rows'][0][0]
+            data = json.loads(resp.data.decode("utf-8"))
+            return resp.status == 200 and data["rows"][0][0]
 
         self._wait_for(validator)

crate/testing/util.py

@@ -1,4 +1,75 @@
-class ExtraAssertions:
+# -*- coding: utf-8; -*-
+#
+# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# license agreements.  See the NOTICE file distributed with this work for
+# additional information regarding copyright ownership.  Crate licenses
+# this file to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# However, if you have executed another commercial license agreement
+# with Crate these terms will supersede the license and you may use the
+# software solely pursuant to the terms of the relevant commercial agreement.
+import unittest
+
+
+class ClientMocked:
+    active_servers = ["http://localhost:4200"]
+
+    def __init__(self):
+        self.response = {}
+        self._server_infos = ("http://localhost:4200", "my server", "2.0.0")
+
+    def sql(self, stmt=None, parameters=None, bulk_parameters=None):
+        return self.response
+
+    def server_infos(self, server):
+        return self._server_infos
+
+    def set_next_response(self, response):
+        self.response = response
+
+    def set_next_server_infos(self, server, server_name, version):
+        self._server_infos = (server, server_name, version)
+
+    def close(self):
+        pass
+
+
+class ParametrizedTestCase(unittest.TestCase):
+    """
+    TestCase classes that want to be parametrized should
+    inherit from this class.
+
+    https://eli.thegreenplace.net/2011/08/02/python-unit-testing-parametrized-test-cases
+    """
+
+    def __init__(self, methodName="runTest", param=None):
+        super(ParametrizedTestCase, self).__init__(methodName)
+        self.param = param
+
+    @staticmethod
+    def parametrize(testcase_klass, param=None):
+        """Create a suite containing all tests taken from the given
+        subclass, passing them the parameter 'param'.
+        """
+        testloader = unittest.TestLoader()
+        testnames = testloader.getTestCaseNames(testcase_klass)
+        suite = unittest.TestSuite()
+        for name in testnames:
+            suite.addTest(testcase_klass(name, param=param))
+        return suite
+
+
+class ExtraAssertions(unittest.TestCase):
     """
     Additional assert methods for unittest.
 
@@ -12,9 +83,13 @@ class ExtraAssertions:
             r = issubclass(cls, superclass)
         except TypeError:
             if not isinstance(cls, type):
-                self.fail(self._formatMessage(msg,
-                          '%r is not a class' % (cls,)))
+                self.fail(
+                    self._formatMessage(msg, "%r is not a class" % (cls,))
+                )
             raise
         if not r:
-            self.fail(self._formatMessage(msg,
-                      '%r is not a subclass of %r' % (cls, superclass)))
+            self.fail(
+                self._formatMessage(
+                    msg, "%r is not a subclass of %r" % (cls, superclass)
+                )
+            )

{crate-1.0.0.dev1.dist-info → crate-1.0.1.dist-info}/LICENSE

@@ -176,73 +176,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-
-===============================================================================
-
-For the `docs` directory:
-
-The source files for the documentation are licensed under the Apache License
-Version 2.0. These source files are used by the project maintainers to build
-online documentation for end-users:
-
-  <https://crate.io/docs/clients/python/en/latest/>
-
-If you want to make contributions to the documentation, it may be necessary for
-you to build the documentation yourself by following the instructions in the
-`DEVELOP.rst` file. If you do this, a number of third-party software components
-are necessary.
-
-We do not ship the source code for these optional third-party software
-components or their dependencies, so we cannot make any guarantees about the
-licensing status of these components.
-
-However, for convenience, the documentation build system explicitly references
-the following software components (grouped by license):
-
-PSF License:
-
- - Python 3 <https://docs.python.org/3/license.html>
-
-MIT License:
-
- - pip <https://pypi.org/project/pip/>
- - setuptools <https://pypi.org/project/setuptools/>
- - sphinx-autobuild <https://pypi.org/project/sphinx-autobuild/>
-
-BSD License:
-
- - alabaster <https://pypi.org/project/alabaster/>
- - sphinx <https://pypi.org/project/Sphinx/>
-
-Apache License 2.0:
-
- - crate-docs-theme <https://pypi.org/project/crate-docs-theme/>
-
-Please note that each of these components may specify its own dependencies and
-those dependencies may be licensed differently.

{crate-1.0.0.dev1.dist-info → crate-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: crate
-Version: 1.0.0.dev1
+Version: 1.0.1
 Summary: CrateDB Python Client
 Home-page: https://github.com/crate/crate-python
 Author: Crate.io
@@ -21,6 +21,7 @@ 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: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Database
@@ -28,25 +29,24 @@ Requires-Python: >=3.6
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: urllib3<2.3
-Requires-Dist: verlib2==0.2.0
+Requires-Dist: urllib3
+Requires-Dist: verlib2
 Provides-Extra: doc
-Requires-Dist: sphinx<8,>=3.5; extra == "doc"
 Requires-Dist: crate-docs-theme>=0.26.5; extra == "doc"
+Requires-Dist: sphinx<9,>=3.5; extra == "doc"
 Provides-Extra: test
-Requires-Dist: tox<5,>=3; extra == "test"
-Requires-Dist: zope.testing<6,>=4; extra == "test"
-Requires-Dist: zope.testrunner<7,>=5; extra == "test"
-Requires-Dist: zc.customdoctests<2,>=1.0.1; extra == "test"
+Requires-Dist: backports.zoneinfo<1; python_version < "3.9" and extra == "test"
 Requires-Dist: certifi; extra == "test"
 Requires-Dist: createcoverage<2,>=1; extra == "test"
-Requires-Dist: dask[dataframe]; extra == "test"
+Requires-Dist: mypy<1.14; extra == "test"
+Requires-Dist: poethepoet<0.31; extra == "test"
+Requires-Dist: ruff<0.8; extra == "test"
 Requires-Dist: stopit<2,>=1.1.2; extra == "test"
-Requires-Dist: flake8<8,>=4; extra == "test"
-Requires-Dist: pandas<2.3; extra == "test"
-Requires-Dist: pueblo>=0.0.7; extra == "test"
+Requires-Dist: tox<5,>=3; extra == "test"
 Requires-Dist: pytz; extra == "test"
-Requires-Dist: backports.zoneinfo<1; python_version < "3.9" and extra == "test"
+Requires-Dist: zc.customdoctests<2,>=1.0.1; extra == "test"
+Requires-Dist: zope.testing<6,>=4; extra == "test"
+Requires-Dist: zope.testrunner<7,>=5; extra == "test"
 
 =====================
 CrateDB Python Client
@@ -56,7 +56,7 @@ CrateDB Python Client
     :target: https://github.com/crate/crate-python/actions?workflow=Tests
     :alt: Build status
 
-.. image:: https://codecov.io/gh/crate/crate-python/branch/master/graph/badge.svg
+.. image:: https://codecov.io/gh/crate/crate-python/branch/main/graph/badge.svg
     :target: https://app.codecov.io/gh/crate/crate-python
     :alt: Coverage
 
@@ -152,5 +152,3 @@ GitHub`_. We appreciate contributions of any kind.
 .. _sqlalchemy-cratedb documentation: https://cratedb.com/docs/sqlalchemy-cratedb/
 .. _StackOverflow: https://stackoverflow.com/tags/cratedb
 .. _support channels: https://cratedb.com/support/
-
-

{crate-1.0.0.dev1.dist-info → crate-1.0.1.dist-info}/NOTICE

@@ -1,5 +1,5 @@
 CrateDB Python Adapter
-Copyright 2013-2022 Crate.IO GmbH ("Crate")
+Copyright 2013-2024 Crate.IO GmbH ("Crate")
 
 
 Licensed to Crate.IO GmbH (referred to in this notice as "Crate") under one or