python-stdlib/enum/enum.py: Add Enum class. #980

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

Jump to bottom

Open

IhorNehrutsa wants to merge 3 commits into micropython:master

from IhorNehrutsa:enum

Open

python-stdlib/enum/enum.py: Add Enum class. #980

IhorNehrutsa wants to merge 3 commits into micropython:master from IhorNehrutsa:enum

Conversation

@IhorNehrutsa

Copy link

@IhorNehrutsa IhorNehrutsa commented Mar 5, 2025 •

edited

Loading

Docs in:
docs/library/enum.rst: Add Enum class. #16842
Usage example:

from enum import Enum
e = Enum({"X": 1, "Y": 2}) # create Enum object from dictionary of key-value pairs
print(e)
print("add new key-value pair")
e.A = 'A' # add new key-value pair
e.B = 'B'
print(e)
print("e.X:", e.X) # get value from key
print("e.X.value:", e.X.value) # get value from key
print("e(e.X):", e(e.X)) # get value from key
print("e.key_from_value(1):", e.key_from_value(1)) # get key from value
print("e.is_value(e.B):", e.is_value(e.B))
print("del e.B")
del e.B # delete key-value pair
print(e)
print("e.is_value('B'):", e.is_value('B')) # check if the value is in the Enum object
print("e.B: will raise the KeyError exception")
print(e.B) # raise an exception due to no such a key attribute

Output is:

Enum({'Y': 2, 'X': 1})
add new key-value pair
Enum({'A': 'A', 'B': 'B', 'Y': 2, 'X': 1})
e.X: 1
e.X.value: 1
e(e.X): 1
e.key_from_value(1): Enum.X
e.is_value(e.B): True
del e.B
Enum({'A': 'A', 'Y': 2, 'X': 1})
e.is_value('B'): False
e.B: will raise the KeyError exception
Traceback (most recent call last):
File "<stdin>", line 234, in <module>
File "<stdin>", line 126, in __getattr__
KeyError: no such attribute: B

EDITED:
Inspired by @shariltumin Dot class from the Way to use dot notation to refer to states in a state machine #15694
and @njourdane enum() func from the Request for package: micropython-enum #269

@IhorNehrutsa


 python-stdlib\enum\enum.py: Add Enum class.

fb5bcae

Signed-off-by: Ihor Nehrutsa <Ihor.Nehrutsa@gmail.com>

This was referenced Mar 5, 2025

docs/library/enum.rst: Add Enum class. micropython/micropython#16842

Open

Enum for micropython micropython/micropython#8545

Open

Request for package: micropython-enum #269

Open

@IhorNehrutsa IhorNehrutsa changed the title ~~(削除) Add Enum class. (削除ここまで)~~ (追記) python-stdlib/enum/enum.py: Add Enum class. (追記ここまで)

Mar 5, 2025

@IhorNehrutsa

Copy link

Author

IhorNehrutsa commented Mar 5, 2025

Usage example::

from enum import Enum
class State(Enum):
 Stop = 10
 Run = 20
 Ready = 30
state = State()
print("state:", State())
current_state = state.Stop
print("current_state:", current_state, state.key_from_value(current_state))
if current_state == state.Stop:
 print(" Stop state")
if current_state != state.Ready:
 print(" Not a Ready state")
 print(" Run!")
 current_state = state.Run
print("current_state:", current_state, state.key_from_value(current_state))
# some process
i = -1
while current_state != state.Ready:
 i += 1
 if state.is_value(i):
 if state(i) == state.Ready:
 current_state = state.Ready
 print(".", end="")
print()
print("current_state:", current_state, state.key_from_value(current_state))
print("Done!")

Output is::

state: State({'Ready': 30, 'Stop': 10, 'Run': 20})
current_state: 10 State.Stop
Stop state
Not a Ready state
Run!
current_state: 20 State.Run
...............................
current_state: 30 State.Ready
Done!

@dpgeorge

Copy link

Member

dpgeorge commented Mar 11, 2025

Thanks for the contribution, this looks pretty good!

Did you implement this from scratch, or copy parts from CPython's implementation? I'm just wondering about licensing and copyright.

Can you please add the test to the CI, in tools/ci.sh inside the function ci_package_tests_run.

@IhorNehrutsa

Copy link

Author

IhorNehrutsa commented Mar 11, 2025

Did you implement this from scratch, or copy parts from CPython's implementation?

I just saw CPython Enum. It looks like incredible magic. :-)

@IhorNehrutsa


 tools\ci.sh: Add enum_test.py to the CI.

8edf766

Signed-off-by: Ihor Nehrutsa <Ihor.Nehrutsa@gmail.com>

@dpgeorge

Copy link

Member

dpgeorge commented Mar 11, 2025

I just saw CPython Enum. It looks like incredible magic. :-)

That doesn't really answer the question. Did you copy this implementation from CPython?

