webcode-tk 0.7.3__tar.gz → 0.7.5__tar.gz

{webcode_tk-0.7.3 → webcode_tk-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webcode-tk
-Version: 0.7.3
+Version: 0.7.5
 Summary: 
 Home-page: https://github.com/HundredVisionsGuy/webcode-tk
 License: MIT

{webcode_tk-0.7.3 → webcode_tk-0.7.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "webcode-tk"
-version = "0.7.3"
+version = "0.7.5"
 description = ""
 authors = ["hundredvisionsguy <cwinikka@gmail.com>"]
 keywords = ["html", "validation", "css", ]

{webcode_tk-0.7.3 → webcode_tk-0.7.5}/webcode_tk/__init__.py

@@ -4,15 +4,15 @@
 Modules exported by this package:
 - `color_keywords`: helper library to align color keywords with their
           properties and hex and rgb values.
-- `colortools`: processes CSS color related properties and values.
-- `css`: creates Stylesheet objects that store CSS information.
-- `html`: gets html files from a project folder, gets the HTML code
+- `color_tools`: processes CSS color related properties and values.
+- `css_tools`: creates Stylesheet objects that store CSS information.
+- `html_tools`: gets html files from a project folder, gets the HTML code
           from files, gets number of a particular element in a file
           or folder, gets elements as tags, and much more.
 - `ux_tools`: gets readability stats for paragraphs of text (could
           be from just `p` tags or a list of other tags e.g. `li`,
           `div`, etc.).
-- `validator`: sends HTML or CSS code to the W3C Validator to check
+- `validator_tools`: sends HTML or CSS code to the W3C Validator to check
           for errors.
 """
-__version__ = "0.7.3"
+__version__ = "0.7.5"

{webcode_tk-0.7.3 → webcode_tk-0.7.5}/webcode_tk/css_tools.py

@@ -1295,7 +1295,12 @@ def get_color_codes_of_type(color_type: str, gradient: str) -> list:
 
 
 def is_required_selector(selector_type: str, selector: str) -> bool:
-    """checks selector to see if it's required type or not
+    """checks selector to see if it's required type or not.
+
+    Example: you may wish to loop through selectors and see which
+    ones are class selectors, or id selectors, etc..
+
+    It makes use of the list of regex_patterns for selector type.
 
     Args:
         selector_type: the type of selector in question, such as
@@ -1817,6 +1822,119 @@ def get_project_color_contrast(
     return results
 
 
+def file_applies_property_by_selector(
+    file_path: str, selector: str, property: str
+) -> bool:
+    """determines whether a specific property is applied to selector or not.
+
+    Args:
+        file_path: path to html doc in question.
+        selector: CSS selector (or element) that the property is applied.
+        property: the CSS property we are looking for.
+
+    Returns:
+        applies_property: whether that selector applies the property or not.
+    """
+    applies_property = False
+    style_sheets = get_all_stylesheets_by_file(file_path)
+
+    # look for the selector get all declaration block
+    declarations = []
+    for sheet in style_sheets:
+        declaration_block = get_declaration_block_from_selector(
+            selector, sheet
+        )
+        if declaration_block:
+            declarations.append(declaration_block)
+    combined_declaration_block = "\n".join(declarations)
+    if combined_declaration_block:
+        # check for property in declaration_block
+        declarations = combined_declaration_block.split(";")
+        for declaration in declarations:
+            try:
+                prop, value = declaration.split(":")
+                if property in prop:
+                    applies_property = True
+                    break
+            except ValueError:
+                print("Declaration is missing a colon!")
+    return applies_property
+
+
+def get_declaration_block_from_selector(
+    selector: str, style_sheet: Stylesheet
+) -> str:
+    declaration_block = ""
+    for ruleset in style_sheet.rulesets:
+        cur_selector = ruleset.selector
+        if selector in cur_selector:
+            # Check for grouped selectors
+            grouped_selectors = cur_selector.split(",")
+            if len(grouped_selectors) > 1:
+                for item in grouped_selectors:
+                    if selector in item:
+                        if " " not in item:
+                            declaration_block += ruleset.declaration_block.text
+                            break
+                        elif is_selector_at_end_of_descendant(selector, item):
+                            declaration_block += ruleset.declaration_block.text
+                            break
+
+            # Check for descendant selectors
+            if " " in cur_selector:
+                # we have a descendant selector
+                if is_selector_at_end_of_descendant(selector, cur_selector):
+                    declaration_block += ruleset.declaration_block.text
+                continue
+            declaration_block += ruleset.declaration_block.text + "\n"
+    return declaration_block
+
+
+def is_selector_at_end_of_descendant(selector: str, cur_selector: str) -> bool:
+    """returns whether a selector is at the end of a descendant selector"""
+    selector_at_end_of_descendant = False
+    selectors = cur_selector.split()
+    if selector in selectors[-1]:
+        # selector must be at the end of descendant selector
+        # or it doesn't count
+        selector_at_end_of_descendant = True
+    return selector_at_end_of_descendant
+
+
+def get_declaration_value_by_property(
+    block: Union[str, DeclarationBlock], property: str
+) -> str:
+    """returns the value of a property from a declaration block
+
+    Args:
+        block: the declaration block in question (could be as a string
+            or as a DeclarationBlock)
+        property: the property we are looking for
+
+    Returns:
+        value: the value of the property"""
+    value = ""
+    try:
+        block = block.text
+    except AttributeError:
+        declarations = block.strip()
+    declarations = block.split(";")
+    for item in declarations:
+        item = item.strip()
+        try:
+            # check for @media rules
+            if "{" in item:
+                item_split = item.split("{")
+                item = item_split[1].strip()
+            prop, val = item.split(":")
+            if prop.lower().strip() == property.lower():
+                value = val.strip()
+                continue
+        except ValueError:
+            print("Doh! no colon")
+    return value
+
+
 if __name__ == "__main__":
     insane_gradient = """
     -moz-radial-gradient(0% 200%, ellipse cover,

{webcode_tk-0.7.3 → webcode_tk-0.7.5}/webcode_tk/html_tools.py

@@ -25,6 +25,7 @@ from lxml import html
 STARTS_WITH_OPENING_TAG_RE = "^<[^/]+?>"
 OPENING_TAG_RE = "<[^/]+?>"
 CLOSING_TAG_RE = "</.+?>"
+STYLE_TAG_RE = r"<(\w+)\s[^>]*?style=([\"|\']).*?\2\s?[^>]*?(\/?)>"
 
 
 def get_all_html_files(dir_path: str) -> list:
@@ -257,6 +258,80 @@ def uses_inline_styles(markup: Union[Tag, str]) -> bool:
     return has_inline_styles
 
 
+def get_style_attribute_data(file: str) -> list:
+    """returns a list of all tags that contain a style attribute
+
+    Checks to make sure file path goes to HTML doc and raises an
+    exception if not. It will return a list of tuples. The tuples
+    each contain filename, tag, and style attribute value (for
+    reference).
+
+    Args:
+        file: path to an html document.
+
+    Returns:
+        data: a list of style attribute data (filename, tag, and
+            attribute value) or st
+
+    Raises:
+        ValueError: to get a list of attribute values, the file must
+            be an HTML document
+    """
+    data = []
+    file_type = clerk.get_file_type(file)
+    if file_type != "html":
+        raise ValueError(f"{file} is not an HTML document")
+    html_soup = get_html(file)
+
+    # check the html and body for style attribute
+    html_tag = html_soup.find("html")
+    style_value = html_tag.attrs.get("style")
+    if style_value:
+        data.append((file, "html", style_value))
+    body_tag = html_soup.find("body")
+    style_value = body_tag.attrs.get("style")
+    if style_value:
+        data.append((file, "body", style_value))
+
+    # Check all other tags in the body for style attributes
+    for tag in body_tag.children:
+        # deal with any "tag" that is a navigable string
+        tag_string = str(tag).strip()
+        if not tag_string:
+            continue
+        value = tag.attrs.get("style")
+        if not value:
+            continue
+        element = tag.name
+        data.append((file, element, value))
+    return data
+
+
+def has_style_attribute_data(file: str) -> bool:
+    """returns whether a file has style attributes or not
+
+    Makes use of get_style_attribute_data(), and if there is any
+    data, returns True; otherwise, False
+
+    Args:
+        file: path to an html document.
+
+    Returns:
+        has_style_attribute: a boolean (has or has not) a style
+            attribute.
+
+    Raises:
+        ValueError: to get a list of attribute values, the file must
+            be an HTML document
+    """
+    file_type = clerk.get_file_type(file)
+    if file_type != "html":
+        raise ValueError(f"{file} is not an HTML document")
+    results = get_style_attribute_data(file)
+    has_style_attribute = bool(results)
+    return has_style_attribute
+
+
 if __name__ == "__main__":
     file_with_inline_styles = "tests/test_files/sample_with_inline_styles.html"
     markup = clerk.file_to_string(file_with_inline_styles)