Skip to content

Commit

Permalink
Deploying to gh-pages from @ a850336 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
rockleona committed Jan 26, 2024
1 parent ffe33e2 commit f8020c5
Show file tree
Hide file tree
Showing 563 changed files with 1,852 additions and 1,418 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 22b93d79a6e2b655281e07781f03cbb7
config: 5ed0fcad641de016763490be4730d71e
tags: 645f666f9bcd5a90fca523b33c5a78b7
19 changes: 10 additions & 9 deletions _sources/c-api/structures.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -551,11 +551,11 @@ The following flags can be used with :c:member:`PyMemberDef.flags`:
from ``PyObject``.
Can only be used as part of :c:member:`Py_tp_members <PyTypeObject.tp_members>`
:c:type:`slot <PyTypeSlot>` when creating a class using negative
:c:type:`slot <PyType_Slot>` when creating a class using negative
:c:member:`~PyType_Spec.basicsize`.
It is mandatory in that case.
This flag is only used in :c:type:`PyTypeSlot`.
This flag is only used in :c:type:`PyType_Slot`.
When setting :c:member:`~PyTypeObject.tp_members` during
class creation, Python clears it and sets
:c:member:`PyMemberDef.offset` to the offset from the ``PyObject`` struct.
Expand Down Expand Up @@ -693,7 +693,8 @@ Defining Getters and Setters
.. c:member:: setter set
Optional C function to set or delete the attribute, if omitted the attribute is readonly.
Optional C function to set or delete the attribute.
If ``NULL``, the attribute is read-only.
.. c:member:: const char* doc
Expand All @@ -703,18 +704,18 @@ Defining Getters and Setters
Optional function pointer, providing additional data for getter and setter.
The ``get`` function takes one :c:expr:`PyObject*` parameter (the
instance) and a function pointer (the associated ``closure``)::
.. c:type:: PyObject *(*getter)(PyObject *, void *)
typedef PyObject *(*getter)(PyObject *, void *);
The ``get`` function takes one :c:expr:`PyObject*` parameter (the
instance) and a function pointer (the associated ``closure``):
It should return a new reference on success or ``NULL`` with a set exception
on failure.
``set`` functions take two :c:expr:`PyObject*` parameters (the instance and
the value to be set) and a function pointer (the associated ``closure``)::
.. c:type:: int (*setter)(PyObject *, PyObject *, void *)
typedef int (*setter)(PyObject *, PyObject *, void *);
``set`` functions take two :c:expr:`PyObject*` parameters (the instance and
the value to be set) and a function pointer (the associated ``closure``):
In case the attribute should be deleted the second parameter is ``NULL``.
Should return ``0`` on success or ``-1`` with a set exception on failure.
4 changes: 2 additions & 2 deletions _sources/library/argparse.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1936,8 +1936,8 @@ FileType objects
>>> parser.parse_args(['-'])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)

.. versionadded:: 3.4
The *encodings* and *errors* keyword arguments.
.. versionchanged:: 3.4
Added the *encodings* and *errors* parameters.


Argument groups
Expand Down
4 changes: 2 additions & 2 deletions _sources/library/asyncio-stream.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ and work with streams:
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.

.. versionadded:: 3.8
Added *happy_eyeballs_delay* and *interleave* parameters.
.. versionchanged:: 3.8
Added the *happy_eyeballs_delay* and *interleave* parameters.

.. versionchanged:: 3.10
Removed the *loop* parameter.
Expand Down
33 changes: 16 additions & 17 deletions _sources/library/asyncio-task.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -825,23 +825,22 @@ Waiting Primitives
*return_when* indicates when this function should return. It must
be one of the following constants:

.. tabularcolumns:: |l|L|

