cmdline.py

Helper functions to run Bladerunner from the command line with argparse.

This file is part of Bladerunner.

Copyright (c) 2014, Activision Publishing, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Activision Publishing, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

bladerunner.cmdline.argparse_unlisted(settings)

Argparse likes to nest everything in lists. This undoes that.

bladerunner.cmdline.cmdline_entry()

argparse’s main entry point, performs logic and preformatting.

bladerunner.cmdline.cmdline_exit(results, options)

A buffer for selecting the correct output function and exiting.

Args:

results: the results dictionary from Bladerunner.run
options: the options dictionary, uses 'style' and 'stacked' keys

bladerunner.cmdline.convert_to_options(settings)

Converts argparse’s namespace into a dictionary. Removes temp keys.

bladerunner.cmdline.get_commands(settings)

Opens the command file from the settings namespace.

Args:

settings: the argparse namespace from the cmdline

Returns:

tuple of (commands list, settings namespace)

bladerunner.cmdline.get_passwords(settings)

Prompt and sets all passwords.

bladerunner.cmdline.get_servers(settings)

Checks to see if a file has been passed as a list of servers.

bladerunner.cmdline.get_version()

Returns the version of Bladerunner and the python it’s running on.

bladerunner.cmdline.main()

Main run loop, except KeyboardInterrupts.

bladerunner.cmdline.print_help()

Overrides argparses’s –help, prints usage only.

bladerunner.cmdline.setup_argparse(args)

Sets up the parser’s arguments.

bladerunner.cmdline.setup_output_file(options)

Make sure we can write to the output file if that’s being used.

Args:

options: original Bladerunner options dictionary

Returns:

None, raises SystemExit if the output_file cannot be written