gh-81313: Add the math.integer module (PEP-791) #133909

serhiy-storchaka · 2025-05-11T20:37:01Z

Issue: PEP-791: Add a module for integer related math functions #81313

📚 Documentation preview 📚: https://cpython-previews--133909.org.readthedocs.build/

serhiy-storchaka · 2025-05-11T20:41:31Z

This is a further development of #13741.

vstinner · 2025-05-11T21:11:25Z

A PEP is being written for this module: skirpichev/peps#8

Doc/library/imath.rst

Doc/library/intmath.rst

Doc/library/math.integer.rst

Doc/library/intmath.rst

Modules/intmathmodule.c

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

serhiy-storchaka · 2025-10-29T07:37:41Z

Perhaps, module in Lib/ (which will import stuff from private C module) is better.

No, this would only make things worse. This would break the module name for math functions too.

The right solution is to compile the math module to math/__init__.cpython-315d-x86_64-linux-gnu.so instead of math.cpython-315d-x86_64-linux-gnu.so, but I was not able to find how to do this. I hope we will fix this in the following PR.

stale

serhiy-storchaka · 2025-10-29T08:55:51Z

I used other way to fix the module name. This is a temporary hack, I hope we will make it a straight way in future.

skirpichev · 2025-10-29T10:05:18Z

I think test failures are relevant.

Misc/NEWS.d/next/Library/2019-06-02-13-56-16.gh-issue-81313.axawSH.rst

Doc/whatsnew/3.15.rst

vstinner · 2025-10-29T11:55:35Z

@vstinner, I worked on this several days ago, and here is the result. But there is a flaw in this implementation -- math.integer.name is not 'math.integer', and the module attribute of its functions is not 'math.integer'. This affects pickling and the help output.

IMO it's good enough for a first iteration, we will have enough time until Python 3.15 final to find a way to fix these issues.

…awSH.rst Co-authored-by: Victor Stinner <vstinner@python.org>

skirpichev

Playing with the new module, I found also this:

>>> math.integer.__spec__
ModuleSpec(name='_math_integer', loader=<_frozen_importlib_external.ExtensionFileLoader object at 0x7fdbdae6f150>, origin='/home/sk/src/cpython/build/lib.linux-x86_64-3.15/_math_integer.cpython-315-x86_64-linux-gnu.so')

Doc/library/math.integer.rst

skirpichev · 2025-10-29T23:57:12Z

Doc/library/math.rst

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


Please mention there, that these aliases are soft-deprecated.

BTW, why this section was moved?

Because it is less important than other sections.

Maybe it is, if we want to communicate users this renaming. Though, it's important only for those who read docs in order... Up to you.

skirpichev · 2025-10-30T00:19:01Z

Modules/mathintegermodule.c

+    /* Fix the __name__ attribute of the module and the __module__ attribute
+     * of its functions.
+     */


Could you, please, create an issue to track this?

IIUIC, currently it's also not clear how to name the module file (math_integermodule.c, math/integermodule.c or even intmathmodule.c). I.e. we should extend current naming scheme to submodules.

See #140824.

Doc/library/math.integer.rst

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

skirpichev

LGTM, with few nitpicks (up to Serhiy) and note about ModuleSpec(). (I suspect this might affect something.)

vstinner

LGTM

vstinner · 2025-10-31T12:27:23Z

Doc/library/math.rst

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


Maybe add a versionchanged to mention that these functions became aliases to math.integer functions?

This did not change their behavior.

vstinner · 2025-10-31T12:32:29Z

Doc/library/math.rst

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


You should add .. deprecated:: 3.15 to repeat that these functions are soft deprecated and math.integer functions should be used instead.

pythongh-81313: Add the imath module

6e47acd

serhiy-storchaka requested review from a team, corona10 and erlend-aasland as code owners May 11, 2025 20:37

bedevere-app bot mentioned this pull request May 11, 2025

PEP-791: Add a module for integer related math functions #81313

Closed

bedevere-app bot added the awaiting core review label May 11, 2025

Fix Sphinx warning.

62cb235

