finally commented my code lol

Author: Jack Adam

README.md

@@ -32,5 +32,5 @@ Wrote file2-clean.css
 TODO:
 
 0. thoroughly edgecase re-writing stage
-1. fix comments disappearing in media queries?
-2. comment your code, dummy
+1. something is wrong with cleaning multiple files
+2. fix comments disappearing in media queries?

cleaner.py

@@ -2,62 +2,74 @@
 
 def clean(u, fn, fc):
     nums, numItems = [], []
+    # pre-populate arrays
     for _ in range(fc):
         nums.append({})
         numItems.append(0)
 
+    # extract line numbers, filenames
     for key, value in u.items():
-        x, y = key.split(), value.split()[2:]
-        rule = x[0]
-        ind = fn.index(x[2])
-        for i in range(len(y)):
-            if y[i][-1:] == ',':
-                nums[ind][int(y[i][:-1])] = rule
-            else:
-                nums[ind][int(y[i])] = rule
+        k, v = key.split(), value.split()[2:]
+        rule = k[0]
+        ind = fn.index(k[2])
+        # for each line number
+        for i in range(len(v)):
+            nums[ind][int(comma(v[i]))] = rule
             numItems[ind] += 1
 
+    # for each file
     for i in range(fc):
+        # sort by line number
         nums[i] = sorted(nums[i].items())
-        index = 0
-        file = fn[i]
+        index, file = 0, fn[i]
         with open(file) as f:
             new = file[:-4] + '-clean.css'
             print(f'Wrote {new}')
 
+            # open new file to write
             with open(new, 'w') as newF:
                 soloFlag, mediaFlag, multiFlag, newline = False, False, False, False
                 for num, line in enumerate(f, 1):
+                    # if haven't yet removed all items
                     if index < numItems[i]:
+                        # if line has an unused rule
                         if num == nums[i][index][0]:
                             x = solo(line)
                             soloFlag = x
                             multiFlag = not(x)
+                        # if multiple rules
                         if multiFlag:
                             l = line.split()
                             ll = len(l)
                             for word in l:
+                                # remove unused rules
                                 if comma(word) == nums[i][index][1] or word == nums[i][index][1]:
                                     l.remove(word)
                             ll = len(l)
+                            # adjust commas based on presence of opening brace
                             if l[ll - 1] == '{':
                                 l[ll - 2] = comma(l[ll - 2])
                             else:
                                 l[ll - 1] = comma(l[ll - 1])
                             line = ' '.join(l) + '\n'
                             index += 1
                             multiFlag = False
+                        # if media query opening
                         if line[:6] == '@media':
                             mediaFlag = True
+                        # if one rule
                         if soloFlag:
                             for c in line:
+                                # ignore until rule closes
                                 if c == '}':
                                     soloFlag = False
                                     index += 1
                         elif not soloFlag:
+                            # add newlines, but never more than 1
                             if not newline or line != '\n':
                                 newF.write(line)
                             newline = True if line == '\n' else False
+                # bandage, add closing brace to media query
                 if mediaFlag:
                     newF.write('}')
             newF.close()

helper.py

@@ -1,19 +1,22 @@
 from os import path
 from re import match
 
+# obtain filepath/name to .css and .html files
 def intro(hc):
     filepath, ext = '', '',
     end = -5 if hc == 'html' else -4
 
     count = input('Do you have more than 1 .' + hc + ' file? (yes/no): ')
 
+    # find all files in directory
     if count.lower() in ('yes', 'y'):
         filepath = input('Path to directory (blank if PWD): ')
         ext = '*.' + hc
         if filepath != '':
             if not path.isdir(filepath):
                 exit('Invalid path')
 
+    # find 1 file
     elif count.lower() in ('no', 'n'):
         filepath = input('Path to .' + hc + ' file: ')
         if filepath[end:] != '.' + hc:
@@ -23,11 +26,9 @@ def intro(hc):
     else:
         exit('Invalid response')
 
-    if filepath[-1:] == '/' or filepath == '':
-        return filepath + '*.' + hc
-    else:
-        return filepath
+    return filepath + '*.' + hc if filepath[-1:] == '/' or filepath == '' else filepath
 
+# remove duplicates from dictionary
 def remove_dups(d):
     r, l = {}, 0
     for k, v in d.items():
