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 return app
.winmain(main
)
36 parser
= argparse
.ArgumentParser()
37 # Newer versions of argparse (Python 3.6+) emit an error message for
38 # "--help-commands" unless we register the flag on the main parser.
39 if compat
.PY_VERSION
>= (3, 6):
40 add_help_options(parser
)
41 parser
.set_defaults(func
=lambda _
: parser
.print_help())
43 subparser
= parser
.add_subparsers(title
='valid commands')
44 add_cola_command(subparser
)
45 add_about_command(subparser
)
46 add_am_command(subparser
)
47 add_archive_command(subparser
)
48 add_branch_command(subparser
)
49 add_browse_command(subparser
)
50 add_clone_command(subparser
)
51 add_config_command(subparser
)
52 add_dag_command(subparser
)
53 add_diff_command(subparser
)
54 add_fetch_command(subparser
)
55 add_find_command(subparser
)
56 add_grep_command(subparser
)
57 add_merge_command(subparser
)
58 add_pull_command(subparser
)
59 add_push_command(subparser
)
60 add_rebase_command(subparser
)
61 add_recent_command(subparser
)
62 add_remote_command(subparser
)
63 add_search_command(subparser
)
64 add_stash_command(subparser
)
65 add_tag_command(subparser
)
66 add_version_command(subparser
)
68 return parser
.parse_args(argv
)
71 def add_help_options(parser
):
72 """Add the --help-commands flag to the parser"""
77 help='show available sub-commands',
81 def add_command(parent
, name
, description
, func
):
82 parser
= parent
.add_parser(str(name
), help=description
)
83 parser
.set_defaults(func
=func
)
84 app
.add_common_arguments(parser
)
88 def add_cola_command(subparser
):
89 parser
= add_command(subparser
, 'cola', 'start git-cola', cmd_cola
)
91 '--amend', default
=False, action
='store_true', help='start in amend mode'
93 add_help_options(parser
)
95 '--status-filter', '-s', metavar
='<path>', default
='', help='status path filter'
99 def add_about_command(parent
):
100 add_command(parent
, 'about', 'about git-cola', cmd_about
)
103 def add_am_command(parent
):
104 parser
= add_command(parent
, 'am', 'apply patches using "git am"', cmd_am
)
106 'patches', metavar
='<patches>', nargs
='*', help='patches to apply'
110 def add_archive_command(parent
):
111 parser
= add_command(parent
, 'archive', 'save an archive', cmd_archive
)
113 'ref', metavar
='<ref>', nargs
='?', default
=None, help='commit to archive'
117 def add_branch_command(subparser
):
118 add_command(subparser
, 'branch', 'create a branch', cmd_branch
)
121 def add_browse_command(subparser
):
122 add_command(subparser
, 'browse', 'browse repository', cmd_browse
)
125 def add_clone_command(subparser
):
126 add_command(subparser
, 'clone', 'clone repository', cmd_clone
)
129 def add_config_command(subparser
):
130 add_command(subparser
, 'config', 'edit configuration', cmd_config
)
133 def add_dag_command(subparser
):
134 parser
= add_command(subparser
, 'dag', 'start git-dag', cmd_dag
)
141 help='number of commits to display',
147 help='visualize all branches',
150 parser
.add_argument('args', nargs
='*', metavar
='<args>', help='git log arguments')
153 def add_diff_command(subparser
):
154 parser
= add_command(subparser
, 'diff', 'view diffs', cmd_diff
)
155 parser
.add_argument('args', nargs
='*', metavar
='<args>', help='git diff arguments')
158 def add_fetch_command(subparser
):
159 add_command(subparser
, 'fetch', 'fetch remotes', cmd_fetch
)
162 def add_find_command(subparser
):
163 parser
= add_command(subparser
, 'find', 'find files', cmd_find
)
164 parser
.add_argument('paths', nargs
='*', metavar
='<path>', help='filter by path')
167 def add_grep_command(subparser
):
168 parser
= add_command(subparser
, 'grep', 'grep source', cmd_grep
)
169 parser
.add_argument('args', nargs
='*', metavar
='<args>', help='git grep arguments')
172 def add_merge_command(subparser
):
173 parser
= add_command(subparser
, 'merge', 'merge branches', cmd_merge
)
175 'ref', nargs
='?', metavar
='<ref>', help='branch, tag, or commit to merge'
179 def add_pull_command(subparser
):
180 parser
= add_command(subparser
, 'pull', 'pull remote branches', cmd_pull
)
185 help='rebase local branch when pulling',
189 def add_push_command(subparser
):
190 add_command(subparser
, 'push', 'push remote branches', cmd_push
)
193 def add_rebase_command(subparser
):
194 parser
= add_command(subparser
, 'rebase', 'interactive rebase', cmd_rebase
)
200 help='display a diffstat of what changed upstream',
207 help='be quiet. implies --no-stat',
210 '-i', '--interactive', default
=True, action
='store_true', help=argparse
.SUPPRESS
216 help='automatically stash/stash pop before and after',
222 help="use 'merge-base --fork-point' to refine upstream",
228 help='rebase onto given branch instead of upstream',
235 help='try to recreate merges instead of ignoring them',
241 metavar
='<strategy>',
242 help='use the given merge strategy',
248 help='cherry-pick all commits, even if unchanged',
255 help='use merging strategies to rebase',
261 help='add exec lines after each commit of ' 'the editable list',
268 help='preserve empty commits during rebase',
275 help='force rebase even if branch is up to date',
282 help='pass the argument through to the merge strategy',
288 help='display a diffstat of what changed upstream',
295 help='do not show diffstat of what changed upstream',
301 help='allow pre-rebase hook to run',
304 '--rerere-autoupdate',
307 help='allow rerere to update index with ' 'resolved conflicts',
313 help='rebase all reachable commits up to the root(s)',
319 help='move commits that begin with ' 'squash!/fixup! under -i',
324 action
='store_false',
326 help='do not move commits that begin with ' 'squash!/fixup! under -i',
329 '--committer-date-is-author-date',
332 help="passed to 'git am' by 'git rebase'",
338 help="passed to 'git am' by 'git rebase'",
344 help="passed to 'git apply' by 'git rebase'",
347 '--ignore-whitespace',
350 help="passed to 'git apply' by 'git rebase'",
354 dest
='context_lines',
357 help="passed to 'git apply' by 'git rebase'",
360 actions
= parser
.add_argument_group('actions')
361 actions
.add_argument(
362 '--continue', default
=False, action
='store_true', help='continue'
364 actions
.add_argument(
368 help='abort and check out the original branch',
370 actions
.add_argument(
374 help='skip current patch and continue',
376 actions
.add_argument(
380 help='edit the todo list during an interactive rebase',
387 metavar
='<upstream>',
388 help='the upstream configured in branch.<name>.remote '
389 'and branch.<name>.merge options will be used '
390 'when <upstream> is omitted; see git-rebase(1) '
391 'for details. If you are currently not on any '
392 'branch or if the current branch does not have '
393 'a configured upstream, the rebase will abort',
400 help='git rebase will perform an automatic '
401 '"git checkout <branch>" before doing anything '
402 'else when <branch> is specified',
406 def add_recent_command(subparser
):
407 add_command(subparser
, 'recent', 'edit recent files', cmd_recent
)
410 def add_remote_command(subparser
):
411 add_command(subparser
, 'remote', 'edit remotes', cmd_remote
)
414 def add_search_command(subparser
):
415 add_command(subparser
, 'search', 'search commits', cmd_search
)
418 def add_stash_command(subparser
):
419 add_command(subparser
, 'stash', 'stash and unstash changes', cmd_stash
)
422 def add_tag_command(subparser
):
423 parser
= add_command(subparser
, 'tag', 'create tags', cmd_tag
)
425 'name', metavar
='<name>', nargs
='?', default
=None, help='tag name'
428 'ref', metavar
='<ref>', nargs
='?', default
=None, help='commit to tag'
435 help='annotated and GPG-signed tag',
439 def add_version_command(subparser
):
440 parser
= add_command(subparser
, 'version', 'print the version', cmd_version
)
445 help='print the version number only',
451 from .widgets
.main
import MainView
# pylint: disable=all
453 status_filter
= args
.status_filter
455 status_filter
= core
.abspath(status_filter
)
457 context
= app
.application_init(args
)
459 context
.timer
.start('view')
460 view
= MainView(context
)
462 cmds
.do(cmds
.AmendMode
, context
, amend
=True)
465 view
.set_filter(core
.relpath(status_filter
))
467 context
.timer
.stop('view')
469 context
.timer
.display('view')
471 return app
.application_run(context
, view
, start
=start_cola
, stop
=app
.default_stop
)
474 def start_cola(context
, view
):
475 app
.default_start(context
, view
)
480 from .widgets
import about
# pylint: disable=all
482 context
= app
.application_init(args
)
483 view
= about
.about_dialog(context
)
484 return app
.application_start(context
, view
)
488 from .widgets
.patch
import new_apply_patches
# pylint: disable=all
490 context
= app
.application_init(args
)
491 view
= new_apply_patches(context
, patches
=args
.patches
)
492 return app
.application_start(context
, view
)
495 def cmd_archive(args
):
496 from .widgets
import archive
# pylint: disable=all
498 context
= app
.application_init(args
, update
=True)
500 args
.ref
= context
.model
.currentbranch
501 view
= archive
.Archive(context
, args
.ref
)
502 return app
.application_start(context
, view
)
505 def cmd_branch(args
):
506 from .widgets
.createbranch
import create_new_branch
# pylint: disable=all
508 context
= app
.application_init(args
, update
=True)
509 view
= create_new_branch(context
)
510 return app
.application_start(context
, view
)
513 def cmd_browse(args
):
514 from .widgets
.browse
import worktree_browser
# pylint: disable=all
516 context
= app
.application_init(args
)
517 view
= worktree_browser(context
, show
=False, update
=False)
518 return app
.application_start(context
, view
)
522 from .widgets
import clone
# pylint: disable=all
524 context
= app
.application_init(args
)
525 view
= clone
.clone(context
)
526 context
.set_view(view
)
527 result
= 0 if view
.exec_() == view
.Accepted
else 1
528 app
.default_stop(context
, view
)
532 def cmd_config(args
):
533 from .widgets
.prefs
import preferences
# pylint: disable=all
535 context
= app
.application_init(args
)
536 view
= preferences(context
)
537 return app
.application_start(context
, view
)
541 from .widgets
import dag
# pylint: disable=all
543 context
= app
.application_init(args
)
544 # cola.main() uses parse_args(), unlike dag.main() which uses
545 # parse_known_args(), thus we aren't able to automatically forward
546 # all unknown arguments. Special-case support for "--all" since it's
547 # used by the history viewer command on Windows.
549 args
.args
.insert(0, '--all')
550 view
= dag
.git_dag(context
, args
=args
, show
=False)
551 return app
.application_start(context
, view
)
555 from .difftool
import diff_expression
# pylint: disable=all
557 context
= app
.application_init(args
)
558 expr
= core
.list2cmdline(args
.args
)
559 view
= diff_expression(context
, None, expr
, create_widget
=True)
560 return app
.application_start(context
, view
)
564 # TODO: the calls to update_status() can be done asynchronously
565 # by hooking into the message_updated notification.
566 from .widgets
import remote
# pylint: disable=all
568 context
= app
.application_init(args
)
569 context
.model
.update_status()
570 view
= remote
.fetch(context
)
571 return app
.application_start(context
, view
)
575 from .widgets
import finder
# pylint: disable=all
577 context
= app
.application_init(args
)
578 paths
= core
.list2cmdline(args
.paths
)
579 view
= finder
.finder(context
, paths
=paths
)
580 return app
.application_start(context
, view
)
584 from .widgets
import grep
# pylint: disable=all
586 context
= app
.application_init(args
)
587 text
= core
.list2cmdline(args
.args
)
588 view
= grep
.new_grep(context
, text
=text
, parent
=None)
589 return app
.application_start(context
, view
)
593 from .widgets
.merge
import Merge
# pylint: disable=all
595 context
= app
.application_init(args
, update
=True)
596 view
= Merge(context
, parent
=None, ref
=args
.ref
)
597 return app
.application_start(context
, view
)
600 def cmd_version(args
):
601 from . import version
# pylint: disable=all
603 version
.print_version(brief
=args
.brief
)
608 from .widgets
import remote
# pylint: disable=all
610 context
= app
.application_init(args
, update
=True)
611 view
= remote
.pull(context
)
613 view
.set_rebase(True)
614 return app
.application_start(context
, view
)
618 from .widgets
import remote
# pylint: disable=all
620 context
= app
.application_init(args
, update
=True)
621 view
= remote
.push(context
)
622 return app
.application_start(context
, view
)
625 def cmd_rebase(args
):
627 'verbose': args
.verbose
,
629 'autostash': args
.autostash
,
630 'fork_point': args
.fork_point
,
632 'preserve_merges': args
.preserve_merges
,
633 'strategy': args
.strategy
,
636 'exec': getattr(args
, 'exec', None), # python keyword
637 'keep_empty': args
.keep_empty
,
638 'force_rebase': args
.force_rebase
,
639 'strategy_option': args
.strategy_option
,
641 'no_stat': args
.no_stat
,
642 'verify': args
.verify
,
643 'rerere_autoupdate': args
.rerere_autoupdate
,
645 'autosquash': args
.autosquash
,
646 'committer_date_is_author_date': args
.committer_date_is_author_date
,
647 'ignore_date': args
.ignore_date
,
648 'whitespace': args
.whitespace
,
649 'ignore_whitespace': args
.ignore_whitespace
,
650 'C': args
.context_lines
,
651 'continue': getattr(args
, 'continue', False), # python keyword
654 'edit_todo': args
.edit_todo
,
655 'upstream': args
.upstream
,
656 'branch': args
.branch
,
658 context
= app
.application_init(args
)
659 status
, _
, _
= cmds
.do(cmds
.Rebase
, context
, **kwargs
)
663 def cmd_recent(args
):
664 from .widgets
import recent
# pylint: disable=all
666 context
= app
.application_init(args
)
667 view
= recent
.browse_recent_files(context
)
668 return app
.application_start(context
, view
)
671 def cmd_remote(args
):
672 from .widgets
import editremotes
# pylint: disable=all
674 context
= app
.application_init(args
)
675 view
= editremotes
.editor(context
, run
=False)
676 return app
.application_start(context
, view
)
679 def cmd_search(args
):
680 from .widgets
.search
import search
# pylint: disable=all
682 context
= app
.application_init(args
)
683 view
= search(context
)
684 return app
.application_start(context
, view
)
688 from .widgets
import stash
# pylint: disable=all
690 context
= app
.application_init(args
)
691 view
= stash
.view(context
, show
=False)
692 return app
.application_start(context
, view
)
696 from .widgets
.createtag
import new_create_tag
# pylint: disable=all
698 context
= app
.application_init(args
)
699 view
= new_create_tag(context
, name
=args
.name
, ref
=args
.ref
, sign
=args
.sign
)
700 return app
.application_start(context
, view
)
703 # Windows shortcut launch features:
704 def shortcut_launch():
705 """Launch from a shortcut
707 Prompt for the repository by default.
712 argv
= ['cola', '--prompt']
713 return app
.winmain(main
, argv
)