fix: allow lazy/translation proxy objects as State/Event name (#632)#636
Merged
Conversation
Signed-off-by: Fernando Macedo <fgmacedo@gmail.com>
Signed-off-by: Fernando Macedo <fgmacedo@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #636 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 52 52
Lines 5505 5505
Branches 869 869
=========================================
Hits 5505 5505
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
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
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.



Fixes #632.
Problem
Lazy translation strings (e.g.
django.utils.translation.gettext_lazy) are proxy objects that are not realstrinstances, although castable viastr(). Changes in 3.x stored aState/Eventnameas-is and later assumed it was a realstr, so a proxy broke:TransitionNotAllowedmessage (str.joinrequires realstrelements) —statemachine/exceptions.py;str(state)—State.__str__returned the proxy directly, raisingTypeError: __str__ returned non-string.Fix
Coerce to
strat the point of use, keeping the lazy object untouched in storage. Coercing at assignment would resolve the translation at class-definition time, defeating the purpose of i18n (translation must resolve at display time, honoring the active locale).exceptions.py:", ".join(str(s.name) ...)in theTransitionNotAllowedmessage.state.py:__str__returnsstr(self.name); the hash usesstr(self.name)for robust hashability regardless of locale.contrib/diagram/extract.py: coerce names tostronce at the domain→model boundary, so every renderer (dot/mermaid/table) receives realstr.Docs
docs/releases/3.2.1.md.docs/states.mdthatnameaccepts any object castable tostr, resolved at display time.