mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-04 15:28:27 +01:00
Saugat Pachhai
b9000ed926
* pre-commit: update black to 21.5b1 also updated others, but black is more noticeable * remove magic trailing comma
112 lines
2.9 KiB
Python
112 lines
2.9 KiB
Python
import argparse
|
|
import logging
|
|
|
|
import shtab
|
|
|
|
from dvc.command.base import CmdBaseNoRepo, append_doc_link
|
|
from dvc.ui import ui
|
|
|
|
logger = logging.getLogger(__name__)
|
|
FILE = shtab.FILE
|
|
DIR = shtab.DIRECTORY
|
|
|
|
PREAMBLE = {
|
|
"bash": """
|
|
# $1=COMP_WORDS[1]
|
|
_dvc_compgen_DVCFiles() {
|
|
compgen -d -S '/' -- $1 # recurse into subdirs
|
|
compgen -f -X '!*?.dvc' -- $1
|
|
compgen -f -X '!*Dvcfile' -- $1
|
|
compgen -f -X '!*dvc.yaml' -- $1
|
|
}
|
|
|
|
_dvc_compgen_stages() {
|
|
local _dvc_stages=($(dvc stage list -q --names-only))
|
|
compgen -W "${_dvc_stages[*]}" -- $1
|
|
}
|
|
_dvc_compgen_stages_and_files() {
|
|
_dvc_compgen_DVCFiles $1
|
|
_dvc_compgen_stages $1
|
|
}
|
|
|
|
_dvc_compgen_exps() {
|
|
local _dvc_exps=($(dvc exp list -q --all --names-only))
|
|
compgen -W "${_dvc_exps[*]}" -- $1
|
|
}
|
|
""",
|
|
"zsh": """
|
|
_dvc_compadd_DVCFiles() {
|
|
_files -g '(*?.dvc|Dvcfile|dvc.yaml)'
|
|
}
|
|
_dvc_compadd_stages() {
|
|
# this will also show up the description of the stages
|
|
_describe 'stages' "($(_dvc_stages_output))"
|
|
}
|
|
|
|
_dvc_stages_output() {
|
|
dvc stage list -q | awk '{
|
|
# escape possible `:` on the stage name
|
|
sub(/:/, "\\\\\\\\:", $1);
|
|
# read all of the columns except the first
|
|
# reading `out` from $2, so as not to have a leading whitespace
|
|
out=$2; for(i=3;i<=NF;i++){out=out" "$i};
|
|
# print key, ":" and then single-quote the description
|
|
# colon is a delimiter used by `_describe` to separate field/description
|
|
print $1":""\\047"out"\\047"
|
|
# single quote -> \\047
|
|
}'
|
|
}
|
|
|
|
_dvc_compadd_stages_and_files() {
|
|
_dvc_compadd_DVCFiles
|
|
_dvc_compadd_stages
|
|
}
|
|
|
|
_dvc_compadd_exps() {
|
|
_describe 'experiments' "($(dvc exp list -q -a --names-only))"
|
|
}
|
|
""",
|
|
}
|
|
|
|
DVC_FILE = {"bash": "_dvc_compgen_DVCFiles", "zsh": "_dvc_compadd_DVCFiles"}
|
|
|
|
STAGE = {"bash": "_dvc_compgen_stages", "zsh": "_dvc_compadd_stages"}
|
|
|
|
DVCFILES_AND_STAGE = {
|
|
"bash": "_dvc_compgen_stages_and_files",
|
|
"zsh": "_dvc_compadd_stages_and_files",
|
|
}
|
|
|
|
EXPERIMENT = {"bash": "_dvc_compgen_exps", "zsh": "_dvc_compadd_exps"}
|
|
|
|
|
|
class CmdCompletion(CmdBaseNoRepo):
|
|
def run(self):
|
|
from dvc.cli import get_main_parser
|
|
|
|
parser = get_main_parser()
|
|
shell = self.args.shell
|
|
script = shtab.complete(parser, shell=shell, preamble=PREAMBLE)
|
|
ui.write(script, force=True)
|
|
return 0
|
|
|
|
|
|
def add_parser(subparsers, parent_parser):
|
|
COMPLETION_HELP = "Generate shell tab completion."
|
|
COMPLETION_DESCRIPTION = "Prints out shell tab completion scripts."
|
|
completion_parser = subparsers.add_parser(
|
|
"completion",
|
|
parents=[parent_parser],
|
|
description=append_doc_link(COMPLETION_DESCRIPTION, "completion"),
|
|
help=COMPLETION_HELP,
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
completion_parser.add_argument(
|
|
"-s",
|
|
"--shell",
|
|
help="Shell syntax for completions.",
|
|
default="bash",
|
|
choices=["bash", "zsh"],
|
|
)
|
|
completion_parser.set_defaults(func=CmdCompletion)
|