mibi88/PythonExtra
1
0
Fork 0
forked from Lephenixnoir/PythonExtra
Code Issues Pull requests Projects Releases Wiki Activity

docs/uio: Document StringIO/BytesIO(alloc_size) constructors.

Browse source
This commit is contained in:
Paul Sokolovsky 2018-09-29 13:23:33 +03:00 committed by Damien George
parent a07e56cbd8
commit 5f7088f84d
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/library/uio.rst
View file

@ -112,3 +112,18 @@ Classes
.. method:: getvalue()
Get the current contents of the underlying buffer which holds data.
.. class:: StringIO(alloc_size)
.. class:: BytesIO(alloc_size)
Create an empty `StringIO`/`BytesIO` object, preallocated to hold up
to *alloc_size* number of bytes. That means that writing that amount
of bytes won't lead to reallocation of the buffer, and thus won't hit
out-of-memory situation or lead to memory fragmentation. These constructors
are a MicroPython extension and are recommended for usage only in special
cases and in system-level libraries, not for end-user applications.
.. admonition:: Difference to CPython
:class: attention
These constructors are a MicroPython extension.