@@ -36,27 +37,34 @@ def remove_dups(d):
             l += 1
     return (r, l)
 
+# determine if line has one or multiple rules
 def solo(line):
     pattern = '(\.|\#)-?[_a-zA-Z]+[_a-zA-Z0-9-]*'
     flag, found, count = False, '', 0
     for c in line:
+        # found a rule
         if c == '.' or c == '#':
             flag = True
+        # nevermind, start over
         if c == ';':
             flag = False
             found = ''
+        # reached the end of a rule
         if c == '{' or c == ',':
             if len(found) > 0:
                 if match(pattern, found):
                     count += 1
         if flag:
             found += c
+    # single rule
     if count == 0 or count == 1:
         if match(pattern, found):
             count += 1
         return True
+    # multiple rules
     elif count > 1:
         return False
 
+# removes comma if last character of string
 def comma(w):
     return w[:-1] if w[-1:] == ',' else w

main.py

@@ -3,17 +3,20 @@
 from sys import exit
 
 def main():
+    # parse the files
     c = parse_css()
     h = parse_html()
     unused, fileNames, css, fileCount = {}, [], [], 0
 
+    # identify unused classes
     for cla, num in c[0][0].items():
         x = cla.split()
         if ':' not in x[0]:
             css.append(x[0])
         if x[0] not in h[0][0]:
             unused[cla] = num
 
+    # identify unused IDs
     for ID, num in c[1][0].items():
         y = ID.split()
         if ':' not in y[0]:
@@ -23,6 +26,7 @@ def main():
 
     print(f'\nIdentified {c[0][1]} unique classes and {c[1][1]} unique IDs.\n')
 
+    # identify undefined classes and IDs
     for d in h:
         for dd in d:
             for rule, num in dd.items():
@@ -33,6 +37,7 @@ def main():
 
     final = dict(unused)
 
+    # identify pseudoclasses
     for rule, num in unused.items():
         z = rule.split()
         if z[2] not in fileNames:

parser.py

@@ -4,34 +4,44 @@
 from re import match
 
 def parse_css():
+    # obtain filename/path
     filepath = intro('css')
     classes, ids, found, flag = {}, {}, '', False
 
+    # read each file
     for file in glob(filepath):
         with open(file) as f:
             print(f'Read {file}')
 
             for num, line in enumerate(f, 1):
                 for c in line:
+                    # found a rule
                     if c == '.' or c == '#':
                         flag = True
+                    # nevermind
                     if c == ';':
                         flag = False
                         found = ''
+                    # rule is ending
                     if c == '{' or c == ',':
                         if len(found) > 0:
                             found = found.strip()
+                            # check for invalid chars
                             if match('(\.|\#)-?[_a-zA-Z]+[_a-zA-Z0-9-]*', found):
                                 found += ' : ' + file
+                                # if brace on own line, rule is on line before
                                 if line == '{\n':
                                     num -= 1
                                 sNum = str(num)
+                                # found a class
                                 if found[0] == '.':
                                     if found in classes:
+                                        # avoid multiple occurrences on same line
                                         if sNum not in classes[found]:
                                             classes[found] += ', ' + sNum
                                     else:
                                         classes[found] = ', line ' + sNum
+                                # found an ID
                                 elif found[0] == '#':
                                     if found in ids:
                                         if sNum not in ids[found]:
@@ -49,27 +59,34 @@ def parse_css():
         return (remove_dups(classes), remove_dups(ids))
 
 def parse_html():
+    # obtain filename/path
     filepath = intro('html')
     cl, id, fc = [], [], 0
 
+    # read each file
     for file in glob(filepath):
         with open(file) as f:
             print(f'Read {file}')
+            # append a dict for each file
             cl.append({})
             id.append({})
 
             for num, line in enumerate(f, 1):
+                # split line into words
                 words = line.split()
                 for piece in words:
                     found, start = '', None
+                    # found an ID
                     if piece[:2] == 'id':
                         start, found = 4, '#'
+                    # found a class
                     elif piece[:5] == 'class':
                         start, found = 7, '.'
-                    if start != None:
+                    if start:
                         for char in piece[start:]:
                             if char != "'" and char != '"':
                                 found += char
+                            # at end of rule name
                             else:
                                 if start == 4:
                                     id[fc][found] = file