Accept --no-echo to turn off run.echo

Open
#1,000 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Reproduce the behavior with the tasks.py example and the shown inv commands, then trace the CLI option handling for run.echo and its config/environment precedence. Done means inv --no-echo print-echo-param is recognized and overrides an enabled run.echo setting without breaking the existing --echo behavior.

Written by the indexing model from the issue text.

Description

It may be useful to override run.echo parameter if it is set already in a config file/environment variable.

Consider tasks.py:

from invoke import task

@task
def print_echo_param(c):
    c.run(f"echo '{c.config.run.echo=}'")

Then:

$ inv print-echo-param
c.config.run.echo=False

$ inv --echo print-echo-param
echo 'c.config.run.echo=True'
c.config.run.echo=True

If there is export INVOKE_RUN_ECHO=1 then:

$ inv print-echo-param
echo 'c.config.run.echo=True'
c.config.run.echo=True

$ INVOKE_RUN_ECHO=0 inv print-echo-param
c.config.run.echo=False

It would be nice to provide --no-echo instead of INVOKE_RUN_ECHO=0 here.

The current version doesn't recognize --no-echo parameter:

inv --no-echo print-echo-param
No idea what '--no-echo' is!
Dominant language
Python
Stars
4.8k
Forks
412
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyinvoke/invoke

All issues in pyinvoke/invoke

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.