Also, please make sure the CI all passes, there's currently a failure.

@IhorNehrutsa

Copy link

Author

IhorNehrutsa commented Mar 11, 2025

| Did you implement this from scratch, or copy parts from CPython's implementation?

No, I didn't use CPython implementation.

It was inspired by @shariltumin Dot class from the Way to use dot notation to refer to states in a state machine #15694
and @njourdane enum() func from the Request for package: micropython-enum #269

Josverl

Josverl reviewed

Mar 11, 2025

View reviewed changes

python-stdlib/enum/manifest.py Outdated Show resolved Hide resolved

@IhorNehrutsa IhorNehrutsa force-pushed the enum branch from 2c994fe to e70dd06 Compare

March 12, 2025 07:31

@IhorNehrutsa


 tools\ci.sh: Add test_enum.py to the CI.

6ab2ebe

Signed-off-by: Ihor Nehrutsa <Ihor.Nehrutsa@gmail.com>

@IhorNehrutsa IhorNehrutsa force-pushed the enum branch from e70dd06 to 6ab2ebe Compare

March 12, 2025 07:34

@IhorNehrutsa

Copy link

Author

IhorNehrutsa commented Mar 12, 2025

Should I squash commits?

dpgeorge

dpgeorge reviewed

Apr 10, 2025

View reviewed changes

python-stdlib/enum/test_enum.py

@@ -0,0 +1,91 @@

# enum_test.py

from enum import Enum, enum

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

I tried to run this test under CPython 3.12.2 but it doesn't work, for many reasons. And it should run under CPython so we can test that the implementation of MicroPython's enum matches the CPython enum.

For example, enum does not exist in the enum CPython module. Which version of CPython were you testing against?

python-stdlib/enum/test_enum.py

Enabled = True

state = Enum()

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython cannot create enums in this way.

python-stdlib/enum/test_enum.py

state = Enum()

print(state)

state = Direction()

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython requires a value in the constructor here.

python-stdlib/enum/test_enum.py

print(state)

state = State()

print(state)

state = State({"X": 1.0, "Y": 2.0})

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython doesn't allow such an argument to the constructor.

python-stdlib/enum/test_enum.py

print("Direction(Direction.CCW):", Direction(Direction.CCW))

print("Direction('CW'):", Direction("CW"))

print("state(10):", state(10))

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython doesn't allow calling an enum.

python-stdlib/enum/test_enum.py

print("state('CW'):", state("CW"))

print("type(state('CW')):", type(state("CW")))

print("state.key_from_value(20):", state.key_from_value(20))

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython doesn't have key_from_value().

python-stdlib/enum/test_enum.py

CCW = "CCW"

class State(Direction):

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython doesn't allow inheriting enums from each other.

python-stdlib/enum/test_enum.py

print("type(state('CW')):", type(state("CW")))

print("state.key_from_value(20):", state.key_from_value(20))

print("len(state):", len(state))

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython doesn't have __len__ on an enum.

python-stdlib/enum/test_enum.py

print("state.keys():", state.keys())

print("state.values():", state.values())

print("state.items():", state.items())

Copy link

Member

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

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

CPython enums don't have keys/values/items methods.

@jonnor

Copy link

jonnor commented Apr 25, 2025

There is a quite comprehensive set of unit-tests for enum available in CPython: https://github.com/python/cpython/blob/main/Lib/test/test_enum.py
With some exceptions like the tests using inspect, threading, pickle it seems possible to port most of them to MicroPython. That would give a very high degree of confidence that the implementation is conformant. And in the cases that one chooses to not be conformant, that can be documented with skipped tests.

@IhorNehrutsa

Copy link

Author

IhorNehrutsa commented Apr 30, 2025

I have successfully completed the task that requires the Enum class.
I don't plan to support this PR in the future.
You are welcome to continue working with this PR as you wish.
Thanks everyone.

Labels

None yet

4 participants

@IhorNehrutsa @dpgeorge @jonnor @Josverl

Uh oh!

python-stdlib/enum/enum.py: Add Enum class. #980

Are you sure you want to change the base?

python-stdlib/enum/enum.py: Add Enum class. #980

Uh oh!

Conversation

@IhorNehrutsa IhorNehrutsa commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IhorNehrutsa commented Mar 5, 2025

Uh oh!

dpgeorge commented Mar 11, 2025

Uh oh!

IhorNehrutsa commented Mar 11, 2025

Uh oh!

dpgeorge commented Mar 11, 2025

Uh oh!

IhorNehrutsa commented Mar 11, 2025

Uh oh!

Uh oh!

IhorNehrutsa commented Mar 12, 2025

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

@dpgeorge dpgeorge Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

jonnor commented Apr 25, 2025

Uh oh!

IhorNehrutsa commented Apr 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

@IhorNehrutsa IhorNehrutsa commented Mar 5, 2025 •

edited

Loading