Using sys.argv in examples¶

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

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.

Out:

sys.argv: ['/build/sphinx-gallery-xOFXyJ/sphinx-gallery-0.6.2/examples/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')
print('sys.argv:', sys.argv)
print('parsed args:', parser.parse_args())

Estimated memory usage: 9 MB

Gallery generated by Sphinx-Gallery