+-----------------------------+----------------------------------------+
| Constant | Description |
+=============================+========================================+
| :const:`FIRST_COMPLETED` | The function will return when any |
| | future finishes or is cancelled. |
+-----------------------------+----------------------------------------+
| :const:`FIRST_EXCEPTION` | The function will return when any |
| | future finishes by raising an |
| | exception. If no future raises an |
| | exception then it is equivalent to |
| | :const:`ALL_COMPLETED`. |
+-----------------------------+----------------------------------------+
| :const:`ALL_COMPLETED` | The function will return when all |
| | futures finish or are cancelled. |
+-----------------------------+----------------------------------------+
.. list-table::
:header-rows: 1

* - Constant
- Description

* - .. data:: FIRST_COMPLETED
- The function will return when any future finishes or is cancelled.

* - .. data:: FIRST_EXCEPTION
- The function will return when any future finishes by raising an
exception. If no future raises an exception
then it is equivalent to :const:`ALL_COMPLETED`.

* - .. data:: ALL_COMPLETED
- The function will return when all futures finish or are cancelled.

Unlike :func:`~asyncio.wait_for`, ``wait()`` does not cancel the
futures when a timeout occurs.
Expand Down
4 changes: 2 additions & 2 deletions _sources/library/bdb.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ The :mod:`bdb` module also defines two classes:
frame is considered to originate in a certain module is determined
by the ``__name__`` in the frame globals.

.. versionadded:: 3.1
The *skip* argument.
.. versionchanged:: 3.1
Added the *skip* parameter.

The following methods of :class:`Bdb` normally don't need to be overridden.

Expand Down
46 changes: 24 additions & 22 deletions _sources/library/concurrent.futures.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ And::
should be higher than the number of workers
for :class:`ProcessPoolExecutor`.

.. versionadded:: 3.6
The *thread_name_prefix* argument was added to allow users to
.. versionchanged:: 3.6
Added the *thread_name_prefix* parameter to allow users to
control the :class:`threading.Thread` names for worker threads created by
the pool for easier debugging.

Expand Down Expand Up @@ -271,7 +271,8 @@ to a :class:`ProcessPoolExecutor` will result in deadlock.

.. versionchanged:: 3.3
When one of the worker processes terminates abruptly, a
:exc:`BrokenProcessPool` error is now raised. Previously, behaviour
:exc:`~concurrent.futures.process.BrokenProcessPool` error is now raised.
Previously, behaviour
was undefined but operations on the executor or its futures would often
freeze or deadlock.

Expand Down Expand Up @@ -485,23 +486,22 @@ Module Functions
*return_when* indicates when this function should return. It must be one of
the following constants:

.. tabularcolumns:: |l|L|

+-----------------------------+----------------------------------------+
| Constant | Description |
+=============================+========================================+
| :const:`FIRST_COMPLETED` | The function will return when any |
| | future finishes or is cancelled. |
+-----------------------------+----------------------------------------+
| :const:`FIRST_EXCEPTION` | The function will return when any |
| | future finishes by raising an |
| | exception. If no future raises an |
| | exception then it is equivalent to |
| | :const:`ALL_COMPLETED`. |
+-----------------------------+----------------------------------------+
| :const:`ALL_COMPLETED` | The function will return when all |
| | futures finish or are cancelled. |
+-----------------------------+----------------------------------------+
.. list-table::
:header-rows: 1

* - Constant
- Description

* - .. data:: FIRST_COMPLETED
- The function will return when any future finishes or is cancelled.

* - .. data:: FIRST_EXCEPTION
- The function will return when any future finishes by raising an
exception. If no future raises an exception
then it is equivalent to :const:`ALL_COMPLETED`.

* - .. data:: ALL_COMPLETED
- The function will return when all futures finish or are cancelled.

.. function:: as_completed(fs, timeout=None)

Expand Down Expand Up @@ -562,7 +562,8 @@ Exception classes
.. exception:: BrokenThreadPool

Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception
class is raised when one of the workers of a :class:`ThreadPoolExecutor`
class is raised when one of the workers
of a :class:`~concurrent.futures.ThreadPoolExecutor`
has failed initializing.

