Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review help/usage for cli commands #802

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Review help/usage for cli commands #802

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9775e8
Review help/usage for cli commands
amritghimire Jan 7, 2025
a21923a
Bring uniformity for Studio mention
amritghimire Jan 8, 2025
c05200d
Merge branch 'main' into amrit/fix-typos
amritghimire Jan 8, 2025
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
81 changes: 42 additions & 39 deletions src/datachain/cli/parser/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import argparse
from argparse import ArgumentParser
from importlib.metadata import PackageNotFoundError, version

Expand All @@ -18,7 +19,8 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
__version__ = "unknown"

parser = ArgumentParser(
description="DataChain: Wrangle unstructured AI data at scale", prog="datachain"
description="DataChain: Wrangle unstructured AI data at scale.",
prog="datachain",
)
parser.add_argument("-V", "--version", action="version", version=__version__)

Expand Down Expand Up @@ -46,24 +48,24 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"--debug-sql",
action="store_true",
default=False,
help="Show All SQL Queries (very verbose output, for debugging only)",
help=argparse.SUPPRESS,
)
parent_parser.add_argument(
"--pdb",
action="store_true",
default=False,
help="Drop into the pdb debugger on fatal exception",
help=argparse.SUPPRESS,
)

subp = parser.add_subparsers(
title="Available Commands",
metavar="command",
dest="command",
help=f"Use `{parser.prog} command --help` for command-specific help.",
help=f"Use `{parser.prog} command --help` for command-specific help",
required=True,
)
parse_cp = subp.add_parser(
"cp", parents=[parent_parser], description="Copy data files from the cloud"
"cp", parents=[parent_parser], description="Copy data files from the cloud."
)
add_sources_arg(parse_cp).complete = shtab.DIR # type: ignore[attr-defined]
parse_cp.add_argument("output", type=str, help="Output")
Expand All @@ -90,7 +92,7 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
)

parse_clone = subp.add_parser(
"clone", parents=[parent_parser], description="Copy data files from the cloud"
"clone", parents=[parent_parser], description="Copy data files from the cloud."
)
add_sources_arg(parse_clone).complete = shtab.DIR # type: ignore[attr-defined]
parse_clone.add_argument("output", type=str, help="Output")
Expand Down Expand Up @@ -139,17 +141,18 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"dataset",
aliases=["ds"],
parents=[parent_parser],
description="Commands for managing datasers",
description="Commands for managing datasets.",
)
datasets_subparser = datasets_parser.add_subparsers(
dest="datasets_cmd",
help="Use `datachain datasets CMD --help` to display command specific help",
required=True,
help="Use `datachain dataset CMD --help` to display command-specific help",
)

parse_pull = datasets_subparser.add_parser(
"pull",
parents=[parent_parser],
description="Pull specific dataset version from SaaS",
description="Pull specific dataset version from SaaS.",
amritghimire marked this conversation as resolved.
Show resolved Hide resolved
)
parse_pull.add_argument(
"dataset",
Expand Down Expand Up @@ -202,7 +205,7 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
)

parse_edit_dataset = datasets_subparser.add_parser(
"edit", parents=[parent_parser], description="Edit dataset metadata"
"edit", parents=[parent_parser], description="Edit dataset metadata."
)
parse_edit_dataset.add_argument("name", type=str, help="Dataset name")
parse_edit_dataset.add_argument(
Expand Down Expand Up @@ -244,11 +247,11 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"--team",
action="store",
default=None,
help="The team to edit a dataset. By default, it will use team from config.",
help="The team to edit a dataset. By default, it will use team from config",
)

datasets_parser = datasets_subparser.add_parser(
"ls", parents=[parent_parser], description="List datasets"
"ls", parents=[parent_parser], description="List datasets."
)
datasets_parser.add_argument(
"--studio",
Expand All @@ -274,11 +277,11 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"--team",
action="store",
default=None,
help="The team to list datasets for. By default, it will use team from config.",
help="The team to list datasets for. By default, it will use team from config",
)

rm_dataset_parser = datasets_subparser.add_parser(
"rm", parents=[parent_parser], description="Removes dataset", aliases=["remove"]
"rm", parents=[parent_parser], description="Remove dataset.", aliases=["remove"]
)
rm_dataset_parser.add_argument("name", type=str, help="Dataset name")
rm_dataset_parser.add_argument(
Expand All @@ -292,7 +295,7 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"--force",
default=False,
action=BooleanOptionalAction,
help="Force delete registered dataset with all of it's versions",
help="Force delete registered dataset with all of its versions",
)
rm_dataset_parser.add_argument(
"--studio",
Expand All @@ -318,13 +321,11 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"--team",
action="store",
default=None,
help="The team to delete a dataset. By default, it will use team from config.",
help="The team to delete a dataset. By default, it will use team from config",
)

