Adding :class: ManimColor to manim and converting all types #3020

MrDiver · 2022-11-13T05:03:54Z

Overview: What does this pull request change?

This pull request aims to remove all the duplicates of color handling in Manim and unify all colors under one Color type named ManimColor and a TypeAlias ParsableManimColor which represents all types that can be converted to a ManimColor

Motivation and Explanation: Why and how do your changes improve the library?

Links to added or changed documentation pages

Further Information and Comments

Reviewer Checklist

The PR title is descriptive enough for the changelog, and the PR is labeled correctly
If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
If applicable: newly added functions and classes are tested

closes #2837

for more information, see https://pre-commit.ci

manim/utils/color.py

behackl

Is TypeAlias Python 3.10+ only? I'd perhaps be fine with deprecating Python 3.7, but skipping everything until 3.10 is somewhat inconvenient. :-)

MrDiver · 2022-11-14T21:46:28Z

I think it was more about the reuse of all the lists in ManimColor and ParsableManimColor

And yes TypeAlias is only 3.10 that's why I didn't use it directly but you can still do it without typing

Viicos · 2022-11-15T09:24:18Z

Is TypeAlias Python 3.10+ only? I'd perhaps be fine with deprecating Python 3.7, but skipping everything until 3.10 is somewhat inconvenient. :-)

