pre-commit/pre_commit/main.py at v5-install · pre-commit/pre-commit · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

from __future__ import annotations

import argparse

import logging

import os

import sys

from collections.abc import Sequence

import pre_commit.constants as C

from pre_commit import clientlib

from pre_commit import git

from pre_commit.color import add_color_option

from pre_commit.commands import hazmat

from pre_commit.commands.autoupdate import autoupdate

from pre_commit.commands.clean import clean

from pre_commit.commands.gc import gc

from pre_commit.commands.hook_impl import hook_impl

from pre_commit.commands.init_templatedir import init_templatedir

from pre_commit.commands.install_uninstall import install

from pre_commit.commands.install_uninstall import install_hooks

from pre_commit.commands.install_uninstall import uninstall

from pre_commit.commands.migrate_config import migrate_config

from pre_commit.commands.run import run

from pre_commit.commands.sample_config import sample_config

from pre_commit.commands.try_repo import try_repo

from pre_commit.commands.validate_config import validate_config

from pre_commit.commands.validate_manifest import validate_manifest

from pre_commit.error_handler import error_handler

from pre_commit.logging_handler import logging_handler

from pre_commit.store import Store

logger = logging.getLogger('pre_commit')

# https://github.com/pre-commit/pre-commit/issues/217

# On OSX, making a virtualenv using pyvenv at . causes `virtualenv` and `pip`

# to install packages to the wrong place. We don't want anything to deal with

# pyvenv

os.environ.pop('__PYVENV_LAUNCHER__', None)

# https://github.com/getsentry/snuba/pull/5388

os.environ.pop('PYTHONEXECUTABLE', None)

COMMANDS_NO_GIT = {

'clean', 'gc', 'hazmat', 'init-templatedir', 'sample-config',

'validate-config', 'validate-manifest',

}

def _add_config_option(parser: argparse.ArgumentParser) -> None:

parser.add_argument(

'-c', '--config', default=C.CONFIG_FILE,

help='Path to alternate config file',

)

def _add_hook_type_option(parser: argparse.ArgumentParser) -> None:

parser.add_argument(

'-t', '--hook-type',

choices=clientlib.HOOK_TYPES, action='append', dest='hook_types',

)

def _add_run_options(parser: argparse.ArgumentParser) -> None:

parser.add_argument('hook', nargs='?', help='A single hook-id to run')

parser.add_argument('--verbose', '-v', action='store_true')

mutex_group = parser.add_mutually_exclusive_group(required=False)

mutex_group.add_argument(

'--all-files', '-a', action='store_true',

help='Run on all the files in the repo.',

)

mutex_group.add_argument(

'--files', nargs='*', default=[],

help='Specific filenames to run hooks on.',

)

parser.add_argument(

'--show-diff-on-failure', action='store_true',

help='When hooks fail, run `git diff` directly afterward.',

)

parser.add_argument(

'--fail-fast', action='store_true',

help='Stop after the first failing hook.',

)

parser.add_argument(

'--hook-stage',

choices=clientlib.STAGES,

type=clientlib.transform_stage,

default='pre-commit',

help='The stage during which the hook is fired. One of %(choices)s',

)

parser.add_argument(

'--remote-branch', help='Remote branch ref used by `git push`.',

)

parser.add_argument(

'--local-branch', help='Local branch ref used by `git push`.',

)

