tool: Setup ruff, removing python2 code (#320)

* tool: Setup ruff, removing python2 code

Author: fgmacedo

.editorconfig

@@ -7,11 +7,29 @@ repos:
         exclude: docs/auto_examples
     -   id: trailing-whitespace
         exclude: docs/auto_examples
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  # Ruff version.
+  rev: 'v0.0.220'
+  hooks:
+    - id: ruff
+      # Respect `exclude` and `extend-exclude` settings.
+      args: ["--force-exclude"]
 -   repo: https://github.com/psf/black
     rev: 22.10.0
     hooks:
     -   id: black
--   repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.9.0
-    hooks:
-    -   id: reorder-python-imports
+
+- repo: local
+  hooks:
+  - id: mypy
+    name: Mypy
+    entry: poetry run mypy statemachine/ tests/
+    types: [python]
+    language: system
+    pass_filenames: false
+  - id: pytest
+    name: Pytest
+    entry: poetry run pytest
+    types: [python]
+    language: system
+    pass_filenames: false

.pre-commit-config.yaml

@@ -26,7 +26,7 @@
       },
       "outputs": [],
       "source": [
-        "from unittest import mock\n\nfrom statemachine import State\nfrom statemachine import StateMachine\n\n\nclass AllActionsMachine(StateMachine):\n\n    initial = State(\"Initial\", initial=True)\n    final = State(\"Final\", final=True)\n\n    go = initial.to(\n        final,\n        validators=[\"validation_1\", \"validation_2\"],\n        cond=[\"condition_1\", \"condition_2\"],\n        unless=[\"unless_1\", \"unless_2\"],\n        on=[\"on_inline_1\", \"on_inline_2\"],\n        before=[\"before_go_inline_1\", \"before_go_inline_2\"],\n        after=[\"after_go_inline_1\", \"after_go_inline_2\"],\n    )\n\n    def __init__(self, *args, **kwargs):\n        self.spy = mock.Mock(side_effect=lambda x: x)\n        super(AllActionsMachine, self).__init__(*args, **kwargs)\n\n    # validators and guards\n\n    def validation_1(self):\n        # this method may raise an exception\n        return self.spy(\"validation_1\")\n\n    def validation_2(self):\n        # this method may raise an exception\n        return self.spy(\"validation_2\")\n\n    def condition_1(self):\n        self.spy(\"condition_1\")\n        return True\n\n    def condition_2(self):\n        self.spy(\"condition_2\")\n        return True\n\n    def unless_1(self):\n        self.spy(\"unless_1\")\n        return False\n\n    def unless_2(self):\n        self.spy(\"unless_2\")\n        return False\n\n    # generics state\n\n    def on_enter_state(self):\n        return self.spy(\"on_enter_state\")\n\n    def on_exit_state(self):\n        return self.spy(\"on_exit_state\")\n\n    # generics transition\n\n    def before_transition(self):\n        return self.spy(\"before_transition\")\n\n    def on_transition(self):\n        return self.spy(\"on_transition\")\n\n    def after_transition(self):\n        return self.spy(\"after_transition\")\n\n    # before / after specific\n\n    @go.before\n    def before_go_decor(self):\n        return self.spy(\"before_go_decor\")\n\n    def before_go_inline_1(self):\n        return self.spy(\"before_go_inline_1\")\n\n    def before_go_inline_2(self):\n        return self.spy(\"before_go_inline_2\")\n\n    def before_go(self):\n        return self.spy(\"before_go\")\n\n    @go.on\n    def go_on_decor(self):\n        return self.spy(\"go_on_decor\")\n\n    def on_inline_1(self):\n        return self.spy(\"on_inline_1\")\n\n    def on_inline_2(self):\n        return self.spy(\"on_inline_2\")\n\n    def on_go(self):\n        return self.spy(\"on_go\")\n\n    @go.after\n    def after_go_decor(self):\n        return self.spy(\"after_go_decor\")\n\n    def after_go_inline_1(self):\n        return self.spy(\"after_go_inline_1\")\n\n    def after_go_inline_2(self):\n        return self.spy(\"after_go_inline_2\")\n\n    def after_go(self):\n        return self.spy(\"after_go\")\n\n    # enter / exit specific\n\n    @initial.enter\n    def enter_initial_decor(self):\n        return self.spy(\"enter_initial_decor\")\n\n    def on_enter_initial(self):\n        return self.spy(\"on_enter_initial\")\n\n    @initial.exit\n    def exit_initial_decor(self):\n        return self.spy(\"exit_initial_decor\")\n\n    def on_exit_initial(self):\n        return self.spy(\"on_exit_initial\")\n\n    def on_enter_final(self):\n        return self.spy(\"on_enter_final\")\n\n    def on_exit_final(self):\n        \"hopefully this will not be called\"\n        return self.spy(\"on_exit_final\")"
+        "from unittest import mock\n\nfrom statemachine import State\nfrom statemachine import StateMachine\n\n\nclass AllActionsMachine(StateMachine):\n\n    initial = State(\"Initial\", initial=True)\n    final = State(\"Final\", final=True)\n\n    go = initial.to(\n        final,\n        validators=[\"validation_1\", \"validation_2\"],\n        cond=[\"condition_1\", \"condition_2\"],\n        unless=[\"unless_1\", \"unless_2\"],\n        on=[\"on_inline_1\", \"on_inline_2\"],\n        before=[\"before_go_inline_1\", \"before_go_inline_2\"],\n        after=[\"after_go_inline_1\", \"after_go_inline_2\"],\n    )\n\n    def __init__(self, *args, **kwargs):\n        self.spy = mock.Mock(side_effect=lambda x: x)\n        super().__init__(*args, **kwargs)\n\n    # validators and guards\n\n    def validation_1(self):\n        # this method may raise an exception\n        return self.spy(\"validation_1\")\n\n    def validation_2(self):\n        # this method may raise an exception\n        return self.spy(\"validation_2\")\n\n    def condition_1(self):\n        self.spy(\"condition_1\")\n        return True\n\n    def condition_2(self):\n        self.spy(\"condition_2\")\n        return True\n\n    def unless_1(self):\n        self.spy(\"unless_1\")\n        return False\n\n    def unless_2(self):\n        self.spy(\"unless_2\")\n        return False\n\n    # generics state\n\n    def on_enter_state(self):\n        return self.spy(\"on_enter_state\")\n\n    def on_exit_state(self):\n        return self.spy(\"on_exit_state\")\n\n    # generics transition\n\n    def before_transition(self):\n        return self.spy(\"before_transition\")\n\n    def on_transition(self):\n        return self.spy(\"on_transition\")\n\n    def after_transition(self):\n        return self.spy(\"after_transition\")\n\n    # before / after specific\n\n    @go.before\n    def before_go_decor(self):\n        return self.spy(\"before_go_decor\")\n\n    def before_go_inline_1(self):\n        return self.spy(\"before_go_inline_1\")\n\n    def before_go_inline_2(self):\n        return self.spy(\"before_go_inline_2\")\n\n    def before_go(self):\n        return self.spy(\"before_go\")\n\n    @go.on\n    def go_on_decor(self):\n        return self.spy(\"go_on_decor\")\n\n    def on_inline_1(self):\n        return self.spy(\"on_inline_1\")\n\n    def on_inline_2(self):\n        return self.spy(\"on_inline_2\")\n\n    def on_go(self):\n        return self.spy(\"on_go\")\n\n    @go.after\n    def after_go_decor(self):\n        return self.spy(\"after_go_decor\")\n\n    def after_go_inline_1(self):\n        return self.spy(\"after_go_inline_1\")\n\n    def after_go_inline_2(self):\n        return self.spy(\"after_go_inline_2\")\n\n    def after_go(self):\n        return self.spy(\"after_go\")\n\n    # enter / exit specific\n\n    @initial.enter\n    def enter_initial_decor(self):\n        return self.spy(\"enter_initial_decor\")\n\n    def on_enter_initial(self):\n        return self.spy(\"on_enter_initial\")\n\n    @initial.exit\n    def exit_initial_decor(self):\n        return self.spy(\"exit_initial_decor\")\n\n    def on_exit_initial(self):\n        return self.spy(\"on_exit_initial\")\n\n    def on_enter_final(self):\n        return self.spy(\"on_enter_final\")\n\n    def on_exit_final(self):\n        \"hopefully this will not be called\"\n        return self.spy(\"on_exit_final\")"
       ]
     },
     {
@@ -100,7 +100,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.1"
+      "version": "3.11.1"
     }
   },
   "nbformat": 4,

