Skip to content

PEP 791: address PEP review comments #4430

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.

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from 3 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
33 changes: 32 additions & 1 deletion peps/pep-0791.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ subsection of the documentation return a float, but the
documentation doesn't say so. In the documentation for the proposed ``imath`` module the sentence "All
return values are integers." would be accurate. In a similar way we
can simplify the description of the accepted arguments for functions in both the
:external+py3.14:mod:`math` and the new module.
new module and the :external+py3.14:mod:`math`.
Which content, as in beginning, will be again related to work with "just
numbers" --- that for most people with basic education means some model of real
numbers).
Comment on lines +41 to +43
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels dismissive, can we reword it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any suggestions?

I meant we can't expect advanced math background from average Python users. What they might expect from "just numbers"? They are closed for arithmetic operations (python's int's - aren't), but sometimes not for algebraic (e.g. sqrt(-1)), and they are more than just rational numbers (i.e. sqrt(2)). People also probably aware of decimal floating-point model for real numbers (or at least with fixed-point).


Apparently, the :external+py3.14:mod:`math` module can't serve as a catch-all place
for mathematical functions since we also have the :external+py3.14:mod:`cmath` and
Expand All @@ -52,6 +55,30 @@ Currently the :external+py3.14:mod:`math` module code in the CPython is around
comparable with the :external+py3.14:mod:`cmath` (1340LOC), which is *not* a
simple wrapper to the ``libm``, as most functions in the
:external+py3.14:mod:`math` module.
And this situation tends to be worse. When the module split `was first
proposed
<https://mail.python.org/archives/list/python-ideas@python.org/thread/YYJ5YJBJNCVXQWK5K3WSVNMPUSV56LOR/>`_,
there were only two integer-related functions:
:external+py3.14:func:`~math.factorial` and :external+py3.14:func:`~math.gcd`.
Now there are six, :external+py3.14:func:`~math.factorial` doesn't accept
:class:`float`'s anymore and :external+py3.14:func:`~math.gcd` changed it's
signature.


Rationale
=========

Why not fix the :external+py3.14:mod:`math` module documentation instead?
Sure, we can be much more vague in the module preamble (i.e. roughly say
that "the :external+py3.14:mod:`math` module contains some mathematical
functions") and we can accurately describe input/output for each function.

But the major issue is that current module mix different, almost non-interlaced
application domains. Adding more documentation will just highlight this and
make the issue worse for end users (more stuff to read/skip). And it will not
fix issue with discoverability (to know in which module to find a function, and
that it can be found at all, you need to look at all the functions in the
module), nor with tab-completion.


Specification
Expand Down Expand Up @@ -131,6 +158,10 @@ interval math or numerical integration.
Other proposed names include ``ntheory`` (like SymPy's submodule),
``integermath`` and ``imaths``.

As a variant, new module can be added as a submodule of the
:external+py3.14:mod:`math`. The main module itself will preserve "catch-all"
role for mathematics in the stdlib.


Module scope and possible extensions
------------------------------------
Expand Down