This comment was marked as resolved.

Sign in to view

skirpichev reviewed May 12, 2025

View reviewed changes

Doc/library/imath.rst Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

Support multiple interpreters.

091dab6

This comment was marked as resolved.

Sign in to view

serhiy-storchaka added 4 commits May 12, 2025 09:55

_PyLong_NumBits returns int64_t now.

71d7f4f

Fix build on Windows.

7b61c5e

Add in a toctree.

eaea554

Regen generated files.

da3ceab

skirpichev self-requested a review May 13, 2025 12:39

This comment was marked as resolved.

Sign in to view

serhiy-storchaka added 4 commits June 1, 2025 09:17

Merge branch 'main' into imath3

2ab90a5

imath -> intmath

3299bf7

Remove ilog2().

9b6a151

Remove unneeded import.

7b327ec

skirpichev changed the title ~~gh-81313: Add the imath module~~ gh-81313: Add the intmath module Jun 1, 2025

picnixz changed the title ~~gh-81313: Add the intmath module~~ gh-81313: Add the intmath module (PEP-791) Jun 1, 2025

skirpichev reviewed Jun 1, 2025

View reviewed changes

Apply suggestions from code review

3194384

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

Merge branch 'main' into imath3

3b7bd99

Fix the module name.

a5bac9c

bedevere-app bot added awaiting review and removed awaiting core review labels Oct 29, 2025

Rewrite the math module documentation.

4425774

Fix test_capi on macOS.

21791cd

serhiy-storchaka requested a review from markshannon as a code owner October 29, 2025 11:14

vstinner reviewed Oct 29, 2025

View reviewed changes

Misc/NEWS.d/next/Library/2019-06-02-13-56-16.gh-issue-81313.axawSH.rst Outdated Show resolved Hide resolved

Doc/whatsnew/3.15.rst Show resolved Hide resolved

Update Misc/NEWS.d/next/Library/2019-06-02-13-56-16.gh-issue-81313.ax…

835a46c

…awSH.rst Co-authored-by: Victor Stinner <vstinner@python.org>

skirpichev reviewed Oct 30, 2025

View reviewed changes

Doc/library/math.integer.rst Outdated Show resolved Hide resolved

Doc/library/math.integer.rst Outdated Show resolved Hide resolved

Doc/library/math.integer.rst Outdated Show resolved Hide resolved

Doc/library/math.integer.rst Outdated Show resolved Hide resolved

serhiy-storchaka and others added 2 commits October 31, 2025 11:08

Apply suggestions from code review

5599504

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

soft deprecated

f7a06e5

skirpichev approved these changes Oct 31, 2025

View reviewed changes

bedevere-app bot added awaiting core review and removed awaiting review labels Oct 31, 2025

Move the nbsp definition.

badeb5c

vstinner approved these changes Oct 31, 2025

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting core review labels Oct 31, 2025

Update documentation.

0f385a5

serhiy-storchaka merged commit dcf3cc5 into python:main Oct 31, 2025
54 checks passed

bedevere-app bot removed the awaiting merge label Oct 31, 2025

serhiy-storchaka deleted the imath3 branch October 31, 2025 14:13

jjhelmus mentioned this pull request Nov 19, 2025

Update to CPython 3.15.0a2 astral-sh/python-build-standalone#860

Merged

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

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

Uh oh!

gh-81313: Add the math.integer module (PEP-791) #133909

gh-81313: Add the math.integer module (PEP-791) #133909

Uh oh!

Conversation

serhiy-storchaka commented May 11, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

serhiy-storchaka commented May 11, 2025

Uh oh!

vstinner commented May 11, 2025

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka commented Oct 29, 2025

Uh oh!

serhiy-storchaka commented Oct 29, 2025

Uh oh!

skirpichev commented Oct 29, 2025

Uh oh!

Uh oh!

Uh oh!

vstinner commented Oct 29, 2025

Uh oh!

skirpichev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

skirpichev left a comment

Choose a reason for hiding this comment

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

serhiy-storchaka commented May 11, 2025 •

edited by github-actions bot

Loading