Note

Go to the end to download the full example code. or to run this example in your browser via Binder

# Using `sys.argv` in examples

This example demonstrates the use of `sys.argv` in example `.py` files.

By default, all example `.py` files will be run by Sphinx-Gallery without any arguments. Notice below that `sys.argv` is a list consisting of only the file name. Further, any arguments added will take on the default value.

This behavior can be changed by using the reset_argv option in the sphinx configuration, see Passing command line arguments to example scripts.

    sys.argv: ['plot_7_sys_argv.py']
    parsed args: Namespace(option='default')

    import argparse
    import sys

    parser = argparse.ArgumentParser(description="Toy parser")
    parser.add_argument("--option", default="default", help="a dummy optional argument")
    sys.argv[0] = sys.argv[0].split("/")[-1]
    print("sys.argv:", sys.argv)
    print("parsed args:", parser.parse_args())

Gallery generated by Sphinx-Gallery