webcode-tk 1.2.4__tar.gz → 1.2.7__tar.gz

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: webcode-tk
-Version: 1.2.4
-Summary: 
+Version: 1.2.7
+Summary: A set of tools for inspecting HTML and CSS code
 License: MIT
 License-File: LICENSE.rst
 Keywords: html,validation,css
@@ -23,6 +23,7 @@ Requires-Dist: lxml (>=6.0.0,<7.0.0)
 Requires-Dist: mechanicalsoup (>=1.4.0,<2.0.0)
 Requires-Dist: nltk (>=3.8.1,<4.0.0)
 Requires-Dist: py-readability-metrics (>=1.4.5,<2.0.0)
+Requires-Dist: pytest-mock (>=3.15.1,<4.0.0)
 Requires-Dist: requests (>=2.28.1,<3.0.0)
 Requires-Dist: textatistic (>=0.0.1,<0.0.2)
 Requires-Dist: tinycss2 (>=1.4.0,<2.0.0)

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "webcode-tk"
-version = "1.2.4"
-description = ""
+version = "1.2.7"
+description = "A set of tools for inspecting HTML and CSS code"
 authors = ["hundredvisionsguy <cwinikka@gmail.com>"]
 keywords = ["html", "validation", "css", ]
 license = "MIT"
@@ -26,6 +26,7 @@ nltk = "^3.8.1"
 tinycss2 = "^1.4.0"
 lxml = "^6.0.0"
 mechanicalsoup = "^1.4.0"
+pytest-mock = "^3.15.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "*"

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/webcode_tk/__init__.py

@@ -16,6 +16,11 @@
 
 - **`color_tools`**: processes CSS color related properties and values.
 
+- **`contrast_tools`**: calculates contrast results taking into account how
+          the background is invisible, but still affects contrast on elements
+          even if those elements do not have a background color explicitly
+          applied. It also only checks elements with text in the innerHTML.
+
 - **`css_tools`**: creates Stylesheet objects that store CSS information.
 
 - **`font_tools`**: A collection of functions used to process font-related
@@ -35,4 +40,4 @@
 - **`validator_tools`**: sends HTML or CSS code to the W3C Validator to check
           for errors.
 """
-__version__ = "1.2.4"
+__version__ = "1.2.7"

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/webcode_tk/color_tools.py

@@ -409,7 +409,7 @@ def hex_to_decimal(c: str) -> int:
         msg += "2 digits"
         raise ValueError(msg)
     if c[0].lower() not in hex_map.keys():
-        raise ValueError(f"The value `{c}` is not a valid hex code.")
+        raise ValueError(f"The value {repr(c)} is not a valid hex code.")
     c = c.lower()
     ones = hex_map[c[1]]
     sixteens = hex_map[c[0]] * 16

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/webcode_tk/contrast_tools.py

@@ -158,7 +158,8 @@ def generate_contrast_report(
             msg = f"{result}: in {current_file}, the {element} failed WCAG "
             msg += f"{wcag_level} contrast requirements (ratio: "
             msg += f"{actual_ratio}, required: {target_ratio})."
-            project_files[current_file].append(msg)
+            if msg not in project_files[current_file]:
+                project_files[current_file].append(msg)
 
     # Check for html docs with no fails.
     for file in project_files:
@@ -169,9 +170,21 @@ def generate_contrast_report(
             else:
                 report.extend(errors)
         else:
-            msg = f"pass: {file} passes color contrast."
-            report.append(msg)
+            # Check for global selectors (html, *, or body) and calculate
+            # contrast
+            global_color_result = css_tools.get_global_color_report(
+                project_path
+            )
+            if isinstance(global_color_result, list):
+                for result in global_color_result:
+                    if "fail" in result:
+                        if file in result:
+                            error_msg = result.split(file)[1]
+                            msg = f"fail: in {file}, {error_msg.strip()}"
+                    else:
+                        msg = f"pass: {file} passes color contrast."
 
+            report.append(msg)
     return report
 
 
@@ -194,7 +207,7 @@ def analyze_contrast(project_folder: str) -> list[dict]:
 
     # Analyze CSS Files
     for html_doc in parsed_html_docs:
-        doc_results = analyze_css(html_doc, css_files)
+        doc_results = analyze_css(html_doc, css_files, project_folder)
         project_contrast_results.extend(doc_results)
     return project_contrast_results
 
@@ -368,7 +381,9 @@ def append_style_data(
     css_source[html_file].append(data)
 
 
-def analyze_css(html_doc: dict, css_files: list[dict]) -> list[dict]:
+def analyze_css(
+    html_doc: dict, css_files: list[dict], project_path=""
+) -> list[dict]:
     """
     Analyzes CSS application and color contrast for a single HTML document.
 
