Ruff E through P (ScreenPyHQ#45)

* E
* EM101
* EM102
* F
* FA
* I
* PGH
* PL
* PT006
* PT007
* PT011
* PT018
* PT019
* saving possible safe fixes for ruff
* fixing broken test after converting to using future annotations

.pre-commit-config.yaml

@@ -2,13 +2,13 @@ files: '(screenpy_selenium|tests)/.*'
 fail_fast: false
 repos:
   - repo: https://github.com/psf/black
-    rev: 23.12.1
+    rev: 24.1.1
     hooks:
       - id: black
         language_version: python3.12
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.1.11
+    rev: v0.2.0
     hooks:
       - id: ruff
   - repo: https://github.com/pre-commit/mirrors-mypy

Makefile

@@ -26,6 +26,12 @@ black-check:
 black:
 	black .
 
+isort-check:
+	isort . --check
+
+isort:
+	isort .
+
 ruff:
 	ruff check .
 
@@ -35,12 +41,12 @@ ruff-fix:
 mypy:
 	mypy .
 
-lint: ruff mypy
+lint: isort-check ruff mypy
 
-.PHONY: black-check black ruff ruff-fix mypy lint
+.PHONY: black-check black isort-check isort ruff ruff-fix mypy lint
 
 pre-check-in: black-check lint
 
-pre-check-in-fix: black ruff-fix mypy
+pre-check-in-fix: black isort ruff-fix mypy
 
 .PHONY: pre-check-in pre-check-in-fix

pyproject.toml

@@ -73,7 +73,7 @@ isort = {version = "*", optional = true}
 mypy = {version = "*", optional = true}
 pre-commit = {version = "*", optional = true}
 pytest = {version = "*", optional = true}
-ruff = {version = "*", optional = true}
+ruff = {version = ">=0.2.0", optional = true}
 sphinx = {version = "*", optional = true}
 tox = {version = "*", optional = true}
 
@@ -107,6 +107,14 @@ build-backend = "poetry.core.masonry.api"
 [tool.ruff]
 target-version = "py38"  # minimum supported version
 line-length = 88  # same as Black.
+
+extend-exclude = [
+    "screenpy_selenium/__init__.py",
+    "screenpy_selenium/__version__.py",
+    "docs",
+]
+
+[tool.ruff.lint]
 select = [
     "A",  # flake8-builtins
     "ANN",  # flake8-annotations  # coming back to this one later to compare against mypy
@@ -115,21 +123,21 @@ select = [
     "BLE",  # flake8-blind-except
     "C4",  # flake8-comprehensions
     "D",  # pydocstyle
-#    "E",  # pycodestyle error
-#    "EM",  # flake8-errmsg
-#    "ERA",  # eradicate
-#    "F",  # Pyflakes
-#    "FA",  # flake8-future-annotations
+    "E",  # pycodestyle error
+    "EM",  # flake8-errmsg
+    "ERA",  # eradicate
+    "F",  # Pyflakes
+    "FA",  # flake8-future-annotations
 #    "FBT",  # flake8-boolean-trap
-#    "FIX",  # flake8-fixme
-#    "FLY",  # flynt
-#    "I",  # isort
-#    "ICN",  # flake8-import-conventions
-#    "ISC",  # flake8-implicit-str-concat
-#    "PGH",  # pygrep-hooks
-#    "PIE",  # flake8-pie
-#    "PL",  # pylint
-#    "PT",  # flake8-pytest-style
+    "FIX",  # flake8-fixme
+    "FLY",  # flynt
+    "I",  # isort
+    "ICN",  # flake8-import-conventions
+    "ISC",  # flake8-implicit-str-concat
+    "PGH",  # pygrep-hooks
+    "PIE",  # flake8-pie
+    "PL",  # pylint
+    "PT",  # flake8-pytest-style
 #    "Q",  # flake8-quotes
 #    "RET",  # flake8-return
 #    "RSE",  # flake8-raise
@@ -153,20 +161,20 @@ ignore = [
     "ANN101",  # missing self annotation, we only annotate self when we return it.
     "ANN102",  # missing cls annotation, we only annotate cls when we return it.
 ]
-exclude = [
-    "screenpy_selenium/__init__.py",
-    "screenpy_selenium/__version__.py",
-    "docs",
-]
 
-
-[tool.ruff.lint]
 extend-safe-fixes = [
+    "EM101",
+    "EM102",
 #    "TCH001", "TCH002", "TCH003", "TCH004",
 #    "SIM108"
+    # maybe?
+#    "F841",
+    "C419",
+    "D200", "D205", "D415",
+    "PT003", "PT006", "PT018",
 ]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/**" = [
     "D",  # we don't need public-API-polished docstrings in tests.
     "FBT",  # using a boolean as a test object is useful!
@@ -176,20 +184,30 @@ extend-safe-fixes = [
     "FA100",  # we are purposely testing pacing without future annotations.
 ]
 
-
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 combine-as-imports = true
 split-on-trailing-comma = true
 known-first-party = ["screenpy_selenium", "tests"]
 
 
-[tool.ruff.flake8-pytest-style]
+[tool.ruff.lint.flake8-pytest-style]
 mark-parentheses = false
 
 
-[tool.ruff.pycodestyle]
+[tool.ruff.lint.pycodestyle]
 ignore-overlong-task-comments = true
 
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
+
+
+[tool.isort]
+line_length = 88
+multi_line_output = 3
+include_trailing_comma = true
+use_parentheses = true
+combine_as_imports = true
+
+skip = [".idea", ".tox", "docs"]
+src_paths = ["screenpy_selenium","tests"]

screenpy_selenium/__version__.py

@@ -3,6 +3,7 @@
   ▀▀▀▄▄ █   █▄▄▀ █▀▀ █▀▀ █  █ ░█▄▄█ █▄▄█    ▀▀▀▄▄ █▀▀ █   █▀▀ █  █ ▀█▀ █  █ █ ▀ █
  ░█▄▄▄█ ▀▀▀ ▀ ▀▀ ▀▀▀ ▀▀▀ ▀  ▀ ░█    ▄▄▄█   ░█▄▄▄█ ▀▀▀ ▀▀▀ ▀▀▀ ▀  ▀ ▀▀▀  ▀▀▀ ▀   ▀
 """
+
 try:
     # importlib.metadata is present in Python 3.8 and later
     import importlib.metadata as importlib_metadata  # type: ignore

screenpy_selenium/abilities/browse_the_web.py

@@ -1,5 +1,7 @@
 """Enable the actor to browse the web."""
 
+from __future__ import annotations
+
 import os
 from typing import Type, TypeVar
 
@@ -73,7 +75,8 @@ def using_ios(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
             "browserName": "Safari",
         }
         if IOS_CAPABILITIES["platformVersion"] is None:
-            raise BrowsingError("IOS_DEVICE_VERSION Environment variable must be set.")
+            msg = "IOS_DEVICE_VERSION Environment variable must be set."
+            raise BrowsingError(msg)
 
         return cls.using(browser=Remote(hub_url, IOS_CAPABILITIES))
 
@@ -105,9 +108,8 @@ def using_android(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
             "browserName": "Chrome",
         }
         if ANDROID_CAPABILITIES["platformVersion"] is None:
-            raise BrowsingError(
-                "ANDROID_DEVICE_VERSION environment variable must be set."
-            )
+            msg = "ANDROID_DEVICE_VERSION environment variable must be set."
+            raise BrowsingError(msg)
 
         return cls.using(browser=Remote(hub_url, ANDROID_CAPABILITIES))
 

screenpy_selenium/actions/accept_alert.py

@@ -1,5 +1,7 @@
 """Accept a javascript alert."""
 
+from __future__ import annotations
+
 from screenpy.actor import Actor
 from screenpy.pacing import aside, beat
 

screenpy_selenium/actions/chain.py

@@ -1,5 +1,7 @@
 """A meta-Action to group a series of chainable Actions together."""
 
+from __future__ import annotations
+
 from screenpy.actor import Actor
 from screenpy.exceptions import UnableToAct
 from screenpy.pacing import beat
@@ -35,13 +37,12 @@ def describe(self) -> str:
     def perform_as(self, the_actor: Actor) -> None:
         """Choreograph the Actions and direct the Actor to perform the chain."""
         browser = the_actor.ability_to(BrowseTheWeb).browser
-        the_chain = ActionChains(browser)  # type: ignore[arg-type]
+        the_chain = ActionChains(browser)
 
         for action in self.actions:
             if not isinstance(action, Chainable):
-                raise UnableToAct(
-                    f"The {action.__class__.__name__} Action cannot be chained."
-                )
+                msg = f"The {action.__class__.__name__} Action cannot be chained."
+                raise UnableToAct(msg)
             action.add_to_chain(the_actor, the_chain)
         the_chain.perform()
 

screenpy_selenium/actions/clear.py

@@ -1,4 +1,7 @@
 """Clear text from an input."""
+
+from __future__ import annotations
+
 from typing import Type, TypeVar
 
 from screenpy.actor import Actor

screenpy_selenium/actions/click.py

@@ -1,5 +1,7 @@
 """Click on an element."""
 
+from __future__ import annotations
+
 from typing import Optional, Type, TypeVar
 
 from screenpy.actor import Actor
@@ -57,10 +59,11 @@ def describe(self: SelfClick) -> str:
     def perform_as(self: SelfClick, the_actor: Actor) -> None:
         """Direct the Actor to click on the element."""
         if self.target is None:
-            raise UnableToAct(
-                "Target was not supplied for Click. Provide a Target by using the "
-                ".on() or .on_the() method."
+            msg = (
+                "Target was not supplied for Click. "
+                "Provide a Target by using the .on() or .on_the() method."
             )
+            raise UnableToAct(msg)
 
         element = self.target.found_by(the_actor)
 

screenpy_selenium/actions/dismiss_alert.py

@@ -1,5 +1,7 @@
 """Dismiss a javascript alert."""
 
+from __future__ import annotations
+
 from screenpy.actor import Actor
 from screenpy.pacing import aside, beat
 

screenpy_selenium/actions/double_click.py

@@ -1,5 +1,7 @@
 """Double-click on an element, or wherever the cursor currently is."""
 
+from __future__ import annotations
+
 from typing import Optional, Type, TypeVar
 
 from screenpy.actor import Actor

screenpy_selenium/actions/enter.py

@@ -1,5 +1,7 @@
 """Enter text into an input field, or press keys."""
 
+from __future__ import annotations
+
 from functools import partial
 from typing import List, Optional, Type, TypeVar
 
@@ -112,10 +114,11 @@ def describe(self: SelfEnter) -> str:
     def perform_as(self: SelfEnter, the_actor: Actor) -> None:
         """Direct the Actor to enter the text into the element."""
         if self.target is None:
-            raise UnableToAct(
+            msg = (
                 "Target was not supplied for Enter. Provide a Target by using either "
                 "the .into(), .into_the(), or .on() method."
             )
+            raise UnableToAct(msg)
 
         element = self.target.found_by(the_actor)
 

screenpy_selenium/actions/enter_2fa_token.py

@@ -1,4 +1,7 @@
 """Enter a 2-factor authentication code into a text field."""
+
+from __future__ import annotations
+
 from typing import Type, TypeVar
 
 from screenpy.actor import Actor

screenpy_selenium/actions/go_back.py

@@ -1,5 +1,7 @@
 """Press the browser back button."""
 
+from __future__ import annotations
+
 from screenpy.actor import Actor
 from screenpy.pacing import beat
 

screenpy_selenium/actions/go_forward.py

@@ -1,5 +1,7 @@
 """Press the browser forward button."""
 
+from __future__ import annotations
+
 from screenpy.actor import Actor
 from screenpy.pacing import beat
 

screenpy_selenium/actions/hold_down.py

@@ -1,5 +1,7 @@
 """Hold down a specific key or the left mouse button, optionally on an element."""
 
+from __future__ import annotations
+
 import platform
 from typing import Optional, Type, TypeVar
 
@@ -80,7 +82,8 @@ def add_to_chain(
         elif self.key is not None:
             the_chain.key_down(self.key)
         else:
-            raise UnableToAct("HoldDown must be told what to hold down.")
+            msg = "HoldDown must be told what to hold down."
+            raise UnableToAct(msg)
 
     def __init__(
         self: SelfHoldDown, key: Optional[str] = None, lmb: bool = False

screenpy_selenium/actions/move_mouse.py

@@ -1,5 +1,7 @@
 """Move the mouse to a specific element, or by an offset."""
 
+from __future__ import annotations
+
 from typing import Optional, Tuple, Type, TypeVar
 
 from screenpy.actor import Actor
@@ -106,10 +108,11 @@ def _add_action_to_chain(
         elif self.offset is not None:
             the_chain.move_by_offset(*self.offset)
         else:
-            raise UnableToAct(
-                "MoveMouse was given neither coordinates nor a Target. Supply "
-                "one of these using MoveMouse.by_offset or MoveMouse.to_the."
+            msg = (
+                "MoveMouse was given neither coordinates nor a Target. "
+                "Supply one of these using MoveMouse.by_offset or MoveMouse.to_the."
             )
+            raise UnableToAct(msg)
 
     def describe(self: SelfMoveMouse) -> str:
         """Describe the Action in present tense."""

screenpy_selenium/actions/open.py

@@ -1,5 +1,7 @@
 """Open a browser on a URL."""
 
+from __future__ import annotations
+
 import os
 from typing import Type, TypeVar, Union
 

screenpy_selenium/actions/pause.py

@@ -1,5 +1,7 @@
 """Pause just like in ScreenPy, but also be able to do it in a Chain!"""
 
+from __future__ import annotations
+
 from screenpy import Actor
 from screenpy.actions import Pause as BasePause
 from screenpy.pacing import beat