refac: Using f-strings (#333)

Author: fgmacedo

.github/workflows/python-package.yml

@@ -65,10 +65,14 @@ jobs:
         source .venv/bin/activate
         pytest --cov-report=xml:coverage.xml
         coverage xml
+      #----------------------------------------------
+      #          upload coverage
+      #----------------------------------------------
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3
       if: matrix.python-version == 3.11
       with:
+        token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
         directory: .
         env_vars: OS,PYTHON
         fail_ci_if_error: true

README.md

@@ -65,15 +65,9 @@ Define your state machine:
 ...     stop = yellow.to(red)
 ...     go = red.to(green)
 ...
-...     def before_cycle(self, event_data=None):
-...         message = event_data.kwargs.get("message", "")
+...     def before_cycle(self, event: str, source: State, target: State, message: str = ""):
 ...         message = ". " + message if message else ""
-...         return "Running {} from {} to {}{}".format(
-...             event_data.event,
-...             event_data.transition.source.id,
-...             event_data.transition.target.id,
-...             message,
-...         )
+...         return f"Running {event} from {source.id} to {target.id}{message}"
 ...
 ...     def on_enter_red(self):
 ...         print("Don't move.")

docs/actions.md

@@ -39,21 +39,21 @@ The follow example can get you an overview of the "generic" callbacks available:
 ...     go = initial.to(final)
 ...
 ...     def before_transition(self, event, state):
-...         print("Before '{}', on the '{}' state.".format(event, state.id))
+...         print(f"Before '{event}', on the '{state.id}' state.")
 ...         return "before_transition_return"
 ...
 ...     def on_transition(self, event, state):
-...         print("On '{}', on the '{}' state.".format(event, state.id))
+...         print(f"On '{event}', on the '{state.id}' state.")
 ...         return "on_transition_return"
 ...
 ...     def on_exit_state(self, event, state):
-...         print("Exiting '{}' state from '{}' event.".format(state.id, event))
+...         print(f"Exiting '{state.id}' state from '{event}' event.")
 ...
 ...     def on_enter_state(self, event, state):
-...         print("Entering '{}' state from '{}' event.".format(state.id, event))
+...         print(f"Entering '{state.id}' state from '{event}' event.")
 ...
 ...     def after_transition(self, event, state):
-...         print("After '{}', on the '{}' state.".format(event, state.id))
+...         print(f"After '{event}', on the '{state.id}' state.")
 
 
 >>> sm = ExampleStateMachine()  # On initialization, the machine run a special event `__initial__`