cli: add --cd flag to change directories before executing commands (#…

…4566) * cli: add -C flag to change directories before executing commands Fixes #4025 * add deprecation notice to dvc repro help message
iterative · Sep 25, 2020 · c94ab35 · c94ab35
1 parent 9643ff7
commit c94ab35
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 4 deletions.
diff --git a/dvc/cli.py b/dvc/cli.py
@@ -1,6 +1,7 @@
 """DVC command line interface"""
 import argparse
 import logging
+import os
 import sys
 
 from .command import (
@@ -191,6 +192,14 @@ def get_main_parser():
         help="Show program's version.",
     )
 
+    parser.add_argument(
+        "--cd",
+        default=os.path.curdir,
+        metavar="<path>",
+        help="Change to directory before executing.",
+        type=str,
+    )
+
     # Sub commands
     subparsers = parser.add_subparsers(
         title="Available Commands",

diff --git a/dvc/command/base.py b/dvc/command/base.py
@@ -1,4 +1,5 @@
 import logging
+import os
 from abc import ABC, abstractmethod
 
 logger = logging.getLogger(__name__)
@@ -32,6 +33,8 @@ def __init__(self, args):
         from dvc.repo import Repo
         from dvc.updater import Updater
 
+        os.chdir(args.cd)
+
         self.repo = Repo()
         self.config = self.repo.config
         self.args = args
@@ -55,3 +58,5 @@ def run(self):
 class CmdBaseNoRepo(CmdBase):
     def __init__(self, args):  # pylint: disable=super-init-not-called
         self.args = args
+
+        os.chdir(args.cd)
diff --git a/dvc/command/repro.py b/dvc/command/repro.py
@@ -15,8 +15,7 @@
 class CmdRepro(CmdBase):
     def run(self):
         saved_dir = os.path.realpath(os.curdir)
-        if self.args.cwd:
-            os.chdir(self.args.cwd)
+        os.chdir(self.args.cwd)
 
         # Dirty hack so the for loop below can at least enter once
         if self.args.all_pipelines:
@@ -97,7 +96,8 @@ def add_parser(subparsers, parent_parser):
         "-c",
         "--cwd",
         default=os.path.curdir,
-        help="Directory within your repo to reproduce from.",
+        help="Directory within your repo to reproduce from. Note: deprecated "
+        "by `dvc --cd <path>`.",
         metavar="<path>",
     )
     repro_parser.add_argument(

diff --git a/tests/func/test_cli.py b/tests/func/test_cli.py
@@ -160,19 +160,37 @@ def test(self):
 
 class TestFindRoot(TestDvc):
     def test(self):
-        os.chdir("..")
+        class Cmd(CmdBase):
+            def run(self):
+                pass
+
+        class A:
+            quiet = False
+            verbose = True
+            cd = os.path.pardir
 
+        args = A()
+        with self.assertRaises(DvcException):
+            Cmd(args)
+
+
+class TestCd(TestDvc):
+    def test(self):
         class Cmd(CmdBase):
             def run(self):
                 pass
 
         class A:
             quiet = False
             verbose = True
+            cd = os.path.pardir
 
+        parent_dir = os.path.realpath(os.path.pardir)
         args = A()
         with self.assertRaises(DvcException):
             Cmd(args)
+        current_dir = os.path.realpath(os.path.curdir)
+        self.assertEqual(parent_dir, current_dir)
 
 
 def test_unknown_command_help(capsys):