Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-140806: add docs for enum.bin function #140807

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.

Sign up for GitHub

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

Merged
hugovk merged 8 commits into from
Jan 12, 2026
Merged

gh-140806: add docs for enum.bin function #140807

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
135199e
add docs for `enum.bin` function
guoci Oct 30, 2025
5a08f39
📜🤖 Added by blurb_it.
blurb-it[bot] Oct 30, 2025
b470926
fix doctest
guoci Oct 30, 2025
9551c59
Update Doc/library/enum.rst
guoci Oct 30, 2025
a9c136f
Update Doc/library/enum.rst
guoci Oct 30, 2025
ffed7d9
Update Doc/library/enum.rst
guoci Oct 30, 2025
8d91cef
Update Doc/library/enum.rst
guoci Oct 30, 2025
b72d728
Update Doc/library/enum.rst
guoci Oct 30, 2025
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
Next Next commit
add docs for enum.bin function
  • Loading branch information
@guoci
guoci committed Oct 30, 2025
commit 135199e5ea0abca1e7438c7756c0d56d85a5e764
20 changes: 20 additions & 0 deletions Doc/library/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,12 @@ Module Contents

Return a list of all power-of-two integers contained in a flag.

:func:`enum.bin`

Like built-in :func:`bin`, except negative values are represented in
two's-complement, and the leading bit always indicates sign
Comment thread
guoci marked this conversation as resolved.
Outdated
(0=positive, 1=negative).
Comment thread
guoci marked this conversation as resolved.
Outdated


.. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto``
.. versionadded:: 3.11 ``StrEnum``, ``EnumCheck``, ``ReprEnum``, ``FlagBoundary``, ``property``, ``member``, ``nonmember``, ``global_enum``, ``show_flag_values``
Expand Down Expand Up @@ -1034,6 +1040,20 @@ Utilities and Decorators

.. versionadded:: 3.11

.. function:: bin(num, max_bits=None)

Like built-in :func:`bin`, except negative values are represented in
two's-complement, and the leading bit always indicates sign
Comment thread
guoci marked this conversation as resolved.
Outdated
(0=positive, 1=negative).
Comment thread
guoci marked this conversation as resolved.
Outdated

>>> from enum import enum
>>> enum.bin(10)
'0b0 1010'
>>> enum.bin(~10) # ~10 is -11
'0b1 0101'

.. versionadded:: 3.11
Comment thread
guoci marked this conversation as resolved.
Outdated

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

Notes
Expand Down
2 changes: 2 additions & 0 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ are always available. They are listed here in alphabetical order.
>>> f'{14:#b}', f'{14:b}'
('0b1110', '1110')

See also :func:`enum.bin` to represent negative values as twos-complement.

See also :func:`format` for more information.


Expand Down
3 changes: 2 additions & 1 deletion Lib/enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def show_flag_values(value):
def bin(num, max_bits=None):
"""
Like built-in bin(), except negative values are represented in
twos-compliment, and the leading bit always indicates sign
twos-complement, and the leading bit always indicates sign
(0=positive, 1=negative).

>>> bin(10)
Expand All @@ -139,6 +139,7 @@ def bin(num, max_bits=None):
'0b1 0101'
"""

num = num.__index__()
Comment thread
ethanfurman marked this conversation as resolved.
ceiling = 2 ** (num).bit_length()
if num >= 0:
s = bltns.bin(num + ceiling).replace('1', '0', 1)
Expand Down
Loading