mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-08 15:28:26 +01:00
Jorge Orpinel
b23f43a7e7
* get/import: update cmd and url arg descs with correct behavior * get/import: update path arg desc as well (See previous commit) * get/imp: udpate help output with simpler terms per https://github.com/iterative/dvc/pull/3277#pullrequestreview-352650016 * api: url->URL in a docstring * metrics show: update help output per per https://github.com/iterative/dvc.org/pull/933#pullrequestreview-351862579 * diff: update `diff` and `metrics diff` help desc to match docs per https://github.com/iterative/dvc.org/pull/933#pullrequestreview-356890960 * diff: update autocomplete scripts per https://github.com/iterative/dvc/pull/3308#issuecomment-585220300 * diff: update help output again per https://github.com/iterative/dvc.org/pull/933#pullrequestreview-356890960 * diff/metrics diff: update help output yet again per https://github.com/iterative/dvc.org/pull/933#discussion_r378654316 * term" under X control -> tracked by X
295 lines
8.4 KiB
Python
295 lines
8.4 KiB
Python
import argparse
|
|
import logging
|
|
|
|
from dvc.command.base import append_doc_link
|
|
from dvc.command.base import CmdBase
|
|
from dvc.exceptions import DvcException
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class CmdDataBase(CmdBase):
|
|
@classmethod
|
|
def check_up_to_date(cls, processed_files_count):
|
|
if processed_files_count == 0:
|
|
logger.info("Everything is up to date.")
|
|
|
|
|
|
class CmdDataPull(CmdDataBase):
|
|
def run(self):
|
|
try:
|
|
processed_files_count = self.repo.pull(
|
|
targets=self.args.targets,
|
|
jobs=self.args.jobs,
|
|
remote=self.args.remote,
|
|
all_branches=self.args.all_branches,
|
|
all_tags=self.args.all_tags,
|
|
with_deps=self.args.with_deps,
|
|
force=self.args.force,
|
|
recursive=self.args.recursive,
|
|
)
|
|
except DvcException:
|
|
logger.exception("failed to pull data from the cloud")
|
|
return 1
|
|
self.check_up_to_date(processed_files_count)
|
|
return 0
|
|
|
|
|
|
class CmdDataPush(CmdDataBase):
|
|
def run(self):
|
|
try:
|
|
processed_files_count = self.repo.push(
|
|
targets=self.args.targets,
|
|
jobs=self.args.jobs,
|
|
remote=self.args.remote,
|
|
all_branches=self.args.all_branches,
|
|
all_tags=self.args.all_tags,
|
|
with_deps=self.args.with_deps,
|
|
recursive=self.args.recursive,
|
|
)
|
|
except DvcException:
|
|
logger.exception("failed to push data to the cloud")
|
|
return 1
|
|
self.check_up_to_date(processed_files_count)
|
|
return 0
|
|
|
|
|
|
class CmdDataFetch(CmdDataBase):
|
|
def run(self):
|
|
try:
|
|
processed_files_count = self.repo.fetch(
|
|
targets=self.args.targets,
|
|
jobs=self.args.jobs,
|
|
remote=self.args.remote,
|
|
all_branches=self.args.all_branches,
|
|
all_tags=self.args.all_tags,
|
|
with_deps=self.args.with_deps,
|
|
recursive=self.args.recursive,
|
|
)
|
|
except DvcException:
|
|
logger.exception("failed to fetch data from the cloud")
|
|
return 1
|
|
self.check_up_to_date(processed_files_count)
|
|
return 0
|
|
|
|
|
|
def shared_parent_parser():
|
|
from dvc.cli import get_parent_parser
|
|
|
|
# Parent parser used in pull/push/status
|
|
shared_parent_parser = argparse.ArgumentParser(
|
|
add_help=False, parents=[get_parent_parser()]
|
|
)
|
|
shared_parent_parser.add_argument(
|
|
"-j", "--jobs", type=int, help="Number of jobs to run simultaneously."
|
|
)
|
|
shared_parent_parser.add_argument(
|
|
"targets",
|
|
nargs="*",
|
|
help="Limit command scope to these DVC-files. "
|
|
"Using -R, directories to search DVC-files in can also be given.",
|
|
)
|
|
|
|
return shared_parent_parser
|
|
|
|
|
|
def add_parser(subparsers, _parent_parser):
|
|
from dvc.command.status import CmdDataStatus
|
|
|
|
# Pull
|
|
PULL_HELP = "Pull data files from a DVC remote storage."
|
|
|
|
pull_parser = subparsers.add_parser(
|
|
"pull",
|
|
parents=[shared_parent_parser()],
|
|
description=append_doc_link(PULL_HELP, "pull"),
|
|
help=PULL_HELP,
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
pull_parser.add_argument(
|
|
"-r", "--remote", help="Remote repository to pull from."
|
|
)
|
|
pull_parser.add_argument(
|
|
"-a",
|
|
"--all-branches",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for all branches.",
|
|
)
|
|
pull_parser.add_argument(
|
|
"-T",
|
|
"--all-tags",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for all tags.",
|
|
)
|
|
pull_parser.add_argument(
|
|
"-f",
|
|
"--force",
|
|
action="store_true",
|
|
default=False,
|
|
help="Do not prompt when removing working directory files.",
|
|
)
|
|
pull_parser.add_argument(
|
|
"-d",
|
|
"--with-deps",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for all dependencies of the specified target.",
|
|
)
|
|
pull_parser.add_argument(
|
|
"-R",
|
|
"--recursive",
|
|
action="store_true",
|
|
default=False,
|
|
help="Pull cache for subdirectories of the specified directory.",
|
|
)
|
|
pull_parser.set_defaults(func=CmdDataPull)
|
|
|
|
# Push
|
|
PUSH_HELP = "Uploads files or directories tracked by DVC"
|
|
" to remote storage."
|
|
|
|
push_parser = subparsers.add_parser(
|
|
"push",
|
|
parents=[shared_parent_parser()],
|
|
description=append_doc_link(PUSH_HELP, "push"),
|
|
help=PUSH_HELP,
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
push_parser.add_argument(
|
|
"-r", "--remote", help="Remote repository to push to."
|
|
)
|
|
push_parser.add_argument(
|
|
"-a",
|
|
"--all-branches",
|
|
action="store_true",
|
|
default=False,
|
|
help="Push cache for all branches.",
|
|
)
|
|
push_parser.add_argument(
|
|
"-T",
|
|
"--all-tags",
|
|
action="store_true",
|
|
default=False,
|
|
help="Push cache for all tags.",
|
|
)
|
|
push_parser.add_argument(
|
|
"-d",
|
|
"--with-deps",
|
|
action="store_true",
|
|
default=False,
|
|
help="Push cache for all dependencies of the specified target.",
|
|
)
|
|
push_parser.add_argument(
|
|
"-R",
|
|
"--recursive",
|
|
action="store_true",
|
|
default=False,
|
|
help="Push cache from subdirectories of specified directory.",
|
|
)
|
|
push_parser.set_defaults(func=CmdDataPush)
|
|
|
|
# Fetch
|
|
FETCH_HELP = "Get files or directories tracked by DVC from remote storage"
|
|
" into the cache."
|
|
|
|
fetch_parser = subparsers.add_parser(
|
|
"fetch",
|
|
parents=[shared_parent_parser()],
|
|
description=append_doc_link(FETCH_HELP, "fetch"),
|
|
help=FETCH_HELP,
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
fetch_parser.add_argument(
|
|
"-r", "--remote", help="Remote repository to fetch from."
|
|
)
|
|
fetch_parser.add_argument(
|
|
"-a",
|
|
"--all-branches",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for all branches.",
|
|
)
|
|
fetch_parser.add_argument(
|
|
"-T",
|
|
"--all-tags",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for all tags.",
|
|
)
|
|
fetch_parser.add_argument(
|
|
"-d",
|
|
"--with-deps",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for all dependencies of the " "specified target.",
|
|
)
|
|
fetch_parser.add_argument(
|
|
"-R",
|
|
"--recursive",
|
|
action="store_true",
|
|
default=False,
|
|
help="Fetch cache for subdirectories of specified directory.",
|
|
)
|
|
fetch_parser.set_defaults(func=CmdDataFetch)
|
|
|
|
# Status
|
|
STATUS_HELP = (
|
|
"Show changed stages, compare local cache and a remote storage."
|
|
)
|
|
|
|
status_parser = subparsers.add_parser(
|
|
"status",
|
|
parents=[shared_parent_parser()],
|
|
description=append_doc_link(STATUS_HELP, "status"),
|
|
help=STATUS_HELP,
|
|
conflict_handler="resolve",
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
status_parser.add_argument(
|
|
"-q",
|
|
"--quiet",
|
|
action="store_true",
|
|
default=False,
|
|
help=(
|
|
"Suppresses all output."
|
|
" Exit with 0 if pipelines are up to date, otherwise 1."
|
|
),
|
|
)
|
|
status_parser.add_argument(
|
|
"-c",
|
|
"--cloud",
|
|
action="store_true",
|
|
default=False,
|
|
help="Show status of a local cache compared to a remote repository.",
|
|
)
|
|
status_parser.add_argument(
|
|
"-r", "--remote", help="Remote repository to compare local cache to."
|
|
)
|
|
status_parser.add_argument(
|
|
"-a",
|
|
"--all-branches",
|
|
action="store_true",
|
|
default=False,
|
|
help="Show status of a local cache compared to a remote repository "
|
|
"for all branches.",
|
|
)
|
|
status_parser.add_argument(
|
|
"-T",
|
|
"--all-tags",
|
|
action="store_true",
|
|
default=False,
|
|
help="Show status of a local cache compared to a remote repository "
|
|
"for all tags.",
|
|
)
|
|
status_parser.add_argument(
|
|
"-d",
|
|
"--with-deps",
|
|
action="store_true",
|
|
default=False,
|
|
help="Show status for all dependencies of the specified target.",
|
|
)
|
|
status_parser.set_defaults(func=CmdDataStatus)
|