cli refactor: move dvc.command.base to dvc.cli.command

dvc/cli/__init__.py

@@ -1,3 +1,5 @@
+"""This module provides an entrypoint to the dvc cli and parsing utils."""
+
 import logging
 
 # Workaround for CPython bug. See [1] and [2] for more info.

dvc/cli/command.py

@@ -0,0 +1,36 @@
+import logging
+import os
+from abc import ABC, abstractmethod
+
+logger = logging.getLogger(__name__)
+
+
+class CmdBase(ABC):
+    UNINITIALIZED = False
+
+    def __init__(self, args):
+        from dvc.repo import Repo
+
+        os.chdir(args.cd)
+
+        self.repo = Repo(uninitialized=self.UNINITIALIZED)
+        self.config = self.repo.config
+        self.args = args
+
+    def do_run(self):
+        with self.repo:
+            return self.run()
+
+    @abstractmethod
+    def run(self):
+        pass
+
+
+class CmdBaseNoRepo(CmdBase):
+    def __init__(self, args):  # pylint: disable=super-init-not-called
+        self.args = args
+
+        os.chdir(args.cd)
+
+    def do_run(self):
+        return self.run()

dvc/cli/parser.py

@@ -1,4 +1,4 @@
-"""DVC command line interface"""
+"""Main parser for the dvc cli."""
 import argparse
 import logging
 import os
@@ -208,7 +208,7 @@ def get_main_parser():
         help="Use `dvc COMMAND --help` for command-specific help.",
     )
 
-    from dvc.command.base import fix_subparsers
+    from .utils import fix_subparsers
 
     fix_subparsers(subparsers)
 

dvc/cli/utils.py

