summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/buffer.rst
Commit message (Collapse)AuthorAgeFilesLines
* gh-107298: Fix C API Buffer documentation (#108011)Victor Stinner2023-08-161-9/+13
|
* Docs: Document PyBUF_MAX_NDIM (#107865)Erlend E. Aasland2023-08-111-3/+7
|
* gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)Eric Snow2023-08-071-2/+5
| | | | | PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
* gh-107298: Fix Sphinx warnings in the C API doc (#107302)Victor Stinner2023-07-261-1/+1
| | | | * Update Doc/tools/.nitignore * Fix BufferedIOBase.write() link in buffer.rst
* gh-107091: Fix the use of some C domain roles (#107092)Serhiy Storchaka2023-07-231-2/+2
|
* gh-102383: [docs] Arguments of `PyObject_CopyData` are `PyObject *` (#102390)Nikita Sobolev2023-03-031-1/+1
|
* Fix types in buffer/memoryview docs (#98118)da-woods2022-10-101-1/+1
| | | | | | | | The definition of obj in the `Py_buffer` struct is as a PyObject* https://github.com/python/cpython/blob/ec091bd47e2f968b0d1631b9a8104283a7beeb1b/Include/pybuffer.h#L22 PyMemoryView_GET_BASE returns `.obj` - thus its return type should be a PyObject* (or at least a void*). It definitely doesn't return `Py_buffer`
* bpo-45459: Add Py_buffer to limited API (GH-29991)Christian Heimes2022-02-021-0/+7
| | | | | | | | | | | - [x] ``Py_buffer`` struct - [x] ``PyBuffer_*()`` API functions - [x] ``PyBUF_*`` constants - [x] ``Py_bf_getbuffer`` and ``Py_bf_releasebuffer`` type slots - [x] ``PyMemoryView_FromBuffer()`` API - [x] tests for limited API - [x] ``make regen-limited-abi`` - [x] documentation update - [ ] export ``PyPickleBuffer*()`` API ???
* bpo-46140: take more Py_buffer arguments as const * (GH-30217)David Hewitt2021-12-221-4/+4
|
* bpo-40204, doc: Fix syntax of C variables (GH-21846)Victor Stinner2020-08-131-13/+13
| | | | | | | | | | | | | | | For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3.
* bpo-40204: Fix duplicates in the documentation (GH-21857)Victor Stinner2020-08-131-1/+1
| | | | | | | | | Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'.
* bpo-38600: NULL -> ``NULL``. (GH-17001)Serhiy Storchaka2019-10-301-4/+4
| | | Also fix some other formatting.
* bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950)Serhiy Storchaka2019-10-301-11/+11
| | | | Replace all *NULL* with ``NULL``.
* bpo-37698: Update doc of PyBuffer_ToContiguous (GH-14992)Hai Shi2019-09-111-2/+2
| | | https://bugs.python.org/issue37698
* bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988)Hai Shi2019-09-111-0/+7
| | | | | | | https://bugs.python.org/issue37750 Automerge-Triggered-By: @matrixise
* Unmark files as executable that can't actually be executed. (GH-15353)Greg Price2019-08-211-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | There are plenty of legitimate scripts in the tree that begin with a `#!`, but also a few that seem to be marked executable by mistake. Found them with this command -- it gets executable files known to Git, filters to the ones that don't start with a `#!`, and then unmarks them as executable: $ git ls-files --stage \ | perl -lane 'print $F[3] if (!/^100644/)' \ | while read f; do head -c2 "$f" | grep -qxF '#!' \ || chmod a-x "$f"; \ done Looking at the list by hand confirms that we didn't sweep up any files that should have the executable bit after all. In particular * The `.psd` files are images from Photoshop. * The `.bat` files sure look like things that can be run. But we have lots of other `.bat` files, and they don't have this bit set, so it must not be needed for them. Automerge-Triggered-By: @benjaminp
* bpo-15913: Implement PyBuffer_SizeFromFormat() (GH-13873)Joannah Nanjekye2019-08-201-2/+4
| | | | Implement PyBuffer_SizeFromFormat() function (previously documented but not implemented): call struct.calcsize().
* bpo-34101: Add doc of PyBuffer_GetPointer (GH-14994)Hai Shi2019-07-311-0/+6
|
* Docs: Correct formatting of a multiline code block (GH-13806)Joseph Fox-Rabinovitz2019-07-171-2/+4
|
* Doc: Replace the deprecated highlightlang directive by highlight. (#13377)Stéphane Wirtel2019-05-171-1/+1
| | | | highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
* bpo-35461: Document C API functions which suppress exceptions. (GH-11119)Serhiy Storchaka2018-12-181-2/+2
|
* Correct a couple of unbalanced parenthesis. (GH-10779)Andre Delfino2018-12-051-1/+1
|
* bpo-33126: Document PyBuffer_ToContiguous() (#6292)Antoine Pitrou2018-03-281-3/+9
|
* bpo-31754: Fix type of 'itemsize' in PyBuffer_FillContiguousStrides (GH-3993)vyas452017-10-151-1/+1
|
* Issue #28496: Mark up constants 0, 1 and -1 that denote return values orSerhiy Storchaka2016-10-271-6/+6
| | | | special input values as literal text.
* Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5Martin Panter2015-11-021-1/+1
|\
| * Issue #25523: Correct "a" article to "an" articleMartin Panter2015-11-021-1/+1
| | | | | | | | | | | | This changes the main documentation, doc strings, source code comments, and a couple error messages in the test suite. In some cases the word was removed or edited some other way to fix the grammar.
* | merge 3.4 (#24883)Benjamin Peterson2015-08-181-4/+4
|\ \ | |/
| * 'Py_Buffer' should be 'Py_buffer' (closes #24883)Benjamin Peterson2015-08-181-4/+4
| |
| * Whitespace.Stefan Krah2015-02-011-1/+1
| |
* | Issue #23756: Clarify the terms "contiguous" and "bytes-like object".Stefan Krah2015-08-081-6/+9
| | | | | | | | Patch by Martin Panter.
* | Whitespace.Stefan Krah2015-02-011-1/+1
|/
* Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsetsStefan Krah2015-02-011-0/+3
| | | | are required.
* Issue #21778: Clarify use of flags if PyBuffer_FillInfo() is used inside aStefan Krah2014-06-291-2/+2
| | | | getbufferproc().
* Closes #21441: Reorder elements in documentation to match actual order in ↵Jesus Cea2014-06-251-10/+10
| | | | the code
* Closes #4159: add LaTeX tabular column specifications to tables that ↵Georg Brandl2013-03-281-1/+4
| | | | otherwise are cut off or have overlapping text.
* Improve str() and object.__str__() documentation (issue #13538).Chris Jerdonek2012-11-211-5/+7
|
* Issue #14181: Improve clarity in the documentation for the multi-purposeStefan Krah2012-03-061-6/+14
| | | | Py_buffer.obj field.
* - Issue #10181: New memoryview implementation fixes multiple ownershipStefan Krah2012-02-251-164/+321
| | | | | | | | | | | | | | | | | | and lifetime issues of dynamically allocated Py_buffer members (#9990) as well as crashes (#8305, #7433). Many new features have been added (See whatsnew/3.3), and the documentation has been updated extensively. The ndarray test object from _testbuffer.c implements all aspects of PEP-3118, so further development towards the complete implementation of the PEP can proceed in a test-driven manner. Thanks to Nick Coghlan, Antoine Pitrou and Pauli Virtanen for review and many ideas. - Issue #12834: Fix incorrect results of memoryview.tobytes() for non-contiguous arrays. - Issue #5231: Introduce memoryview.cast() method that allows changing format and shape without making a copy of the underlying memory.
* #12072: merge with 3.1.Ezio Melotti2011-05-201-1/+1
|\
| * #12072: add missing parenthesis in the doc. Patch by Sandro Tosi.Ezio Melotti2011-05-201-1/+1
| |
* | Remove documentation to non-existent function PyObject_CopyToObject (fixes ↵Antoine Pitrou2011-03-131-14/+0
|\ \ | |/ | | | | #11478)
| * Remove documentation to non-existent function PyObject_CopyToObject (fixes ↵Antoine Pitrou2011-03-131-14/+0
| | | | | | | | #11478)
| * Merged revisions 87188-87190,87192-87194 via svnmerge fromAntoine Pitrou2010-12-121-15/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r87188 | antoine.pitrou | 2010-12-12 19:25:25 +0100 (dim., 12 déc. 2010) | 3 lines Make this a warning and fix indentation ........ r87189 | antoine.pitrou | 2010-12-12 20:59:47 +0100 (dim., 12 déc. 2010) | 3 lines Better explain the buffer interface (hopefully) ........ r87190 | antoine.pitrou | 2010-12-12 21:01:43 +0100 (dim., 12 déc. 2010) | 3 lines Add link to the buffer protocol description from the memory description. ........ r87192 | antoine.pitrou | 2010-12-12 21:09:18 +0100 (dim., 12 déc. 2010) | 3 lines Remove redundant sentence, and fix markup ........ r87193 | antoine.pitrou | 2010-12-12 21:13:31 +0100 (dim., 12 déc. 2010) | 3 lines Fix heading level ........ r87194 | antoine.pitrou | 2010-12-12 21:17:29 +0100 (dim., 12 déc. 2010) | 3 lines Consistent ordering of availability statements ........
| * Merged revisions 76923,76926,77009,77082-77083,77085,77087,77121 via ↵Georg Brandl2010-10-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | svnmerge from svn+ssh://svn.python.org/python/branches/py3k ................ r76923 | georg.brandl | 2009-12-20 15:24:06 +0100 (So, 20 Dez 2009) | 1 line #7493: more review fixes. ................ r76926 | georg.brandl | 2009-12-20 15:38:23 +0100 (So, 20 Dez 2009) | 9 lines Recorded merge of revisions 76925 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r76925 | georg.brandl | 2009-12-20 15:33:20 +0100 (So, 20 Dez 2009) | 1 line #7381: subprocess documentation and library docstring consistency fixes. ........ ................ r77009 | georg.brandl | 2009-12-23 11:30:45 +0100 (Mi, 23 Dez 2009) | 1 line #7417: add signature to open() docstring. ................ r77082 | georg.brandl | 2009-12-28 08:59:20 +0100 (Mo, 28 Dez 2009) | 1 line #7577: fix signature info for getbufferproc. ................ r77083 | georg.brandl | 2009-12-28 09:00:47 +0100 (Mo, 28 Dez 2009) | 9 lines Merged revisions 77081 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r77081 | georg.brandl | 2009-12-28 08:59:05 +0100 (Mo, 28 Dez 2009) | 1 line #7577: fix signature of PyBuffer_FillInfo(). ........ ................ r77085 | georg.brandl | 2009-12-28 09:02:38 +0100 (Mo, 28 Dez 2009) | 9 lines Merged revisions 77084 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r77084 | georg.brandl | 2009-12-28 09:01:59 +0100 (Mo, 28 Dez 2009) | 1 line #7586: fix typo. ........ ................ r77087 | georg.brandl | 2009-12-28 09:10:38 +0100 (Mo, 28 Dez 2009) | 9 lines Recorded merge of revisions 77086 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r77086 | georg.brandl | 2009-12-28 09:09:32 +0100 (Mo, 28 Dez 2009) | 1 line #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. ........ ................ r77121 | georg.brandl | 2009-12-29 22:38:35 +0100 (Di, 29 Dez 2009) | 1 line #7590: exception classes no longer are in the "exceptions" module. Also clean up text that was written with string exceptions in mind. ................
| * Work around a bug in Sphinx 0.6.x.Georg Brandl2010-10-061-2/+4
| |
| * Merged revisions 85132 via svnmerge fromGeorg Brandl2010-10-011-92/+90
| | | | | | | | | | | | | | | | | | | | svn+ssh://svn.python.org/python/branches/py3k ........ r85132 | georg.brandl | 2010-10-01 07:38:10 +0200 (Fr, 01 Okt 2010) | 1 line Fix weird markup that caused latex to fail. ........
| * Merged revisions 85084 via svnmerge fromAntoine Pitrou2010-09-291-48/+2
| | | | | | | | | | | | | | | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r85084 | antoine.pitrou | 2010-09-29 01:59:51 +0200 (mer., 29 sept. 2010) | 5 lines Give a dedicated page to memoryview objects, so that they can be part of the concrete objects layer, while the buffer protocol is part of the abstract objects layer. ........
| * Merged revisions 85082 via svnmerge fromAntoine Pitrou2010-09-281-13/+14
| | | | | | | | | | | | | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r85082 | antoine.pitrou | 2010-09-29 01:39:41 +0200 (mer., 29 sept. 2010) | 4 lines Buffers are not sequence objects (!). Put them in the abstract objects layers instead. ........
| * Merged revisions 85080 via svnmerge fromAntoine Pitrou2010-09-281-47/+82
| | | | | | | | | | | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r85080 | antoine.pitrou | 2010-09-29 01:04:04 +0200 (mer., 29 sept. 2010) | 3 lines Various improvements to the docs of the buffer API ........
generated by cgit v0.12 at 2025-02-28 13:08:06 (GMT)