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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webcode-tk
-Version: 1.2.4
+Version: 1.2.6
 Summary: 
 License: MIT
 License-File: LICENSE.rst
@@ -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.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "webcode-tk"
-version = "1.2.4"
+version = "1.2.6"
 description = ""
 authors = ["hundredvisionsguy <cwinikka@gmail.com>"]
 keywords = ["html", "validation", "css", ]
@@ -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.6}/webcode_tk/__init__.py

@@ -35,4 +35,4 @@
 - **`validator_tools`**: sends HTML or CSS code to the W3C Validator to check
           for errors.
 """
-__version__ = "1.2.4"
+__version__ = "1.2.6"

{webcode_tk-1.2.4 → webcode_tk-1.2.6}/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.6}/webcode_tk/contrast_tools.py

@@ -169,9 +169,20 @@ def generate_contrast_report(
             else:
                 report.extend(errors)
         else:
-            msg = f"pass: {file} passes color contrast."
+            # 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 +205,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 +379,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.
 
@@ -452,7 +465,6 @@ def analyze_css(html_doc: dict, css_files: list[dict]) -> list[dict]:
                 "warning_impact": warning["impact"],
             }
             doc_results.append(warning_result)
-
     return doc_results
 
 
@@ -1613,5 +1625,6 @@ 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")
     print(contrast_results)

{webcode_tk-1.2.4 → webcode_tk-1.2.6}/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.