Make @transition function-based decorator a class-based decorator
#34
Conversation
Codecov Report
@@ Coverage Diff @@
## main #34 +/- ##
==========================================
+ Coverage 97.40% 97.43% +0.03%
==========================================
Files 9 9
Lines 231 234 +3
==========================================
+ Hits 225 228 +3
Misses 6 6
Continue to review full report at Codecov.
|
| for item in source: | ||
| if not isinstance(item, allowed_types): | ||
| raise ValueError("Source can be a bool, int, string, Enum, or list") | ||
| class transition: |
There was a problem hiding this comment.
lowercase class name allows us to keep the interface the same
|
|
||
| return _wrapper | ||
| else: | ||
| def __init__(self, source, target, conditions=None, on_error=None): |
There was a problem hiding this comment.
This way of doing things allows us to process decorator parameters inside of the __init__ function. This feels a bit cleaner than before.
| raise ValueError("on_error needs to be a bool, int or string") | ||
| self.on_error = on_error | ||
|
|
||
| def __call__(self, func): |
There was a problem hiding this comment.
Decorators function take functions as input. Our class-based implementation will make our object instance callable and accept a function.
| self.on_error = on_error | ||
|
|
||
| def __call__(self, func): | ||
| func._fsm = Transition( |
There was a problem hiding this comment.
Changed the internal location of Transition metadata from .__fsm to ._fsm since the double underscore version was mangling names when introspected in the draw_state_diagram CLI
| @@ -29,7 +29,7 @@ def generate_state_diagram_markdown(cls, initial_state): | |||
|
|
|||
| class_fns = inspect.getmembers(cls, predicate=inspect.isfunction) | |||
| state_transitions: List[Transition] = [ | |||
| func.__fsm for name, func in class_fns if hasattr(func, "__fsm") | |||
| func._fsm for name, func in class_fns if hasattr(func, "_fsm") | |||
There was a problem hiding this comment.
the corresponding change in the draw_state_diagram CLI
alysivji
changed the title
@transition function-based decorator a class-based decorator
To implement the functionality required to complete #19, we need a
@transitiondecorator that holds internal state.This PR changes the underlying implementation of the
@transitiondecorator from a function-based decorator to a class-based decorator.If tests still pass, this means the underlying implementation was changed correctly.