utilities.py File Reference

Main module of project-independent BASIS utilities. More...

Go to the source code of this file.

Classes
class	basis::utilities::SubprocessError
	Exception thrown when command execution failed. More...
Namespaces
namespace	basis::utilities
Functions
def	basis::utilities::execute
	Execute command as subprocess.
def	basis::utilities::exedir
	Get directory of executable file.
def	basis::utilities::exename
	Get name of executable file.
def	basis::utilities::exepath
	Get absolute path of executable file.
def	basis::utilities::istarget
	Determine whether a given build target is known.
def	basis::utilities::print_contact
	Print contact information.
def	basis::utilities::print_version
	Print version information including copyright and license notices.
def	basis::utilities::qsplit
	Split quoted string of arguments.
def	basis::utilities::targetuid
	Get UID of build target.
def	basis::utilities::tostring
	Convert array of arguments to quoted string.
Variables
list	basis::utilities::__all__ = []
tuple	basis::utilities::_MODULE_DIR = os.path.dirname(os.path.realpath(__file__))
string	basis::utilities::CONTACT = "SBIA Group <sbia-software at uphs.upenn.edu>"
	Default contact to use for help output of executables.
string	basis::utilities::COPYRIGHT = "2011, 2012, 2013 University of Pennsylvania"
	Default copyright of executables.
string	basis::utilities::LICENSE = "See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file."
	Default license of executables.

---

Detailed Description

Main module of project-independent BASIS utilities.

This module defines the BASIS Utilities whose implementations are not project-specific, i.e., do not make use of particular project attributes such as the name or version of the project. The utility functions defined by this module are intended for use in Python scripts and modules that are not build as part of a particular BASIS project. Otherwise, the project-specific implementations should be used instead, i.e., those defined by the basis.py module of the project. The basis.py module and the submodules imported by it are generated from template modules which are customized for the particular project that is being build.

Copyright (c) 2011, 2012 University of Pennsylvania. All rights reserved.
See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.

Contact: SBIA Group <sbia-software at uphs.upenn.edu>

Definition in file utilities.py.