mirror of
https://github.com/pre-commit/pre-commit.git
synced 2026-01-13 04:20:28 -06:00
88 lines
2.4 KiB
Python
88 lines
2.4 KiB
Python
from __future__ import unicode_literals
|
|
|
|
import os
|
|
import os.path
|
|
|
|
from cached_property import cached_property
|
|
|
|
import pre_commit.constants as C
|
|
from pre_commit import git
|
|
from pre_commit.clientlib.validate_config import load_config
|
|
from pre_commit.repository import Repository
|
|
from pre_commit.store import Store
|
|
from pre_commit.util import resource_filename
|
|
|
|
|
|
class Runner(object):
|
|
"""A `Runner` represents the execution context of the hooks. Notably the
|
|
repository under test.
|
|
"""
|
|
|
|
def __init__(self, git_root):
|
|
self.git_root = git_root
|
|
|
|
@classmethod
|
|
def create(cls):
|
|
"""Creates a PreCommitRunner by doing the following:
|
|
- Finds the root of the current git repository
|
|
- chdirs to that directory
|
|
"""
|
|
root = git.get_root()
|
|
os.chdir(root)
|
|
return cls(root)
|
|
|
|
@cached_property
|
|
def config_file_path(self):
|
|
return os.path.join(self.git_root, C.CONFIG_FILE)
|
|
|
|
@cached_property
|
|
def repositories(self):
|
|
"""Returns a tuple of the configured repositories."""
|
|
config = load_config(self.config_file_path)
|
|
repositories = tuple(Repository.create(x, self.store) for x in config)
|
|
for repository in repositories:
|
|
repository.require_installed()
|
|
return repositories
|
|
|
|
def get_hook_path(self, hook_type):
|
|
return os.path.join(self.git_root, '.git', 'hooks', hook_type)
|
|
|
|
@cached_property
|
|
def pre_commit_path(self):
|
|
return self.get_hook_path('pre-commit')
|
|
|
|
@cached_property
|
|
def pre_push_path(self):
|
|
return self.get_hook_path('pre-push')
|
|
|
|
@cached_property
|
|
def pre_template(self):
|
|
return resource_filename('hook-tmpl')
|
|
|
|
@cached_property
|
|
def pre_push_template(self):
|
|
return resource_filename('pre-push-tmpl')
|
|
|
|
@property
|
|
def pre_commit_legacy_path(self):
|
|
"""The path in the 'hooks' directory representing the temporary
|
|
storage for existing pre-commit hooks.
|
|
"""
|
|
return self.pre_commit_path + '.legacy'
|
|
|
|
@property
|
|
def pre_push_legacy_path(self):
|
|
"""The path in the 'hooks' directory representing the temporary
|
|
storage for existing pre-push hooks.
|
|
"""
|
|
return self.pre_push_path + '.legacy'
|
|
|
|
@cached_property
|
|
def cmd_runner(self):
|
|
# TODO: remove this and inline runner.store.cmd_runner
|
|
return self.store.cmd_runner
|
|
|
|
@cached_property
|
|
def store(self):
|
|
return Store()
|