mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-10 15:28:34 +01:00
Saugat PachhaiandJorge Orpinel
066ccea733
* checkout: implement --show-changes flag to show detailed checkout details Show summary by default on checkout checkout: show directory modified even when files are removed from inside it checkout: refactor template logic checkout: change output format checkout: do not show summary if nothing's changed checkout: do not show summary if show_changes is specified checkout: show '/' at the end if it's a directory rename variable name test: cover stats for checkout checkout: show relink as not modified checkout: remove unwanted message during empty checkout pull: show summary on checkout import/get: change external_repo to catch CheckoutError fix tests and check if path is url checkout: support external deps/outputs tests: checkout on external outputs * fix tests * checkout: make show changes default and introduce summary flag to show summary * address suggestions * exceptions: remove extra spacing on erorr * Update dvc/command/checkout.py Co-Authored-By: Jorge Orpinel <[email protected]> Co-authored-by: Jorge Orpinel <[email protected]>
137 lines
3.4 KiB
Python
137 lines
3.4 KiB
Python
import argparse
|
|
import logging
|
|
|
|
import colorama
|
|
|
|
from dvc.command.base import append_doc_link
|
|
from dvc.command.base import CmdBase
|
|
from dvc.exceptions import CheckoutError
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def _human_join(words):
|
|
words = list(words)
|
|
if not words:
|
|
return ""
|
|
|
|
return (
|
|
"{before} and {after}".format(
|
|
before=", ".join(words[:-1]), after=words[-1],
|
|
)
|
|
if len(words) > 1
|
|
else words[0]
|
|
)
|
|
|
|
|
|
def log_summary(stats):
|
|
states = ("added", "deleted", "modified")
|
|
summary = (
|
|
"{} {}".format(len(stats[state]), state)
|
|
for state in states
|
|
if stats.get(state)
|
|
)
|
|
logger.info(_human_join(summary))
|
|
|
|
|
|
def log_changes(stats):
|
|
colors = [
|
|
("modified", colorama.Fore.YELLOW,),
|
|
("added", colorama.Fore.GREEN),
|
|
("deleted", colorama.Fore.RED,),
|
|
]
|
|
|
|
for state, color in colors:
|
|
entries = stats.get(state)
|
|
|
|
if not entries:
|
|
continue
|
|
|
|
for entry in entries:
|
|
logger.info(
|
|
"{color}{state}{nc}{spacing}{entry}".format(
|
|
color=color,
|
|
state=state[0].upper(),
|
|
nc=colorama.Fore.RESET,
|
|
spacing="\t",
|
|
entry=entry,
|
|
)
|
|
)
|
|
|
|
|
|
class CmdCheckout(CmdBase):
|
|
def run(self):
|
|
stats, exc = None, None
|
|
try:
|
|
stats = self.repo.checkout(
|
|
targets=self.args.targets,
|
|
with_deps=self.args.with_deps,
|
|
force=self.args.force,
|
|
relink=self.args.relink,
|
|
recursive=self.args.recursive,
|
|
)
|
|
except CheckoutError as _exc:
|
|
exc = _exc
|
|
stats = exc.stats
|
|
|
|
if self.args.summary:
|
|
log_summary(stats)
|
|
else:
|
|
log_changes(stats)
|
|
|
|
if exc:
|
|
raise exc
|
|
return 0
|
|
|
|
|
|
def add_parser(subparsers, parent_parser):
|
|
CHECKOUT_HELP = "Checkout data files from cache."
|
|
|
|
checkout_parser = subparsers.add_parser(
|
|
"checkout",
|
|
parents=[parent_parser],
|
|
description=append_doc_link(CHECKOUT_HELP, "checkout"),
|
|
help=CHECKOUT_HELP,
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
checkout_parser.add_argument(
|
|
"--summary",
|
|
action="store_true",
|
|
default=False,
|
|
help="Show summary of the changes.",
|
|
)
|
|
checkout_parser.add_argument(
|
|
"-d",
|
|
"--with-deps",
|
|
action="store_true",
|
|
default=False,
|
|
help="Checkout all dependencies of the specified target.",
|
|
)
|
|
checkout_parser.add_argument(
|
|
"-R",
|
|
"--recursive",
|
|
action="store_true",
|
|
default=False,
|
|
help="Checkout all subdirectories of the specified directory.",
|
|
)
|
|
checkout_parser.add_argument(
|
|
"-f",
|
|
"--force",
|
|
action="store_true",
|
|
default=False,
|
|
help="Do not prompt when removing working directory files.",
|
|
)
|
|
checkout_parser.add_argument(
|
|
"--relink",
|
|
action="store_true",
|
|
default=False,
|
|
help="Recreate links or copies from cache to workspace.",
|
|
)
|
|
checkout_parser.add_argument(
|
|
"targets",
|
|
nargs="*",
|
|
help="DVC-files to checkout. Optional. "
|
|
"(Finds all DVC-files in the workspace by default.)",
|
|
)
|
|
checkout_parser.set_defaults(func=CmdCheckout)
|