@@ -389,6 +404,9 @@ def analyze_css(html_doc: dict, css_files: list[dict]) -> list[dict]:
     filename = html_doc["filename"]
     soup = html_doc["soup"]
 
+    # Check to see if background color was set globally
+    global_bg = detect_document_background(project_path, filename)
+
     # Check for CSS sources and create warnings if needed
     warnings = []
 
@@ -404,7 +422,7 @@ def analyze_css(html_doc: dict, css_files: list[dict]) -> list[dict]:
         )
 
     # Step 1: Apply default styles to all elements
-    default_styles = apply_browser_defaults(soup)
+    default_styles = apply_browser_defaults(soup, default_bg=global_bg)
 
     # Find CSS rules specific to this HTML document
     doc_css_rules = get_css_rules_for_document(filename, css_files)
@@ -452,10 +470,50 @@ def analyze_css(html_doc: dict, css_files: list[dict]) -> list[dict]:
                 "warning_impact": warning["impact"],
             }
             doc_results.append(warning_result)
-
     return doc_results
 
 
+def detect_document_background(project_path: str, filename: str) -> str:
+    """
+    Detect global background color from CSS rules for this document.
+
+    Args:
+        project_path: Path to project root
+        filename: Name of current HTML file
+
+    Returns:
+        str: Background color hex value, or DEFAULT_GLOBAL_BACKGROUND if
+            none found
+    """
+    # Get global colors for entire project
+    global_colors = css_tools.get_project_global_colors(project_path)
+
+    # Find entry for this specific HTML file
+    for file_path, color_data_list in global_colors.items():
+        # Match filename (handle both full path and just filename)
+        if filename in file_path:
+            # color_data_list is a list of dicts with global selector info
+            if isinstance(color_data_list, dict):
+                color_data_list = [
+                    color_data_list,
+                ]
+            for color_data in color_data_list:
+                # Look for body selector specifically
+                if color_data.get("selector") == "body":
+                    bg_color = color_data.get("background-color")
+                    if bg_color:
+                        return bg_color
+
+                # Also check for html or * selectors
+                if color_data.get("selector") in ["html", "*"]:
+                    bg_color = color_data.get("background-color")
+                    if bg_color:
+                        return bg_color
+
+    # No global background found, use default white
+    return DEFAULT_GLOBAL_BACKGROUND
+
+
 def has_any_css_sources(soup: BeautifulSoup) -> bool:
     """
     Check if HTML document has any CSS sources (external or internal).
@@ -483,7 +541,9 @@ def has_any_css_sources(soup: BeautifulSoup) -> bool:
     return False
 
 
-def apply_browser_defaults(soup: BeautifulSoup) -> dict:
+def apply_browser_defaults(
+    soup: BeautifulSoup, default_bg: str = DEFAULT_GLOBAL_BACKGROUND
+) -> dict:
     """
     Apply browser default styles to all elements with text content.
 