.. versionadded:: 3.7
Expand All @@ -573,7 +574,8 @@ Exception classes

Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly
:exc:`RuntimeError`), this exception class is raised when one of the
workers of a :class:`ProcessPoolExecutor` has terminated in a non-clean
workers of a :class:`~concurrent.futures.ProcessPoolExecutor`
has terminated in a non-clean
fashion (for example, if it was killed from the outside).

.. versionadded:: 3.3
16 changes: 8 additions & 8 deletions _sources/library/configparser.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1045,14 +1045,14 @@ ConfigParser Objects
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
encoding='cp1250')

.. versionadded:: 3.2
The *encoding* parameter. Previously, all files were read using the
default encoding for :func:`open`.
.. versionchanged:: 3.2
Added the *encoding* parameter.
Previously, all files were read using the default encoding for :func:`open`.

.. versionadded:: 3.6.1
.. versionchanged:: 3.6.1
The *filenames* parameter accepts a :term:`path-like object`.

.. versionadded:: 3.7
.. versionchanged:: 3.7
The *filenames* parameter accepts a :class:`bytes` object.


Expand Down Expand Up @@ -1291,9 +1291,9 @@ Exceptions
that is already present or in strict parsers when a section if found more
than once in a single input file, string or dictionary.

.. versionadded:: 3.2
Optional ``source`` and ``lineno`` attributes and arguments to
:meth:`!__init__` were added.
.. versionchanged:: 3.2
Added the optional *source* and *lineno* attributes and parameters to
:meth:`!__init__`.


.. exception:: DuplicateOptionError
Expand Down
8 changes: 8 additions & 0 deletions _sources/library/contextlib.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,14 @@ Functions and classes provided:
without needing to explicitly close ``page``. Even if an error occurs,
``page.close()`` will be called when the :keyword:`with` block is exited.

.. note::

Most types managing resources support the :term:`context manager` protocol,
which closes *thing* on leaving the :keyword:`with` statement.
As such, :func:`!closing` is most useful for third party types that don't
support context managers.
This example is purely for illustration purposes,
as :func:`~urllib.request.urlopen` would normally be used in a context manager.

.. function:: aclosing(thing)

Expand Down
20 changes: 10 additions & 10 deletions _sources/library/datetime.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -856,8 +856,8 @@ Constructor:

If an argument outside those ranges is given, :exc:`ValueError` is raised.

.. versionadded:: 3.6
Added the ``fold`` argument.
.. versionchanged:: 3.6
Added the *fold* parameter.

Other constructors, all class methods:

Expand Down Expand Up @@ -1252,8 +1252,8 @@ Instance methods:
``tzinfo=None`` can be specified to create a naive datetime from an aware
datetime with no conversion of date and time data.

.. versionadded:: 3.6
Added the ``fold`` argument.
.. versionchanged:: 3.6
Added the *fold* parameter.


.. method:: datetime.astimezone(tz=None)
Expand Down Expand Up @@ -1496,8 +1496,8 @@ Instance methods:
>>> dt.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'

.. versionadded:: 3.6
Added the *timespec* argument.
.. versionchanged:: 3.6
Added the *timespec* parameter.


.. method:: datetime.__str__()
Expand Down Expand Up @@ -1830,8 +1830,8 @@ Instance methods:
``tzinfo=None`` can be specified to create a naive :class:`.time` from an
aware :class:`.time`, without conversion of the time data.

.. versionadded:: 3.6
Added the ``fold`` argument.
.. versionchanged:: 3.6
Added the *fold* parameter.


.. method:: time.isoformat(timespec='auto')
Expand Down Expand Up @@ -1874,8 +1874,8 @@ Instance methods:
>>> dt.isoformat(timespec='auto')
'12:34:56'

.. versionadded:: 3.6
Added the *timespec* argument.
.. versionchanged:: 3.6
Added the *timespec* parameter.


.. method:: time.__str__()
Expand Down
Loading

0 comments on commit f8020c5

Please sign in to comment.