Merge pull request #123 from source-foundry/progress-indicators

Add indeterminate progress indicator during processing

Author: chrissimpkins

lib/fdiff/__main__.py

@@ -5,6 +5,8 @@
 import sys
 from typing import Iterable, Iterator, List, Optional, Text, Tuple
 
+from rich.console import Console  # type: ignore
+
 from . import __version__
 from .color import color_unified_diff_line
 from .diff import external_diff, u_diff
@@ -105,6 +107,9 @@ def run(argv: List[Text]) -> None:
     #
     # /////////////////////////////////////////////////////////
 
+    # instantiate a rich Console
+    console = Console()
+
     # parse explicitly included or excluded tables in
     # the command line arguments
     # set as a Python list if it was defined on the command line
@@ -137,24 +142,25 @@ def run(argv: List[Text]) -> None:
             sys.exit(1)
 
         try:
-            ext_diff: Iterable[Tuple[Text, Optional[int]]] = external_diff(
-                args.external,
-                args.PREFILE,
-                args.POSTFILE,
-                include_tables=include_list,
-                exclude_tables=exclude_list,
-                use_multiprocess=use_mp,
-            )
-
-            # write stdout from external tool
-            for line, exit_code in ext_diff:
-                # format with color if color flag is entered on command line
-                if args.color:
-                    sys.stdout.write(color_unified_diff_line(line))
-                else:
-                    sys.stdout.write(line)
-                if exit_code is not None:
-                    sys.exit(exit_code)
+            with console.status("Processing...", spinner="dots10"):
+                ext_diff: Iterable[Tuple[Text, Optional[int]]] = external_diff(
+                    args.external,
+                    args.PREFILE,
+                    args.POSTFILE,
+                    include_tables=include_list,
+                    exclude_tables=exclude_list,
+                    use_multiprocess=use_mp,
+                )
+
+                # write stdout from external tool
+                for line, exit_code in ext_diff:
+                    # format with color if color flag is entered on command line
+                    if args.color:
+                        sys.stdout.write(color_unified_diff_line(line))
+                    else:
+                        sys.stdout.write(line)
+                    if exit_code is not None:
+                        sys.exit(exit_code)
         except Exception as e:
             sys.stderr.write(f"[*] ERROR: {e}{os.linesep}")
             sys.exit(1)
@@ -163,38 +169,39 @@ def run(argv: List[Text]) -> None:
         #  Unified diff
         # ---------------
         # perform the unified diff analysis
-        try:
-            uni_diff: Iterator[Text] = u_diff(
-                args.PREFILE,
-                args.POSTFILE,
-                context_lines=args.lines,
-                include_tables=include_list,
-                exclude_tables=exclude_list,
-                use_multiprocess=use_mp,
-            )
-        except Exception as e:
-            sys.stderr.write(f"[*] ERROR: {e}{os.linesep}")
-            sys.exit(1)
-
-        # re-define the line contents of the diff iterable
-        # if head or tail is requested
-        if args.head:
-            iterable = head(uni_diff, args.head)
-        elif args.tail:
-            iterable = tail(uni_diff, args.tail)
-        else:
-            iterable = uni_diff
-
-        # print unified diff results to standard output stream
-        has_diff = False
-        if args.color:
-            for line in iterable:
-                has_diff = True
-                sys.stdout.write(color_unified_diff_line(line))
-        else:
-            for line in iterable:
-                has_diff = True
-                sys.stdout.write(line)
+        with console.status("Processing...", spinner="dots10"):
+            try:
+                uni_diff: Iterator[Text] = u_diff(
+                    args.PREFILE,
+                    args.POSTFILE,
+                    context_lines=args.lines,
+                    include_tables=include_list,
+                    exclude_tables=exclude_list,
+                    use_multiprocess=use_mp,
+                )
+            except Exception as e:
+                sys.stderr.write(f"[*] ERROR: {e}{os.linesep}")
+                sys.exit(1)
+
+            # re-define the line contents of the diff iterable
+            # if head or tail is requested
+            if args.head:
+                iterable = head(uni_diff, args.head)
+            elif args.tail:
+                iterable = tail(uni_diff, args.tail)
+            else:
+                iterable = uni_diff
+
+            # print unified diff results to standard output stream
+            has_diff = False
+            if args.color:
+                for line in iterable:
+                    has_diff = True
+                    sys.stdout.write(color_unified_diff_line(line))
+            else:
+                for line in iterable:
+                    has_diff = True
+                    sys.stdout.write(line)
 
         # if no difference was found, tell the user instead of
         # simply closing with zero exit status code.

lib/fdiff/diff.py

@@ -12,8 +12,7 @@
 from fontTools.ttLib import TTFont  # type: ignore
 
 from .exceptions import AIOError
-from .remote import (_get_filepath_from_url,
-                     create_async_get_request_session_and_run)
+from .remote import _get_filepath_from_url, create_async_get_request_session_and_run
 from .utils import get_file_modtime
 
 #

lib/fdiff/remote.py

@@ -3,6 +3,7 @@
 import asyncio
 import os.path
 import urllib.parse
+
 # from collections import namedtuple
 from typing import Any, AnyStr, List, NamedTuple, Optional, Text, Tuple
 

requirements.txt

@@ -4,17 +4,41 @@
 #
 #    pip-compile
 #
-aiodns==2.0.0             # via fdiff (setup.py)
-aiofiles==0.6.0           # via fdiff (setup.py)
-aiohttp==3.7.4.post0            # via fdiff (setup.py)
-async-timeout==3.0.1      # via aiohttp
-attrs==21.2.0             # via aiohttp
-cffi==1.14.5              # via pycares
-chardet==3.0.4            # via aiohttp
-fonttools==4.23.1         # via fdiff (setup.py)
-idna==3.1                # via yarl
-multidict==5.1.0          # via aiohttp, yarl
-pycares==4.0.0            # via aiodns
-pycparser==2.20           # via cffi
-typing-extensions==3.10.0.0  # via aiohttp
-yarl==1.6.3               # via aiohttp
+aiodns==3.0.0
+    # via fdiff (setup.py)
+aiofiles==0.6.0
+    # via fdiff (setup.py)
+aiohttp==3.7.4.post0
+    # via fdiff (setup.py)
+async-timeout==3.0.1
+    # via aiohttp
+attrs==21.2.0
+    # via aiohttp
+cffi==1.14.5
+    # via pycares
+chardet==4.0.0
+    # via aiohttp
+colorama==0.4.4
+    # via rich
+commonmark==0.9.1
+    # via rich
+fonttools==4.23.1
+    # via fdiff (setup.py)
+idna==3.1
+    # via yarl
+multidict==5.1.0
+    # via
+    #   aiohttp
+    #   yarl
+pycares==4.0.0
+    # via aiodns
+pycparser==2.20
+    # via cffi
+pygments==2.9.0
+    # via rich
+rich==10.2.0
+    # via fdiff (setup.py)
+typing-extensions==3.10.0.0
+    # via aiohttp
+yarl==1.6.3
+    # via aiohttp

setup.py

@@ -16,7 +16,8 @@
     "fontTools >= 4.0.0",
     "aiohttp >= 3.6.0",
     "aiodns >= 2.0.0",
-    "aiofiles >= 0.4.0"
+    "aiofiles >= 0.4.0",
+    "rich",
 ]
 # Optional packages
 EXTRAS_REQUIRES = {