BREAKING CHANGE: buffer expose as bytes instead of str #100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyi
Outdated
| """ | ||
|
|
||
| def __str__(self) -> str: | ||
| """Return the constructed buffer as a string. Use for debugging.""" | ||
| def peek(self) -> bytes: |
There was a problem hiding this comment.
In Python it would be idiomatic to use __bytes__ instead.
amunra
reviewed
Mar 25, 2025
src/questdb/extra_cpython.pxd
Outdated
Comment on lines
30
to
32
| # Ditto, see comment on why not returning a `PyObject` above. | ||
| object PyBytes_FromStringAndSize( | ||
| const char* u, Py_ssize_t size) |
There was a problem hiding this comment.
Remove.
This is already defined in the cython standard lib correctly.
See: https://github.com/cython/cython/blob/master/Cython/Includes/cpython/bytes.pxd where it defines:
bytes PyBytes_FromStringAndSize(char *v, Py_ssize_t len)Usage within ingress.pyx would be something like:
from cpython.bytes cimport PyBytes_FromStringAndSize
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyi
Outdated
| @@ -345,11 +345,11 @@ class Buffer: | |||
| """ | |||
| The current number of bytes currently in the buffer. | |||
|
|
|||
| Equivalent (but cheaper) to ``len(str(sender))``. | |||
| Equivalent (but cheaper) to ``len(buffer.peek())``. | |||
There was a problem hiding this comment.
Update docs to to len(bytes(buffer)).
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyi
Outdated
| """ | ||
|
|
||
| def __str__(self) -> str: | ||
| """Return the constructed buffer as a string. Use for debugging.""" | ||
| def peek(self) -> bytes: |
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyi
Outdated
|
|
||
| Also see :func:`Sender.__len__`. | ||
| Equivalent (but cheaper) to ``len(sender.peek())``. |
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyi
Outdated
| """ | ||
|
|
||
| def __len__(self) -> int: | ||
| def peek(self) -> bytes: |
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyx
Outdated
| @@ -825,18 +825,20 @@ cdef class Buffer: | |||
| """ | |||
| The current number of bytes currently in the buffer. | |||
|
|
|||
| Equivalent (but cheaper) to ``len(str(sender))``. | |||
| Equivalent (but cheaper) to ``len(buffer.peek())``. | |||
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyx
Outdated
| """ | ||
| return line_sender_buffer_size(self._impl) | ||
|
|
||
| def __str__(self) -> str: | ||
| def peek(self) -> bytes: |
amunra
reviewed
Mar 25, 2025
src/questdb/ingress.pyx
Outdated
| return PyUnicode_FromStringAndSize(utf8, <Py_ssize_t>size) | ||
| cdef inline object _to_bytes(self): | ||
| cdef line_sender_buffer_view view = line_sender_buffer_peek(self._impl) | ||
| if view.len: |
There was a problem hiding this comment.
The if statement is redundant here I think. Impl:
PyObject *
PyBytes_FromStringAndSize(const char *str, Py_ssize_t size)
{
PyBytesObject *op;
if (size < 0) {
PyErr_SetString(PyExc_SystemError,
"Negative size passed to PyBytes_FromStringAndSize");
return NULL;
}
if (size == 1 && str != NULL) {
op = CHARACTER(*str & 255);
assert(_Py_IsImmortal(op));
return (PyObject *)op;
}
if (size == 0) {
return bytes_get_empty(); // <<<<<<<<<<<<<<<<<<<
}
...There was a problem hiding this comment.
Yes, PyBytes_FromStringAndSize handles the <= 0 case.
|
CI needs a tweak as well: I suspect |
Yeah, macOS-12 has been moved |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE: buffer expose as bytes instead of str