Skip to content

Add __hash__ to ManimColor #4051

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
merged 7 commits into from
Jan 19, 2025
Merged

Add __hash__ to ManimColor #4051

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9a6a867
add __hash__ to ManimColor
sophiawisdom Dec 8, 2024
bec6983
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 8, 2024
92b8c45
Update core.py
sophiawisdom Dec 8, 2024
1492893
add test
sophiawisdom Dec 8, 2024
98d65e1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 8, 2024
55f65dd
fix: correct typehint
behackl Jan 19, 2025
490a75d
fix test
behackl Jan 19, 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
3 changes: 3 additions & 0 deletions manim/utils/color/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,6 +1021,9 @@ def __xor__(self, other: Self) -> Self:
self._internal_from_integer(self.to_integer() ^ int(other), 1.0)
)

def __hash__(self) -> str:
Copy link
Member

Choose a reason for hiding this comment

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

The Python docs recommend that __hash__ returns an integer.
Can you just return hash(self.to_hex(with_alpha=True))?

Copy link
Contributor

Choose a reason for hiding this comment

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

Don't forget to change the return typehint to int.

return hash(self.to_hex(with_alpha=True))


RGBA = ManimColor
"""RGBA Color Space"""
Expand Down
7 changes: 6 additions & 1 deletion tests/module/utils/test_color.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import numpy as np

from manim import BLACK, Mobject, Scene, VMobject
from manim import BLACK, RED, WHITE, Mobject, Scene, VMobject


def test_import_color():
Expand Down Expand Up @@ -49,3 +49,8 @@ def test_set_color():
assert m.color.to_hex() == "#FFFFFF"
m.set_color(BLACK)
assert m.color.to_hex() == "#000000"


def test_color_hash():
assert hash(WHITE) == hash(WHITE.copy())
assert hash(WHITE) != hash(RED)
Loading