parser.add_argument(

'--from-ref', '--source', '-s',

help=(

'(for usage with `--to-ref`) -- this option represents the '

'original ref in a `from_ref...to_ref` diff expression. '

'For `pre-push` hooks, this represents the branch you are pushing '

'to. '

'For `post-checkout` hooks, this represents the branch that was '

'previously checked out.'

)

parser.add_argument(

'--to-ref', '--origin', '-o',

help=(

'(for usage with `--from-ref`) -- this option represents the '

'destination ref in a `from_ref...to_ref` diff expression. '

'For `pre-push` hooks, this represents the branch being pushed. '

'For `post-checkout` hooks, this represents the branch that is '

'now checked out.'

)

parser.add_argument(

'--pre-rebase-upstream', help=(

'The upstream from which the series was forked.'

)

parser.add_argument(

'--pre-rebase-branch', help=(

'The branch being rebased, and is not set when '

'rebasing the current branch.'

)

parser.add_argument(

'--commit-msg-filename',

help='Filename to check when running during `commit-msg`',

)

parser.add_argument(

'--prepare-commit-message-source',

help=(

'Source of the commit message '

'(typically the second argument to .git/hooks/prepare-commit-msg)'

)

parser.add_argument(

'--commit-object-name',

help=(

'Commit object name '

'(typically the third argument to .git/hooks/prepare-commit-msg)'

)

parser.add_argument(

'--remote-name', help='Remote name used by `git push`.',

)

parser.add_argument('--remote-url', help='Remote url used by `git push`.')

parser.add_argument(

'--checkout-type',

help=(

'Indicates whether the checkout was a branch checkout '

'(changing branches, flag=1) or a file checkout (retrieving a '

'file from the index, flag=0).'

)

parser.add_argument(

'--is-squash-merge',

help=(

'During a post-merge hook, indicates whether the merge was a '

'squash merge'

)

parser.add_argument(

'--rewrite-command',

help=(

'During a post-rewrite hook, specifies the command that invoked '

'the rewrite'

)

def _adjust_args_and_chdir(args: argparse.Namespace) -> None:

# `--config` was specified relative to the non-root working directory

if os.path.exists(args.config):

args.config = os.path.abspath(args.config)

if args.command in {'run', 'try-repo'}:

args.files = [os.path.abspath(filename) for filename in args.files]

if args.commit_msg_filename is not None:

args.commit_msg_filename = os.path.abspath(

args.commit_msg_filename,

)

if args.command == 'try-repo' and os.path.exists(args.repo):

args.repo = os.path.abspath(args.repo)

toplevel = git.get_root()

os.chdir(toplevel)

args.config = os.path.relpath(args.config)

if args.command in {'run', 'try-repo'}:

args.files = [os.path.relpath(filename) for filename in args.files]

if args.commit_msg_filename is not None:

args.commit_msg_filename = os.path.relpath(

args.commit_msg_filename,

)

if args.command == 'try-repo' and os.path.exists(args.repo):

args.repo = os.path.relpath(args.repo)

def main(argv: Sequence[str] | None = None) -> int:

argv = argv if argv is not None else sys.argv[1:]

parser = argparse.ArgumentParser(prog='pre-commit')

# https://stackoverflow.com/a/8521644/812183

parser.add_argument(

'-V', '--version',

action='version',

version=f'%(prog)s {C.VERSION}',

)

subparsers = parser.add_subparsers(dest='command')

def _add_cmd(name: str, *, help: str) -> argparse.ArgumentParser:

parser = subparsers.add_parser(name, help=help)

add_color_option(parser)

return parser

autoupdate_parser = _add_cmd(

'autoupdate',

help="Auto-update pre-commit config to the latest repos' versions.",

)

_add_config_option(autoupdate_parser)

autoupdate_parser.add_argument(

'--bleeding-edge', action='store_true',

help=(

'Update to the bleeding edge of `HEAD` instead of the latest '

'tagged version (the default behavior).'

)

autoupdate_parser.add_argument(

'--freeze', action='store_true',

help='Store "frozen" hashes in `rev` instead of tag names',

)

autoupdate_parser.add_argument(

'--repo', dest='repos', action='append', metavar='REPO', default=[],

help='Only update this repository -- may be specified multiple times.',

)

autoupdate_parser.add_argument(

'-j', '--jobs', type=int, default=1,

help='Number of threads to use. (default %(default)s).',

)

_add_cmd('clean', help='Clean out pre-commit files.')

_add_cmd('gc', help='Clean unused cached repos.')

hazmat_parser = _add_cmd(

'hazmat', help='Composable tools for rare use in hook `entry`.',

)

hazmat.add_parsers(hazmat_parser)

init_templatedir_parser = _add_cmd(

'init-templatedir',

help=(

'Install hook script in a directory intended for use with '

'`git config init.templateDir`.'

)

_add_config_option(init_templatedir_parser)

init_templatedir_parser.add_argument(

'directory', help='The directory in which to write the hook script.',

)

init_templatedir_parser.add_argument(

'--no-allow-missing-config',

action='store_false',

dest='allow_missing_config',

help='Assume cloned repos should have a `pre-commit` config.',

)

_add_hook_type_option(init_templatedir_parser)

install_parser = _add_cmd('install', help='Install the pre-commit script.')

_add_config_option(install_parser)

install_parser.add_argument(

'-f', '--overwrite', action='store_true',

help='Overwrite existing hooks / remove migration mode.',

)

install_parser.add_argument(

'--install-hooks', action='store_true',

help=(

'Whether to install hook environments for all environments '

'in the config file.'

)

_add_hook_type_option(install_parser)

install_parser.add_argument(

'--allow-missing-config', action='store_true',

help=(

'Whether to allow a missing `pre-commit` configuration file '

'or exit with a failure code.'

)

install_hooks_parser = _add_cmd(

'install-hooks',

help=(

'Install hook environments for all environments in the config '

'file. You may find `pre-commit install --install-hooks` more '

'useful.'

)

_add_config_option(install_hooks_parser)

migrate_config_parser = _add_cmd(

'migrate-config',

help='Migrate list configuration to new map configuration.',

)

_add_config_option(migrate_config_parser)

run_parser = _add_cmd('run', help='Run hooks.')

_add_config_option(run_parser)

_add_run_options(run_parser)

_add_cmd('sample-config', help=f'Produce a sample {C.CONFIG_FILE} file')

try_repo_parser = _add_cmd(

'try-repo',

help='Try the hooks in a repository, useful for developing new hooks.',

)

_add_config_option(try_repo_parser)

try_repo_parser.add_argument(

'repo', help='Repository to source hooks from.',

)

try_repo_parser.add_argument(

'--ref', '--rev',

help=(

'Manually select a rev to run against, otherwise the `HEAD` '

'revision will be used.'

)

_add_run_options(try_repo_parser)

uninstall_parser = _add_cmd(

'uninstall', help='Uninstall the pre-commit script.',

)

_add_config_option(uninstall_parser)

_add_hook_type_option(uninstall_parser)

validate_config_parser = _add_cmd(

'validate-config', help='Validate .pre-commit-config.yaml files',

)

validate_config_parser.add_argument('filenames', nargs='*')

validate_manifest_parser = _add_cmd(

'validate-manifest', help='Validate .pre-commit-hooks.yaml files',

)

validate_manifest_parser.add_argument('filenames', nargs='*')

# does not use `_add_cmd` because it doesn't use `--color`

help = subparsers.add_parser(

'help', help='Show help for a specific command.',

)

help.add_argument('help_cmd', nargs='?', help='Command to show help for.')

# not intended for users to call this directly

hook_impl_parser = subparsers.add_parser('hook-impl')

add_color_option(hook_impl_parser)

_add_config_option(hook_impl_parser)

hook_impl_parser.add_argument('--hook-type')

hook_impl_parser.add_argument('--hook-dir')

hook_impl_parser.add_argument(

'--skip-on-missing-config', action='store_true',

)

hook_impl_parser.add_argument(dest='rest', nargs=argparse.REMAINDER)

# argparse doesn't really provide a way to use a `default` subparser

if len(argv) == 0:

argv = ['run']

args = parser.parse_args(argv)

if args.command == 'help' and args.help_cmd:

parser.parse_args([args.help_cmd, '--help'])

elif args.command == 'help':

parser.parse_args(['--help'])

with error_handler(), logging_handler(args.color):

git.check_for_cygwin_mismatch()

store = Store()

if args.command not in COMMANDS_NO_GIT:

_adjust_args_and_chdir(args)

store.mark_config_used(args.config)

if args.command == 'autoupdate':

return autoupdate(

args.config,

tags_only=not args.bleeding_edge,

freeze=args.freeze,

repos=args.repos,

jobs=args.jobs,

)

elif args.command == 'clean':

return clean(store)

elif args.command == 'gc':

return gc(store)

elif args.command == 'hazmat':

return hazmat.impl(args)

elif args.command == 'hook-impl':

return hook_impl(

store,

config=args.config,

color=args.color,

hook_type=args.hook_type,

hook_dir=args.hook_dir,

skip_on_missing_config=args.skip_on_missing_config,

args=args.rest[1:],

)

elif args.command == 'install':

return install(

args.config, store,

hook_types=args.hook_types,

overwrite=args.overwrite,

hooks=args.install_hooks,

skip_on_missing_config=args.allow_missing_config,

)

elif args.command == 'init-templatedir':

return init_templatedir(

args.config, store, args.directory,

hook_types=args.hook_types,

skip_on_missing_config=args.allow_missing_config,

)

elif args.command == 'install-hooks':

return install_hooks(args.config, store)

elif args.command == 'migrate-config':

return migrate_config(args.config)

elif args.command == 'run':

return run(args.config, store, args)

elif args.command == 'sample-config':

return sample_config()

elif args.command == 'try-repo':

return try_repo(args)

elif args.command == 'uninstall':

return uninstall(

config_file=args.config,

hook_types=args.hook_types,

)

elif args.command == 'validate-config':

return validate_config(args.filenames)

elif args.command == 'validate-manifest':

return validate_manifest(args.filenames)

else:

raise NotImplementedError(

f'Command {args.command} not implemented.',

)

raise AssertionError(

f'Command {args.command} failed to exit with a returncode',

)

if __name__ == '__main__':

raise SystemExit(main())

pre-commit/pre_commit/main.py at v5-install · pre-commit/pre-commit · GitHub

Repository navigation

Expand file tree

Breadcrumbs

main.py

Latest commit

History

Breadcrumbs

main.py

File metadata and controls