Skip to content

gh-102500: Document PEP 688 #102571

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
JelleZijlstra merged 10 commits into from
May 4, 2023
Merged

gh-102500: Document PEP 688 #102571

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d55ca46
Document PEP 688
JelleZijlstra Mar 10, 2023
c64c546
Improvements
JelleZijlstra Mar 10, 2023
f561ddf
No flags argument to memoryview
JelleZijlstra Mar 11, 2023
14f9c43
Apply suggestions by Hugo
JelleZijlstra Mar 15, 2023
ebe51b5
Update Doc/library/inspect.rst
JelleZijlstra Mar 15, 2023
f30d3fc
Merge branch 'main' into pep688docs
JelleZijlstra Apr 13, 2023
d60c477
Merge branch 'main' into pep688docs
JelleZijlstra Apr 25, 2023
2313ac0
Merge branch 'main' into pep688docs
hauntsaninja Apr 28, 2023
050a2d4
Merge branch 'main' into pep688docs
JelleZijlstra May 4, 2023
647aa35
remove weird sentence
JelleZijlstra May 4, 2023
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
Prev Previous commit
Next Next commit
No flags argument to memoryview
  • Loading branch information
@JelleZijlstra
JelleZijlstra committed Mar 11, 2023
commit f561ddf8871391ca2d161434213787f6463faa02
2 changes: 1 addition & 1 deletion Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1070,7 +1070,7 @@ are always available. They are listed here in alphabetical order.


.. _func-memoryview:
.. class:: memoryview(object, *, flags=BufferFlags.FULL_RO)
.. class:: memoryview(object)
:noindex:

Return a "memory view" object created from the given argument. See
Expand Down
14 changes: 1 addition & 13 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3704,7 +3704,7 @@ Memory Views
of an object that supports the :ref:`buffer protocol <bufferobjects>` without
copying.

.. class:: memoryview(object, *, flags=BufferFlags.FULL_RO)
.. class:: memoryview(object)

Create a :class:`memoryview` that references *object*. *object* must
support the buffer protocol. Built-in objects that support the buffer
Expand Down Expand Up @@ -3789,15 +3789,6 @@ copying.
>>> hash(v[::-2]) == hash(b'abcefg'[::-2])
True

The optional ``flags`` can be used to control the :class:`inspect.BufferFlags <buffer flags>`
passed to the underlying buffer. For example::

>>> import inspect
>>> v = memoryview(b"x", flags=inspect.BufferFlags.WRITABLE)
...
BufferError: Object is not writable.
>>> v = memoryview(b"x", flags=inspect.BufferFlags.SIMPLE)

.. versionchanged:: 3.3
One-dimensional memoryviews can now be sliced.
One-dimensional memoryviews with formats 'B', 'b' or 'c' are now :term:`hashable`.
Expand All @@ -3809,9 +3800,6 @@ copying.
.. versionchanged:: 3.5
memoryviews can now be indexed with tuple of integers.

.. versionchanged:: 3.12
Added the ``flags`` argument.

:class:`memoryview` has several methods:

.. method:: __eq__(exporter)
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.12.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ are now usable as buffer types.

The new :class:`collections.abc.Buffer` ABC provides a standard
way to represent buffer objects, for example in type annotations.
:class:`memoryview` has a new ``flags`` argument to control the flags
(:class:`inspect.BufferFlags`) passed to the underlying buffer.
The new :class:`inspect.BufferFlags` enum represents the flags that
can be used to customize buffer creation.
(Contributed by Jelle Zijlstra in :gh:`102500`.)

Other Language Changes
Expand Down