Refactor meta hooks

pre_commit/meta_hooks/check_files_matches_any.py

@@ -1,36 +1,40 @@
-import re
-import sys
+import argparse
 
 import pre_commit.constants as C
-from pre_commit.clientlib import load_config
+from pre_commit.commands.run import _filter_by_include_exclude
+from pre_commit.commands.run import _filter_by_types
 from pre_commit.git import get_all_files
+from pre_commit.runner import Runner
 
 
-def files_matches_any(filenames, include):
-    include_re = re.compile(include)
-    for filename in filenames:
-        if include_re.search(filename):
-            return True
-    return False
-
-
-def check_files_matches_any(config_file=None):
-    config = load_config(config_file or C.CONFIG_FILE)
+def check_all_hooks_match_files(config_file):
+    runner = Runner.create(config_file)
     files = get_all_files()
-    files_not_matched = False
+    files_matched = True
 
-    for repo in config['repos']:
-        for hook in repo['hooks']:
-            include = hook.get('files', '')
-            if include and not files_matches_any(files, include):
-                print(
-                    'The files pattern for {} does not match any files'
-                    .format(hook['id'])
-                )
-                files_not_matched = True
+    for repo in runner.repositories:
+        for hook_id, hook in repo.hooks:
+            include, exclude = hook['files'], hook['exclude']
+            filtered = _filter_by_include_exclude(files, include, exclude)
+            types, exclude_types = hook['types'], hook['exclude_types']
+            filtered = _filter_by_types(filtered, types, exclude_types)
+            if not filtered:
+                print('{} does not apply to this repository'.format(hook_id))
+                files_matched = False
 
-    return files_not_matched
+    return files_matched
+
+
+def main(argv=None):
+    parser = argparse.ArgumentParser()
+    parser.add_argument('filenames', nargs='*', default=[C.CONFIG_FILE])
+    args = parser.parse_args(argv)
+
+    retv = 0
+    for filename in args.filenames:
+        retv |= not check_all_hooks_match_files(filename)
+    return retv
 
 
 if __name__ == '__main__':
-    sys.exit(check_files_matches_any())
+    exit(main())

pre_commit/meta_hooks/check_useless_excludes.py

@@ -1,5 +1,7 @@
+from __future__ import print_function
+
+import argparse
 import re
-import sys
 
 import pre_commit.constants as C
 from pre_commit.clientlib import load_config
@@ -14,14 +16,17 @@ def exclude_matches_any(filenames, include, exclude):
     return False
 
 
-def check_useless_excludes(config_file=None):
-    config = load_config(config_file or C.CONFIG_FILE)
+def check_useless_excludes(config_file):
+    config = load_config(config_file)
     files = get_all_files()
     useless_excludes = False
 
     exclude = config.get('exclude')
     if exclude != '^$' and not exclude_matches_any(files, '', exclude):
-        print('The global exclude pattern does not match any files')
+        print(
+            'The global exclude pattern {!r} does not match any files'
+            .format(exclude),
+        )
         useless_excludes = True
 
     for repo in config['repos']:
@@ -29,13 +34,24 @@ def check_useless_excludes(config_file=None):
             include, exclude = hook.get('files', ''), hook.get('exclude')
             if exclude and not exclude_matches_any(files, include, exclude):
                 print(
-                    'The exclude pattern for {} does not match any files'
-                    .format(hook['id'])
+                    'The exclude pattern {!r} for {} does not match any files'
+                    .format(exclude, hook['id']),
                 )
                 useless_excludes = True
 
     return useless_excludes
 
 
+def main(argv=None):
+    parser = argparse.ArgumentParser()
+    parser.add_argument('filenames', nargs='*', default=[C.CONFIG_FILE])
+    args = parser.parse_args(argv)
+
+    retv = 0
+    for filename in args.filenames:
+        retv |= check_useless_excludes(filename)
+    return retv
+
+
 if __name__ == '__main__':
-    sys.exit(check_useless_excludes())
+    exit(main())

pre_commit/repository.py

@@ -252,50 +252,56 @@ class LocalRepository(Repository):
 
 
 class MetaRepository(LocalRepository):
-    # Note: the hook `entry` is passed through `shlex.split()` by the command
-    # runner, so to prevent issues with spaces and backslashes (on Windows) it
-    # must be quoted here.
-    meta_hooks = {
-        'check-useless-excludes': {
-            'name': 'Check for useless excludes',
-            'files': '.pre-commit-config.yaml',
-            'language': 'system',
-            'entry': pipes.quote(sys.executable),
-            'args': ['-m', 'pre_commit.meta_hooks.check_useless_excludes'],
-        },
-        'check-files-matches-any': {
-            'name': 'Check hooks match any files',
-            'files': '.pre-commit-config.yaml',
-            'language': 'system',
-            'entry': pipes.quote(sys.executable),
-            'args': ['-m', 'pre_commit.meta_hooks.check_files_matches_any'],
-        },
-    }
+    @cached_property
+    def manifest_hooks(self):
+        # The hooks are imported here to prevent circular imports.
+        from pre_commit.meta_hooks import check_files_matches_any
+        from pre_commit.meta_hooks import check_useless_excludes
+
+        # Note: the hook `entry` is passed through `shlex.split()` by the
+        # command runner, so to prevent issues with spaces and backslashes
+        # (on Windows) it must be quoted here.
+        meta_hooks = [
+            {
+                'id': 'check-useless-excludes',
+                'name': 'Check for useless excludes',
+                'files': '.pre-commit-config.yaml',
+                'language': 'system',
+                'entry': pipes.quote(sys.executable),
+                'args': ['-m', check_useless_excludes.__name__],
+            },
+            {
+                'id': 'check-files-matches-any',
+                'name': 'Check hooks match any files',
+                'files': '.pre-commit-config.yaml',
+                'language': 'system',
+                'entry': pipes.quote(sys.executable),
+                'args': ['-m', check_files_matches_any.__name__],
+            },
+        ]
+
+        return {
+            hook['id']: apply_defaults(
+                validate(hook, MANIFEST_HOOK_DICT),
+                MANIFEST_HOOK_DICT,
+            )
+            for hook in meta_hooks
+        }
 
     @cached_property
     def hooks(self):
         for hook in self.repo_config['hooks']:
-            if hook['id'] not in self.meta_hooks:
+            if hook['id'] not in self.manifest_hooks:
                 logger.error(
                     '`{}` is not a valid meta hook.  '
                     'Typo? Perhaps it is introduced in a newer version?  '
-                    'Often `pre-commit autoupdate` fixes this.'.format(
-                        hook['id'],
-                    ),
+                    'Often `pip install --upgrade pre-commit` fixes this.'
+                    .format(hook['id']),
                 )
                 exit(1)
 
         return tuple(
-            (
-                hook['id'],
-                apply_defaults(
-                    validate(
-                        dict(self.meta_hooks[hook['id']], **hook),
-                        MANIFEST_HOOK_DICT,
-                    ),
-                    MANIFEST_HOOK_DICT,
-                ),
-            )
+            (hook['id'], _hook(self.manifest_hooks[hook['id']], hook))
             for hook in self.repo_config['hooks']
         )