docs/auto_examples/all_actions_machine.ipynb

@@ -28,7 +28,7 @@ class AllActionsMachine(StateMachine):
 
     def __init__(self, *args, **kwargs):
         self.spy = mock.Mock(side_effect=lambda x: x)
-        super(AllActionsMachine, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     # validators and guards
 

docs/auto_examples/all_actions_machine.py

@@ -1 +1 @@
-bc9e763d829c16d3337524a4db82811a
+367d00862fc4336899e7dfdbd0d7a80e

docs/auto_examples/all_actions_machine.py.md5

@@ -50,7 +50,7 @@ A StateMachine that exercices all possible :ref:`Actions` and :ref:`Guards`.
 
         def __init__(self, *args, **kwargs):
             self.spy = mock.Mock(side_effect=lambda x: x)
-            super(AllActionsMachine, self).__init__(*args, **kwargs)
+            super().__init__(*args, **kwargs)
 
         # validators and guards
 

docs/auto_examples/all_actions_machine.rst

@@ -26,7 +26,7 @@
       },
       "outputs": [],
       "source": [
-        "import random\n\nfrom statemachine import State\nfrom statemachine import StateMachine\n\n\nclass GuessTheNumberMachine(StateMachine):\n\n    start = State(\"Start\", initial=True)\n    low = State(\"Low\")\n    high = State(\"High\")\n    won = State(\"Won\", final=True)\n    lose = State(\"Lose\", final=True)\n\n    guess = (\n        lose.from_(low, high, cond=\"max_guesses_reached\")\n        | won.from_(low, high, cond=\"guess_is_equal\")\n        | low.from_(low, high, start, cond=\"guess_is_lower\")\n        | high.from_(low, high, start, cond=\"guess_is_higher\")\n    )\n\n    def __init__(self, max_attempts=5, lower=1, higher=5, seed=42):\n        self.max_attempts = max_attempts\n        self.lower = lower\n        self.higher = higher\n        self.guesses = 0\n\n        # lets play a not so random game, or our tests will be crazy\n        random.seed(seed)\n        self.number = random.randint(self.lower, self.higher)\n        super(GuessTheNumberMachine, self).__init__()\n\n    def max_guesses_reached(self):\n        return self.guesses >= self.max_attempts\n\n    def before_guess(self, number):\n        self.guesses += 1\n        print(\"You guess is {}...\".format(number))\n\n    def guess_is_lower(self, number):\n        return number < self.number\n\n    def guess_is_higher(self, number):\n        return number > self.number\n\n    def guess_is_equal(self, number):\n        return self.number == number\n\n    def on_enter_start(self):\n        print(\"(psss.. don't tell anyone the number is {})\".format(self.number))\n        print(\n            \"I'm thinking of a number between {} and {}. Can you guess what it is?\".format(\n                self.lower, self.higher\n            )\n        )\n\n    def on_enter_low(self):\n        print(\"Too low. Try again.\")\n\n    def on_enter_high(self):\n        print(\"Too high. Try again.\")\n\n    def on_enter_won(self):\n        print(\n            \"Congratulations, you guessed the number in {} guesses!\".format(\n                self.guesses\n            )\n        )\n\n    def on_enter_lose(self):\n        print(\"Oh, no! You've spent all your {} attempts!\".format(self.guesses))"
+        "import random\n\nfrom statemachine import State\nfrom statemachine import StateMachine\n\n\nclass GuessTheNumberMachine(StateMachine):\n\n    start = State(\"Start\", initial=True)\n    low = State(\"Low\")\n    high = State(\"High\")\n    won = State(\"Won\", final=True)\n    lose = State(\"Lose\", final=True)\n\n    guess = (\n        lose.from_(low, high, cond=\"max_guesses_reached\")\n        | won.from_(low, high, cond=\"guess_is_equal\")\n        | low.from_(low, high, start, cond=\"guess_is_lower\")\n        | high.from_(low, high, start, cond=\"guess_is_higher\")\n    )\n\n    def __init__(self, max_attempts=5, lower=1, higher=5, seed=42):\n        self.max_attempts = max_attempts\n        self.lower = lower\n        self.higher = higher\n        self.guesses = 0\n\n        # lets play a not so random game, or our tests will be crazy\n        random.seed(seed)\n        self.number = random.randint(self.lower, self.higher)\n        super().__init__()\n\n    def max_guesses_reached(self):\n        return self.guesses >= self.max_attempts\n\n    def before_guess(self, number):\n        self.guesses += 1\n        print(\"You guess is {}...\".format(number))\n\n    def guess_is_lower(self, number):\n        return number < self.number\n\n    def guess_is_higher(self, number):\n        return number > self.number\n\n    def guess_is_equal(self, number):\n        return self.number == number\n\n    def on_enter_start(self):\n        print(\"(psss.. don't tell anyone the number is {})\".format(self.number))\n        print(\n            \"I'm thinking of a number between {} and {}. Can you guess what it is?\".format(\n                self.lower, self.higher\n            )\n        )\n\n    def on_enter_low(self):\n        print(\"Too low. Try again.\")\n\n    def on_enter_high(self):\n        print(\"Too high. Try again.\")\n\n    def on_enter_won(self):\n        print(\n            \"Congratulations, you guessed the number in {} guesses!\".format(\n                self.guesses\n            )\n        )\n\n    def on_enter_lose(self):\n        print(\"Oh, no! You've spent all your {} attempts!\".format(self.guesses))"
       ]
     },
     {
@@ -152,7 +152,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.1"
+      "version": "3.11.1"
     }
   },
   "nbformat": 4,

docs/auto_examples/guess_the_number_machine.ipynb

@@ -37,7 +37,7 @@ def __init__(self, max_attempts=5, lower=1, higher=5, seed=42):
         # lets play a not so random game, or our tests will be crazy
         random.seed(seed)
         self.number = random.randint(self.lower, self.higher)
-        super(GuessTheNumberMachine, self).__init__()
+        super().__init__()
 
     def max_guesses_reached(self):
         return self.guesses >= self.max_attempts

docs/auto_examples/guess_the_number_machine.py

@@ -1 +1 @@
-410f2a4ba51943452eddefeb5dd03d41
+5cc32510289a92a9594e06000e1ee8f8

docs/auto_examples/guess_the_number_machine.py.md5

@@ -59,7 +59,7 @@ Well leave the machine imagine a number and also play the game. Why not?
             # lets play a not so random game, or our tests will be crazy
             random.seed(seed)
             self.number = random.randint(self.lower, self.higher)
-            super(GuessTheNumberMachine, self).__init__()
+            super().__init__()
 
         def max_guesses_reached(self):
             return self.guesses >= self.max_attempts