Skip to content

packer: add buf_size option #604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
methane merged 5 commits into from
May 5, 2024
+15 −27
Merged

packer: add buf_size option #604

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
edb61db
Allow users to specify Packer internal buf_size
rtobar Jul 18, 2023
db39717
Merge branch 'main' into bufsize-argument
methane May 5, 2024
fdf5c1c
change default buffer size to 256KiB
methane May 5, 2024
fe30d22
Merge branch 'main' into bufsize-argument
methane May 5, 2024
09825cb
update fallback
methane May 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Allow users to specify Packer internal buf_size 
Giving this flexibility to users means that internal reallocations can
be avoided if the buffer size is good enough, at the expense of
potentially allocating more memory than needed. This, together with
reusing a Packer object, means that multiple serialisations can end up
requiring no memory allocations other than the initial buffer creation,
which can be a big win in some situations.

The default value is still 1MB, making this backwards compatible.

Signed-off-by: Rodrigo Tobar <[email protected]>
  • Loading branch information
@rtobar
rtobar committed Jul 18, 2023
commit edb61db61e6822ebee632b94f6adb281cecdff8e
10 changes: 7 additions & 3 deletions msgpack/_packer.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ cdef class Packer(object):
:param str unicode_errors:
The error handler for encoding unicode. (default: 'strict')
DO NOT USE THIS!! This option is kept for very specific usage.

:param int buf_size:
The size of the internal buffer. (default: 1024 * 1024)
Useful if serialisation size can be correctly estimated,
avoid unnecessary reallocations.
"""
cdef msgpack_packer pk
cdef object _default
Expand All @@ -112,8 +117,7 @@ cdef class Packer(object):
cdef bint autoreset
cdef bint datetime

def __cinit__(self):
cdef int buf_size = 1024*1024
def __cinit__(self, buf_size=1024*1024, **_kwargs):
self.pk.buf = <char*> PyMem_Malloc(buf_size)
if self.pk.buf == NULL:
raise MemoryError("Unable to allocate internal buffer.")
Expand All @@ -122,7 +126,7 @@ cdef class Packer(object):

def __init__(self, *, default=None,
bint use_single_float=False, bint autoreset=True, bint use_bin_type=True,
bint strict_types=False, bint datetime=False, unicode_errors=None):
bint strict_types=False, bint datetime=False, unicode_errors=None, buf_size=1024*1024):
self.use_float = use_single_float
self.strict_types = strict_types
self.autoreset = autoreset
Expand Down