Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions Doc/library/calendar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -710,8 +710,7 @@ The following options are accepted:
.. option:: month

The month of the specified :option:`year` to print the calendar for.
Must be a number between 1 and 12,
and may only be used in text mode.
Must be a number between 1 and 12.
Defaults to printing a calendar for the full year.


Expand Down
33 changes: 20 additions & 13 deletions Doc/library/html.parser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,18 @@
This module defines a class :class:`HTMLParser` which serves as the basis for
parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML.

.. class:: HTMLParser(*, convert_charrefs=True)
.. class:: HTMLParser(*, convert_charrefs=True, scripting=False)

Create a parser instance able to parse invalid markup.

If *convert_charrefs* is ``True`` (the default), all character
references (except the ones in ``script``/``style`` elements) are
If *convert_charrefs* is true (the default), all character
references (except the ones in elements like ``script`` and ``style``) are
automatically converted to the corresponding Unicode characters.

If *scripting* is false (the default), the content of the ``noscript``
element is parsed normally; if it's true, it's returned as is without
being parsed.

An :class:`.HTMLParser` instance is fed HTML data and calls handler methods
when start tags, end tags, text, comments, and other markup elements are
encountered. The user should subclass :class:`.HTMLParser` and override its
Expand All @@ -37,6 +41,9 @@ parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML.
.. versionchanged:: 3.5
The default value for argument *convert_charrefs* is now ``True``.

.. versionchanged:: 3.14.1
Added the *scripting* parameter.


Example HTML Parser Application
-------------------------------
Expand Down Expand Up @@ -161,24 +168,24 @@ implementations do nothing (except for :meth:`~HTMLParser.handle_startendtag`):
.. method:: HTMLParser.handle_data(data)

This method is called to process arbitrary data (e.g. text nodes and the
content of ``<script>...</script>`` and ``<style>...</style>``).
content of elements like ``script`` and ``style``).


.. method:: HTMLParser.handle_entityref(name)

This method is called to process a named character reference of the form
``&name;`` (e.g. ``&gt;``), where *name* is a general entity reference
(e.g. ``'gt'``). This method is never called if *convert_charrefs* is
``True``.
(e.g. ``'gt'``).
This method is only called if *convert_charrefs* is false.


.. method:: HTMLParser.handle_charref(name)

This method is called to process decimal and hexadecimal numeric character
references of the form :samp:`&#{NNN};` and :samp:`&#x{NNN};`. For example, the decimal
equivalent for ``&gt;`` is ``&#62;``, whereas the hexadecimal is ``&#x3E;``;
in this case the method will receive ``'62'`` or ``'x3E'``. This method
is never called if *convert_charrefs* is ``True``.
in this case the method will receive ``'62'`` or ``'x3E'``.
This method is only called if *convert_charrefs* is false.


.. method:: HTMLParser.handle_comment(data)
Expand Down Expand Up @@ -292,8 +299,8 @@ Parsing an element with a few attributes and a title:
Data : Python
End tag : h1

The content of ``script`` and ``style`` elements is returned as is, without
further parsing:
The content of elements like ``script`` and ``style`` is returned as is,
without further parsing:

.. doctest::

Expand All @@ -304,10 +311,10 @@ further parsing:
End tag : style

>>> parser.feed('<script type="text/javascript">'
... 'alert("<strong>hello!</strong>");</script>')
... 'alert("<strong>hello! &#9786;</strong>");</script>')
Start tag: script
attr: ('type', 'text/javascript')
Data : alert("<strong>hello!</strong>");
Data : alert("<strong>hello! &#9786;</strong>");
End tag : script

Parsing comments:
Expand Down Expand Up @@ -336,7 +343,7 @@ correct char (note: these 3 references are all equivalent to ``'>'``):

Feeding incomplete chunks to :meth:`~HTMLParser.feed` works, but
:meth:`~HTMLParser.handle_data` might be called more than once
(unless *convert_charrefs* is set to ``True``):
if *convert_charrefs* is false:

.. doctest::

Expand Down
85 changes: 85 additions & 0 deletions Doc/library/math.integer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
:mod:`math.integer` --- integer-specific mathematics functions
==============================================================

.. module:: math.integer
:synopsis: Integer-specific mathematics functions.

