Refactor get_ignore() into an Ignore callable

Author: AA-Turner

sphinx_autobuild/__main__.py

@@ -11,7 +11,7 @@
 
 from sphinx_autobuild import __version__
 from sphinx_autobuild.build import SPHINX_BUILD_OPTIONS, Builder
-from sphinx_autobuild.ignore import get_ignore
+from sphinx_autobuild.ignore import Ignore
 from sphinx_autobuild.utils import find_free_port
 
 
@@ -36,16 +36,15 @@ def _get_build_args(args):
     return build_args, pre_build_commands
 
 
-def _get_ignore_handler(args):
-    regular = [os.path.realpath(path) for path in args.ignore[:]]
-    regular.append(os.path.realpath(args.outdir))  # output directory
-    if args.w:  # Logfile
-        regular.append(os.path.realpath(args.w[0]))
-    if args.d:  # Doctrees
-        regular.append(os.path.realpath(args.d[0]))
+def _get_ignore_handler(ignore, regex_based, out_dir, doctree_dir, warnings_file):
+    regular = list(map(os.path.realpath, ignore))
+    regular.append(os.path.realpath(out_dir))  # output directory
+    if doctree_dir:  # Doctrees
+        regular.append(os.path.realpath(doctree_dir))
+    if warnings_file:  # Logfile
+        regular.append(os.path.realpath(warnings_file))
 
-    regex_based = args.re_ignore
-    return get_ignore(regular, regex_based)
+    return Ignore(regular, regex_based)
 
 
 def get_parser():
@@ -184,7 +183,8 @@ def main():
         pre_build_commands=pre_build_commands,
     )
 
-    ignore_handler = _get_ignore_handler(args)
+    ignore_handler = _get_ignore_handler(args.ignore, args.re_ignore, outdir,
+                                         args.w, args.d)
     server.watch(srcdir, builder, ignore=ignore_handler)
     for dirpath in args.additional_watched_dirs:
         dirpath = os.path.realpath(dirpath)

sphinx_autobuild/ignore.py

@@ -1,27 +1,32 @@
 """Logic for ignoring paths."""
+
 import fnmatch
 import os
 import re
 
 
-def get_ignore(regular_patterns, regex_based):
-    """Prepare the function that determines whether a path should be ignored."""
-    regex_based_patterns = list(map(re.compile, regex_based))
+class Ignore:
+    def __init__(self, regular, regex_based):
+        """Prepare the function that determines whether a path should be ignored."""
+        self.regular_patterns = regular
+        self.regex_based_patterns = list(map(re.compile, regex_based))
+
+    def __repr__(self):
+        return (f"Ignore(regular={self.regular_patterns!r}, "
+                f"regex_based={self.regex_based_patterns!r})")
 
-    def ignore(path):
-        """Determine if path should be ignored."""
+    def __call__(self, path):
+        """Determine if 'path' should be ignored."""
         # Any regular pattern matches.
-        for pattern in regular_patterns:
-            if path.startswith((pattern + os.sep, pattern + '/')):
+        for pattern in self.regular_patterns:
+            if path.startswith((pattern + os.sep, pattern + "/")):
                 return True
             if fnmatch.fnmatch(path, pattern):
                 return True
 
         # Any regular expression matches.
-        for regex in regex_based_patterns:
+        for regex in self.regex_based_patterns:
             if regex.search(path):
                 return True
 
         return False
-
-    return ignore

tests/test_ignore.py

@@ -1,8 +1,8 @@
-from sphinx_autobuild.ignore import get_ignore
+from sphinx_autobuild.ignore import Ignore
 
 
 def test_empty():
-    ignored = get_ignore([], [])
+    ignored = Ignore([], [])
 
     assert not ignored("amazing-file.txt")
     assert not ignored("module.pyc")
@@ -14,7 +14,7 @@ def test_empty():
 
 
 def test_single_regex():
-    ignored = get_ignore([], [r"\.pyc$"])
+    ignored = Ignore([], [r"\.pyc$"])
 
     assert not ignored("amazing-file.txt")
     assert ignored("module.pyc")
@@ -26,7 +26,7 @@ def test_single_regex():
 
 
 def test_multiple_regex():
-    ignored = get_ignore([], [r"\.md", r"one\.rst"])
+    ignored = Ignore([], [r"\.md", r"one\.rst"])
 
     assert not ignored("amazing-file.txt")
     assert not ignored("module.pyc")
@@ -38,7 +38,7 @@ def test_multiple_regex():
 
 
 def test_single_regular():
-    ignored = get_ignore(["*.pyc"], [])
+    ignored = Ignore(["*.pyc"], [])
 
     assert not ignored("amazing-file.txt")
     assert ignored("module.pyc")
@@ -50,7 +50,7 @@ def test_single_regular():
 
 
 def test_multiple_regular():
-    ignored = get_ignore(["bar", "foo"], [])
+    ignored = Ignore(["bar", "foo"], [])
 
     assert not ignored("amazing-file.txt")
     assert not ignored("module.pyc")
@@ -62,7 +62,7 @@ def test_multiple_regular():
 
 
 def test_multiple_both():
-    ignored = get_ignore(["bar", "foo"], [r"\.txt", r"one\.*"])
+    ignored = Ignore(["bar", "foo"], [r"\.txt", r"one\.*"])
 
     assert ignored("amazing-file.txt")
     assert not ignored("module.pyc")