@@ -504,7 +564,7 @@ def apply_browser_defaults(soup: BeautifulSoup) -> dict:
                     "is_default": True,
                 },
                 "background-color": {
-                    "value": DEFAULT_GLOBAL_BACKGROUND,
+                    "value": default_bg,
                     "specificity": default_specificity,
                     "source": "default",
                     "is_default": True,
@@ -1613,5 +1673,9 @@ def element_name_or_default(property_data: dict) -> str:
 
 if __name__ == "__main__":
     project_path = "tests/test_files/large_project/"
-    contrast_results = generate_contrast_report(project_path, "AA")
+    project_path = "tests/test_files/contrast_tool_test/"
+    contrast_results = generate_contrast_report(project_path, "AAA")
+    project_path = "tests/test_files/contrast_tool_test/"
+    global_colors = css_tools.get_project_global_colors(project_path)
+    print(global_colors)
     print(contrast_results)

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/webcode_tk/css_tools.py

@@ -2458,7 +2458,10 @@ def get_global_color_report(project_dir: str, level="aaa") -> list:
             if global_color_data:
                 for item in global_color_data:
                     file, result = get_color_data(filename, item, level)
-                    passes.append(f"pass: {file} {result}")
+                    if "fail" in result:
+                        passes.append(f"fail: {file} {result}")
+                    else:
+                        passes.append(f"pass: {file} {result}")
         if passes:
             details = ""
             for detail in passes:
@@ -2877,3 +2880,7 @@ if __name__ == "__main__":
     rulesets = get_element_rulesets(
         "tests/test_files/cascade_complexities", "figure"
     )
+    passing_global_colors = get_global_color_report(project_folder)
+    project_path = "tests/test_files/contrast_tool_test/"
+    global_colors = get_global_color_report(project_path)
+    print(global_colors)

{webcode_tk-1.2.4 → webcode_tk-1.2.7}/webcode_tk/validator_tools.py

@@ -96,11 +96,16 @@ def get_markup_validity(file_path: str) -> list:
         headers = {
             "content-type": "text/html; charset=utf-8",
             "Accept-Charset": "UTF-8",
+            "User-Agent": "python-requests/2.32.5",
         }
 
         r = requests.post(w3cURL, data=payload, headers=headers)
-        errors = r.json()
-        errors = errors.get("messages")
+        try:
+            errors = r.json()
+            errors = errors.get("messages")
+        except Exception:
+            # We need to use the web browser
+            errors = get_validation_by_browser(file_path)
 
         # raise the alarm if the response code is not 200
         if r.status_code != 200:
@@ -220,6 +225,45 @@ def is_css_valid(validator_results):
     return bool(soup.find(id="congrats"))
 
 
+def get_validation_by_browser(file_path: str) -> list:
+    """Validates HTML using the browser.
+
+    This function will get the HTML code by file and use the mechanical
+    soup browser to get validator results as a ResultSet.
+
+    Args:
+        css_code: CSS code in the form of a string.
+
+    Returns:
+        results: A ResultSet of Tag objects.
+    """
+    # Get HTML code from file path
+    html_code = clerk.file_to_string(file_path)
+    try:
+        response = browser.open("https://validator.w3.org/")
+        if not response.ok:
+            response = browser.open("https://validator.w3.org/nu/#textarea")
+            browser.select_form("form")
+            browser["doc"] = html_code
+            browser.submit_selected()
+            results = browser.get_current_page().select("div#results")
+        else:
+            browser.select_form("#validate-by-input form")
+            browser["fragment"] = html_code
+            browser.submit_selected()
+            results = browser.get_current_page().select("div#results")
+    except Exception:
+        # Convert the file "no_css_connection.html" into a soup tag object
+        no_connection_code = (
+            "<h1>Sorry, but we could not make a connection</h1>"
+        )
+        no_connection_code += "<h2>Please try later</h2>"
+        soup = BeautifulSoup(no_connection_code, "lxml")
+        # Convert string to result set
+        results = soup.contents
+    return results
+
+
 def validate_css(css_code: str) -> bs4.ResultSet:
     """Validates CSS and returns the results from the css-validator.