.. versionadded:: next

--------------

This module provides access to the mathematical functions defined for integer arguments.
These functions accept integers and objects that implement the
:meth:`~object.__index__` method which is used to convert the object to an integer
number.

The following functions are provided by this module. All return values are
computed exactly and are integers.


.. function:: comb(n, k, /)

Return the number of ways to choose *k* items from *n* items without repetition
and without order.

Evaluates to ``n! / (k! * (n - k)!)`` when ``k <= n`` and evaluates
to zero when ``k > n``.

Also called the binomial coefficient because it is equivalent
to the coefficient of k-th term in polynomial expansion of
``(1 + x)ⁿ``.

Raises :exc:`ValueError` if either of the arguments are negative.


.. function:: factorial(n, /)

Return factorial of the nonnegative integer *n*.


.. function:: gcd(*integers)

Return the greatest common divisor of the specified integer arguments.
If any of the arguments is nonzero, then the returned value is the largest
positive integer that is a divisor of all arguments. If all arguments
are zero, then the returned value is ``0``. ``gcd()`` without arguments
returns ``0``.


.. function:: isqrt(n, /)

Return the integer square root of the nonnegative integer *n*. This is the
floor of the exact square root of *n*, or equivalently the greatest integer
*a* such that *a*\ ² |nbsp| ≤ |nbsp| *n*.

For some applications, it may be more convenient to have the least integer
*a* such that *n* |nbsp| ≤ |nbsp| *a*\ ², or in other words the ceiling of
the exact square root of *n*. For positive *n*, this can be computed using
``a = 1 + isqrt(n - 1)``.


.. |nbsp| unicode:: 0xA0
:trim:


.. function:: lcm(*integers)

Return the least common multiple of the specified integer arguments.
If all arguments are nonzero, then the returned value is the smallest
positive integer that is a multiple of all arguments. If any of the arguments
is zero, then the returned value is ``0``. ``lcm()`` without arguments
returns ``1``.


.. function:: perm(n, k=None, /)

Return the number of ways to choose *k* items from *n* items
without repetition and with order.

Evaluates to ``n! / (n - k)!`` when ``k <= n`` and evaluates
to zero when ``k > n``.

If *k* is not specified or is ``None``, then *k* defaults to *n*
and the function returns ``n!``.

Raises :exc:`ValueError` if either of the arguments are negative.
168 changes: 71 additions & 97 deletions Doc/library/math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,6 @@ noted otherwise, all return values are floats.


==================================================== ============================================
**Number-theoretic functions**
--------------------------------------------------------------------------------------------------
:func:`comb(n, k) <comb>` Number of ways to choose *k* items from *n* items without repetition and without order
:func:`factorial(n) <factorial>` *n* factorial
:func:`gcd(*integers) <gcd>` Greatest common divisor of the integer arguments
:func:`isqrt(n) <isqrt>` Integer square root of a nonnegative integer *n*
:func:`lcm(*integers) <lcm>` Least common multiple of the integer arguments
:func:`perm(n, k) <perm>` Number of ways to choose *k* items from *n* items without repetition and with order

**Floating point arithmetic**
--------------------------------------------------------------------------------------------------
:func:`ceil(x) <ceil>` Ceiling of *x*, the smallest integer greater than or equal to *x*
Expand Down Expand Up @@ -126,92 +117,6 @@ noted otherwise, all return values are floats.
==================================================== ============================================


Number-theoretic functions
--------------------------

.. function:: comb(n, k)

Return the number of ways to choose *k* items from *n* items without repetition
and without order.

Evaluates to ``n! / (k! * (n - k)!)`` when ``k <= n`` and evaluates
to zero when ``k > n``.

Also called the binomial coefficient because it is equivalent
to the coefficient of k-th term in polynomial expansion of
``(1 + x)ⁿ``.

Raises :exc:`TypeError` if either of the arguments are not integers.
Raises :exc:`ValueError` if either of the arguments are negative.

.. versionadded:: 3.8


.. function:: factorial(n)

Return factorial of the nonnegative integer *n*.

.. versionchanged:: 3.10
Floats with integral values (like ``5.0``) are no longer accepted.


.. function:: gcd(*integers)