Ah yes forgot about that, but indeed it can still be done without it (e.g. ManimColorInputType = str | int | list[...)

for more information, see https://pre-commit.ci

…y in utils

for more information, see https://pre-commit.ci

manim/utils/color/core.py

+from typing import Any, Sequence, Union
+
+import numpy as np
+from typing_extensions import Literal, TypeAlias


Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

for more information, see https://pre-commit.ci

jsonvillanueva · 2023-08-01T03:00:45Z

For the record, #3264 introduces a new file and also a new class which could use the ParsableManimColor. I'm not sure to what extent you're trying to cover all instances of color within the library, but it's shaping out nicely. Should I maybe check this branch out and give it a closer look for/commit other missing occurrences?

… so that internal methods can be documented

MrDiver · 2023-08-04T04:19:06Z

For the record, #3264 introduces a new file and also a new class which could use the ParsableManimColor. I'm not sure to what extent you're trying to cover all instances of color within the library, but it's shaping out nicely. Should I maybe check this branch out and give it a closer look for/commit other missing occurrences?

Already ✅ done thank you for the info! that was very helpful to know!

MrDiver · 2023-08-04T04:22:20Z

Remaining TODOs, almost done here:
* check remaining TODOs still committed

There are 2 Todos still remaining, one is the fixing of the color structure passing down colors through constructors and making sure that there are sane default values for everything but it seems to work fine because labeled.py worked flawless without any changes.

The other one with the gradient is just some issue that we kind of also had before, because we just didn't have a good implementation. I just referenced the other function for now. So it can safely be done at a later stage.

* fix color example

Still needs to be done

* perhaps somewhat more information what "included in global namespace" means

In which file do we have this ?

* one-line docstrings for `core.py` would be nice

core.py is fully documented now!

for more information, see https://pre-commit.ci

manim/utils/color/core.py

manim/utils/color/manim_colors.py

+
+"""
+
+from .core import ManimColor


manim/utils/color/manim_colors.py

manim/utils/color/__init__.py

+
+from . import AS2700, BS381, X11, XKCD
+from .core import *
+from .manim_colors import *


manim/utils/color/manim_colors.py

+LOGO_RED = ManimColor("#E07A5F")
+LOGO_BLACK = ManimColor("#343434")
+
+_all_manim_colors: List[ManimColor] = [


manim/utils/color/core.py

+    ManimColor
+        _description_
+    """
+    import manim.utils.color.manim_colors as manim_colors


behackl

I am very happy to finally get a sane(r) color model into the library. Thanks to everyone who was involved here, and in particular @MrDiver! 👏

first draft of color class + starting library conversion

bd4d123

MrDiver added the enhancement Additions and improvements in general label Nov 13, 2022

MrDiver and others added 2 commits November 13, 2022 06:05

Merge branch 'main' into color_fix

01e28fd

[pre-commit.ci] auto fixes from pre-commit.com hooks

a0e85af

for more information, see https://pre-commit.ci

Viicos reviewed Nov 13, 2022

View reviewed changes

manim/utils/color.py Outdated Show resolved Hide resolved

behackl reviewed Nov 14, 2022

View reviewed changes

MrDiver and others added 15 commits November 19, 2022 03:18

Merge branch 'main' into color_fix

8af3f81

[pre-commit.ci] auto fixes from pre-commit.com hooks

332d327

for more information, see https://pre-commit.ci

changed everything to Manim color todo: figure out circular dependenc…

da0806a

…y in utils

[pre-commit.ci] auto fixes from pre-commit.com hooks

73ffb51

for more information, see https://pre-commit.ci

first working draft of new color version

157c504

Merge branch 'main' into color_fix

a7e4a3e

resolving conflicts

d21583d

resolving conflicts

074345e

resolving conflicts

128b8ab

resolving conflicts

31bcdac

resolving conflicts

27c0ddb

changed default internal value of ManimColor to np.ndarray[float]

195512a

starting to fix tests

9823616

fixed more tests and changed precision of manim color

e638643

removed premature color conversion

7867aa3

MrDiver marked this pull request as draft December 17, 2022 11:37

MrDiver marked this pull request as ready for review December 17, 2022 11:38

MrDiver added 5 commits December 17, 2022 15:05

fixed some more tests

a12507a

final test changes

15c4998

fix doctests

76d7cda

fix for 3.8

a27aff4

fixing ManimColor string representation

1580c82

behackl and others added 2 commits May 3, 2023 01:15

Merge remote-tracking branch 'origin/main' into color_fix

1e6be03

[pre-commit.ci] auto fixes from pre-commit.com hooks

3c1ca10

for more information, see https://pre-commit.ci

github-advanced-security bot found potential problems May 2, 2023

View reviewed changes

manim/utils/color/core.py

from typing import Any, Sequence, Union

import numpy as np

from typing_extensions import Literal, TypeAlias

Check notice

Code scanning / CodeQL

Unused import

Import of 'Literal' is not used.

MrDiver and others added 4 commits July 31, 2023 16:42

merge fix

322249a

Update manim/mobject/mobject.py

3282c75

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

[pre-commit.ci] auto fixes from pre-commit.com hooks

884846e

for more information, see https://pre-commit.ci

fix flake8 errors

e1c8419

MrDiver force-pushed the color_fix branch 2 times, most recently from 67772a8 to e1c8419 Compare August 4, 2023 04:03

MrDiver added 4 commits August 4, 2023 06:04

Removed test in test_text_mobject

025cd3a

Improved Documentation of core.py and added private members in sphinx…

7b599f2

… so that internal methods can be documented

Merge branch 'main' of github.com:ManimCommunity/manim into color_fix

1c6899f

Change color types of labeled.py

4388cce

behackl and others added 4 commits August 8, 2023 12:25

removed some unused imports

f41bef3

turned docstring into comment

c3e7b99

_colors -> _all_manim_colors; move to manim_color module

112470d

[pre-commit.ci] auto fixes from pre-commit.com hooks

38d3c3f

for more information, see https://pre-commit.ci

github-advanced-security bot found potential problems Aug 8, 2023

View reviewed changes

fixed typing

3576be6

github-advanced-security bot found potential problems Aug 8, 2023

View reviewed changes

manim/utils/color/manim_colors.py

LOGO_RED = ManimColor("#E07A5F")

LOGO_BLACK = ManimColor("#343434")

_all_manim_colors: List[ManimColor] = [

Check notice

Code scanning / CodeQL

Unused global variable

The global variable '_all_manim_colors' is not used.

rewrite import

7da5946

github-advanced-security bot found potential problems Aug 8, 2023

View reviewed changes

manim/utils/color/core.py

ManimColor

_description_

"""

import manim.utils.color.manim_colors as manim_colors

Check notice

Code scanning / CodeQL

Cyclic import

Import of module [manim.utils.color.manim_colors](1) begins an import cycle.

Merge branch 'main' into color_fix

6651ab9

behackl approved these changes Aug 8, 2023

View reviewed changes

behackl added the highlight For contributions that should be highlighted explicitly in the next changelog label Aug 8, 2023

behackl merged commit 82e55b5 into ManimCommunity:main Aug 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding :class: ManimColor to manim and converting all types #3020

Adding :class: ManimColor to manim and converting all types #3020

Uh oh!

MrDiver commented Nov 13, 2022 •

edited

Loading

Uh oh!

Uh oh!

behackl left a comment

Uh oh!

MrDiver commented Nov 14, 2022 •

edited

Loading

Uh oh!

Viicos commented Nov 15, 2022

Uh oh!

Check notice

jsonvillanueva commented Aug 1, 2023

Uh oh!

MrDiver commented Aug 4, 2023

Uh oh!

MrDiver commented Aug 4, 2023 •

edited

Loading

Uh oh!

Uh oh!

Check notice

Uh oh!

Check notice

Check notice

Check notice

behackl left a comment

Uh oh!

Uh oh!

Adding :class: ManimColor to manim and converting all types #3020

Adding :class: ManimColor to manim and converting all types #3020

Uh oh!

Conversation

MrDiver commented Nov 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview: What does this pull request change?

Motivation and Explanation: Why and how do your changes improve the library?

Links to added or changed documentation pages

Further Information and Comments

Reviewer Checklist

Uh oh!

Uh oh!

behackl left a comment

Choose a reason for hiding this comment

Uh oh!

MrDiver commented Nov 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Viicos commented Nov 15, 2022

Uh oh!

Check notice

jsonvillanueva commented Aug 1, 2023

Uh oh!

MrDiver commented Aug 4, 2023

Uh oh!

MrDiver commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Check notice

Uh oh!

Check notice

Check notice

Check notice

behackl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MrDiver commented Nov 13, 2022 •

edited

Loading

MrDiver commented Nov 14, 2022 •

edited

Loading

MrDiver commented Aug 4, 2023 •

edited

Loading