Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions dvc/repo/ls.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
import os
from itertools import chain
from typing import TYPE_CHECKING, Optional

from dvc.exceptions import PathMissingError

if TYPE_CHECKING:
from dvc.fs.repo import RepoFileSystem

def ls(url, path=None, rev=None, recursive=None, dvc_only=False):
from . import Repo


def ls(
url: str,
path: Optional[str] = None,
rev: str = None,
recursive: bool = None,
dvc_only: bool = False,
):
"""Methods for getting files and outputs for the repo.

Args:
Expand All @@ -31,10 +43,7 @@ def ls(url, path=None, rev=None, recursive=None, dvc_only=False):
with Repo.open(url, rev=rev, subrepos=True, uninitialized=True) as repo:
path = path or ""

ret = _ls(repo.repo_fs, path, recursive, dvc_only)

if path and not ret:
raise PathMissingError(path, repo, dvc_only=dvc_only)
ret = _ls(repo, path, recursive, dvc_only)

ret_list = []
for path, info in ret.items():
Expand All @@ -44,13 +53,16 @@ def ls(url, path=None, rev=None, recursive=None, dvc_only=False):
return ret_list


def _ls(fs, path, recursive=None, dvc_only=False):
def _ls(
repo: "Repo", path: str, recursive: bool = None, dvc_only: bool = False
):
fs: "RepoFileSystem" = repo.repo_fs
fs_path = fs.from_os_path(path)

try:
fs_path = fs.info(fs_path)["name"]
except FileNotFoundError:
return {}
raise PathMissingError(path, repo, dvc_only=dvc_only)

infos = {}
for root, dirs, files in fs.walk(
Expand Down
13 changes: 12 additions & 1 deletion tests/func/test_ls.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,20 @@ def test_ls_repo_with_path_dir_dvc_only_empty(tmp_dir, dvc, scm):
tmp_dir.scm_gen(FS_STRUCTURE, commit="init")
tmp_dir.dvc_gen(DVC_STRUCTURE, commit="dvc")
tmp_dir.scm_gen({"folder/.keep": "content"}, commit="add .keep")
tmp_dir.scm_gen({"empty_scm_folder/": {}}, commit="add scm empty")
tmp_dir.dvc_gen({"empty_dvc_folder": {}}, commit="empty dvc folder")

with pytest.raises(PathMissingError):
Repo.ls(os.fspath(tmp_dir), path="folder", dvc_only=True)
Repo.ls(os.fspath(tmp_dir), path="not_exist_folder")

assert Repo.ls(os.fspath(tmp_dir), path="empty_scm_folder") == []

assert Repo.ls(os.fspath(tmp_dir), path="folder", dvc_only=True) == []

assert (
Repo.ls(os.fspath(tmp_dir), path="empty_dvc_folder", dvc_only=True)
== []
)


def test_ls_repo_with_path_subdir(tmp_dir, dvc, scm):
Expand Down