cola/main.py

   1 """Launcher and command line interface to git-cola"""
   2
   3 from __future__ import absolute_import, division, unicode_literals
   4
   5 import argparse
   6 import os
   7 import sys
   8
   9 from .app import add_common_arguments
  10 from .app import application_init
  11 from .app import application_start
  12
  13 from . import cmds
  14 from . import compat
  15 from . import core
  16 from . import utils
  17
  18
  19 def main(argv=None):
  20     if argv is None:
  21         argv = sys.argv[1:]
  22     # we're using argparse with subparser, but argparse
  23     # does not allow us to assign a default subparser
  24     # when none has been specified.  We fake it by injecting
  25     # 'cola' into the command-line so that parse_args()
  26     # routes them to the 'cola' parser by default.
  27     if (len(argv) < 1 or
  28             argv[0].startswith('-') and
  29             '--help-commands' not in argv):
  30         argv.insert(0, 'cola')
  31     elif '--help-commands' in argv:
  32         argv.append('--help')
  33     args = parse_args(argv)
  34     return args.func(args)
  35
  36
  37 def parse_args(argv):
  38     parser = argparse.ArgumentParser()
  39     subparser = parser.add_subparsers(title='valid commands')
  40
  41     add_cola_command(subparser)
  42     add_about_command(subparser)
  43     add_am_command(subparser)
  44     add_archive_command(subparser)
  45     add_branch_command(subparser)
  46     add_browse_command(subparser)
  47     add_config_command(subparser)
  48     add_dag_command(subparser)
  49     add_diff_command(subparser)
  50     add_fetch_command(subparser)
  51     add_find_command(subparser)
  52     add_grep_command(subparser)
  53     add_merge_command(subparser)
  54     add_pull_command(subparser)
  55     add_push_command(subparser)
  56     add_rebase_command(subparser)
  57     add_remote_command(subparser)
  58     add_search_command(subparser)
  59     add_stash_command(subparser)
  60     add_tag_command(subparser)
  61     add_version_command(subparser)
  62
  63     return parser.parse_args(argv)
  64
  65
  66 def add_command(parent, name, description, func):
  67     parser = parent.add_parser(str(name), help=description)
  68     parser.set_defaults(func=func)
  69     add_common_arguments(parser)
  70     return parser
  71
  72
  73 def add_cola_command(subparser):
  74     parser = add_command(subparser, 'cola', 'start git-cola', cmd_cola)
  75     parser.add_argument('--amend', default=False, action='store_true',
  76                         help='start in amend mode')
  77     parser.add_argument('--help-commands', default=False, action='store_true',
  78                         help='show available sub-commands')
  79     parser.add_argument('--status-filter', '-s', metavar='<path>',
  80                         default='', help='status path filter')
  81
  82
  83 def add_about_command(parent):
  84     parser = add_command(parent, 'about', 'about git-cola', cmd_about)
  85
  86 def add_am_command(parent):
  87     parser = add_command(parent, 'am', 'apply patches using "git am"', cmd_am)
  88     parser.add_argument('patches', metavar='<patches>', nargs='*',
  89                         help='patches to apply')
  90
  91
  92 def add_archive_command(parent):
  93     parser = add_command(parent, 'archive', 'save an archive', cmd_archive)
  94     parser.add_argument('ref', metavar='<ref>', nargs='?', default=None,
  95                         help='commit to archive')
  96
  97
  98 def add_branch_command(subparser):
  99     add_command(subparser, 'branch', 'create a branch', cmd_branch)
 100
 101
 102 def add_browse_command(subparser):
 103     add_command(subparser, 'browse', 'browse repository', cmd_browse)
 104     add_command(subparser, 'classic', 'browse repository', cmd_browse)
 105
 106
 107 def add_config_command(subparser):
 108     add_command(subparser, 'config', 'edit configuration', cmd_config)
 109
 110
 111 def add_dag_command(subparser):
 112     parser = add_command(subparser, 'dag', 'start git-dag', cmd_dag)
 113     parser.add_argument('-c', '--count', metavar='<count>',
 114                         type=int, default=1000,
 115                         help='number of commits to display')
 116     parser.add_argument('args', nargs='*', metavar='<args>',
 117                         help='git log arguments')
 118
 119
 120 def add_diff_command(subparser):
 121     parser = add_command(subparser, 'diff', 'view diffs', cmd_diff)
 122     parser.add_argument('args', nargs='*', metavar='<args>',
 123                         help='git diff arguments')
 124
 125
 126 def add_fetch_command(subparser):
 127     add_command(subparser, 'fetch', 'fetch remotes', cmd_fetch)
 128
 129
 130 def add_find_command(subparser):
 131     parser = add_command(subparser, 'find', 'find files', cmd_find)
 132     parser.add_argument('paths', nargs='*', metavar='<path>',
 133                         help='filter by path')
 134
 135
 136 def add_grep_command(subparser):
 137     parser = add_command(subparser, 'grep', 'grep source', cmd_grep)
 138     parser.add_argument('args', nargs='*', metavar='<args>',
 139                         help='git grep arguments')
 140
 141
 142 def add_merge_command(subparser):
 143     add_command(subparser, 'merge', 'merge branches', cmd_merge)
 144
 145
 146 def add_pull_command(subparser):
 147     parser = add_command(subparser, 'pull', 'pull remote branches', cmd_pull)
 148     parser.add_argument('--rebase', default=False, action='store_true',
 149                         help='rebase local branch when pulling')
 150
 151
 152 def add_push_command(subparser):
 153     add_command(subparser, 'push', 'push remote branches', cmd_push)
 154
 155
 156 def add_rebase_command(subparser):
 157     parser = add_command(subparser, 'rebase', 'interactive rebase', cmd_rebase)
 158     parser.add_argument('-v', '--verbose', default=False, action='store_true',
 159                         help='display a diffstat of what changed upstream')
 160     parser.add_argument('-q', '--quiet', default=False, action='store_true',
 161                         help='be quiet. implies --no-stat')
 162     parser.add_argument('-i', '--interactive', default=True,
 163                         action='store_true', help=argparse.SUPPRESS)
 164     parser.add_argument('--autostash', default=False, action='store_true',
 165                         help='automatically stash/stash pop before and after')
 166     parser.add_argument('--fork-point', default=False, action='store_true',
 167                         help="use 'merge-base --fork-point' to refine upstream")
 168     parser.add_argument('--onto', default=None, metavar='<newbase>',
 169                         help='rebase onto given branch instead of upstream')
 170     parser.add_argument('-p', '--preserve-merges',
 171                         default=False, action='store_true',
 172                         help='try to recreate merges instead of ignoring them')
 173     parser.add_argument('-s', '--strategy', default=None, metavar='<strategy>',
 174                         help='use the given merge strategy')
 175     parser.add_argument('--no-ff', default=False, action='store_true',
 176                         help='cherry-pick all commits, even if unchanged')
 177     parser.add_argument('-m', '--merge', default=False, action='store_true',
 178                         help='use merging strategies to rebase')
 179     parser.add_argument('-x', '--exec', default=None,
 180                         help='add exec lines after each commit of '
 181                              'the editable list')
 182     parser.add_argument('-k', '--keep-empty', default=False,
 183                         action='store_true',
 184                         help='preserve empty commits during rebase')
 185     parser.add_argument('-f', '--force-rebase', default=False,
 186                         action='store_true',
 187                         help='force rebase even if branch is up to date')
 188     parser.add_argument('-X', '--strategy-option', default=None,
 189                         metavar='<arg>',
 190                         help='pass the argument through to the merge strategy')
 191     parser.add_argument('--stat', default=False, action='store_true',
 192                         help='display a diffstat of what changed upstream')
 193     parser.add_argument('-n', '--no-stat', default=False, action='store_true',
 194                         help='do not show diffstat of what changed upstream')
 195     parser.add_argument('--verify', default=False, action='store_true',
 196                         help='allow pre-rebase hook to run')
 197     parser.add_argument('--rerere-autoupdate',
 198                         default=False, action='store_true',
 199                         help='allow rerere to update index with '
 200                              'resolved conflicts')
 201     parser.add_argument('--root', default=False, action='store_true',
 202                         help='rebase all reachable commits up to the root(s)')
 203     parser.add_argument('--autosquash', default=True, action='store_true',
 204                         help='move commits that begin with '
 205                              'squash!/fixup! under -i')
 206     parser.add_argument('--no-autosquash', default=True, action='store_false',
 207                         dest='autosquash',
 208                         help='do not move commits that begin with '
 209                              'squash!/fixup! under -i')
 210     parser.add_argument('--committer-date-is-author-date',
 211                         default=False, action='store_true',
 212                         help="passed to 'git am' by 'git rebase'")
 213     parser.add_argument('--ignore-date', default=False, action='store_true',
 214                         help="passed to 'git am' by 'git rebase'")
 215     parser.add_argument('--whitespace', default=False, action='store_true',
 216                         help="passed to 'git apply' by 'git rebase'")
 217     parser.add_argument('--ignore-whitespace', default=False,
 218                         action='store_true',
 219                         help="passed to 'git apply' by 'git rebase'")
 220     parser.add_argument('-C', dest='context_lines', default=None, metavar='<n>',
 221                         help="passed to 'git apply' by 'git rebase'")
 222
 223     actions = parser.add_argument_group('actions')
 224     actions.add_argument('--continue', default=False, action='store_true',
 225                          help='continue')
 226     actions.add_argument('--abort', default=False, action='store_true',
 227                          help='abort and check out the original branch')
 228     actions.add_argument('--skip', default=False, action='store_true',
 229                          help='skip current patch and continue')
 230     actions.add_argument('--edit-todo', default=False, action='store_true',
 231                          help='edit the todo list during an interactive rebase')
 232
 233     parser.add_argument('upstream', nargs='?', default=None,
 234                         metavar='<upstream>',
 235                         help='the upstream configured in branch.<name>.remote '
 236                              'and branch.<name>.merge options will be used '
 237                              'when <upstream> is omitted; see git-rebase(1) '
 238                              'for details. If you are currently not on any '
 239                              'branch or if the current branch does not have '
 240                              'a configured upstream, the rebase will abort')
 241     parser.add_argument('branch', nargs='?', default=None, metavar='<branch>',
 242                         help='git rebase will perform an automatic '
 243                              '"git checkout <branch>" before doing anything '
 244                              'else when <branch> is specified')
 245
 246
 247 def add_remote_command(subparser):
 248     add_command(subparser, 'remote', 'edit remotes', cmd_remote)
 249
 250
 251 def add_search_command(subparser):
 252     add_command(subparser, 'search', 'search commits', cmd_search)
 253
 254
 255 def add_stash_command(subparser):
 256     add_command(subparser, 'stash', 'stash and unstash changes', cmd_stash)
 257
 258
 259 def add_tag_command(subparser):
 260     parser = add_command(subparser, 'tag', 'create tags', cmd_tag)
 261     parser.add_argument('name', metavar='<name>', nargs='?', default=None,
 262                         help='tag name')
 263     parser.add_argument('ref', metavar='<ref>', nargs='?', default=None,
 264                         help='commit to tag')
 265     parser.add_argument('-s', '--sign', default=False, action='store_true',
 266                         help='annotated and GPG-signed tag')
 267
 268
 269 def add_version_command(subparser):
 270     parser = add_command(subparser, 'version', 'print the version', cmd_version)
 271     parser.add_argument('--brief', action='store_true', default=False,
 272                         help='print the version number only')
 273
 274
 275 # entry points
 276 def cmd_cola(args):
 277     from .widgets.main import MainView
 278     status_filter = args.status_filter
 279     if status_filter:
 280         status_filter = core.abspath(status_filter)
 281
 282     context = application_init(args)
 283     view = MainView(context.model, settings=args.settings)
 284     if args.amend:
 285         cmds.do(cmds.AmendMode, True)
 286
 287     if status_filter:
 288         view.set_filter(core.relpath(status_filter))
 289
 290     return application_start(context, view)
 291
 292
 293 def cmd_about(args):
 294     from .widgets import about
 295     context = application_init(args)
 296     view = about.about_dialog()
 297     return application_start(context, view)
 298
 299
 300 def cmd_am(args):
 301     from .widgets.patch import new_apply_patches
 302     context = application_init(args)
 303     view = new_apply_patches(patches=args.patches)
 304     return application_start(context, view)
 305
 306
 307 def cmd_archive(args):
 308     from .widgets.archive import GitArchiveDialog
 309     context = application_init(args, update=True)
 310     if args.ref is None:
 311         args.ref = context.model.currentbranch
 312     view = GitArchiveDialog(args.ref)
 313     return application_start(context, view)
 314
 315
 316 def cmd_branch(args):
 317     from .widgets.createbranch import create_new_branch
 318     context = application_init(args, update=True)
 319     view = create_new_branch(settings=args.settings)
 320     return application_start(context, view)
 321
 322
 323 def cmd_browse(args):
 324     from .widgets.browse import worktree_browser
 325     context = application_init(args)
 326     view = worktree_browser(update=False, settings=args.settings)
 327     return application_start(context, view)
 328
 329
 330 def cmd_config(args):
 331     from .widgets.prefs import preferences
 332     context = application_init(args)
 333     view = preferences()
 334     return application_start(context, view)
 335
 336
 337 def cmd_dag(args):
 338     context = application_init(args)
 339     from .widgets.dag import git_dag
 340     view = git_dag(context.model, args=args, settings=args.settings)
 341     return application_start(context, view)
 342
 343
 344 def cmd_diff(args):
 345     context = application_init(args)
 346     from .difftool import diff_expression
 347     expr = core.list2cmdline(args.args)
 348     view = diff_expression(None, expr, create_widget=True)
 349     return application_start(context, view)
 350
 351
 352 def cmd_fetch(args):
 353     # TODO: the calls to update_status() can be done asynchronously
 354     # by hooking into the message_updated notification.
 355     context = application_init(args)
 356     from .widgets import remote
 357     context.model.update_status()
 358     view = remote.fetch()
 359     return application_start(context, view)
 360
 361
 362 def cmd_find(args):
 363     context = application_init(args)
 364     from .widgets import finder
 365     paths = core.list2cmdline(args.paths)
 366     view = finder.finder(paths=paths)
 367     return application_start(context, view)
 368
 369
 370 def cmd_grep(args):
 371     context = application_init(args)
 372     from .widgets import grep
 373     text = core.list2cmdline(args.args)
 374     view = grep.new_grep(text=text, parent=None)
 375     return application_start(context, view)
 376
 377
 378 def cmd_merge(args):
 379     context = application_init(args, update=True)
 380     from .widgets.merge import MergeView
 381     view = MergeView(context.cfg, context.model, parent=None)
 382     return application_start(context, view)
 383
 384
 385 def cmd_version(args):
 386     from . import version
 387     version.print_version(brief=args.brief)
 388     return 0
 389
 390
 391 def cmd_pull(args):
 392     from .widgets import remote
 393     context = application_init(args, update=True)
 394     view = remote.pull()
 395     if args.rebase:
 396         view.set_rebase(True)
 397     return application_start(context, view)
 398
 399
 400 def cmd_push(args):
 401     from .widgets import remote
 402     context = application_init(args, update=True)
 403     view = remote.push()
 404     return application_start(context, view)
 405
 406
 407 def cmd_rebase(args):
 408     kwargs = {
 409             'verbose': args.verbose,
 410             'quiet': args.quiet,
 411             'autostash': args.autostash,
 412             'fork_point': args.fork_point,
 413             'onto': args.onto,
 414             'preserve_merges': args.preserve_merges,
 415             'strategy': args.strategy,
 416             'no_ff': args.no_ff,
 417             'merge': args.merge,
 418             'exec': getattr(args, 'exec', None),  # python keyword
 419             'keep_empty': args.keep_empty,
 420             'force_rebase': args.force_rebase,
 421             'strategy_option': args.strategy_option,
 422             'stat': args.stat,
 423             'no_stat': args.no_stat,
 424             'verify': args.verify,
 425             'rerere_autoupdate': args.rerere_autoupdate,
 426             'root': args.root,
 427             'autosquash': args.autosquash,
 428             'committer_date_is_author_date': args.committer_date_is_author_date,
 429             'ignore_date': args.ignore_date,
 430             'whitespace': args.whitespace,
 431             'ignore_whitespace': args.ignore_whitespace,
 432             'C': args.context_lines,
 433             'continue': getattr(args, 'continue', False),  # python keyword
 434             'abort': args.abort,
 435             'skip': args.skip,
 436             'edit_todo': args.edit_todo,
 437             'upstream': args.upstream,
 438             'branch': args.branch,
 439             'capture_output': False,
 440     }
 441     status, out, err = cmds.do(cmds.Rebase, **kwargs)
 442     if out:
 443         core.stdout(out)
 444     if err:
 445         core.stderr(err)
 446     return status
 447
 448
 449 def cmd_remote(args):
 450     from .widgets import editremotes
 451     context = application_init(args)
 452     view = editremotes.new_remote_editor()
 453     return application_start(context, view)
 454
 455
 456 def cmd_search(args):
 457     from .widgets.search import search
 458     context = application_init(args)
 459     view = search()
 460     return application_start(context, view)
 461
 462
 463 def cmd_stash(args):
 464     from .widgets.stash import stash
 465     context = application_init(args)
 466     view = stash()
 467     return application_start(context, view)
 468
 469
 470 def cmd_tag(args):
 471     from .widgets.createtag import new_create_tag
 472     context = application_init(args)
 473     view = new_create_tag(name=args.name, ref=args.ref, sign=args.sign,
 474                           settings=args.settings)
 475     return application_start(context, view)
 476
 477
 478 # Windows shortcut launch features:
 479
 480 def find_git():
 481     """Return the path of git.exe, or None if we can't find it."""
 482     if not utils.is_win32():
 483         return None  # UNIX systems have git in their $PATH
 484
 485     # If the user wants to use a Git/bin/ directory from a non-standard
 486     # directory then they can write its location into
 487     # ~/.config/git-cola/git-bindir
 488     git_bindir = os.path.expanduser(os.path.join('~', '.config', 'git-cola',
 489                                                  'git-bindir'))
 490     if core.exists(git_bindir):
 491         custom_path = core.read(git_bindir).strip()
 492         if custom_path and core.exists(custom_path):
 493             return custom_path
 494
 495     # Try to find Git's bin/ directory in one of the typical locations
 496     pf = os.environ.get('ProgramFiles', 'C:\\Program Files')
 497     pf32 = os.environ.get('ProgramFiles(x86)', 'C:\\Program Files (x86)')
 498     for p in [pf32, pf, 'C:\\']:
 499         candidate = os.path.join(p, 'Git\\bin')
 500         if os.path.isdir(candidate):
 501             return candidate
 502
 503     return None
 504
 505
 506 def shortcut_launch():
 507     """Launch from a shortcut
 508
 509     Prompt for the repository by default, and try to find git.
 510     """
 511     argv = ['cola', '--prompt']
 512     git_path = find_git()
 513     if git_path:
 514         prepend_path(git_path)
 515
 516     return main(argv)
 517
 518
 519 def prepend_path(path):
 520     # Adds git to the PATH.  This is needed on Windows.
 521     path = core.decode(path)
 522     path_entries = core.getenv('PATH', '').split(os.pathsep)
 523     if path not in path_entries:
 524         path_entries.insert(0, path)
 525         compat.setenv('PATH', os.pathsep.join(path_entries))