Skip to main content

Show and print the content of argparse.Namespace (args) objects for debugging.

Project description

Print a nicely formatted view of an argparse.Namespace object for debugging purposes:

import sys
import argparse
import printargs

def main(args):
    printargs.show(args)
    # do somthing with args

def get_argument_parser():
    p = argparse.ArgumentParser()
    p.add_argument('-f', '--foo', action='store')
    p.add_argument('-b', '--bar', action='store', type=int)
    p.add_argument('-o', '--output', action='store', default=sys.stdout)
    return p

if __name__ == "__main__":
    argument_parser = get_argument_parser()
    args = argument_parser.parse_args()
    main(args)

To use the output for logging or to edit it use the printargs.formatted function, which returns the string instead of printing it:

import sys
import argparse
import printargs

def main(args):
    t = printargs.formatted(args)
    with open('log', 'a') as logfile:
        logfile.write("Test program called with parameters:")
        logfile.write(t)
        logfile.write("\n\n")


def get_argument_parser():
    p = argparse.ArgumentParser()
    p.add_argument('-f', '--foo', action='store')
    p.add_argument('-b', '--bar', action='store', type=int)
    p.add_argument('-o', '--output', action='store', default=sys.stdout)
    return p

if __name__ == "__main__":
    argument_parser = get_argument_parser()
    args = argument_parser.parse_args()
    main(args)

Installation

Printargs can be installed with pip:

me@machine:~$ pip install printargs

or from the sources:

me@machine:~$ git clone https://HenningTimm@bitbucket.org/HenningTimm/printargs.git
me@machine:~$ cd printargs
me@machine:~/printargs$ python setup.py install

Planned features

  • curses based output with colors

License

Printargs is Open Source and licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
printargs-1.0.1.tar.gz (3.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page