Kaydet (Commit) abdc16ee authored tarafından Éric Araujo's avatar Éric Araujo

Merge 3.3 (#16805)

...@@ -45,6 +45,7 @@ in any early abort case). ...@@ -45,6 +45,7 @@ in any early abort case).
Unless otherwise stated, buffers are not NUL-terminated. Unless otherwise stated, buffers are not NUL-terminated.
.. note:: .. note::
For all ``#`` variants of formats (``s#``, ``y#``, etc.), the type of For all ``#`` variants of formats (``s#``, ``y#``, etc.), the type of
the length argument (int or :c:type:`Py_ssize_t`) is controlled by the length argument (int or :c:type:`Py_ssize_t`) is controlled by
defining the macro :c:macro:`PY_SSIZE_T_CLEAN` before including defining the macro :c:macro:`PY_SSIZE_T_CLEAN` before including
......
...@@ -582,6 +582,7 @@ code, or when embedding the Python interpreter: ...@@ -582,6 +582,7 @@ code, or when embedding the Python interpreter:
.. index:: module: _thread .. index:: module: _thread
.. note:: .. note::
When only the main thread exists, no GIL operations are needed. This is a When only the main thread exists, no GIL operations are needed. This is a
common situation (most Python programs do not use threads), and the lock common situation (most Python programs do not use threads), and the lock
operations slow the interpreter down a bit. Therefore, the lock is not operations slow the interpreter down a bit. Therefore, the lock is not
......
...@@ -513,6 +513,7 @@ For data that is more regular (e.g. a homogeneous list of ints or floats), ...@@ -513,6 +513,7 @@ For data that is more regular (e.g. a homogeneous list of ints or floats),
you can also use the :mod:`array` module. you can also use the :mod:`array` module.
.. note:: .. note::
To read and write binary data, it is mandatory to open the file in To read and write binary data, it is mandatory to open the file in
binary mode (here, passing ``"rb"`` to :func:`open`). If you use binary mode (here, passing ``"rb"`` to :func:`open`). If you use
``"r"`` instead (the default), the file will be open in text mode ``"r"`` instead (the default), the file will be open in text mode
......
...@@ -99,7 +99,9 @@ another rational number, or from a string. ...@@ -99,7 +99,9 @@ another rational number, or from a string.
value of *flt*, which must be a :class:`float`. Beware that value of *flt*, which must be a :class:`float`. Beware that
``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)`` ``Fraction.from_float(0.3)`` is not the same value as ``Fraction(3, 10)``
.. note:: From Python 3.2 onwards, you can also construct a .. note::
From Python 3.2 onwards, you can also construct a
:class:`Fraction` instance directly from a :class:`float`. :class:`Fraction` instance directly from a :class:`float`.
...@@ -108,7 +110,9 @@ another rational number, or from a string. ...@@ -108,7 +110,9 @@ another rational number, or from a string.
This class method constructs a :class:`Fraction` representing the exact This class method constructs a :class:`Fraction` representing the exact
value of *dec*, which must be a :class:`decimal.Decimal` instance. value of *dec*, which must be a :class:`decimal.Decimal` instance.
.. note:: From Python 3.2 onwards, you can also construct a .. note::
From Python 3.2 onwards, you can also construct a
:class:`Fraction` instance directly from a :class:`decimal.Decimal` :class:`Fraction` instance directly from a :class:`decimal.Decimal`
instance. instance.
......
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
-------------- --------------
.. note:: .. note::
The :mod:`getopt` module is a parser for command line options whose API is The :mod:`getopt` module is a parser for command line options whose API is
designed to be familiar to users of the C :c:func:`getopt` function. Users who designed to be familiar to users of the C :c:func:`getopt` function. Users who
are unfamiliar with the C :c:func:`getopt` function or who would like to write are unfamiliar with the C :c:func:`getopt` function or who would like to write
......
...@@ -686,6 +686,7 @@ than raw I/O does. ...@@ -686,6 +686,7 @@ than raw I/O does.
:exc:`UnsupportedOperation`. :exc:`UnsupportedOperation`.
.. warning:: .. warning::
:class:`BufferedRWPair` does not attempt to synchronize accesses to :class:`BufferedRWPair` does not attempt to synchronize accesses to
its underlying raw streams. You should not pass it the same object its underlying raw streams. You should not pass it the same object
as reader and writer; use :class:`BufferedRandom` instead. as reader and writer; use :class:`BufferedRandom` instead.
......
...@@ -148,7 +148,9 @@ in :mod:`logging` itself) and defining handlers which are declared either in ...@@ -148,7 +148,9 @@ in :mod:`logging` itself) and defining handlers which are declared either in
send it to the socket as a string of bytes preceded by a four-byte length send it to the socket as a string of bytes preceded by a four-byte length
string packed in binary using ``struct.pack('>L', n)``. string packed in binary using ``struct.pack('>L', n)``.
.. note:: Because portions of the configuration are passed through .. note::
Because portions of the configuration are passed through
:func:`eval`, use of this function may open its users to a security risk. :func:`eval`, use of this function may open its users to a security risk.
While the function only binds to a socket on ``localhost``, and so does While the function only binds to a socket on ``localhost``, and so does
not accept connections from remote machines, there are scenarios where not accept connections from remote machines, there are scenarios where
...@@ -752,7 +754,9 @@ The ``class`` entry is optional. It indicates the name of the formatter's class ...@@ -752,7 +754,9 @@ The ``class`` entry is optional. It indicates the name of the formatter's class
:class:`~logging.Formatter` can present exception tracebacks in an expanded or :class:`~logging.Formatter` can present exception tracebacks in an expanded or
condensed format. condensed format.
.. note:: Due to the use of :func:`eval` as described above, there are .. note::
Due to the use of :func:`eval` as described above, there are
potential security risks which result from using the :func:`listen` to send potential security risks which result from using the :func:`listen` to send
and receive configurations via sockets. The risks are limited to where and receive configurations via sockets. The risks are limited to where
multiple users with no mutual trust run code on the same machine; see the multiple users with no mutual trust run code on the same machine; see the
......
...@@ -260,7 +260,9 @@ process and user. ...@@ -260,7 +260,9 @@ process and user.
Availability: Unix. Availability: Unix.
.. note:: On Mac OS X, :func:`getgroups` behavior differs somewhat from .. note::
On Mac OS X, :func:`getgroups` behavior differs somewhat from
other Unix platforms. If the Python interpreter was built with a other Unix platforms. If the Python interpreter was built with a
deployment target of :const:`10.5` or earlier, :func:`getgroups` returns deployment target of :const:`10.5` or earlier, :func:`getgroups` returns
the list of effective group ids associated with the current user process; the list of effective group ids associated with the current user process;
......
...@@ -147,6 +147,7 @@ support. ...@@ -147,6 +147,7 @@ support.
*prefix* is a string to output on the front of every module name on output. *prefix* is a string to output on the front of every module name on output.
.. note:: .. note::
Only works for a :term:`finder` which defines an ``iter_modules()`` Only works for a :term:`finder` which defines an ``iter_modules()``
method. This interface is non-standard, so the module also provides method. This interface is non-standard, so the module also provides
implementations for :class:`importlib.machinery.FileFinder` and implementations for :class:`importlib.machinery.FileFinder` and
...@@ -185,6 +186,7 @@ support. ...@@ -185,6 +186,7 @@ support.
walk_packages(ctypes.__path__, ctypes.__name__ + '.') walk_packages(ctypes.__path__, ctypes.__name__ + '.')
.. note:: .. note::
Only works for a :term:`finder` which defines an ``iter_modules()`` Only works for a :term:`finder` which defines an ``iter_modules()``
method. This interface is non-standard, so the module also provides method. This interface is non-standard, so the module also provides
implementations for :class:`importlib.machinery.FileFinder` and implementations for :class:`importlib.machinery.FileFinder` and
......
...@@ -799,6 +799,7 @@ to sockets. ...@@ -799,6 +799,7 @@ to sockets.
:keyword:`with` statement around them. :keyword:`with` statement around them.
.. note:: .. note::
:meth:`close()` releases the resource associated with a connection but :meth:`close()` releases the resource associated with a connection but
does not necessarily close the connection immediately. If you want does not necessarily close the connection immediately. If you want
to close the connection in a timely fashion, call :meth:`shutdown()` to close the connection in a timely fashion, call :meth:`shutdown()`
......
...@@ -818,6 +818,7 @@ SSL sockets also have the following additional methods and attributes: ...@@ -818,6 +818,7 @@ SSL sockets also have the following additional methods and attributes:
'version': 3} 'version': 3}
.. note:: .. note::
To validate a certificate for a particular service, you can use the To validate a certificate for a particular service, you can use the
:func:`match_hostname` function. :func:`match_hostname` function.
......
...@@ -227,7 +227,9 @@ always available. ...@@ -227,7 +227,9 @@ always available.
installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y* installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y*
is the version number of Python, for example ``3.2``. is the version number of Python, for example ``3.2``.
.. note:: If a :ref:`virtual environment <venv-def>` is in effect, this .. note::
If a :ref:`virtual environment <venv-def>` is in effect, this
value will be changed in ``site.py`` to point to the virtual environment. value will be changed in ``site.py`` to point to the virtual environment.
The value for the Python installation will still be available, via The value for the Python installation will still be available, via
:data:`base_exec_prefix`. :data:`base_exec_prefix`.
......
...@@ -199,6 +199,7 @@ The :mod:`test.support` module provides support for Python's regression ...@@ -199,6 +199,7 @@ The :mod:`test.support` module provides support for Python's regression
test suite. test suite.
.. note:: .. note::
:mod:`test.support` is not a public module. It is documented here to help :mod:`test.support` is not a public module. It is documented here to help
Python developers write tests. The API of this module is subject to change Python developers write tests. The API of this module is subject to change
without backwards compatibility concerns between releases. without backwards compatibility concerns between releases.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment