Refactor: make rc_ultraplot and rc_matplotlib internal by cvanelteren · Pull Request #384 · Ultraplot/UltraPlot

cvanelteren · 2025-10-27T16:40:51Z

This PR moves the global variables of rc_ultraplot and rc_matplotlib internal to the Configurator class.

Why?

Currently we have global variables that are being passed around which causes us to track rc_matplotlib, rc_ultraplotand rc separately. If we wanna move to a thread safe rc setter our Configurator class needs to encapsulate the rc parameters properly. It eases our understanding of the how UltraPlot is configured without having to see where the rc are update. The general use of rc is focused on the Configurator anyway so making them apart of this setting is a logical encapsulation.

It also moves the logic from __init__.py to a new sync class method.

Todos

Refactor rc dicts inside Configurator
Remove old deprication warnings
adjust document if necessary
add unittests

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

codecov · 2025-10-27T17:01:44Z

Codecov Report

❌ Patch coverage is 88.33333% with 21 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
ultraplot/config.py	79.41%	11 Missing and 10 partials ⚠️

📢 Thoughts on this report? Let us know!

cvanelteren · 2025-10-27T17:59:23Z

Note: I may just remove the inputs as the user should not be concerned with the defaults rc`s

cvanelteren · 2025-10-28T10:06:15Z

Still reaching the time-out ...

beckermr

Is there a way we can do this without breaking the API?

beckermr · 2025-10-29T10:35:11Z

ultraplot/config.py

    return kw_ultraplot


-def config_inline_backend(fmt=None):


Why was this function removed?

It is moved as a class function now. It was moved there as it was referencing as global var (rc_ultraplot). The encapsulation is more appropriate with this recent change.

It is here now: https://github.com/Ultraplot/UltraPlot/pull/384/files#diff-849c439d454bf26e1102dce232b08a417344e1d97a4add022d4088cd00b743caR1060

Note this PR looks more heavy than it is. I moved _int and __init__ to the top of the class to make it read easier. The only major change is moving rc_ultraplot and rc_matplotlib as class variables and adjusting the logic elsewhere in the code (mainly a couple of references in figure.py)

To add to this. I looked into to how this function is called, and it also happens inside Configurator. I first thought the function was called by IPython directly -- but it is not.

cvanelteren · 2025-10-29T12:33:27Z

Is there a way we can do this without breaking the API?

It doesn't change the api that much. Users are guided to use rc (the Configurator class) anyway. That remains unchanged here. The only difference here is that we don't have to manage the rc params separately. Before we had 3 objects (rc,rc_ultraplot and rc_matplotlib). The rc objects would ensure that we are retrieving or setting the correct matplotlib settings. I think it is cleaner to just use rc and make the respective rc params for ultraplot and matplotlib available from this configuration rather bookkeeping them separately. In this way, we could also ensure that we can do thread safety by providing blocks and proper context protection in the class.

beckermr · 2025-10-29T12:41:13Z

An API change is an API change even if it is small. We'll need to bump to 2.0 after this IMHO.

cvanelteren · 2025-10-29T12:50:50Z

I see a version increase merely as a version increase, but perhaps we should add an api warning for few Y releases (x.Y) before we make the change.

beckermr · 2025-10-31T11:27:14Z

ultraplot/config.py

+    def sync(self):
+        """
+        Sync settings between ultraplot and matplotlib rc dictionaries.
+        """
+        for _src in (self.rc_ultraplot, self.rc_matplotlib):
+            for _key in _src:  # loop through unsynced properties
+                if "color" not in _key:
+                    continue
+                try:
+                    _src[_key] = _src[_key]
+                except ValueError as err:
+                    warnings._warn_ultraplot(f"Invalid user rc file setting: {err}")
+                    _src[_key] = "black"  # fill value


I don't follow how this code works to be honest. Also the method should probably be called sync_colors since it only deals with colors?

Code was originally part of init. Merely wrapped it. I think it triggers the validators.

I don't follow how this code works to be honest. Also the method should probably be called sync_colors since it only deals with colors?

actually taht is a good point -- will change it for clarity

I don't see how the settings from one rc object end up in the other. It must happen on the backend as you say.

At least for the rc_ultraplot it will run a validator on setting a key (see rcsetup.py); matplotlib prolly has a similar setting.

Initially I was also scratching my head at this section in the code. Will replace it as we progress to something a bit cleaner.

cvanelteren · 2026-02-01T05:35:51Z

~~I believe this is not the issue -- I am closing it without removing the branch.~~ Wrong PR!

make rc_ultraplot and rc_matplotlib internal

a460892

cvanelteren marked this pull request as draft October 27, 2025 16:41

cvanelteren added 2 commits October 27, 2025 17:47

update docs

f920b8e

label as object in docs

1bc455d

cvanelteren requested a review from Copilot October 27, 2025 16:51

This comment was marked as resolved.

Sign in to view

cvanelteren and others added 2 commits October 27, 2025 17:52

Update ultraplot/config.py

b3f7021

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

add new params to docstring

f2b3d7d

cvanelteren requested a review from Copilot October 27, 2025 16:54

This comment was marked as resolved.

Sign in to view

cvanelteren added 3 commits October 27, 2025 18:13

add defaults

c0ebba1

refactor tests

33e054a

rm comment

c0105d3

cvanelteren marked this pull request as ready for review October 27, 2025 18:17

cvanelteren requested a review from beckermr October 27, 2025 18:17

cvanelteren added 3 commits October 27, 2025 19:26

more tests

25e6b2e

Merge branch 'main' into refactor-config

439862e

Merge branch 'main' into refactor-config

84b35de

cvanelteren added 2 commits October 29, 2025 10:51

Merge branch 'main' into refactor-config

e7606a7

Merge branch 'main' into refactor-config

6020f86

beckermr requested changes Oct 29, 2025

View reviewed changes

beckermr reviewed Oct 29, 2025

View reviewed changes

cvanelteren mentioned this pull request Oct 29, 2025

Feature: Threadsafe RcParams #383

Closed

Merge branch 'main' into refactor-config

ab02933

cvanelteren added this to the v2.0 milestone Oct 29, 2025

beckermr requested changes Oct 31, 2025

View reviewed changes

beckermr approved these changes Oct 31, 2025

View reviewed changes

Merge branch 'main' into refactor-config

5837e08

cvanelteren added the Wait Suspending current issue until further notice label Jan 22, 2026

cvanelteren closed this Feb 1, 2026

cvanelteren reopened this Feb 1, 2026

Conversation

cvanelteren commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why?

Todos

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

codecov bot commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cvanelteren commented Oct 27, 2025

Uh oh!

cvanelteren commented Oct 28, 2025

Uh oh!

beckermr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cvanelteren commented Oct 29, 2025

Uh oh!

beckermr commented Oct 29, 2025

Uh oh!

cvanelteren commented Oct 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cvanelteren commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cvanelteren commented Oct 27, 2025 •

edited

Loading

codecov bot commented Oct 27, 2025 •

edited

Loading

cvanelteren commented Feb 1, 2026 •

edited

Loading