dataset_stats_parser = datasets_subparser.add_parser(
"stats",
parents=[parent_parser],
description="Shows basic dataset stats",
"stats", parents=[parent_parser], description="Show basic dataset statistics."
)
dataset_stats_parser.add_argument("name", type=str, help="Dataset name")
dataset_stats_parser.add_argument(
Expand All @@ -349,15 +350,15 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
)

parse_ls = subp.add_parser(
"ls", parents=[parent_parser], description="List storage contents"
"ls", parents=[parent_parser], description="List storage contents."
)
add_sources_arg(parse_ls, nargs="*")
parse_ls.add_argument(
"-l",
"--long",
action="count",
default=0,
help="List files in the long format",
help="List files in long format",
)
parse_ls.add_argument(
"--studio",
Expand All @@ -383,11 +384,11 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
"--team",
action="store",
default=None,
help="The team to list datasets for. By default, it will use team from config.",
help="The team to list datasets for. By default, it will use team from config",
)

parse_du = subp.add_parser(
"du", parents=[parent_parser], description="Display space usage"
"du", parents=[parent_parser], description="Display space usage."
)
add_sources_arg(parse_du)
parse_du.add_argument(
Expand All @@ -405,8 +406,8 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
type=int,
metavar="N",
help=(
"Display sizes for N directory depths below the given directory, "
"the default is 0 (summarize provided directory only)."
"Display sizes up to N directory levels deep "
"(default: 0, summarize provided directory only)"
),
)
parse_du.add_argument(
Expand All @@ -417,40 +418,40 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
)

parse_find = subp.add_parser(
"find", parents=[parent_parser], description="Search in a directory hierarchy"
"find", parents=[parent_parser], description="Search in a directory hierarchy."
)
add_sources_arg(parse_find)
parse_find.add_argument(
"--name",
type=str,
action="append",
help="Filename to match pattern.",
help="Match filename pattern",
)
parse_find.add_argument(
"--iname",
type=str,
action="append",
help="Like -name but case insensitive.",
help="Match filename pattern (case insensitive)",
)
parse_find.add_argument(
"--path",
type=str,
action="append",
help="Path to match pattern.",
help="Path to match pattern",
)
parse_find.add_argument(
"--ipath",
type=str,
action="append",
help="Like -path but case insensitive.",
help="Like -path but case insensitive",
)
parse_find.add_argument(
"--size",
type=str,
help=(
"Filter by size (+ is greater or equal, - is less or equal). "
"Specified size is in bytes, or use a suffix like K, M, G for "
"kilobytes, megabytes, gigabytes, etc."
"kilobytes, megabytes, gigabytes, etc"
),
)
parse_find.add_argument(
Expand All @@ -470,14 +471,14 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
)

parse_index = subp.add_parser(
"index", parents=[parent_parser], description="Index storage location"
"index", parents=[parent_parser], description="Index storage location."
)
add_sources_arg(parse_index)

show_parser = subp.add_parser(
"show",
parents=[parent_parser],
description="Create a new dataset with a query script",
description="Create a new dataset with a query script.",
)
show_parser.add_argument("name", type=str, help="Dataset name")
show_parser.add_argument(
Expand All @@ -493,7 +494,7 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
query_parser = subp.add_parser(
"query",
parents=[parent_parser],
description="Create a new dataset with a query script",
description="Create a new dataset with a query script.",
)
query_parser.add_argument(
"script", metavar="<script.py>", type=str, help="Filepath for script"
Expand All @@ -507,7 +508,7 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
metavar="N",
help=(
"Use multiprocessing to run any query script UDFs with N worker processes. "
"N defaults to the CPU count."
"N defaults to the CPU count"
),
)
query_parser.add_argument(
Expand All @@ -520,10 +521,12 @@ def get_parser() -> ArgumentParser: # noqa: PLR0915
)

subp.add_parser(
"clear-cache", parents=[parent_parser], description="Clear the local file cache"
"clear-cache",
parents=[parent_parser],
description="Clear the local file cache.",
)
subp.add_parser(
"gc", parents=[parent_parser], description="Garbage collect temporary tables"
"gc", parents=[parent_parser], description="Garbage collect temporary tables."
)

subp.add_parser("internal-run-udf", parents=[parent_parser])
Expand All @@ -536,12 +539,12 @@ def add_completion_parser(subparsers, parents):
parser = subparsers.add_parser(
"completion",
parents=parents,
description="Output shell completion script",
description="Output shell completion script.",
)
parser.add_argument(
"-s",
"--shell",
help="Shell syntax for completions.",
help="Shell syntax for completions",
default="bash",
choices=shtab.SUPPORTED_SHELLS,
)
Loading
Loading