Ruff q-z (ScreenPyHQ#46)

* RET
* TCH
* UP
* YTT
* fixing mypy configuration

mypy.ini

@@ -6,7 +6,7 @@ exclude = (?x)(
           | docs/
           )
 
-[mypy-screenpy.*]
+[mypy-screenpy_selenium.*]
 disallow_untyped_defs = True
 
 [mypy-tests.*]

pyproject.toml

@@ -138,18 +138,18 @@ select = [
     "PIE",  # flake8-pie
     "PL",  # pylint
     "PT",  # flake8-pytest-style
-#    "Q",  # flake8-quotes
-#    "RET",  # flake8-return
-#    "RSE",  # flake8-raise
-#    "RUF",  # ruff specific
-#    "SIM",  # flake8-simplify
-#    "T10",  # flake8-debugger
-#    "T20",  # flake8-print
-#    "TCH",  # flake8-type-checking
-#    "TRY",  # tryceratops
-#    "UP",  # python upgrade
+    "Q",  # flake8-quotes
+    "RET",  # flake8-return
+    "RSE",  # flake8-raise
+    "RUF",  # ruff specific
+    "SIM",  # flake8-simplify
+    "T10",  # flake8-debugger
+    "T20",  # flake8-print
+    "TCH",  # flake8-type-checking
+    "TRY",  # tryceratops
+    "UP",  # python upgrade
     "W",  # pycodestyle warning
-#    "YTT",  # flake8-2020
+    "YTT",  # flake8-2020
 
     # we would like these someday, but not yet
     # "FURB",  # refurb
@@ -165,13 +165,15 @@ ignore = [
 extend-safe-fixes = [
     "EM101",
     "EM102",
-#    "TCH001", "TCH002", "TCH003", "TCH004",
+    "TCH001", "TCH002", "TCH003", "TCH004",
 #    "SIM108"
     # maybe?
 #    "F841",
     "C419",
     "D200", "D205", "D415",
     "PT003", "PT006", "PT018",
+    "RET504",
+    "UP007",
 ]
 
 [tool.ruff.lint.per-file-ignores]

screenpy_selenium/abilities/browse_the_web.py

@@ -3,13 +3,15 @@
 from __future__ import annotations
 
 import os
-from typing import Type, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
 from selenium.webdriver import Chrome, Firefox, Remote, Safari
-from selenium.webdriver.remote.webdriver import WebDriver
 
 from ..exceptions import BrowsingError
 
+if TYPE_CHECKING:
+    from selenium.webdriver.remote.webdriver import WebDriver
+
 DEFAULT_APPIUM_HUB_URL = "http://localhost:4723/wd/hub"
 
 
@@ -33,22 +35,22 @@ class BrowseTheWeb:
     browser: WebDriver
 
     @classmethod
-    def using_chrome(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
+    def using_chrome(cls: type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         """Create and use a default Chrome Selenium webdriver instance."""
         return cls.using(browser=Chrome())
 
     @classmethod
-    def using_firefox(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
+    def using_firefox(cls: type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         """Create and use a default Firefox Selenium webdriver instance."""
         return cls.using(browser=Firefox())
 
     @classmethod
-    def using_safari(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
+    def using_safari(cls: type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         """Create and use a default Safari Selenium webdriver instance."""
         return cls.using(browser=Safari())
 
     @classmethod
-    def using_ios(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
+    def using_ios(cls: type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         """
         Create and use a default Remote driver instance.
 
@@ -81,7 +83,7 @@ def using_ios(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         return cls.using(browser=Remote(hub_url, IOS_CAPABILITIES))
 
     @classmethod
-    def using_android(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
+    def using_android(cls: type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         """
         Create and use a default Remote driver instance.
 
@@ -114,7 +116,7 @@ def using_android(cls: Type[SelfBrowseTheWeb]) -> SelfBrowseTheWeb:
         return cls.using(browser=Remote(hub_url, ANDROID_CAPABILITIES))
 
     @classmethod
-    def using(cls: Type[SelfBrowseTheWeb], browser: WebDriver) -> SelfBrowseTheWeb:
+    def using(cls: type[SelfBrowseTheWeb], browser: WebDriver) -> SelfBrowseTheWeb:
         """Provide an already-set-up WebDriver to use to browse the web."""
         return cls(browser=browser)
 

screenpy_selenium/actions/accept_alert.py

@@ -2,11 +2,15 @@
 
 from __future__ import annotations
 
-from screenpy.actor import Actor
+from typing import TYPE_CHECKING
+
 from screenpy.pacing import aside, beat
 
 from ..abilities import BrowseTheWeb
 
+if TYPE_CHECKING:
+    from screenpy.actor import Actor
+
 
 class AcceptAlert:
     """Accept an alert!

screenpy_selenium/actions/chain.py

@@ -2,14 +2,18 @@
 
 from __future__ import annotations
 
-from screenpy.actor import Actor
+from typing import TYPE_CHECKING
+
 from screenpy.exceptions import UnableToAct
 from screenpy.pacing import beat
 from selenium.webdriver.common.action_chains import ActionChains
 
 from ..abilities import BrowseTheWeb
 from ..protocols import Chainable
 
+if TYPE_CHECKING:
+    from screenpy.actor import Actor
+
 
 class Chain:
     """Group a series of chainable Actions together.

screenpy_selenium/actions/clear.py

@@ -2,14 +2,16 @@
 
 from __future__ import annotations
 
-from typing import Type, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
-from screenpy.actor import Actor
 from screenpy.exceptions import DeliveryError
 from screenpy.pacing import beat
 from selenium.common.exceptions import WebDriverException
 
-from ..target import Target
+if TYPE_CHECKING:
+    from screenpy.actor import Actor
+
+    from ..target import Target
 
 SelfClear = TypeVar("SelfClear", bound="Clear")
 
@@ -26,7 +28,7 @@ class Clear:
     """
 
     @classmethod
-    def the_text_from_the(cls: Type[SelfClear], target: Target) -> SelfClear:
+    def the_text_from_the(cls: type[SelfClear], target: Target) -> SelfClear:
         """
         Specify the Target from which to clear the text.
 
@@ -37,13 +39,13 @@ def the_text_from_the(cls: Type[SelfClear], target: Target) -> SelfClear:
         return cls(target=target)
 
     @classmethod
-    def the_text_from(cls: Type[SelfClear], target: Target) -> SelfClear:
+    def the_text_from(cls: type[SelfClear], target: Target) -> SelfClear:
         """Alias for :meth:`~screenpy_selenium.actions.Clear.the_text_from_the`."""
         return cls.the_text_from_the(target=target)
 
     @classmethod
     def the_text_from_the_first_of_the(
-        cls: Type[SelfClear], target: Target
+        cls: type[SelfClear], target: Target
     ) -> SelfClear:
         """Alias for :meth:`~screenpy_selenium.actions.Clear.the_text_from_the`."""
         return cls.the_text_from_the(target=target)

screenpy_selenium/actions/click.py

@@ -2,15 +2,17 @@
 
 from __future__ import annotations
 
-from typing import Optional, Type, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
-from screenpy.actor import Actor
 from screenpy.exceptions import DeliveryError, UnableToAct
 from screenpy.pacing import beat
 from selenium.common.exceptions import WebDriverException
-from selenium.webdriver.common.action_chains import ActionChains
 
-from ..target import Target
+if TYPE_CHECKING:
+    from screenpy.actor import Actor
+    from selenium.webdriver.common.action_chains import ActionChains
+
+    from ..target import Target
 
 SelfClick = TypeVar("SelfClick", bound="Click")
 
@@ -31,7 +33,7 @@ class Click:
     """
 
     @classmethod
-    def on_the(cls: Type[SelfClick], target: Target) -> SelfClick:
+    def on_the(cls: type[SelfClick], target: Target) -> SelfClick:
         """
         Target the element to click on.
 
@@ -42,12 +44,12 @@ def on_the(cls: Type[SelfClick], target: Target) -> SelfClick:
         return cls(target=target)
 
     @classmethod
-    def on(cls: Type[SelfClick], target: Target) -> SelfClick:
+    def on(cls: type[SelfClick], target: Target) -> SelfClick:
         """Alias for :meth:`~screenpy_selenium.actions.Click.on_the`."""
         return cls.on_the(target=target)
 
     @classmethod
-    def on_the_first_of_the(cls: Type[SelfClick], target: Target) -> SelfClick:
+    def on_the_first_of_the(cls: type[SelfClick], target: Target) -> SelfClick:
         """Alias for :meth:`~screenpy_selenium.actions.Click.on_the`."""
         return cls.on_the(target=target)
 
@@ -88,6 +90,6 @@ def add_to_chain(
 
         the_chain.click(on_element=the_element)
 
-    def __init__(self: SelfClick, target: Optional[Target] = None) -> None:
+    def __init__(self: SelfClick, target: Target | None = None) -> None:
         self.target = target
         self.description = f" on the {target}" if target is not None else ""

screenpy_selenium/actions/dismiss_alert.py

@@ -2,11 +2,15 @@
 
 from __future__ import annotations
 
-from screenpy.actor import Actor
+from typing import TYPE_CHECKING
+
 from screenpy.pacing import aside, beat
 
 from ..abilities import BrowseTheWeb
 
+if TYPE_CHECKING:
+    from screenpy.actor import Actor
+
 
 class DismissAlert:
     """Dismiss an alert.

screenpy_selenium/actions/double_click.py

@@ -2,14 +2,17 @@
 
 from __future__ import annotations
 
-from typing import Optional, Type, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
-from screenpy.actor import Actor
 from screenpy.pacing import beat
 from selenium.webdriver.common.action_chains import ActionChains
 
 from ..abilities import BrowseTheWeb
-from ..target import Target
+
+if TYPE_CHECKING:
+    from screenpy.actor import Actor
+
+    from ..target import Target
 
 SelfDoubleClick = TypeVar("SelfDoubleClick", bound="DoubleClick")
 
@@ -27,10 +30,10 @@ class DoubleClick:
         the_actor.attempts_to(Chain(DoubleClick()))
     """
 
-    target: Optional[Target]
+    target: Target | None
 
     @classmethod
-    def on_the(cls: Type[SelfDoubleClick], target: Target) -> SelfDoubleClick:
+    def on_the(cls: type[SelfDoubleClick], target: Target) -> SelfDoubleClick:
         """
         Target the element to double-click on.
 
@@ -41,13 +44,13 @@ def on_the(cls: Type[SelfDoubleClick], target: Target) -> SelfDoubleClick:
         return cls(target=target)
 
     @classmethod
-    def on(cls: Type[SelfDoubleClick], target: Target) -> SelfDoubleClick:
+    def on(cls: type[SelfDoubleClick], target: Target) -> SelfDoubleClick:
         """Alias for :meth:`~screenpy_selenium.actions.DoubleClick.on_the`."""
         return cls.on_the(target=target)
 
     @classmethod
     def on_the_first_of_the(
-        cls: Type[SelfDoubleClick], target: Target
+        cls: type[SelfDoubleClick], target: Target
     ) -> SelfDoubleClick:
         """Alias for :meth:`~screenpy_selenium.actions.DoubleClick.on_the`."""
         return cls.on_the(target=target)
@@ -82,6 +85,6 @@ def add_to_chain(
         """Add the DoubleClick Action to a Chain of Actions."""
         self._add_action_to_chain(the_actor, the_chain)
 
-    def __init__(self: SelfDoubleClick, target: Optional[Target] = None) -> None:
+    def __init__(self: SelfDoubleClick, target: Target | None = None) -> None:
         self.target = target
         self.description = f" on the {target}" if target is not None else ""

screenpy_selenium/actions/enter.py

@@ -3,16 +3,19 @@
 from __future__ import annotations
 
 from functools import partial
-from typing import List, Optional, Type, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
-from screenpy import Actor
 from screenpy.exceptions import DeliveryError, UnableToAct
 from screenpy.pacing import aside, beat
 from selenium.common.exceptions import WebDriverException
-from selenium.webdriver.common.action_chains import ActionChains
 
 from ..speech_tools import KEY_NAMES
-from ..target import Target
+
+if TYPE_CHECKING:
+    from screenpy import Actor
+    from selenium.webdriver.common.action_chains import ActionChains
+
+    from ..target import Target
 
 SelfEnter = TypeVar("SelfEnter", bound="Enter")
 
@@ -30,13 +33,13 @@ class Enter:
         )
     """
 
-    target: Optional[Target]
-    following_keys: List[str]
+    target: Target | None
+    following_keys: list[str]
     text: str
     text_to_log: str
 
     @classmethod
-    def the_text(cls: Type[SelfEnter], text: str) -> SelfEnter:
+    def the_text(cls: type[SelfEnter], text: str) -> SelfEnter:
         """Provide the text to enter into the field.
 
         Aliases:
@@ -45,12 +48,12 @@ def the_text(cls: Type[SelfEnter], text: str) -> SelfEnter:
         return cls(text=text)
 
     @classmethod
-    def the_keys(cls: Type[SelfEnter], text: str) -> SelfEnter:
+    def the_keys(cls: type[SelfEnter], text: str) -> SelfEnter:
         """Alias for :meth:`~screenpy_selenium.actions.Enter.the_text`."""
         return cls.the_text(text=text)
 
     @classmethod
-    def the_secret(cls: Type[SelfEnter], text: str) -> SelfEnter:
+    def the_secret(cls: type[SelfEnter], text: str) -> SelfEnter:
         """
         Provide the text to enter into the field, but mask it in logging.
 
@@ -62,7 +65,7 @@ def the_secret(cls: Type[SelfEnter], text: str) -> SelfEnter:
         return cls(text=text, mask=True)
 
     @classmethod
-    def the_password(cls: Type[SelfEnter], text: str) -> SelfEnter:
+    def the_password(cls: type[SelfEnter], text: str) -> SelfEnter:
         """Alias for :meth:`~screenpy_selenium.actions.Enter.the_secret`."""
         return cls.the_secret(text=text)