Bump version: 1.0.0 → 1.0.1 (#16)

* docs: Updated changelog.

* chore: Updated changelog.

* docs: Improved documentation for flushing errors.

* chore: Disabled tagging from bumpversion.

* Bump version: 1.0.0 → 1.0.1

* Update CHANGELOG.rst

Co-authored-by: Amy Wang <[email protected]>

* Update CHANGELOG.rst

Co-authored-by: Amy Wang <[email protected]>

Co-authored-by: Amy Wang <[email protected]>

Author: amunra

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
-current_version = 1.0.0
+current_version = 1.0.1
 commit = True
-tag = True
+tag = False
 
 [bumpversion:file:pyproject.toml]
 search = version = "{current_version}"
@@ -22,3 +22,7 @@ replace = version = release = '{new_version}'
 [bumpversion:file:src/questdb/__init__.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
+
+[bumpversion:file:src/questdb/ingress.pyx]
+search = 'v{current_version}'
+replace = 'v{new_version}'

CHANGELOG.rst

@@ -2,6 +2,20 @@
 Changelog
 =========
 
+1.0.1 (2022-08-16)
+------------------
+
+* Fixed a major bug where Python ``int`` and ``float`` types were handled with
+  32-bit instead of 64-bit precision. This caused certain ``int`` values to be
+  rejected and other ``float`` values to be rounded incorrectly.
+  Closes `#13 <https://github.com/questdb/py-questdb-client/issues/13>`_.
+* As a matter of convenience, the ``Buffer.row`` method can now take ``None`` column
+  values. This has the same semantics as skipping the column altogether.
+  Closes `#3 <https://github.com/questdb/py-questdb-client/issues/3>`_.
+* Fixed a minor bug where an error auto-flush caused a second clean-up error.
+  Closes `#4 <https://github.com/questdb/py-questdb-client/issues/4>`_.
+
+
 1.0.0 (2022-07-15)
 ------------------
 

README.rst

@@ -17,7 +17,7 @@ encryption with TLS.
 Quickstart
 ==========
 
-The latest version of the library is 1.0.0.
+The latest version of the library is 1.0.1.
 
 ::
 

docs/conf.py

@@ -20,7 +20,7 @@
 year = '2022'
 author = 'QuestDB'
 copyright = '{0}, {1}'.format(year, author)
-version = release = '1.0.0'
+version = release = '1.0.1'
 
 github_repo_url = 'https://github.com/questdb/py-questdb-client'
 

docs/troubleshooting.rst

@@ -39,20 +39,68 @@ The :class:`questdb.ingress.Sender` class only  provides auto-flushing based on
 a buffer size and *not on a timer*.
 
 
-Inspecting and debugging errors
-===============================
+Errors during flushing
+----------------------
 
-Both the :class:`questdb.ingress.Sender` and :class:`questdb.ingress.Buffer`
-types support ``__len__`` and ``__str__`` methods to inspect the buffer that is
-about to be flushed.
+Server disconnects
+~~~~~~~~~~~~~~~~~~
 
-Note that the ILP protocol does not send errors back to the client.
+A failure in :func:`questdb.ingress.Sender.flush` generally indicates that the
+network connection was dropped.
 
-On error, the QuestDB server will disconnect and any error messages will be
-present in the `server logs
+The ILP protocol does not send errors back to the client. Instead, by design,
+it will disconnect a client if it encounters any insertion errors. This is to
+avoid errors going unnoticed.
+
+As an example, if a client were to insert a ``STRING`` value into a ``BOOLEAN``
+column, the QuestDB server would disconnect the client.
+
+To determine the root cause of a disconnect, inspect the `server logs
 <https://questdb.io/docs/concept/root-directory-structure#log-directory>`_.
 
 
+Logging outgoing messages
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To understand what data was sent to the server, you may log outgoing messages
+from Python.
+
+Here's an example if you append rows to the ``Sender`` object:
+
+.. code-block:: python
+
+    import textwrap
+
+    with Sender(...) as sender:
+        # sender.row(...)
+        # sender.row(...)
+        # ...
+        pending = str(sender)
+        logging.info('About to flush:\n%s', textwrap.indent(pending, '    '))
+        sender.flush()
+
+Alternatively, if you're constructing buffers explicitly:
+
+.. code-block:: python
+
+    import textwrap
+
+    buffer = sender.new_buffer()
+    # buffer.row(...)
+    # buffer.row(...)
+    # ...
+    pending = str(buffer)
+    logging.info('About to flush:\n%s', textwrap.indent(pending, '    '))
+    sender.flush(buffer)
+
+
+Note that to handle out-of-order messages efficiently, the QuestDB server will
+delay appling changes it receives over ILP after a configurable
+`commit lag <https://questdb.io/docs/guides/out-of-order-commit-lag>`_.
+
+Due to this commit lag, the line that caused the error may not be the last line.
+
+
 Asking for help
 ===============
 

pyproject.toml

@@ -2,7 +2,7 @@
 # See: https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
 name = "questdb"
 requires-python = ">=3.7"
-version = "1.0.0"
+version = "1.0.1"
 description = "QuestDB client library for Python"
 readme = "README.rst"
 classifiers = [

setup.py

@@ -120,7 +120,7 @@ def readme():
 
 setup(
     name='questdb',
-    version='1.0.0',
+    version='1.0.1',
     platforms=['any'],
     python_requires='>=3.7',
     install_requires=[],

src/questdb/__init__.py

@@ -1 +1 @@
-__version__ = '1.0.0'
+__version__ = '1.0.1'

src/questdb/ingress.pyx

@@ -132,8 +132,8 @@ cdef inline object c_err_code_to_py(line_sender_error_code code):
         raise ValueError('Internal error converting error code.')
 
 
-cdef inline object c_err_to_py(line_sender_error* err):
-    """Construct a ``SenderError`` from a C error, which will also be freed."""
+cdef inline object c_err_to_code_and_msg(line_sender_error* err):
+    """Construct a ``SenderError`` from a C error, which will be freed."""
     cdef line_sender_error_code code = line_sender_error_get_code(err)
     cdef size_t c_len = 0
     cdef const char* c_msg = line_sender_error_msg(err, &c_len)
@@ -142,15 +142,24 @@ cdef inline object c_err_to_py(line_sender_error* err):
     cdef object py_code
     try:
         py_code = c_err_code_to_py(code)
-        py_msg = PyUnicode_FromKindAndData(
-            PyUnicode_1BYTE_KIND,
-            c_msg,
-            <Py_ssize_t>c_len)
-        return IngressError(py_code, py_msg)
+        py_msg = PyUnicode_FromStringAndSize(c_msg, <Py_ssize_t>c_len)
+        return (py_code, py_msg)
     finally:
         line_sender_error_free(err)
 
 
+cdef inline object c_err_to_py(line_sender_error* err):
+    """Construct an ``IngressError`` from a C error, which will be freed."""
+    cdef object tup = c_err_to_code_and_msg(err)
+    return IngressError(tup[0], tup[1])
+
+
+cdef inline object c_err_to_py_fmt(line_sender_error* err, str fmt):
+    """Construct an ``IngressError`` from a C error, which will be freed."""
+    cdef object tup = c_err_to_code_and_msg(err)
+    return IngressError(tup[0], fmt.format(tup[1]))
+
+
 cdef bytes str_to_utf8(str string, line_sender_utf8* utf8_out):
     """
     Init the `utf8_out` object from the `string`.
@@ -932,6 +941,11 @@ cdef class Buffer:
     #     raise ValueError('nyi')
 
 
+_FLUSH_FMT = ('{} - See https://py-questdb-client.readthedocs.io/en/'
+    'v1.0.1'
+    '/troubleshooting.html#inspecting-and-debugging-errors#flush-failed')
+
+
 cdef class Sender:
     """
     A sender is a client that inserts rows into QuestDB via the ILP protocol.
@@ -1313,10 +1327,10 @@ cdef class Sender:
         try:
             if clear:
                 if not line_sender_flush(self._impl, c_buf, &err):
-                    raise c_err_to_py(err)
+                    raise c_err_to_py_fmt(err, _FLUSH_FMT)
             else:
                 if not line_sender_flush_and_keep(self._impl, c_buf, &err):
-                    raise c_err_to_py(err)
+                    raise c_err_to_py_fmt(err, _FLUSH_FMT)
         except:
             # Prevent a follow-up call to `.close(flush=True)` (as is usually
             # called from `__exit__`) to raise after the sender entered an error

test/test.py

@@ -327,7 +327,7 @@ def test_auto_flush_on_closed_socket(self):
             with qi.Sender('localhost', server.port, auto_flush=True) as sender:
                 server.accept()
                 server.close()
-                exp_err = 'Could not flush buffer'
+                exp_err = 'Could not flush buffer.* - See https'
                 with self.assertRaisesRegex(qi.IngressError, exp_err):
                     for _ in range(1000):
                         time.sleep(0.01)