skilleter-thingy 0.0.67__tar.gz → 0.0.69__tar.gz

{skilleter_thingy-0.0.67/skilleter_thingy.egg-info → skilleter_thingy-0.0.69}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.67
+Version: 0.0.69
 Summary: A collection of useful utilities, mainly aimed at making Git more friendly
 Author-email: John Skilleter <john@skilleter.org.uk>
 Project-URL: Home, https://skilleter.org.uk

{skilleter_thingy-0.0.67 → skilleter_thingy-0.0.69}/pyproject.toml

@@ -7,7 +7,7 @@ name = "skilleter_thingy"
 
 # Version must be incremented to install updated Thingy
 
-version = "0.0.67"
+version = "0.0.69"
 
 authors = [
     {name="John Skilleter", email="john@skilleter.org.uk"},

{skilleter_thingy-0.0.67 → skilleter_thingy-0.0.69}/skilleter_thingy/readable.py

@@ -10,6 +10,7 @@
 
 # TODO: Not sure it works properly as a pipe
 # TODO: Error handling in file I/O
+# TODO: Ability to remove Terraform 'will be read during apply' blocks (remove from '^ <= .* \{' to ^    \}$')
 
 ################################################################################
 
@@ -63,24 +64,34 @@ TF_IGNORE_LIST = [
 
 ################################################################################
 
+def error(msg):
+    """ Report an error and quit """
+
+    sys.stderr.write(f'{msg}\n')
+    sys.exit(1)
+
+################################################################################
+
 def parse_command_line():
     """ Parse, check and sanitise the command line arguments """
 
     parser = argparse.ArgumentParser(description='Read from standard input and write to standard output modifying ANSI colour codes en-route.')
 
-    parser.add_argument('-l', '--light', action='store_true', help='Modify colours for a light background (the default)')
-    parser.add_argument('-d', '--dark', action='store_true', help='Modify colours for a dark background')
-    parser.add_argument('-n', '--none', action='store_true', help='Remove all colour codes')
-    parser.add_argument('-t', '--tidy', action='store_true',
+    parser.add_argument('--light', '-l', action='store_true', help='Modify colours for a light background (the default)')
+    parser.add_argument('--dark', '-d', action='store_true', help='Modify colours for a dark background')
+    parser.add_argument('--none', '-n', action='store_true', help='Remove all colour codes')
+    parser.add_argument('--tidy', '-t', action='store_true',
                         help='Remove colour codes and stuff that typically occurs in log files causing diffs, but is of no particular interest (e.g. SHA1 values, times, dates)')
-    parser.add_argument('-s', '--strip-blank', action='store_true', help='Strip all blank lines')
-    parser.add_argument('-D', '--debug', action='store_true', help='Replace colours with debug information')
-    parser.add_argument('-o', '--out', action='store_true', help='Output to standard output rather than overwriting input files')
-    parser.add_argument('-O', '--dir', action='store', default=None, help='Store output files in the specified directory (creating it if it doesn\'t exist)')
-    parser.add_argument('-a', '--aws', action='store_true', help='Remove AWS resource IDs')
-    parser.add_argument('-T', '--terraform', action='store_true', help='Clean Terraform plan/apply log files')
-    parser.add_argument('-R', '--replace', action='append', default=None, help='Additional regex replacements in the form "REGEX=REPLACEMENT"')
-    parser.add_argument('-v', '--verbose', action='store_true', help='Output verbose status')
+    parser.add_argument('--strip-blank', '-s', action='store_true', help='Strip all blank lines')
+    parser.add_argument('--debug', '-D', action='store_true', help='Replace colours with debug information')
+    parser.add_argument('--out', '-o', action='store_true', help='Output to standard output rather than overwriting input files')
+    parser.add_argument('--dir', '-O', action='store', default=None, help='Store output files in the specified directory (creating it if it doesn\'t exist)')
+    parser.add_argument('--aws', '-a', action='store_true', help='Remove AWS resource IDs')
+    parser.add_argument('--terraform', '-T', action='store_true', help='Clean Terraform plan/apply log files')
+    parser.add_argument('--replace', '-R', action='append', default=None, help='Additional regex replacements in the form "REGEX=REPLACEMENT"')
+    parser.add_argument('--verbose', '-v', action='store_true', help='Output verbose status')
+    parser.add_argument('--minimal', '-m', action='store_true', help='Remove unnecessary data from the file (e.g. Terraform progress updates (Refreshing..., Reading..., etc.))')
+    parser.add_argument('--non-minimal', '-M', action='store_true', help='Do not remove unnecessary data from the file (e.g. Terraform progress updates (Refreshing..., Reading..., etc.))')
     parser.add_argument('files', nargs='*', default=None, help='The files to convert (use stdin/stout if no input files are specified)')
 
     args = parser.parse_args()
@@ -94,23 +105,29 @@ def parse_command_line():
     # Can't do more than one transformation
 
     if args.light + args.dark + args.none + args.debug > 1:
-        print('ERROR: Only one colour conversion option can be specified')
-        sys.exit(1)
+        error('ERROR: Only one colour conversion option can be specified')
 
     if args.tidy and (args.light or args.dark or args.debug):
-        print('ERROR: The tidy and colour conversion options cannot be specified together')
-        sys.exit(1)
+        error('ERROR: The tidy and colour conversion options cannot be specified together')
 
-    # Default to doing cleanup - removing colour codes, times & Terraform cleanup
+    if args.minimal and args.non_minimal:
+        error('ERROR: Cannot use minimal and non-minimal options together')
 
-    if not args.light and not args.dark and not args.tidy and not args.strip_blank and not args.terraform:
-        args.strip_blank = args.none = args.tidy = args.terraform = True
-        logging.info('No options specified - defaulting to stripping blanks, removing colour codes, tidying and cleaning Terraform data')
+    # Default to doing cleanup - removing colour codes, times & Terraform & minimal cleanup
+
+    if not args.light and not args.dark and not args.tidy and not args.strip_blank and not args.terraform and not args.minimal and not args.non_minimal:
+        args.strip_blank = args.none = args.tidy = args.terraform = args.minimal = True
+        logging.info('No options specified - defaulting to stripping blanks, removing colour codes, tidying, cleaning Terraform data and removing unnecessary data')
 
     # Terraform option also removes ANSI, etc.
 
     if args.terraform:
-        args.strip_blank = args.tidy = args.none = True
+        args.strip_blank = args.tidy = args.none = args.minimal = True
+
+    # Non-minimal overrides minimal
+
+    if args.non_minimal:
+        args.minimal = False
 
     # Create the output directory, if required
 
@@ -206,9 +223,16 @@ def cleanfile(args, infile, outfile):
             for entry in args.regex_replace:
                 clean = entry['regex'].sub(entry['replace'], clean)
 
+        # Additional cleanup - remove 'noise' from the output (currently just TF-related).
+
+        if args.minimal:
+            if args.terraform:
+                if TF_REFRESHING_AND_READING.match(clean):
+                    clean = None
+
         # Do things with Terraform log data
 
-        if args.terraform:
+        if clean and args.terraform:
             clean = tidy.regex_replace(clean, TF_MISC_REGEX)
 
             for ignore in TF_IGNORE_LIST:
@@ -308,7 +332,7 @@ def main():
     if args.files:
         try:
             for filename in args.files:
-                with open(filename, 'rt') as infile:
+                with open(filename, 'rt', encoding='utf8') as infile:
 
                     # Either write to stdout or to a temporary file
 
@@ -332,12 +356,16 @@ def main():
                     if args.dir:
                         # Writing to a directory - just move the output file there unconditionally
 
+                        logging.info('Writing %s to %s', outfile_name, args.dir)
+
                         shutil.move(outfile_name, os.path.join(args.dir, os.path.basename(filename)))
 
                     elif not filecmp.cmp(outfile_name, filename, shallow=False):
                         # Only backup and write the source file if changes have been made (original is
                         # left in place without a backup if nothing's changed)
 
+                        logging.info('Backing up old file and writing new %s', outfile_name)
+
                         files.backup(filename)
 
                         shutil.move(outfile_name, filename)
@@ -345,6 +373,8 @@ def main():
                     else:
                         # Output file hasn't been used, so just delete it
 
+                        logging.info('No changes made to %s', outfile_name)
+
                         os.unlink(outfile_name)
 
         except FileNotFoundError as exc:

{skilleter_thingy-0.0.67 → skilleter_thingy-0.0.69/skilleter_thingy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.67
+Version: 0.0.69
 Summary: A collection of useful utilities, mainly aimed at making Git more friendly
 Author-email: John Skilleter <john@skilleter.org.uk>
 Project-URL: Home, https://skilleter.org.uk