Return the greatest common divisor of the specified integer arguments.
If any of the arguments is nonzero, then the returned value is the largest
positive integer that is a divisor of all arguments. If all arguments
are zero, then the returned value is ``0``. ``gcd()`` without arguments
returns ``0``.

.. versionadded:: 3.5

.. versionchanged:: 3.9
Added support for an arbitrary number of arguments. Formerly, only two
arguments were supported.


.. function:: isqrt(n)

Return the integer square root of the nonnegative integer *n*. This is the
floor of the exact square root of *n*, or equivalently the greatest integer
*a* such that *a*\ ² |nbsp| ≤ |nbsp| *n*.

For some applications, it may be more convenient to have the least integer
*a* such that *n* |nbsp| ≤ |nbsp| *a*\ ², or in other words the ceiling of
the exact square root of *n*. For positive *n*, this can be computed using
``a = 1 + isqrt(n - 1)``.

.. versionadded:: 3.8


.. function:: lcm(*integers)

Return the least common multiple of the specified integer arguments.
If all arguments are nonzero, then the returned value is the smallest
positive integer that is a multiple of all arguments. If any of the arguments
is zero, then the returned value is ``0``. ``lcm()`` without arguments
returns ``1``.

.. versionadded:: 3.9


.. function:: perm(n, k=None)

Return the number of ways to choose *k* items from *n* items
without repetition and with order.

Evaluates to ``n! / (n - k)!`` when ``k <= n`` and evaluates
to zero when ``k > n``.

If *k* is not specified or is ``None``, then *k* defaults to *n*
and the function returns ``n!``.

Raises :exc:`TypeError` if either of the arguments are not integers.
Raises :exc:`ValueError` if either of the arguments are negative.

.. versionadded:: 3.8


Floating point arithmetic
-------------------------

Expand Down Expand Up @@ -812,6 +717,75 @@ Special functions
.. versionadded:: 3.2


Number-theoretic functions
--------------------------

For backward compatibility, the :mod:`math` module provides also aliases of
the following functions from the :mod:`math.integer` module:

.. list-table::

* - .. function:: comb(n, k)
:no-typesetting:

:func:`comb(n, k) <math.integer.comb>`
- Number of ways to choose *k* items from *n* items without repetition
and without order

* - .. function:: factorial(n)
:no-typesetting:

:func:`factorial(n) <math.integer.factorial>`
- *n* factorial

* - .. function:: gcd(*integers)
:no-typesetting:

:func:`gcd(*integers) <math.integer.gcd>`
- Greatest common divisor of the integer arguments

* - .. function:: isqrt(n)
:no-typesetting:

:func:`isqrt(n) <math.integer.isqrt>`
- Integer square root of a nonnegative integer *n*

* - .. function:: lcm(*integers)
:no-typesetting:

:func:`lcm(*integers) <math.integer.lcm>`
- Least common multiple of the integer arguments

* - .. function:: perm(n, k)
:no-typesetting:

:func:`perm(n, k) <math.integer.perm>`
- Number of ways to choose *k* items from *n* items without repetition
and with order

.. versionadded:: 3.5
The :func:`gcd` function.

.. versionadded:: 3.8
The :func:`comb`, :func:`perm` and :func:`isqrt` functions.

.. versionadded:: 3.9
The :func:`lcm` function.

.. versionchanged:: 3.9
Added support for an arbitrary number of arguments in the :func:`gcd`
function.
Formerly, only two arguments were supported.

.. versionchanged:: 3.10
Floats with integral values (like ``5.0``) are no longer accepted in the
:func:`factorial` function.

.. deprecated:: next
These aliases are :term:`soft deprecated` in favor of the
:mod:`math.integer` functions.


Constants
---------

Expand Down Expand Up @@ -894,5 +868,5 @@ Constants
Module :mod:`cmath`
Complex number versions of many of these functions.

.. |nbsp| unicode:: 0xA0
:trim:
Module :mod:`math.integer`
Integer-specific mathematics functions.
1 change: 1 addition & 0 deletions Doc/library/numeric.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The following modules are documented in this chapter:

numbers.rst
math.rst
math.integer.rst
cmath.rst
decimal.rst
fractions.rst
Expand Down
Loading
Loading