How does Python Click library handle options that are flags and True by default?
2
I just stumbled upon a piece of code that defines a click option as such:
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
Does this means that the status is True, unless the -s is supplied, in which case it will become False?
python python-click
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
asked Dec 28 '18 at 10:54
SaboSabo
83111019
add a comment |
2
I just stumbled upon a piece of code that defines a click option as such:
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
Does this means that the status is True, unless the -s is supplied, in which case it will become False?
python python-click
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
asked Dec 28 '18 at 10:54
SaboSabo
83111019
add a comment |
2
2
2
I just stumbled upon a piece of code that defines a click option as such:
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
Does this means that the status is True, unless the -s is supplied, in which case it will become False?
python python-click
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
asked Dec 28 '18 at 10:54
SaboSabo
83111019
I just stumbled upon a piece of code that defines a click option as such:
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
Does this means that the status is True, unless the -s is supplied, in which case it will become False?
python python-click
python python-click
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
asked Dec 28 '18 at 10:54
SaboSabo
83111019
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
asked Dec 28 '18 at 10:54
SaboSabo
83111019
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
edited Dec 28 '18 at 15:34
Stephen Rauch
28k153356
28k153356
asked Dec 28 '18 at 10:54
SaboSabo
83111019
asked Dec 28 '18 at 10:54
SaboSabo
83111019
asked Dec 28 '18 at 10:54
SaboSabo
83111019
83111019
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
2
For options that are both a flag and defaulted to True, specifying the option on the command line will set that option to False; while not specifying will give the default True.
Test Code:
import click
@click.command()
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
def main(status):
click.echo('status: {}'.format(status))
if __name__ == "__main__":
commands = (
'',
'-s',
'--status',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for command in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + command)
time.sleep(0.1)
main(command.split())
except BaseException as exc:
if str(exc) != '0' and
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Results:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
>
status: True
-----------
> -s
status: False
-----------
> --status
status: False
-----------
> --help
Usage: test.py [OPTIONS]
Options:
-s, --status Show status
--help Show this message and exit.
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
draft saved
draft discarded
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53957389%2fhow-does-python-click-library-handle-options-that-are-flags-and-true-by-default%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
2
For options that are both a flag and defaulted to True, specifying the option on the command line will set that option to False; while not specifying will give the default True.
Test Code:
import click
@click.command()
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
def main(status):
click.echo('status: {}'.format(status))
if __name__ == "__main__":
commands = (
'',
'-s',
'--status',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for command in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + command)
time.sleep(0.1)
main(command.split())
except BaseException as exc:
if str(exc) != '0' and
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Results:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
>
status: True
-----------
> -s
status: False
-----------
> --status
status: False
-----------
> --help
Usage: test.py [OPTIONS]
Options:
-s, --status Show status
--help Show this message and exit.
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
add a comment |
2
For options that are both a flag and defaulted to True, specifying the option on the command line will set that option to False; while not specifying will give the default True.
Test Code:
import click
@click.command()
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
def main(status):
click.echo('status: {}'.format(status))
if __name__ == "__main__":
commands = (
'',
'-s',
'--status',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for command in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + command)
time.sleep(0.1)
main(command.split())
except BaseException as exc:
if str(exc) != '0' and
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Results:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
>
status: True
-----------
> -s
status: False
-----------
> --status
status: False
-----------
> --help
Usage: test.py [OPTIONS]
Options:
-s, --status Show status
--help Show this message and exit.
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
add a comment |
2
2
2
For options that are both a flag and defaulted to True, specifying the option on the command line will set that option to False; while not specifying will give the default True.
Test Code:
import click
@click.command()
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
def main(status):
click.echo('status: {}'.format(status))
if __name__ == "__main__":
commands = (
'',
'-s',
'--status',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for command in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + command)
time.sleep(0.1)
main(command.split())
except BaseException as exc:
if str(exc) != '0' and
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Results:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
>
status: True
-----------
> -s
status: False
-----------
> --status
status: False
-----------
> --help
Usage: test.py [OPTIONS]
Options:
-s, --status Show status
--help Show this message and exit.
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
For options that are both a flag and defaulted to True, specifying the option on the command line will set that option to False; while not specifying will give the default True.
Test Code:
import click
@click.command()
@click.option(
"-s",
"--status",
default=True,
is_flag=True,
help="Show status",
)
def main(status):
click.echo('status: {}'.format(status))
if __name__ == "__main__":
commands = (
'',
'-s',
'--status',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for command in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + command)
time.sleep(0.1)
main(command.split())
except BaseException as exc:
if str(exc) != '0' and
not isinstance(exc, (click.ClickException, SystemExit)):
raise
Results:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
>
status: True
-----------
> -s
status: False
-----------
> --status
status: False
-----------
> --help
Usage: test.py [OPTIONS]
Options:
-s, --status Show status
--help Show this message and exit.
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
answered Dec 28 '18 at 15:33
Stephen RauchStephen Rauch
28k153356
28k153356
add a comment |
add a comment |
draft saved
draft discarded
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
draft saved
draft discarded
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53957389%2fhow-does-python-click-library-handle-options-that-are-flags-and-true-by-default%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
