more types

Author: andiwand

.gitignore

@@ -0,0 +1,188 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

src/htmlcmp/compare_output.py

@@ -17,7 +17,7 @@ class Config:
     thread_local = threading.local()
 
 
-def parse_json(path: Path):
+def parse_json(path: Path) -> dict:
     if not isinstance(path, Path):
         raise TypeError(f"Expected Path, got {type(path)}")
     if not path.is_file():
@@ -27,7 +27,7 @@ def parse_json(path: Path):
         return json.load(f)
 
 
-def compare_json(a: Path, b: Path):
+def compare_json(a: Path, b: Path) -> bool:
     if not isinstance(a, Path) or not isinstance(b, Path):
         raise TypeError("Both arguments must be of type Path")
     if not a.is_file() or not b.is_file():
@@ -38,7 +38,7 @@ def compare_json(a: Path, b: Path):
     return json_a == json_b
 
 
-def compare_html(a: Path, b: Path, browser=None, diff_output: Path = None):
+def compare_html(a: Path, b: Path, browser=None, diff_output: Path = None) -> bool:
     if not isinstance(a, Path) or not isinstance(b, Path):
         raise TypeError("Both arguments must be of type Path")
     if not a.is_file() or not b.is_file():
@@ -56,7 +56,7 @@ def compare_html(a: Path, b: Path, browser=None, diff_output: Path = None):
     return result
 
 
-def compare_files(a: Path, b: Path, **kwargs):
+def compare_files(a: Path, b: Path, **kwargs) -> bool:
     if not isinstance(a, Path) or not isinstance(b, Path):
         raise TypeError("Both arguments must be of type Path")
     if not a.is_file() or not b.is_file():
@@ -70,7 +70,7 @@ def compare_files(a: Path, b: Path, **kwargs):
         return compare_html(a, b, **kwargs)
 
 
-def comparable_file(path: Path):
+def comparable_file(path: Path) -> bool:
     if not isinstance(path, Path):
         raise TypeError(f"Expected Path, got {type(path)}")
     if not path.is_file():
@@ -83,7 +83,9 @@ def comparable_file(path: Path):
     return False
 
 
-def submit_compare_dirs(a: Path, b: Path, executor, diff_output: Path = None, **kwargs):
+def submit_compare_dirs(
+    a: Path, b: Path, executor, diff_output: Path = None, **kwargs
+) -> dict[str, list[Path]]:
     if not isinstance(a, Path) or not isinstance(b, Path):
         raise TypeError("Both arguments must be of type Path")
     if not a.is_dir() or not b.is_dir():
@@ -155,7 +157,7 @@ def compare(path_a, path_b, diff_output):
 
 def print_results(
     results: dict[str, list[Path]], a: Path, b: Path, level: int = 0, prefix: str = ""
-):
+) -> dict[str, list[Path]]:
     if not isinstance(a, Path) or not isinstance(b, Path):
         raise TypeError("Both arguments must be of type Path")
     if not a.is_dir() or not b.is_dir():

src/htmlcmp/html_render_diff.py

@@ -14,7 +14,7 @@
 from selenium.webdriver.support.ui import WebDriverWait
 
 
-def to_url(path: str | Path):
+def to_url(path: str | Path) -> str:
     if not isinstance(path, (str, Path)):
         raise TypeError(f"Expected str or Path, got {type(path)}")
 
@@ -25,9 +25,11 @@ def to_url(path: str | Path):
     return path
 
 
-def screenshot(browser, url: str):
+def screenshot(browser: webdriver.Remote, url: str) -> Image.Image:
     if not isinstance(url, str):
         raise TypeError(f"Expected str, got {type(url)}")
+    if not isinstance(browser, webdriver.Remote):
+        raise TypeError(f"Expected webdriver.Remote, got {type(browser)}")
 
     browser.get(url)
 
@@ -57,7 +59,9 @@ def screenshot(browser, url: str):
     return Image.open(io.BytesIO(png))
 
 
-def get_browser(driver: str, max_width: int = 1000, max_height: int = 10000):
+def get_browser(
+    driver: str, max_width: int = 1000, max_height: int = 10000
+) -> webdriver.Remote:
     if not isinstance(driver, str):
         raise TypeError(f"Expected str, got {type(driver)}")
     if not isinstance(max_width, int) or not isinstance(max_height, int):
@@ -81,9 +85,13 @@ def get_browser(driver: str, max_width: int = 1000, max_height: int = 10000):
     return browser
 
 
-def html_render_diff(a: str | Path, b: str | Path, browser):
-    if browser is None:
-        raise TypeError("Browser instance cannot be None")
+def html_render_diff(
+    a: str | Path, b: str | Path, browser: webdriver.Remote
+) -> tuple[Image.Image, tuple[Image.Image, Image.Image]]:
+    if not isinstance(a, (str, Path)) or not isinstance(b, (str, Path)):
+        raise TypeError("Both a and b must be str or Path instances")
+    if not isinstance(browser, webdriver.Remote):
+        raise TypeError(f"Expected webdriver.Remote, got {type(browser)}")
 
     image_a = screenshot(browser, to_url(a))
     image_b = screenshot(browser, to_url(b))