Merge pull request #706 from VWS-Python/more-beartype

Use beartype on all commands

Author: adamtheturtle

pyproject.toml

@@ -33,14 +33,14 @@ dynamic = [
     "version",
 ]
 dependencies = [
+    "beartype>=0.18.5",
     "click",
     "pyyaml",
     "selenium",
 ]
 
 optional-dependencies.dev = [
     "actionlint-py==1.7.1.15",
-    "beartype==0.18.5",
     "check-manifest==0.49",
     "deptry==0.20.0",
     "doc8==1.1.1",

src/vws_web_tools/__init__.py

@@ -8,6 +8,7 @@
 
 import click
 import yaml
+from beartype import beartype
 from selenium import webdriver
 from selenium.common.exceptions import WebDriverException
 from selenium.webdriver.common.by import By
@@ -18,6 +19,7 @@
 from selenium.webdriver.support.wait import WebDriverWait
 
 
+@beartype
 class DatabaseDict(TypedDict):
     """
     A dictionary type which represents a database.
@@ -30,6 +32,7 @@ class DatabaseDict(TypedDict):
     client_secret_key: str
 
 
+@beartype
 def log_in(
     driver: WebDriver,
     email_address: str,
@@ -48,9 +51,8 @@ def log_in(
     password_input_element.send_keys(Keys.RETURN)
 
 
-def wait_for_logged_in(
-    driver: WebDriver,
-) -> None:  # pragma: no cover
+@beartype
+def wait_for_logged_in(driver: WebDriver) -> None:  # pragma: no cover
     """
     Wait for the user to be logged in.
 
@@ -64,6 +66,7 @@ def wait_for_logged_in(
     )
 
 
+@beartype
 def create_license(
     driver: WebDriver,
     license_name: str,
@@ -116,6 +119,7 @@ def create_license(
     agree_terms_checkbox_element.submit()
 
 
+@beartype
 def create_database(
     driver: WebDriver,
     database_name: str,
@@ -178,6 +182,7 @@ def create_database(
     time.sleep(5)
 
 
+@beartype
 def get_database_details(
     driver: WebDriver,
     database_name: str,
@@ -255,13 +260,15 @@ def get_database_details(
     }
 
 
+@beartype
 @click.group(name="vws-web")
 def vws_web_tools_group() -> None:
     """
     Commands for interacting with VWS.
     """
 
 
+@beartype
 @click.command()
 @click.option("--license-name", required=True)
 @click.option("--email-address", envvar="VWS_EMAIL_ADDRESS", required=True)
@@ -281,6 +288,7 @@ def create_vws_license(
     driver.close()
 
 
+@beartype
 @click.command()
 @click.option("--license-name", required=True)
 @click.option("--database-name", required=True)
@@ -306,6 +314,7 @@ def create_vws_database(
     driver.close()
 
 
+@beartype
 @click.command()
 @click.option("--database-name", required=True)
 @click.option("--email-address", envvar="VWS_EMAIL_ADDRESS", required=True)

tests/conftest.py

@@ -6,6 +6,7 @@
 from beartype import beartype
 
 
+@beartype
 def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
     """
     Apply the beartype decorator to all collected test functions.