Deprecate color enum usage and change constants from `str to type Color
#2606
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Converts values in setting_args dict in _get_settings_from_t2xs to string to make sure that all values are of type string. * Makes color constants instances of Color-class from colour-module and updates color_gradient to handle gradient with one color, fixes #7.
Darylgolden
requested changes
Mar 21, 2022
| self, | ||
| mobject, | ||
| color: Colors | None = None, | ||
| color: str | None = None, |
There was a problem hiding this comment.
Suggested change
| color: str | None = None, | |
| color: Color | str | None = None, |
There was a problem hiding this comment.
Pretty sure that a color object would work fine here too.
| # Background rectangle | ||
| def add_background_rectangle( | ||
| self, color: Optional[Colors] = None, opacity: float = 0.75, **kwargs | ||
| self, color: str = None, opacity: float = 0.75, **kwargs |
There was a problem hiding this comment.
Suggested change
| self, color: str = None, opacity: float = 0.75, **kwargs | |
| self, color: Color | str | None = None, opacity: float = 0.75, **kwargs |
|
@BrorSebastianSjovald @ludwigjo any updates here? |
|
Closing this for now. Making Colors the main source of truth again with exporting constants shouldn't break anything. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
This PR improves the color handling by deprecating uses of the Colors class and replace usage of the Enums with color constants as specified in #2451 . At this point, a deprecation warning is raised when trying to use the Colors class using
manim.utils.deprecation.Motivation and Explanation: Why and how do your changes improve the library?
The overall goal is to simplify the use of color by standardizing the approach as stated in #2451 . By deprecating the use of the Enums and providing a way of using the constants in a similar way, we're creating a standard for how colors should be used.
Links to added or changed documentation pages
Further Information and Comments
Reviewer Checklist