move Hook data type to a separate file

pre_commit/commands/run.py

@@ -20,8 +20,9 @@ from pre_commit import color
 from pre_commit import git
 from pre_commit import output
 from pre_commit.clientlib import load_config
+from pre_commit.hook import Hook
+from pre_commit.languages.all import languages
 from pre_commit.repository import all_hooks
-from pre_commit.repository import Hook
 from pre_commit.repository import install_hook_envs
 from pre_commit.staged_files_only import staged_files_only
 from pre_commit.store import Store
@@ -160,7 +161,8 @@ def _run_single_hook(
         if not hook.pass_filenames:
             filenames = ()
         time_before = time.time()
-        retcode, out = hook.run(filenames, use_color)
+        language = languages[hook.language]
+        retcode, out = language.run_hook(hook, filenames, use_color)
         duration = round(time.time() - time_before, 2) or 0
         diff_after = cmd_output_b(*diff_cmd, retcode=None)
 

pre_commit/hook.py

@@ -0,0 +1,63 @@
+import logging
+import shlex
+from typing import Any
+from typing import Dict
+from typing import NamedTuple
+from typing import Sequence
+from typing import Tuple
+
+from pre_commit.prefix import Prefix
+
+logger = logging.getLogger('pre_commit')
+
+
+class Hook(NamedTuple):
+    src: str
+    prefix: Prefix
+    id: str
+    name: str
+    entry: str
+    language: str
+    alias: str
+    files: str
+    exclude: str
+    types: Sequence[str]
+    exclude_types: Sequence[str]
+    additional_dependencies: Sequence[str]
+    args: Sequence[str]
+    always_run: bool
+    pass_filenames: bool
+    description: str
+    language_version: str
+    log_file: str
+    minimum_pre_commit_version: str
+    require_serial: bool
+    stages: Sequence[str]
+    verbose: bool
+
+    @property
+    def cmd(self) -> Tuple[str, ...]:
+        return (*shlex.split(self.entry), *self.args)
+
+    @property
+    def install_key(self) -> Tuple[Prefix, str, str, Tuple[str, ...]]:
+        return (
+            self.prefix,
+            self.language,
+            self.language_version,
+            tuple(self.additional_dependencies),
+        )
+
+    @classmethod
+    def create(cls, src: str, prefix: Prefix, dct: Dict[str, Any]) -> 'Hook':
+        # TODO: have cfgv do this (?)
+        extra_keys = set(dct) - _KEYS
+        if extra_keys:
+            logger.warning(
+                f'Unexpected key(s) present on {src} => {dct["id"]}: '
+                f'{", ".join(sorted(extra_keys))}',
+            )
+        return cls(src=src, prefix=prefix, **{k: dct[k] for k in _KEYS})
+
+
+_KEYS = frozenset(set(Hook._fields) - {'src', 'prefix'})

pre_commit/languages/all.py

@@ -3,8 +3,8 @@ from typing import NamedTuple
 from typing import Optional
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
+from pre_commit.hook import Hook
 from pre_commit.languages import conda
 from pre_commit.languages import docker
 from pre_commit.languages import docker_image
@@ -21,9 +21,6 @@ from pre_commit.languages import swift
 from pre_commit.languages import system
 from pre_commit.prefix import Prefix
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 
 class Language(NamedTuple):
     name: str

pre_commit/languages/conda.py

@@ -3,21 +3,18 @@ import os
 from typing import Generator
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import SubstitutionT
 from pre_commit.envcontext import UNSET
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.prefix import Prefix
 from pre_commit.util import clean_path_on_failure
 from pre_commit.util import cmd_output_b
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'conda'
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/docker.py

@@ -2,18 +2,15 @@ import hashlib
 import os
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.prefix import Prefix
 from pre_commit.util import CalledProcessError
 from pre_commit.util import clean_path_on_failure
 from pre_commit.util import cmd_output_b
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'docker'
 PRE_COMMIT_LABEL = 'PRE_COMMIT'
 get_default_version = helpers.basic_get_default_version

pre_commit/languages/docker_image.py

@@ -1,14 +1,11 @@
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.languages.docker import assert_docker_available
 from pre_commit.languages.docker import docker_cmd
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = None
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/fail.py

@@ -1,12 +1,9 @@
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = None
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/golang.py

@@ -4,13 +4,13 @@ import sys
 from typing import Generator
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
 from pre_commit import git
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.prefix import Prefix
 from pre_commit.util import clean_path_on_failure
@@ -18,9 +18,6 @@ from pre_commit.util import cmd_output
 from pre_commit.util import cmd_output_b
 from pre_commit.util import rmtree
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'golangenv'
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/helpers.py

@@ -8,16 +8,13 @@ from typing import Optional
 from typing import overload
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
+from pre_commit.hook import Hook
 from pre_commit.prefix import Prefix
 from pre_commit.util import cmd_output_b
 from pre_commit.xargs import xargs
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 FIXED_RANDOM_SEED = 1542676186
 
 

pre_commit/languages/node.py

@@ -4,12 +4,12 @@ import sys
 from typing import Generator
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.languages.python import bin_dir
 from pre_commit.prefix import Prefix
@@ -17,9 +17,6 @@ from pre_commit.util import clean_path_on_failure
 from pre_commit.util import cmd_output
 from pre_commit.util import cmd_output_b
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'node_env'
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/pygrep.py

@@ -5,15 +5,12 @@ from typing import Optional
 from typing import Pattern
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 from pre_commit import output
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.xargs import xargs
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = None
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/python.py

@@ -8,13 +8,13 @@ from typing import Generator
 from typing import Optional
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import UNSET
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.parse_shebang import find_executable
 from pre_commit.prefix import Prefix
@@ -23,9 +23,6 @@ from pre_commit.util import clean_path_on_failure
 from pre_commit.util import cmd_output
 from pre_commit.util import cmd_output_b
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'py_env'
 
 

pre_commit/languages/ruby.py

@@ -5,21 +5,18 @@ import tarfile
 from typing import Generator
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.prefix import Prefix
 from pre_commit.util import CalledProcessError
 from pre_commit.util import clean_path_on_failure
 from pre_commit.util import resource_bytesio
 
-if TYPE_CHECKING:
-    from pre_comit.repository import Hook
-
 ENVIRONMENT_DIR = 'rbenv'
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/rust.py

@@ -4,7 +4,6 @@ from typing import Generator
 from typing import Sequence
 from typing import Set
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import toml
 
@@ -12,14 +11,12 @@ import pre_commit.constants as C
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.prefix import Prefix
 from pre_commit.util import clean_path_on_failure
 from pre_commit.util import cmd_output_b
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'rustenv'
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/script.py

@@ -1,12 +1,9 @@
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = None
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/swift.py

@@ -3,20 +3,17 @@ import os
 from typing import Generator
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
 import pre_commit.constants as C
 from pre_commit.envcontext import envcontext
 from pre_commit.envcontext import PatchesT
 from pre_commit.envcontext import Var
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 from pre_commit.prefix import Prefix
 from pre_commit.util import clean_path_on_failure
 from pre_commit.util import cmd_output_b
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 ENVIRONMENT_DIR = 'swift_env'
 get_default_version = helpers.basic_get_default_version
 healthy = helpers.basic_healthy

pre_commit/languages/system.py

@@ -1,12 +1,9 @@
 from typing import Sequence
 from typing import Tuple
-from typing import TYPE_CHECKING
 
+from pre_commit.hook import Hook
 from pre_commit.languages import helpers
 
-if TYPE_CHECKING:
-    from pre_commit.repository import Hook
-
 
 ENVIRONMENT_DIR = None
 get_default_version = helpers.basic_get_default_version

pre_commit/repository.py

@@ -1,11 +1,9 @@
 import json
 import logging
 import os
-import shlex
 from typing import Any
 from typing import Dict
 from typing import List
-from typing import NamedTuple
 from typing import Optional
 from typing import Sequence
 from typing import Set
@@ -14,8 +12,8 @@ from typing import Tuple
 import pre_commit.constants as C
 from pre_commit.clientlib import load_manifest
 from pre_commit.clientlib import LOCAL
-from pre_commit.clientlib import MANIFEST_HOOK_DICT
 from pre_commit.clientlib import META
+from pre_commit.hook import Hook
 from pre_commit.languages.all import languages
 from pre_commit.languages.helpers import environment_dir
 from pre_commit.prefix import Prefix
@@ -53,93 +51,39 @@ def _write_state(prefix: Prefix, venv: str, state: object) -> None:
     os.rename(staging, state_filename)
 
 
-_KEYS = tuple(item.key for item in MANIFEST_HOOK_DICT.items)
-
-
-class Hook(NamedTuple):
-    src: str
-    prefix: Prefix
-    id: str
-    name: str
-    entry: str
-    language: str
-    alias: str
-    files: str
-    exclude: str
-    types: Sequence[str]
-    exclude_types: Sequence[str]
-    additional_dependencies: Sequence[str]
-    args: Sequence[str]
-    always_run: bool
-    pass_filenames: bool
-    description: str
-    language_version: str
-    log_file: str
-    minimum_pre_commit_version: str
-    require_serial: bool
-    stages: Sequence[str]
-    verbose: bool
-
-    @property
-    def cmd(self) -> Tuple[str, ...]:
-        return tuple(shlex.split(self.entry)) + tuple(self.args)
-
-    @property
-    def install_key(self) -> Tuple[Prefix, str, str, Tuple[str, ...]]:
-        return (
-            self.prefix,
-            self.language,
-            self.language_version,
-            tuple(self.additional_dependencies),
+def _hook_installed(hook: Hook) -> bool:
+    lang = languages[hook.language]
+    venv = environment_dir(lang.ENVIRONMENT_DIR, hook.language_version)
+    return (
+        venv is None or (
+            (
+                _read_state(hook.prefix, venv) ==
+                _state(hook.additional_dependencies)
+            ) and
+            lang.healthy(hook.prefix, hook.language_version)
         )
+    )
 
-    def installed(self) -> bool:
-        lang = languages[self.language]
-        venv = environment_dir(lang.ENVIRONMENT_DIR, self.language_version)
-        return (
-            venv is None or (
-                (
-                    _read_state(self.prefix, venv) ==
-                    _state(self.additional_dependencies)
-                ) and
-                lang.healthy(self.prefix, self.language_version)
-            )
-        )
 
-    def install(self) -> None:
-        logger.info(f'Installing environment for {self.src}.')
-        logger.info('Once installed this environment will be reused.')
-        logger.info('This may take a few minutes...')
+def _hook_install(hook: Hook) -> None:
+    logger.info(f'Installing environment for {hook.src}.')
+    logger.info('Once installed this environment will be reused.')
+    logger.info('This may take a few minutes...')
 
-        lang = languages[self.language]
-        assert lang.ENVIRONMENT_DIR is not None
-        venv = environment_dir(lang.ENVIRONMENT_DIR, self.language_version)
+    lang = languages[hook.language]
+    assert lang.ENVIRONMENT_DIR is not None
+    venv = environment_dir(lang.ENVIRONMENT_DIR, hook.language_version)
 
-        # There's potentially incomplete cleanup from previous runs
-        # Clean it up!
-        if self.prefix.exists(venv):
-            rmtree(self.prefix.path(venv))
+    # There's potentially incomplete cleanup from previous runs
+    # Clean it up!
+    if hook.prefix.exists(venv):
+        rmtree(hook.prefix.path(venv))
 
-        lang.install_environment(
-            self.prefix, self.language_version, self.additional_dependencies,
-        )
-        # Write our state to indicate we're installed
-        _write_state(self.prefix, venv, _state(self.additional_dependencies))
-
-    def run(self, file_args: Sequence[str], color: bool) -> Tuple[int, bytes]:
-        lang = languages[self.language]
-        return lang.run_hook(self, file_args, color)
-
-    @classmethod
-    def create(cls, src: str, prefix: Prefix, dct: Dict[str, Any]) -> 'Hook':
-        # TODO: have cfgv do this (?)
-        extra_keys = set(dct) - set(_KEYS)
-        if extra_keys:
-            logger.warning(
-                f'Unexpected key(s) present on {src} => {dct["id"]}: '
-                f'{", ".join(sorted(extra_keys))}',
-            )
-        return cls(src=src, prefix=prefix, **{k: dct[k] for k in _KEYS})
+    lang.install_environment(
+        hook.prefix, hook.language_version, hook.additional_dependencies,
+    )
+    # Write our state to indicate we're installed
+    _write_state(hook.prefix, venv, _state(hook.additional_dependencies))
 
 
 def _hook(
@@ -243,7 +187,7 @@ def install_hook_envs(hooks: Sequence[Hook], store: Store) -> None:
         seen: Set[Tuple[Prefix, str, str, Tuple[str, ...]]] = set()
         ret = []
         for hook in hooks:
-            if hook.install_key not in seen and not hook.installed():
+            if hook.install_key not in seen and not _hook_installed(hook):
                 ret.append(hook)
             seen.add(hook.install_key)
         return ret
@@ -253,7 +197,7 @@ def install_hook_envs(hooks: Sequence[Hook], store: Store) -> None:
     with store.exclusive_lock():
         # Another process may have already completed this work
         for hook in _need_installed():
-            hook.install()
+            _hook_install(hook)
 
 
 def all_hooks(root_config: Dict[str, Any], store: Store) -> Tuple[Hook, ...]: