Add explicit registration of units in examples #23508
Closed
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
Starting in sphinx-gallery/sphinx-gallery#890, sphinx-gallery started clearing Matplotlib's unit registry. But since `basic_units` was already imported, its register-on-import never happened for subsequent examples, breaking them.
story645
approved these changes
Jul 29, 2022
jklymak
reviewed
Jul 29, 2022
| @@ -380,4 +380,17 @@ def cos(x): | |||
| return math.cos(x.convert_to(radians).get_value()) | |||
|
|
|||
|
|
|||
| units.registry[BasicUnit] = units.registry[TaggedValue] = BasicUnitConverter() | |||
| def register_units(): | |||
There was a problem hiding this comment.
I'm still a little tan about who is incorrect here. It really seems sphinx gallery should spawn a new process for each example so the import happens again. However, I can see why that would be slow. It does make me extremely suspicious about changing behaviour via a registry that gets set at import time like this... (and yes we do it internally for dates and categorical as well).
tacaswell
requested changes
Jul 29, 2022
There was a problem hiding this comment.
I think I see a better path using https://sphinx-gallery.github.io/stable/advanced.html#resetting-before-each-example
|
Replaced by #23514. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary
Starting in sphinx-gallery/sphinx-gallery#890, sphinx-gallery started clearing Matplotlib's unit registry. But since
basic_unitswas already imported, its register-on-import never happened for subsequent examples, breaking them.PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).