docs: document callable/lambda guard conditions and add regression tests (#638)#641
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 #641 +/- ##
=========================================
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.



Closes #638.
Investigating the report, this is not a v3 regression: a lambda guard with a parameter named
selffails identically on v2.6.0 and v3.2.0. Callbacks are invoked through dependency injection by parameter name, andselfis only injected when the callable resolves to a bound method (i.e. it is an attribute of the state machine class). Plain callables (lambdas, module-level functions) are called unbound, so they must declare injectable names such asmachine.Since this behavior was neither tested nor documented, this PR:
TestIssue638regression tests covering callable guards: lambda withmachine, zero-arg lambda, lambda receiving event kwargs, lambda withself(asserts the currentTypeError), and a class-body function passed by reference (bound, soselfworks).docs/guards.mdwith doctests and a warning explaining theselfvsmachinedistinction.Full analysis in #638 (comment).