Skip to content
Open
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
20 changes: 20 additions & 0 deletions Doc/library/enum.rst
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
(``0`` implies positive, ``1`` implies negative).


.. 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
(``0`` implies positive, ``1`` implies negative).

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

.. versionadded:: 3.10

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

Notes
Expand Down
2 changes: 2 additions & 0 deletions Doc/library/functions.rst
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
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__()
Copy link
Member

Choose a reason for hiding this comment

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

Why are we mixing doc changes and support for int-like objects?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

To be consistent with builtins.bin.
https://docs.python.org/dev/library/functions.html#bin

ceiling = 2 ** (num).bit_length()
if num >= 0:
s = bltns.bin(num + ceiling).replace('1', '0', 1)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add documentation for :func:`enum.bin`.
Loading