Added typing to help with readability. Also rewroe the readme.

Author: bdkiran

README.md

@@ -93,12 +93,12 @@ I eventually started using the `tinycss2` library, which parses CSS text into a
 
 - This is a very basic implementation, but it has served me well so far. There are certain edge cases that the library does not handle. For example, it struggles with nested classes (a child element within a parent element with a specific class). This nested class example will break the script.
 
-- `Not` selectors and complex `pseudo-selectors` are also tricky and not detected. Feel free to open an issue for any bugs you encounter. If it's feasible, we'll fix them.
+- CSS Combinators and complex `pseudo-selectors` are also tricky and not detected. Feel free to open an issue for any bugs you encounter. If it's feasible, we'll fix them.
 
 - The formatting of the output files is a bit janky. In the future, we can clean this up, but for now, it's easy enough to reformat CSS and HTML in a code editor or IDE.
 
 - The tool currently only works with single files. If the CSS is split across multiple files on a website, you will have to manually combine them for the `input.css`. Similarly, if CSS is embedded in a style tag within the HTML, you'll need to extract that and place it in a separate file.
 
 - Styling and look is heavily affected by the css reset's applied. Make sure that you're using a similar reset file. For example, if your cloning tailwind css, make sure to include the tailwind css reset. Other styling frameworks should work the same.
 
-- If a class is not found in the input stylesheet, the library makes a best note to mark which class could not be found. this appears right after the css class defination as a comment.
+- If a class is not found in the input stylesheet, the library makes a best note to mark which class could not be found. this appears right after the css class defination as a comment.

main.py

@@ -1,6 +1,7 @@
 import re
 import json
 import tinycss2
+from typing import List
 from at_media_handling import extract_class_from_media_queries, combine_matching_media_queries, combine_nested_classes_in_media
 from psudo_selector import split_css_classes_and_pseudo, split_css_by_pseudo_selector, combine_css_classes_with_pseudo
 import logging
@@ -12,7 +13,7 @@
 # This formatting is used across all the scripts
 LOGGING_FORMATING = "%(asctime)s - %(filename)s:%(funcName)s:%(lineno)s - %(levelname)s - %(message)s"
 
-def extract_regular_css_class(css_content, wanted_class_name): 
+def extract_regular_css_class(css_content, wanted_class_name) -> str: 
     rules = tinycss2.parse_stylesheet_bytes(css_content, skip_whitespace=True, skip_comments=True)
     extracted_css_nodes = []
     for rule in rules[0]:
@@ -27,7 +28,7 @@ def extract_regular_css_class(css_content, wanted_class_name):
         extracted_css = tinycss2.serialize(extracted_css_nodes)
         return extracted_css
 
-def combine_regular_css_classes(css_contents, combined_class_name):
+def combine_regular_css_classes(css_contents: str, combined_class_name: str) -> str:
     # Updated regex pattern to match class selectors with dashes and underscores
     class_pattern = re.compile(r'\.([a-zA-Z0-9-_]+)\s*{([^}]*)}', re.DOTALL)
 
@@ -89,7 +90,7 @@ def tailwind_keepout(input_class_name: str):
             return True
     return False
 
-def css_class_converter(css_content: str, new_class_name: str, class_name_array: [str]):
+def css_class_converter(css_content: str, new_class_name: str, class_name_array: List[str]):
     regular_css_buffer = ''
     at_media_css_buffer = ''
     not_found_regular_css_class = []

psudo_selector.py

@@ -2,10 +2,11 @@
 import tinycss2
 import logging
 from collections import defaultdict
+from typing import List, Tuple
 
 logger = logging.getLogger(__name__)
 
-def does_prelude_contain_psuodo_selector(prelude):
+def does_prelude_contain_psuodo_selector(prelude) -> bool:
     for item in prelude:
         if isinstance(item, tinycss2.ast.LiteralToken):
             if item.value == ":":
@@ -23,7 +24,7 @@ def get_psudo_selector_from_prelude(prelude):
             return my_psudo
     return None
 
-def split_css_classes_and_pseudo(css_content):
+def split_css_classes_and_pseudo(css_content: str) -> Tuple[str, str]:
     byte_thing = str.encode(css_content)
     rules = tinycss2.parse_stylesheet_bytes(byte_thing, skip_whitespace=True, skip_comments=True)
     regular_classes = []
@@ -41,7 +42,7 @@ def split_css_classes_and_pseudo(css_content):
     psudo_class_string = tinycss2.serialize(psedo_selector_classes)
     return regular_class_string, psudo_class_string
 
-def split_css_by_pseudo_selector(css_content):
+def split_css_by_pseudo_selector(css_content: str) -> dict:
     pseudo_styles_string_dict = {}
     if css_content == "":
         logger.error("no css content for psudo selector")
@@ -66,8 +67,8 @@ def split_css_by_pseudo_selector(css_content):
 
     return pseudo_styles_string_dict    
 
-def combine_css_classes_with_pseudo(pseudo_selector: str, css_content:str, combine_class_name: str):
-    combined_styles = []
+def combine_css_classes_with_pseudo(pseudo_selector: str, css_content:str, combine_class_name: str) -> str:
+    combined_styles: List[str] = []
     byte_thing = str.encode(css_content)
     rules = tinycss2.parse_stylesheet_bytes(byte_thing, skip_whitespace=True, skip_comments=True)
     for rule in rules[0]: