/
usr
/
share
/
doc
/
python3-docs
/
html
/
c-api
/
/usr/share/doc/python3-docs/html/c-api
mkdir
upload
Name
Size
Mode
Actions
abstract.html
9716
0644
edit
dl
rm
allocation.html
14728
0644
edit
dl
rm
apiabiversion.html
10681
0644
edit
dl
rm
arg.html
89735
0644
edit
dl
rm
bool.html
10333
0644
edit
dl
rm
buffer.html
64150
0644
edit
dl
rm
bytearray.html
15098
0644
edit
dl
rm
bytes.html
25487
0644
edit
dl
rm
capsule.html
21699
0644
edit
dl
rm
cell.html
11942
0644
edit
dl
rm
code.html
12388
0644
edit
dl
rm
codec.html
22641
0644
edit
dl
rm
complex.html
21268
0644
edit
dl
rm
concrete.html
17602
0644
edit
dl
rm
conversion.html
19525
0644
edit
dl
rm
coro.html
9452
0644
edit
dl
rm
datetime.html
26513
0644
edit
dl
rm
descriptor.html
11959
0644
edit
dl
rm
dict.html
35244
0644
edit
dl
rm
exceptions.html
128414
0644
edit
dl
rm
file.html
14544
0644
edit
dl
rm
float.html
15155
0644
edit
dl
rm
function.html
18215
0644
edit
dl
rm
gcsupport.html
23787
0644
edit
dl
rm
gen.html
10939
0644
edit
dl
rm
import.html
42920
0644
edit
dl
rm
index.html
15759
0644
edit
dl
rm
init.html
116862
0644
edit
dl
rm
intro.html
68136
0644
edit
dl
rm
iter.html
10062
0644
edit
dl
rm
iterator.html
11928
0644
edit
dl
rm
list.html
22504
0644
edit
dl
rm
long.html
44839
0644
edit
dl
rm
mapping.html
17524
0644
edit
dl
rm
marshal.html
16935
0644
edit
dl
rm
memory.html
58531
0644
edit
dl
rm
memoryview.html
13510
0644
edit
dl
rm
method.html
17051
0644
edit
dl
rm
module.html
56821
0644
edit
dl
rm
none.html
8755
0644
edit
dl
rm
number.html
44801
0644
edit
dl
rm
objbuffer.html
12624
0644
edit
dl
rm
object.html
60861
0644
edit
dl
rm
objimpl.html
8087
0644
edit
dl
rm
refcounting.html
13454
0644
edit
dl
rm
reflection.html
11189
0644
edit
dl
rm
sequence.html
28925
0644
edit
dl
rm
set.html
31197
0644
edit
dl
rm
slice.html
13459
0644
edit
dl
rm
stable.html
9193
0644
edit
dl
rm
structures.html
37151
0644
edit
dl
rm
sys.html
35639
0644
edit
dl
rm
tuple.html
30022
0644
edit
dl
rm
type.html
18813
0644
edit
dl
rm
typeobj.html
164125
0644
edit
dl
rm
unicode.html
188046
0644
edit
dl
rm
utilities.html
8966
0644
edit
dl
rm
veryhigh.html
54572
0644
edit
dl
rm
weakref.html
13615
0644
edit
dl
rm
Edit:
/usr/share/doc/python3-docs/html/c-api/bytearray.html
(15098B)
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Byte Array Objects — Python 3.6.7 documentation</title> <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 3.6.7 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="Unicode Objects and Codecs" href="unicode.html" /> <link rel="prev" title="Bytes Objects" href="bytes.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/3/c-api/bytearray.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="unicode.html" title="Unicode Objects and Codecs" accesskey="N">next</a> |</li> <li class="right" > <a href="bytes.html" title="Bytes Objects" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">3.6.7 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> »</li> <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li> <li class="right"> <div class="inline-search" style="display: none" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('.inline-search').show(0);</script> | </li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="byte-array-objects"> <span id="bytearrayobjects"></span><h1>Byte Array Objects<a class="headerlink" href="#byte-array-objects" title="Permalink to this headline">¶</a></h1> <span class="target" id="index-0"></span><dl class="type"> <dt id="c.PyByteArrayObject"> <code class="descname">PyByteArrayObject</code><a class="headerlink" href="#c.PyByteArrayObject" title="Permalink to this definition">¶</a></dt> <dd><p>This subtype of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyObject</span></code></a> represents a Python bytearray object.</p> </dd></dl> <dl class="var"> <dt id="c.PyByteArray_Type"> <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> <code class="descname">PyByteArray_Type</code><a class="headerlink" href="#c.PyByteArray_Type" title="Permalink to this definition">¶</a></dt> <dd><p>This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyTypeObject</span></code></a> represents the Python bytearray type; it is the same object as <a class="reference internal" href="../library/stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> in the Python layer.</p> </dd></dl> <div class="section" id="type-check-macros"> <h2>Type check macros<a class="headerlink" href="#type-check-macros" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="c.PyByteArray_Check"> int <code class="descname">PyByteArray_Check</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *o</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_Check" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the object <em>o</em> is a bytearray object or an instance of a subtype of the bytearray type.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_CheckExact"> int <code class="descname">PyByteArray_CheckExact</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *o</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_CheckExact" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the object <em>o</em> is a bytearray object, but not an instance of a subtype of the bytearray type.</p> </dd></dl> </div> <div class="section" id="direct-api-functions"> <h2>Direct API functions<a class="headerlink" href="#direct-api-functions" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="c.PyByteArray_FromObject"> <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyByteArray_FromObject</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *o</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_FromObject" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new bytearray object from any object, <em>o</em>, that implements the <a class="reference internal" href="buffer.html#bufferobjects"><span class="std std-ref">buffer protocol</span></a>.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_FromStringAndSize"> <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyByteArray_FromStringAndSize</code><span class="sig-paren">(</span>const char<em> *string</em>, Py_ssize_t<em> len</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_FromStringAndSize" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new bytearray object from <em>string</em> and its length, <em>len</em>. On failure, <em>NULL</em> is returned.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_Concat"> <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyByteArray_Concat</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *a</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *b</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_Concat" title="Permalink to this definition">¶</a></dt> <dd><p>Concat bytearrays <em>a</em> and <em>b</em> and return a new bytearray with the result.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_Size"> Py_ssize_t <code class="descname">PyByteArray_Size</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *bytearray</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_Size" title="Permalink to this definition">¶</a></dt> <dd><p>Return the size of <em>bytearray</em> after checking for a <em>NULL</em> pointer.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_AsString"> char* <code class="descname">PyByteArray_AsString</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *bytearray</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_AsString" title="Permalink to this definition">¶</a></dt> <dd><p>Return the contents of <em>bytearray</em> as a char array after checking for a <em>NULL</em> pointer. The returned array always has an extra null byte appended.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_Resize"> int <code class="descname">PyByteArray_Resize</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *bytearray</em>, Py_ssize_t<em> len</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_Resize" title="Permalink to this definition">¶</a></dt> <dd><p>Resize the internal buffer of <em>bytearray</em> to <em>len</em>.</p> </dd></dl> </div> <div class="section" id="macros"> <h2>Macros<a class="headerlink" href="#macros" title="Permalink to this headline">¶</a></h2> <p>These macros trade safety for speed and they don’t check pointers.</p> <dl class="function"> <dt id="c.PyByteArray_AS_STRING"> char* <code class="descname">PyByteArray_AS_STRING</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *bytearray</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_AS_STRING" title="Permalink to this definition">¶</a></dt> <dd><p>Macro version of <a class="reference internal" href="#c.PyByteArray_AsString" title="PyByteArray_AsString"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyByteArray_AsString()</span></code></a>.</p> </dd></dl> <dl class="function"> <dt id="c.PyByteArray_GET_SIZE"> Py_ssize_t <code class="descname">PyByteArray_GET_SIZE</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *bytearray</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyByteArray_GET_SIZE" title="Permalink to this definition">¶</a></dt> <dd><p>Macro version of <a class="reference internal" href="#c.PyByteArray_Size" title="PyByteArray_Size"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyByteArray_Size()</span></code></a>.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Byte Array Objects</a><ul> <li><a class="reference internal" href="#type-check-macros">Type check macros</a></li> <li><a class="reference internal" href="#direct-api-functions">Direct API functions</a></li> <li><a class="reference internal" href="#macros">Macros</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="bytes.html" title="previous chapter">Bytes Objects</a></p> <h4>Next topic</h4> <p class="topless"><a href="unicode.html" title="next chapter">Unicode Objects and Codecs</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li> <a href="https://github.com/python/cpython/blob/3.6/Doc/c-api/bytearray.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="unicode.html" title="Unicode Objects and Codecs" >next</a> |</li> <li class="right" > <a href="bytes.html" title="Bytes Objects" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">3.6.7 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> »</li> <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> »</li> <li class="right"> <div class="inline-search" style="display: none" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('.inline-search').show(0);</script> | </li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Dec 18, 2023. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Save
cmd:
run