htmlcmp 1.0.11__tar.gz → 1.0.13__tar.gz

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: htmlcmp
-Version: 1.0.11
+Version: 1.0.13
 Summary: Compare HTML files by rendered output
 Author: Andreas Stefl
 Maintainer-email: Andreas Stefl <stefl.andreas@gmail.com>

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "htmlcmp"
-version = "1.0.11"
+version = "1.0.13"
 description = "Compare HTML files by rendered output"
 classifiers = []
 authors = [
@@ -32,6 +32,9 @@ download = "https://pypi.org/project/pyodr/#files"
 tracker = "https://github.com/opendocument-app/compare-html/issues"
 "release notes" = "https://github.com/opendocument-app/compare-html/releases"
 
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
 [build-system]
 requires = [
     "setuptools",

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/src/htmlcmp/compare_output.py

@@ -17,18 +17,33 @@ class Config:
     thread_local = threading.local()
 
 
-def parse_json(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():
+        raise FileNotFoundError(f"File not found: {path}")
+
     with open(path) as f:
         return json.load(f)
 
 
-def compare_json(a, b):
+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():
+        raise FileNotFoundError("Both arguments must be files")
+
     json_a = json.dumps(parse_json(a), sort_keys=True)
     json_b = json.dumps(parse_json(b), sort_keys=True)
     return json_a == json_b
 
 
-def compare_html(a, b, browser=None, diff_output=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():
+        raise FileNotFoundError("Both arguments must be files")
+
     if browser is None:
         browser = get_browser()
     diff, (image_a, image_b) = html_render_diff(a, b, browser=browser)
@@ -41,7 +56,12 @@ def compare_html(a, b, browser=None, diff_output=None):
     return result
 
 
-def compare_files(a, b, **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():
+        raise FileNotFoundError("Both arguments must be files")
+
     if filecmp.cmp(a, b):
         return True
     if a.suffix == ".json":
@@ -50,7 +70,12 @@ def compare_files(a, b, **kwargs):
         return compare_html(a, b, **kwargs)
 
 
-def comparable_file(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():
+        raise FileNotFoundError(f"File not found: {path}")
+
     if path.suffix == ".json":
         return True
     if path.suffix == ".html":
@@ -58,7 +83,14 @@ def comparable_file(path):
     return False
 
 
-def submit_compare_dirs(a, b, executor, diff_output=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():
+        raise FileNotFoundError("Both arguments must be directories")
+
     results = {
         "common_dirs": [],
         "common_files": [],
@@ -123,7 +155,16 @@ def submit_compare_dirs(a, b, executor, diff_output=None, **kwargs):
     return results
 
 
-def print_results(results, a, b, level=0, prefix=""):
+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():
+        raise FileNotFoundError("Both arguments must be directories")
+    if not isinstance(results, dict):
+        raise TypeError("Results must be a dictionary")
+
     prefix_file = prefix + "├── "
     if level == 0:
         print(f"compare dir {a} with {b}")

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/src/htmlcmp/compare_output_server.py

@@ -8,18 +8,18 @@ import io
 from pathlib import Path
 from concurrent.futures import ThreadPoolExecutor
 
-from compare_output import comparable_file, compare_files
 from flask import Flask, send_from_directory, send_file
 import watchdog.observers
 import watchdog.events
 
-from html_render_diff import get_browser, html_render_diff
+from htmlcmp.compare_output import comparable_file, compare_files
+from htmlcmp.html_render_diff import get_browser, html_render_diff
 
 
 class Config:
-    path_a = None
-    path_b = None
-    driver = None
+    path_a: Path = None
+    path_b: Path = None
+    driver: str = None
     observer = None
     comparator = None
     browser = None
@@ -46,7 +46,12 @@ class Observer:
     def start(self):
         self._observer.start()
 
-        def init_compare(a, b):
+        def init_compare(a: Path, b: Path):
+            if not isinstance(a, Path) or not isinstance(b, Path):
+                raise TypeError("Paths must be of type Path")
+            if not a.is_dir() or not b.is_dir():
+                raise ValueError("Both paths must be directories")
+
             common_path = a / Config.path_a
 
             left = sorted(p.name for p in a.iterdir())
@@ -70,7 +75,7 @@ class Observer:
 
 
 class Comparator:
-    def __init__(self, max_workers):
+    def __init__(self, max_workers: int):
         def initializer():
             browser = getattr(Config.thread_local, "browser", None)
             if browser is None:
@@ -83,7 +88,10 @@ class Comparator:
         self._result = {}
         self._future = {}
 
-    def submit(self, path):
+    def submit(self, path: Path):
+        if not isinstance(path, Path):
+            raise TypeError("Path must be of type Path")
+
         if path in self._future:
             try:
                 self._future[path].cancel()
@@ -95,7 +103,14 @@ class Comparator:
         self._result[path] = "pending"
         self._future[path] = self._executor.submit(self.compare, path)
 
-    def compare(self, path):
+    def compare(self, path: Path):
+        if not isinstance(path, Path):
+            raise TypeError("Path must be of type Path")
+        if not path.is_file():
+            raise ValueError("Path must be a file")
+        if path not in self._future:
+            raise RuntimeError("Path not submitted for comparison")
+
         browser = getattr(Config.thread_local, "browser", None)
         result = compare_files(
             Config.path_a / path,
@@ -105,12 +120,18 @@ class Comparator:
         self._result[path] = "same" if result else "different"
         self._future.pop(path)
 
-    def result(self, path):
+    def result(self, path: Path):
+        if not isinstance(path, Path):
+            raise TypeError("Path must be of type Path")
+
         if path in self._result:
             return self._result[path]
         return "unknown"
 
-    def result_symbol(self, path):
+    def result_symbol(self, path: Path):
+        if not isinstance(path, Path):
+            raise TypeError("Path must be of type Path")
+
         result = self.result(path)
         if result == "pending":
             return "🔄"
@@ -120,7 +141,10 @@ class Comparator:
             return "❌"
         return "⛔"
 
-    def result_css(self, path):
+    def result_css(self, path: Path):
+        if not isinstance(path, Path):
+            raise TypeError("Path must be of type Path")
+
         result = self.result(path)
         if result == "pending":
             return "color:blue;"
@@ -136,7 +160,12 @@ app = Flask("compare")
 
 @app.route("/")
 def root():
-    def print_tree(a, b):
+    def print_tree(a: Path, b: Path):
+        if not isinstance(a, Path) or not isinstance(b, Path):
+            raise TypeError("Paths must be of type Path")
+        if not a.is_dir() or not b.is_dir():
+            raise ValueError("Both paths must be directories")
+
         common_path = a / Config.path_a
 
         left = sorted(p.name for p in a.iterdir())
@@ -209,7 +238,10 @@ def root():
 
 
 @app.route("/compare/<path:path>")
-def compare(path):
+def compare(path: str):
+    if not isinstance(path, str):
+        raise TypeError("Path must be a string")
+
     return f"""<!DOCTYPE html>
 <html>
 <head>
@@ -219,7 +251,7 @@ html,body {{height:100%;margin:0;}}
 </head>
 <body style="display:flex;flex-flow:row;">
 <div style="display:flex;flex:1;flex-flow:column;margin:5px;">
-  <a href="/file/a/{path}">{Config.path_a /path}</a>
+  <a href="/file/a/{path}">{Config.path_a / path}</a>
   <iframe id="a" src="/file/a/{path}" title="a" frameborder="0" align="left" style="flex:1;"></iframe>
 </div>
 <div style="display:flex;flex:0 0 50px;flex-flow:column;">
@@ -246,7 +278,10 @@ iframe_b.contentWindow.addEventListener('scroll', function(event) {{
 
 
 @app.route("/image_diff/<path:path>")
-def image_diff(path):
+def image_diff(path: str):
+    if not isinstance(path, str):
+        raise TypeError("Path must be a string")
+
     diff, _ = html_render_diff(
         Config.path_a / path,
         Config.path_b / path,
@@ -259,7 +294,12 @@ def image_diff(path):
 
 
 @app.route("/file/<variant>/<path:path>")
-def file(variant, path):
+def file(variant: str, path: str):
+    if not isinstance(variant, str) or not isinstance(path, str):
+        raise TypeError("Variant and path must be strings")
+    if variant not in ["a", "b"]:
+        raise ValueError("Variant must be 'a' or 'b'")
+
     variant_root = Config.path_a if variant == "a" else Config.path_b
     return send_from_directory(variant_root, path)
 

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/src/htmlcmp/html_render_diff.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+import shutil
 import sys
 import argparse
 import io
@@ -14,13 +15,23 @@ from selenium.webdriver.support import expected_conditions
 from selenium.webdriver.support.ui import WebDriverWait
 
 
-def to_url(path):
-    if path.is_file():
+def to_url(path: str | Path) -> str:
+    if not isinstance(path, (str, Path)):
+        raise TypeError(f"Expected str or Path, got {type(path)}")
+
+    if isinstance(path, Path):
+        if not path.is_file():
+            raise FileNotFoundError(f"File not found: {path}")
         return path.resolve().as_uri()
     return path
 
 
-def screenshot(browser, url):
+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)
 
     target_find_by = By.TAG_NAME
@@ -49,22 +60,42 @@ def screenshot(browser, url):
     return Image.open(io.BytesIO(png))
 
 
-def get_browser(driver="firefox", max_width=1000, max_height=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):
+        raise TypeError(
+            f"Expected int for max_width and max_height, got {type(max_width)} and {type(max_height)}"
+        )
+
     if driver == "phantomjs":
+        if shutil.which("phantomjs") is None:
+            raise EnvironmentError("PhantomJS is not installed or not found in PATH")
         browser = webdriver.PhantomJS()
     elif driver == "firefox":
         options = webdriver.FirefoxOptions()
         options.add_argument("--headless")
         browser = webdriver.Firefox(options=options)
-    else:  # chrome or unknown
+    elif driver == "chrome":
         options = webdriver.ChromeOptions()
         options.add_argument("--headless=new")
         browser = webdriver.Chrome(options=options)
+    else:
+        raise ValueError(f"Unsupported driver: {driver}")
     browser.set_window_size(max_width, max_height)
     return browser
 
 
-def html_render_diff(a, b, browser):
+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))
 

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/src/htmlcmp/tidy_output.py

@@ -10,7 +10,12 @@ from pathlib import Path
 from htmlcmp.common import bcolors
 
 
-def tidy_json(path):
+def tidy_json(path: Path) -> int:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+
     try:
         with open(path, "r") as f:
             json.load(f)
@@ -19,7 +24,16 @@ def tidy_json(path):
         return 1
 
 
-def tidy_html(path, html_tidy_config=None):
+def tidy_html(path: Path, html_tidy_config: Path = None) -> int:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+    if html_tidy_config is not None and not isinstance(html_tidy_config, Path):
+        raise TypeError("html_tidy_config must be a Path object or None")
+    if html_tidy_config is not None and not html_tidy_config.is_file():
+        raise FileNotFoundError(f"{html_tidy_config} is not a file")
+
     cmd = ["tidy"]
     if html_tidy_config:
         cmd.extend(["-config", str(html_tidy_config.resolve())])
@@ -34,14 +48,24 @@ def tidy_html(path, html_tidy_config=None):
     return 0
 
 
-def tidy_file(path, html_tidy_config=None):
+def tidy_file(path: Path, html_tidy_config: Path = None) -> int:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+
     if path.suffix == ".json":
         return tidy_json(path)
     elif path.suffix == ".html":
         return tidy_html(path, html_tidy_config=html_tidy_config)
 
 
-def tidyable_file(path):
+def tidyable_file(path: Path) -> bool:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+
     if path.suffix == ".json":
         return True
     if path.suffix == ".html":
@@ -49,7 +73,22 @@ def tidyable_file(path):
     return False
 
 
-def tidy_dir(path, level=0, prefix="", html_tidy_config=None):
+def tidy_dir(
+    path: Path, level: int = 0, prefix: str = "", html_tidy_config: Path = None
+) -> dict[str, list[Path]]:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_dir():
+        raise NotADirectoryError(f"{path} is not a directory")
+    if not isinstance(level, int) or level < 0:
+        raise ValueError("level must be a non-negative integer")
+    if not isinstance(prefix, str):
+        raise TypeError("prefix must be a string")
+    if html_tidy_config is not None and not isinstance(html_tidy_config, Path):
+        raise TypeError("html_tidy_config must be a Path object or None")
+    if html_tidy_config is not None and not html_tidy_config.is_file():
+        raise FileNotFoundError(f"{html_tidy_config} is not a file")
+
     prefix_file = prefix + "├── "
     if level == 0:
         print(f"tidy dir {path}")

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/src/htmlcmp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: htmlcmp
-Version: 1.0.11
+Version: 1.0.13
 Summary: Compare HTML files by rendered output
 Author: Andreas Stefl
 Maintainer-email: Andreas Stefl <stefl.andreas@gmail.com>

{htmlcmp-1.0.11 → htmlcmp-1.0.13}/src/htmlcmp.egg-info/SOURCES.txt

@@ -11,4 +11,5 @@ src/htmlcmp.egg-info/SOURCES.txt
 src/htmlcmp.egg-info/dependency_links.txt
 src/htmlcmp.egg-info/entry_points.txt
 src/htmlcmp.egg-info/requires.txt
-src/htmlcmp.egg-info/top_level.txt
+src/htmlcmp.egg-info/top_level.txt
+tests/test_html_render_diff.py

htmlcmp-1.0.13/tests/test_html_render_diff.py

@@ -0,0 +1,53 @@
+import pytest
+from pathlib import Path
+import shutil
+
+from htmlcmp.html_render_diff import to_url, get_browser, html_render_diff
+
+
+def test_to_url():
+    with pytest.raises(TypeError):
+        to_url(None)
+    with pytest.raises(TypeError):
+        to_url(1)
+    with pytest.raises(FileNotFoundError):
+        to_url(Path(__file__).parent)
+    assert to_url("file:///path/to/file") == "file:///path/to/file"
+    assert to_url("https://example.com") == "https://example.com"
+    assert to_url(Path(__file__))
+
+
+def test_get_browser():
+    with pytest.raises(ValueError):
+        get_browser("unsupported_driver")
+
+    # Test with Chrome
+    browser = get_browser("chrome")
+    assert browser.name == "chrome"
+    browser.quit()
+
+    # Test with Firefox
+    browser = get_browser("firefox")
+    assert browser.name == "firefox"
+    browser.quit()
+
+    # Test with PhantomJS
+    if shutil.which("phantomjs") is not None:
+        browser = get_browser("phantomjs")
+        assert browser.name == "phantomjs"
+        browser.quit()
+
+
+def test_html_render_diff():
+    test1 = Path(__file__).parent / "test1.html"
+    test2 = Path(__file__).parent / "test2.html"
+
+    with pytest.raises(TypeError):
+        html_render_diff(None, None, None)
+    with pytest.raises(TypeError):
+        html_render_diff(str(test1), str(test2), None)
+
+    diff, _ = html_render_diff(test1, test1, get_browser("firefox"))
+    assert diff.getbbox() is None
+    diff, _ = html_render_diff(test1, test2, get_browser("firefox"))
+    assert diff.getbbox() is not None