@@ -1,10 +1,3 @@
-import logging
-import os
-from abc import ABC, abstractmethod
-
-logger = logging.getLogger(__name__)
-
-
 def fix_subparsers(subparsers):
     """Workaround for bug in Python 3. See more info at:
     https://bugs.python.org/issue16308
@@ -28,37 +21,6 @@ def append_doc_link(help_message, path):
     )
 
 
-class CmdBase(ABC):
-    UNINITIALIZED = False
-
-    def __init__(self, args):
-        from dvc.repo import Repo
-
-        os.chdir(args.cd)
-
-        self.repo = Repo(uninitialized=self.UNINITIALIZED)
-        self.config = self.repo.config
-        self.args = args
-
-    def do_run(self):
-        with self.repo:
-            return self.run()
-
-    @abstractmethod
-    def run(self):
-        pass
-
-
-class CmdBaseNoRepo(CmdBase):
-    def __init__(self, args):  # pylint: disable=super-init-not-called
-        self.args = args
-
-        os.chdir(args.cd)
-
-    def do_run(self):
-        return self.run()
-
-
 def fix_plumbing_subparsers(subparsers):
     # metavar needs to be explicitly set in order to hide plumbing subcommands
     # from the 'positional arguments' choices list

dvc/command/add.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/cache.py

@@ -1,7 +1,7 @@
 import argparse
 
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command import completion
-from dvc.command.base import append_doc_link, fix_subparsers
 from dvc.command.config import CmdConfig
 from dvc.ui import ui
 

dvc/command/check_ignore.py

@@ -1,7 +1,8 @@
 import argparse
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.ui import ui
 
 

dvc/command/checkout.py

@@ -1,8 +1,9 @@
 import argparse
 import operator
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import CheckoutError
 from dvc.ui import ui
 

dvc/command/commit.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/completion.py

@@ -3,7 +3,8 @@ import logging
 
 import shtab
 
-from dvc.command.base import CmdBaseNoRepo, append_doc_link
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

dvc/command/config.py

@@ -2,7 +2,8 @@ import argparse
 import logging
 import os
 
-from dvc.command.base import CmdBaseNoRepo, append_doc_link
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

dvc/command/daemon.py

@@ -1,5 +1,6 @@
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import fix_subparsers
 from dvc.command import completion
-from dvc.command.base import CmdBaseNoRepo, fix_subparsers
 
 
 class CmdDaemonBase(CmdBaseNoRepo):

dvc/command/dag.py

@@ -1,6 +1,7 @@
 import argparse
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.ui import ui
 
 

dvc/command/data_sync.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/destroy.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/diff.py

@@ -2,8 +2,9 @@ import argparse
 import logging
 import os
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

dvc/command/experiments/__init__.py

@@ -1,6 +1,6 @@
 import argparse
 
-from dvc.command.base import (
+from dvc.cli.utils import (
     append_doc_link,
     fix_plumbing_subparsers,
     fix_subparsers,

dvc/command/experiments/apply.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/experiments/branch.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/experiments/diff.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.command.metrics import DEFAULT_PRECISION
 from dvc.exceptions import DvcException
 from dvc.ui import ui

dvc/command/experiments/exec_run.py

@@ -1,6 +1,6 @@
 import logging
 
-from dvc.command.base import CmdBaseNoRepo
+from dvc.cli.command import CmdBaseNoRepo
 
 logger = logging.getLogger(__name__)
 

dvc/command/experiments/gc.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.exceptions import InvalidArgumentError
 from dvc.ui import ui
 

dvc/command/experiments/init.py

@@ -3,7 +3,8 @@ import logging
 
 from funcy import compact
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.exceptions import InvalidArgumentError
 from dvc.ui import ui
 

dvc/command/experiments/ls.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/experiments/pull.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

dvc/command/experiments/push.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

dvc/command/experiments/remove.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/experiments/run.py

@@ -1,8 +1,8 @@
 import argparse
 import logging
 
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import append_doc_link
 from dvc.command.repro import CmdRepro
 from dvc.command.repro import add_arguments as add_repro_arguments
 from dvc.exceptions import InvalidArgumentError

dvc/command/experiments/show.py

@@ -8,8 +8,9 @@ from typing import TYPE_CHECKING, Dict, Iterable, Optional
 
 from funcy import lmap
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.command.metrics import DEFAULT_PRECISION
 from dvc.exceptions import DvcException, InvalidArgumentError
 from dvc.ui import ui

dvc/command/freeze.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/gc.py

@@ -2,7 +2,8 @@ import argparse
 import logging
 import os
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

dvc/command/get.py

@@ -1,10 +1,11 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBaseNoRepo
 from dvc.exceptions import DvcException
 
+from ..cli.utils import append_doc_link
 from . import completion
-from .base import CmdBaseNoRepo, append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/get_url.py

@@ -1,10 +1,11 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBaseNoRepo
 from dvc.exceptions import DvcException
 
+from ..cli.utils import append_doc_link
 from . import completion
-from .base import CmdBaseNoRepo, append_doc_link
 
 logger = logging.getLogger(__name__)
 

dvc/command/git_hook.py

@@ -1,7 +1,8 @@
 import logging
 import os
 
-from dvc.command.base import CmdBaseNoRepo, fix_subparsers
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import fix_subparsers
 from dvc.exceptions import NotDvcRepoError
 
 logger = logging.getLogger(__name__)

dvc/command/imp.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/imp_url.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/init.py

@@ -4,7 +4,8 @@ import logging
 import colorama
 
 from dvc import analytics
-from dvc.command.base import CmdBaseNoRepo, append_doc_link
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import append_doc_link
 from dvc.utils import boxify
 from dvc.utils import format_link as fmt_link
 

dvc/command/install.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/live.py

@@ -1,8 +1,9 @@
 import argparse
 from pathlib import Path
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import fix_subparsers
 from dvc.command import completion
-from dvc.command.base import CmdBase, fix_subparsers
 from dvc.ui import ui
 
 

dvc/command/ls/__init__.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBaseNoRepo, append_doc_link
 from dvc.command.ls.ls_colors import LsColors
 from dvc.exceptions import DvcException
 from dvc.ui import ui

dvc/command/machine.py

@@ -1,6 +1,7 @@
 import argparse
 
-from dvc.command.base import CmdBase, append_doc_link, fix_subparsers
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command.config import CmdConfig
 from dvc.compare import TabularData
 from dvc.config import ConfigError

dvc/command/metrics.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link, fix_subparsers
 from dvc.exceptions import DvcException
 from dvc.ui import ui
 from dvc.utils.serialize import encode_exception

dvc/command/move.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/params.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link, fix_subparsers
 from dvc.exceptions import DvcException
 from dvc.ui import ui
 

dvc/command/plots.py

@@ -4,8 +4,9 @@ import logging
 
 from funcy import first
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link, fix_subparsers
 from dvc.exceptions import DvcException
 from dvc.ui import ui
 from dvc.utils import format_link

dvc/command/remote.py

@@ -1,6 +1,6 @@
 import argparse
 
-from dvc.command.base import append_doc_link, fix_subparsers
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command.config import CmdConfig
 from dvc.ui import ui
 from dvc.utils import format_link

dvc/command/remove.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/repro.py

@@ -1,7 +1,8 @@
 import argparse
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.command.status import CmdDataStatus
 
 

dvc/command/root.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBaseNoRepo, append_doc_link
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import append_doc_link
 from dvc.utils import relpath
 
 logger = logging.getLogger(__name__)

dvc/command/run.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBase, append_doc_link
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command.stage import parse_cmd
 from dvc.exceptions import DvcException
 

dvc/command/stage.py

@@ -3,8 +3,9 @@ import logging
 from itertools import chain, filterfalse
 from typing import TYPE_CHECKING, Dict, Iterable, List
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link, fix_subparsers
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link, fix_subparsers
 from dvc.utils.cli_parse import parse_params
 from dvc.utils.humanize import truncate_text
 

dvc/command/unprotect.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/update.py

@@ -1,8 +1,9 @@
 import argparse
 import logging
 
+from dvc.cli.command import CmdBase
+from dvc.cli.utils import append_doc_link
 from dvc.command import completion
-from dvc.command.base import CmdBase, append_doc_link
 from dvc.exceptions import DvcException
 
 logger = logging.getLogger(__name__)

dvc/command/version.py

@@ -1,7 +1,8 @@
 import argparse
 import logging
 
-from dvc.command.base import CmdBaseNoRepo, append_doc_link
+from dvc.cli.command import CmdBaseNoRepo
+from dvc.cli.utils import append_doc_link
 from dvc.ui import ui
 
 logger = logging.getLogger(__name__)

tests/func/test_cli.py

@@ -1,8 +1,8 @@
 import os
 
 from dvc.cli import DvcParserError, parse_args
+from dvc.cli.command import CmdBase
 from dvc.command.add import CmdAdd
-from dvc.command.base import CmdBase
 from dvc.command.checkout import CmdCheckout
 from dvc.command.config import CmdConfig
 from dvc.command.data_sync import CmdDataPull, CmdDataPush