GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Creation of the Norm Protocol by trygvrad · Pull Request #30149 · matplotlib/matplotlib

Conversation

@trygvrad

@trygvrad trygvrad commented Jun 6, 2025

Copy link
Copy Markdown
Contributor

This PR is a response to a discussion in the past weeks weekly developer meeting regarding the creation of a Norm protocol before the introduction of MultiNorm #29876 (comment)

Prior to this PR there are no Protocols in matplotlib.

This implementation uses @runtime_checkable so that Colorizer.set_norm() can check _api.check_isinstance((colors.Norm, str, None), norm=norm)

Note that the error message if the class one attempts to use is missing a member, is just the standard wrong-type message, and does not tell you what member of the protocol is missing.

@timhoffm @tacaswell @ksunden @story645

The implementation looks like this:


@runtime_checkable
class Norm(Protocol):

    @property
    def vmin(self):
        """Lower limit of the input data interval; maps to 0."""
        ...


    @property
    def vmax(self):
        """Upper limit of the input data interval; maps to 1."""
        ...

    @property
    def clip(self):
        """
        Determines the behavior for mapping values outside the range ``[vmin, vmax]``.

        See the *clip* parameter in `.Normalize`.
        """
        ...

    def _changed(self):
        """
        Call this whenever the norm is changed to notify all the
        callback listeners to the 'changed' signal.
        """
        ...


    def __call__(self, value, clip=None):
        """
        Normalize the data and return the normalized data.

        Parameters
        ----------
        value
            Data to normalize.
        clip : bool, optional
            See the description of the parameter *clip* in `.Normalize`.

            If ``None``, defaults to ``self.clip`` (which defaults to
            ``False``).

        Notes
        -----
        If not already initialized, ``self.vmin`` and ``self.vmax`` are
        initialized using ``self.autoscale_None(value)``.
        """
        ...

    def inverse(self, value):
        """
        Maps the normalized value (i.e., index in the colormap) back to image
        data value.

        Parameters
        ----------
        value
            Normalized value.
        """
        ...


    def autoscale(self, A):
        """Set *vmin*, *vmax* to min, max of *A*."""
        ...

    def autoscale_None(self, A):
        """If *vmin* or *vmax* are not set, use the min/max of *A* to set them."""
        ...

    def scaled(self):
        """Return whether *vmin* and *vmax* are both set."""
        ...

and some of the docstrings will need to be updated to also allow for MultiNorm, but this can happen in the next PR.

This requires a lot more than the bare minimum. I tested, and I can do a plt.imshow() with just __call__ and autoscale_None, but I get the feeling that it is desirable to lock it down more.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@github-actions github-actions Bot added the topic: color/color & colormaps label Jun 6, 2025
@trygvrad
Creation of the Norm Protocol
f5351ad
@trygvrad
trygvrad force-pushed the norm_protocol branch from 45494d3 to f5351ad Compare June 6, 2025 15:32
@trygvrad trygvrad mentioned this pull request Jun 6, 2025
MultiNorm class #29876
Merged
timhoffm
timhoffm reviewed Jun 6, 2025
View reviewed changes
Comment thread lib/matplotlib/colors.pyi Outdated
class Norm(Protocol):
callbacks: cbook.CallbackRegistry
@property
def vmin(self) -> float | None: ...

@timhoffm timhoffm Jun 6, 2025

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Wouldn't we need something like this to support MultiNorm?

Suggested change
def vmin(self) -> float | None: ...
def vmin(self) -> float | ArrayLike | None: ...

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@trygvrad trygvrad Jun 6, 2025

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Yes,

My logic was to get this into main first, and then change this with the MultiNorm PR, but I guess it is easier if I do it here. I will try to find the time early next week.

Is this PR otherwise as you would expect?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@trygvrad trygvrad Jun 7, 2025

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

This should be updated now, I set it to:

    @property
    def vmin(self) -> float | tuple[float] | None: ...
    @property
    def vmax(self) -> float | tuple[float] | None: ...
    @property
    def clip(self) -> bool | tuple[bool]: ...

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
QuLogic
QuLogic reviewed Jun 7, 2025
View reviewed changes
Comment thread lib/matplotlib/colors.pyi Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread lib/matplotlib/tests/test_colors.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
@trygvrad
updates based on feedback on PR
b0c8093
@timhoffm

timhoffm commented Jun 9, 2025

Copy link
Copy Markdown
Member

Considering this again, I'm leaning slightly towards an abstract base class.

To be clear, both variants are acceptable solutions for the use case and would do the job. The relevant arguments for me are:

  • inheritance is a slightly stronger in communicating the interface: (i) it's made explicit on the class through inheritance - this is by design implicit on protocols, where the implementing class does not state its protocol conformance. (ii) conformance is checked at load time, whereas protocols are only statically type checked and optionally in runtime code.
  • Protocols shine when you want to maintain looser coupling through duck-typing. But we don't need that: For everything internal, we can afford the stronger coupling. Also third parties implementing norms can do that: They have until now for Normalize and somebody who provides a norm can at least afford to conditionally import matplotlib.
  • the usage of runtime_checkable and the test here indicates to me that we are actually more on the side of nominal subtyping, I.e. inheritance.

Since I missed the discussion: What were the reasons to suggest unsung Protocols?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@ksunden

ksunden commented Jun 12, 2025

Copy link
Copy Markdown
Member

The main reasoning to avoid ABCs was to avoid having to deal with metaclasses, since that is often more painful than helpful. Protocols get us to essentially the same place without having to worry about that aspect.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@trygvrad trygvrad mentioned this pull request Jun 15, 2025
Abstract base class for Normalize #30178
Merged
@trygvrad

trygvrad commented Jun 15, 2025

Copy link
Copy Markdown
Contributor Author

@timhoffm Could you take a look at the alternative PR #30178, and see if you still prefer an ABC after considering the implementation details?

I think with the right argument we can get everyone on the same page :)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@timhoffm

timhoffm commented Jun 16, 2025

Copy link
Copy Markdown
Member

@trygvrad Thanks for taking the effort to write out both alternatives! I still like the ABC approach a bit more.

Could you please add Norm to the docs here to see how that renders.

@ksunden I think ABC is much simpler than a generic metaclass. The only complication I see is that one would have to watch out in case of multiple inheritance - But I don't see a case where norms would need multiple inheritance. They are quite straight forward.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@trygvrad

trygvrad commented Jun 19, 2025

Copy link
Copy Markdown
Contributor Author

@timhoffm I'm not able to work on this now, but I will try to get to it at the end of the week.

@tacaswell If i recall you had a preference for a Protocol at the weekly meeting. What is your opinion now, in light of @timhoffm arguments here #30149 (comment) ?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@tacaswell tacaswell modified the milestone: v3.11.0 Jun 19, 2025
@tacaswell

tacaswell commented Jun 19, 2025

Copy link
Copy Markdown
Member

Closing in favor of #30178 (see #30178 (comment))

Thank you @trygvrad for working up both versions!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@tacaswell tacaswell closed this Jun 19, 2025
@trygvrad trygvrad moved this to Superseded in Bivariate and Multivariate Colormapping Jul 3, 2025
@trygvrad trygvrad added this to Bivariate and Multivariate Colormapping Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@QuLogic QuLogic QuLogic left review comments
@timhoffm timhoffm timhoffm left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

topic: color/color & colormaps

Projects

Bivariate and Multivariate Colormapping
Status: Superseded

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@trygvrad @timhoffm @ksunden @tacaswell @QuLogic
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.