Skip to content

feat: deprecate setup flag #1212

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

Merged
merged 1 commit into from
Oct 23, 2025
Merged

feat: deprecate setup flag #1212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/docs/core/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ cocoindex server [OPTIONS] APP_TARGET
| `-ci, --cors-cocoindex` | Allow `https://cocoindex.io` to access the server. |
| `-cl, --cors-local INTEGER` | Allow `http://localhost:<port>` to access the server. |
| `-L, --live-update` | Continuously watch changes from data sources and apply to the target index. |
| `--setup` | Automatically setup backends for the flow if it's not setup yet. |
| `--setup` | (DEPRECATED) Automatically setup backends for the flow if it's not setup yet. This is now the default behavior. [default: True] |
| `--reset` | Drop existing setup before starting server (equivalent to running 'cocoindex drop' first). `--reset` implies `--setup`. |
| `--reexport` | Reexport to targets even if there's no change. |
| `-f, --force` | Force setup without confirmation prompts. |
Expand Down Expand Up @@ -194,7 +194,7 @@ cocoindex update [OPTIONS] APP_FLOW_SPECIFIER
|--------|-------------|
| `-L, --live` | Continuously watch changes from data sources and apply to the target index. |
| `--reexport` | Reexport to targets even if there's no change. |
| `--setup` | Automatically setup backends for the flow if it's not setup yet. |
| `--setup` | (DEPRECATED) Automatically setup backends for the flow if it's not setup yet. This is now the default behavior. [default: True] |
| `--reset` | Drop existing setup before updating (equivalent to running 'cocoindex drop' first). `--reset` implies `--setup`. |
| `-f, --force` | Force setup without confirmation prompts. |
| `-q, --quiet` | Avoid printing anything to the standard output, e.g. statistics. |
Expand Down
27 changes: 23 additions & 4 deletions python/cocoindex/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,23 @@ def _drop_flows(flows: Iterable[flow.Flow], app_ref: str, force: bool = False) -
setup_bundle.apply(report_to_stdout=True)


def _deprecate_setup_flag(
ctx: click.Context, param: click.Parameter, value: bool
) -> bool:
"""Callback to warn users that --setup flag is deprecated."""
# Check if the parameter was explicitly provided by the user
if param.name is not None:
param_source = ctx.get_parameter_source(param.name)
if param_source == click.core.ParameterSource.COMMANDLINE:
click.secho(
"Warning: The --setup flag is deprecated and will be removed in a future version. "
"Setup is now always enabled by default.",
fg="yellow",
err=True,
)
return value


def _setup_flows(
flow_iter: Iterable[flow.Flow],
*,
Expand Down Expand Up @@ -392,8 +409,9 @@ def drop(app_target: str | None, flow_name: tuple[str, ...], force: bool) -> Non
"--setup",
is_flag=True,
show_default=True,
default=False,
help="Automatically setup backends for the flow if it's not setup yet.",
default=True,
callback=_deprecate_setup_flag,
help="(DEPRECATED) Automatically setup backends for the flow if it's not setup yet. This is now the default behavior.",
)
@click.option(
"--reset",
Expand Down Expand Up @@ -553,8 +571,9 @@ def evaluate(
"--setup",
is_flag=True,
show_default=True,
default=False,
help="Automatically setup backends for the flow if it's not setup yet.",
default=True,
callback=_deprecate_setup_flag,
help="(DEPRECATED) Automatically setup backends for the flow if it's not setup yet. This is now the default behavior.",
)
@click.option(
"--reset",
Expand Down
Loading