1 """Launcher and command line interface to git-cola"""
2 from __future__
import absolute_import
, division
, print_function
, unicode_literals
16 # we're using argparse with subparser, but argparse
17 # does not allow us to assign a default subparser
18 # when none has been specified. We fake it by injecting
19 # 'cola' into the command-line so that parse_args()
20 # routes them to the 'cola' parser by default.
21 help_commands
= core
.encode('--help-commands')
22 args
= [core
.encode(arg
) for arg
in argv
]
23 if not argv
or argv
[0].startswith('-') and help_commands
not in args
:
24 argv
.insert(0, 'cola')
25 elif help_commands
in argv
:
27 args
= parse_args(argv
)
28 return args
.func(args
)
32 parser
= argparse
.ArgumentParser()
33 # Newer versions of argparse (Python 3.6+) emit an error message for
34 # "--help-commands" unless we register the flag on the main parser.
35 if compat
.PY_VERSION
>= (3, 6):
36 add_help_options(parser
)
37 parser
.set_defaults(func
=lambda _
: parser
.print_help())
39 subparser
= parser
.add_subparsers(title
='valid commands')
40 add_cola_command(subparser
)
41 add_about_command(subparser
)
42 add_am_command(subparser
)
43 add_archive_command(subparser
)
44 add_branch_command(subparser
)
45 add_browse_command(subparser
)
46 add_clone_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_recent_command(subparser
)
58 add_remote_command(subparser
)
59 add_search_command(subparser
)
60 add_stash_command(subparser
)
61 add_tag_command(subparser
)
62 add_version_command(subparser
)
64 return parser
.parse_args(argv
)
67 def add_help_options(parser
):
68 """Add the --help-commands flag to the parser"""
73 help='show available sub-commands',
77 def add_command(parent
, name
, description
, func
):
78 parser
= parent
.add_parser(str(name
), help=description
)
79 parser
.set_defaults(func
=func
)
80 app
.add_common_arguments(parser
)
84 def add_cola_command(subparser
):
85 parser
= add_command(subparser
, 'cola', 'start git-cola', cmd_cola
)
87 '--amend', default
=False, action
='store_true', help='start in amend mode'
89 add_help_options(parser
)
91 '--status-filter', '-s', metavar
='<path>', default
='', help='status path filter'
95 def add_about_command(parent
):
96 add_command(parent
, 'about', 'about git-cola', cmd_about
)
99 def add_am_command(parent
):
100 parser
= add_command(parent
, 'am', 'apply patches using "git am"', cmd_am
)
102 'patches', metavar
='<patches>', nargs
='*', help='patches to apply'
106 def add_archive_command(parent
):
107 parser
= add_command(parent
, 'archive', 'save an archive', cmd_archive
)
109 'ref', metavar
='<ref>', nargs
='?', default
=None, help='commit to archive'
113 def add_branch_command(subparser
):
114 add_command(subparser
, 'branch', 'create a branch', cmd_branch
)
117 def add_browse_command(subparser
):
118 add_command(subparser
, 'browse', 'browse repository', cmd_browse
)
121 def add_clone_command(subparser
):
122 add_command(subparser
, 'clone', 'clone repository', cmd_clone
)
125 def add_config_command(subparser
):
126 add_command(subparser
, 'config', 'edit configuration', cmd_config
)
129 def add_dag_command(subparser
):
130 parser
= add_command(subparser
, 'dag', 'start git-dag', cmd_dag
)
137 help='number of commits to display',
143 help='visualize all branches',
146 parser
.add_argument('args', nargs
='*', metavar
='<args>', help='git log arguments')
149 def add_diff_command(subparser
):
150 parser
= add_command(subparser
, 'diff', 'view diffs', cmd_diff
)
151 parser
.add_argument('args', nargs
='*', metavar
='<args>', help='git diff arguments')
154 def add_fetch_command(subparser
):
155 add_command(subparser
, 'fetch', 'fetch remotes', cmd_fetch
)
158 def add_find_command(subparser
):
159 parser
= add_command(subparser
, 'find', 'find files', cmd_find
)
160 parser
.add_argument('paths', nargs
='*', metavar
='<path>', help='filter by path')
163 def add_grep_command(subparser
):
164 parser
= add_command(subparser
, 'grep', 'grep source', cmd_grep
)
165 parser
.add_argument('args', nargs
='*', metavar
='<args>', help='git grep arguments')
168 def add_merge_command(subparser
):
169 parser
= add_command(subparser
, 'merge', 'merge branches', cmd_merge
)
171 'ref', nargs
='?', metavar
='<ref>', help='branch, tag, or commit to merge'
175 def add_pull_command(subparser
):
176 parser
= add_command(subparser
, 'pull', 'pull remote branches', cmd_pull
)
181 help='rebase local branch when pulling',
185 def add_push_command(subparser
):
186 add_command(subparser
, 'push', 'push remote branches', cmd_push
)
189 def add_rebase_command(subparser
):
190 parser
= add_command(subparser
, 'rebase', 'interactive rebase', cmd_rebase
)
196 help='display a diffstat of what changed upstream',
203 help='be quiet. implies --no-stat',
206 '-i', '--interactive', default
=True, action
='store_true', help=argparse
.SUPPRESS
212 help='automatically stash/stash pop before and after',
218 help="use 'merge-base --fork-point' to refine upstream",
224 help='rebase onto given branch instead of upstream',
231 help='try to recreate merges instead of ignoring them',
237 metavar
='<strategy>',
238 help='use the given merge strategy',
244 help='cherry-pick all commits, even if unchanged',
251 help='use merging strategies to rebase',
257 help='add exec lines after each commit of ' 'the editable list',
264 help='preserve empty commits during rebase',
271 help='force rebase even if branch is up to date',
278 help='pass the argument through to the merge strategy',
284 help='display a diffstat of what changed upstream',
291 help='do not show diffstat of what changed upstream',
297 help='allow pre-rebase hook to run',
300 '--rerere-autoupdate',
303 help='allow rerere to update index with ' 'resolved conflicts',
309 help='rebase all reachable commits up to the root(s)',
315 help='move commits that begin with ' 'squash!/fixup! under -i',
320 action
='store_false',
322 help='do not move commits that begin with ' 'squash!/fixup! under -i',
325 '--committer-date-is-author-date',
328 help="passed to 'git am' by 'git rebase'",
334 help="passed to 'git am' by 'git rebase'",
340 help="passed to 'git apply' by 'git rebase'",
343 '--ignore-whitespace',
346 help="passed to 'git apply' by 'git rebase'",
352 help='update branches that point to commits that are being rebased',
356 dest
='context_lines',
359 help="passed to 'git apply' by 'git rebase'",
362 actions
= parser
.add_argument_group('actions')
363 actions
.add_argument(
364 '--continue', default
=False, action
='store_true', help='continue'
366 actions
.add_argument(
370 help='abort and check out the original branch',
372 actions
.add_argument(
376 help='skip current patch and continue',
378 actions
.add_argument(
382 help='edit the todo list during an interactive rebase',
389 metavar
='<upstream>',
390 help='the upstream configured in branch.<name>.remote '
391 'and branch.<name>.merge options will be used '
392 'when <upstream> is omitted; see git-rebase(1) '
393 'for details. If you are currently not on any '
394 'branch or if the current branch does not have '
395 'a configured upstream, the rebase will abort',
402 help='git rebase will perform an automatic '
403 '"git checkout <branch>" before doing anything '
404 'else when <branch> is specified',
408 def add_recent_command(subparser
):
409 add_command(subparser
, 'recent', 'edit recent files', cmd_recent
)
412 def add_remote_command(subparser
):
413 add_command(subparser
, 'remote', 'edit remotes', cmd_remote
)
416 def add_search_command(subparser
):
417 add_command(subparser
, 'search', 'search commits', cmd_search
)
420 def add_stash_command(subparser
):
421 add_command(subparser
, 'stash', 'stash and unstash changes', cmd_stash
)
424 def add_tag_command(subparser
):
425 parser
= add_command(subparser
, 'tag', 'create tags', cmd_tag
)
427 'name', metavar
='<name>', nargs
='?', default
=None, help='tag name'
430 'ref', metavar
='<ref>', nargs
='?', default
=None, help='commit to tag'
437 help='annotated and GPG-signed tag',
441 def add_version_command(subparser
):
442 parser
= add_command(subparser
, 'version', 'print the version', cmd_version
)
447 help='print the version number only',
453 from .widgets
.main
import MainView
# pylint: disable=all
455 status_filter
= args
.status_filter
457 status_filter
= core
.abspath(status_filter
)
459 context
= app
.application_init(args
)
461 context
.timer
.start('view')
462 view
= MainView(context
)
464 cmds
.do(cmds
.AmendMode
, context
, amend
=True)
467 view
.set_filter(core
.relpath(status_filter
))
469 context
.timer
.stop('view')
471 context
.timer
.display('view')
473 return app
.application_run(context
, view
, start
=start_cola
, stop
=app
.default_stop
)
476 def start_cola(context
, view
):
477 app
.default_start(context
, view
)
482 from .widgets
import about
# pylint: disable=all
484 context
= app
.application_init(args
)
485 view
= about
.about_dialog(context
)
486 return app
.application_start(context
, view
)
490 from .widgets
.patch
import new_apply_patches
# pylint: disable=all
492 context
= app
.application_init(args
)
493 view
= new_apply_patches(context
, patches
=args
.patches
)
494 return app
.application_start(context
, view
)
497 def cmd_archive(args
):
498 from .widgets
import archive
# pylint: disable=all
500 context
= app
.application_init(args
, update
=True)
502 args
.ref
= context
.model
.currentbranch
503 view
= archive
.Archive(context
, args
.ref
)
504 return app
.application_start(context
, view
)
507 def cmd_branch(args
):
508 from .widgets
.createbranch
import create_new_branch
# pylint: disable=all
510 context
= app
.application_init(args
, update
=True)
511 view
= create_new_branch(context
)
512 return app
.application_start(context
, view
)
515 def cmd_browse(args
):
516 from .widgets
.browse
import worktree_browser
# pylint: disable=all
518 context
= app
.application_init(args
)
519 view
= worktree_browser(context
, show
=False, update
=False)
520 return app
.application_start(context
, view
)
524 from .widgets
import clone
# pylint: disable=all
526 context
= app
.application_init(args
)
527 view
= clone
.clone(context
)
528 context
.set_view(view
)
529 result
= 0 if view
.exec_() == view
.Accepted
else 1
530 app
.default_stop(context
, view
)
534 def cmd_config(args
):
535 from .widgets
.prefs
import preferences
# pylint: disable=all
537 context
= app
.application_init(args
)
538 view
= preferences(context
)
539 return app
.application_start(context
, view
)
543 from .widgets
import dag
# pylint: disable=all
545 context
= app
.application_init(args
)
546 # cola.main() uses parse_args(), unlike dag.main() which uses
547 # parse_known_args(), thus we aren't able to automatically forward
548 # all unknown arguments. Special-case support for "--all" since it's
549 # used by the history viewer command on Windows.
551 args
.args
.insert(0, '--all')
552 view
= dag
.git_dag(context
, args
=args
, show
=False)
553 return app
.application_start(context
, view
)
557 from .difftool
import diff_expression
# pylint: disable=all
559 context
= app
.application_init(args
)
560 expr
= core
.list2cmdline(args
.args
)
561 view
= diff_expression(context
, None, expr
, create_widget
=True)
562 return app
.application_start(context
, view
)
566 # TODO: the calls to update_status() can be done asynchronously
567 # by hooking into the message_updated notification.
568 from .widgets
import remote
# pylint: disable=all
570 context
= app
.application_init(args
)
571 context
.model
.update_status()
572 view
= remote
.fetch(context
)
573 return app
.application_start(context
, view
)
577 from .widgets
import finder
# pylint: disable=all
579 context
= app
.application_init(args
)
580 paths
= core
.list2cmdline(args
.paths
)
581 view
= finder
.finder(context
, paths
=paths
)
582 return app
.application_start(context
, view
)
586 from .widgets
import grep
# pylint: disable=all
588 context
= app
.application_init(args
)
589 text
= core
.list2cmdline(args
.args
)
590 view
= grep
.new_grep(context
, text
=text
, parent
=None)
591 return app
.application_start(context
, view
)
595 from .widgets
.merge
import Merge
# pylint: disable=all
597 context
= app
.application_init(args
, update
=True)
598 view
= Merge(context
, parent
=None, ref
=args
.ref
)
599 return app
.application_start(context
, view
)
602 def cmd_version(args
):
603 from . import version
# pylint: disable=all
605 version
.print_version(brief
=args
.brief
)
610 from .widgets
import remote
# pylint: disable=all
612 context
= app
.application_init(args
, update
=True)
613 view
= remote
.pull(context
)
615 view
.set_rebase(True)
616 return app
.application_start(context
, view
)
620 from .widgets
import remote
# pylint: disable=all
622 context
= app
.application_init(args
, update
=True)
623 view
= remote
.push(context
)
624 return app
.application_start(context
, view
)
627 def cmd_rebase(args
):
629 'verbose': args
.verbose
,
631 'autostash': args
.autostash
,
632 'fork_point': args
.fork_point
,
634 'preserve_merges': args
.preserve_merges
,
635 'strategy': args
.strategy
,
638 'exec': getattr(args
, 'exec', None), # python keyword
639 'keep_empty': args
.keep_empty
,
640 'force_rebase': args
.force_rebase
,
641 'strategy_option': args
.strategy_option
,
643 'no_stat': args
.no_stat
,
644 'verify': args
.verify
,
645 'rerere_autoupdate': args
.rerere_autoupdate
,
647 'autosquash': args
.autosquash
,
648 'committer_date_is_author_date': args
.committer_date_is_author_date
,
649 'ignore_date': args
.ignore_date
,
650 'whitespace': args
.whitespace
,
651 'ignore_whitespace': args
.ignore_whitespace
,
652 'C': args
.context_lines
,
653 'continue': getattr(args
, 'continue', False), # python keyword
656 'edit_todo': args
.edit_todo
,
657 'update_refs': args
.update_refs
,
658 'upstream': args
.upstream
,
659 'branch': args
.branch
,
661 context
= app
.application_init(args
)
662 status
, _
, _
= cmds
.do(cmds
.Rebase
, context
, **kwargs
)
666 def cmd_recent(args
):
667 from .widgets
import recent
# pylint: disable=all
669 context
= app
.application_init(args
)
670 view
= recent
.browse_recent_files(context
)
671 return app
.application_start(context
, view
)
674 def cmd_remote(args
):
675 from .widgets
import editremotes
# pylint: disable=all
677 context
= app
.application_init(args
)
678 view
= editremotes
.editor(context
, run
=False)
679 return app
.application_start(context
, view
)
682 def cmd_search(args
):
683 from .widgets
.search
import search
# pylint: disable=all
685 context
= app
.application_init(args
)
686 view
= search(context
)
687 return app
.application_start(context
, view
)
691 from .widgets
import stash
# pylint: disable=all
693 context
= app
.application_init(args
)
694 view
= stash
.view(context
, show
=False)
695 return app
.application_start(context
, view
)
699 from .widgets
.createtag
import new_create_tag
# pylint: disable=all
701 context
= app
.application_init(args
)
702 view
= new_create_tag(context
, name
=args
.name
, ref
=args
.ref
, sign
=args
.sign
)
703 return app
.application_start(context
, view
)
706 # Windows shortcut launch features:
707 def shortcut_launch():
708 """Launch from a shortcut
710 Prompt for the repository by default.
715 argv
= ['cola', '--prompt']
716 return main(argv
=argv
)