core.py File Reference

Go to the source code of this file.

Data Structures
class	python.core.Popen
class	python.core.ScriptError
class	python.core.KeyValue
Namespaces
namespace	python.core
namespace	grass.script.core
	GRASS Python scripting module (core functions)
Functions
def	python.core.call
def	python.core.decode
def	python.core.make_command
	Return a list of strings suitable for use as the args parameter to Popen() or call().
def	python.core.start_command
	Returns a Popen object with the command created by make_command.
def	python.core.run_command
	Passes all arguments to start_command(), then waits for the process to complete, returning its exit code.
def	python.core.pipe_command
	Passes all arguments to start_command(), but also adds "stdout = PIPE".
def	python.core.feed_command
	Passes all arguments to start_command(), but also adds "stdin = PIPE".
def	python.core.read_command
	Passes all arguments to pipe_command, then waits for the process to complete, returning its stdout (i.e.
def	python.core.parse_command
	Passes all arguments to read_command, then parses the output by parse_key_val().
def	python.core.write_command
	Passes all arguments to feed_command, with the string specified by the 'stdin' argument fed to the process' stdin.
def	python.core.exec_command
	Interface to os.execvpe(), but with the make_command() interface.
def	python.core.message
	Display a message using g.message
def	python.core.debug
	Display a debugging message using g.message -d
def	python.core.verbose
	Display a verbose message using g.message -v
def	python.core.info
	Display an informational message using g.message -i
def	python.core.percent
	Display a progress info message using g.message -p
def	python.core.warning
	Display a warning message using g.message -w
def	python.core.error
	Display an error message using g.message -e
def	python.core.fatal
	Display an error message using g.message -e, then abort.
def	python.core.set_raise_on_error
	Define behaviour on error (error() called)
def	python.core.parser
	Interface to g.parser, intended to be run from the top-level, e.g.
def	python.core.tempfile
	Returns the name of a temporary file, created with g.tempfile.
def	python.core.tempdir
	Returns the name of a temporary dir, created with g.tempfile.
def	python.core.parse_key_val
	Parse a string into a dictionary, where entries are separated by newlines and the key and value are separated by `sep' (default: `=')
def	python.core.gisenv
	Returns the output from running g.gisenv (with no arguments), as a dictionary.
def	python.core.region
	Returns the output from running "g.region -g", as a dictionary.
def	python.core.region_env
	Returns region settings as a string which can used as GRASS_REGION environmental variable.
def	python.core.use_temp_region
	Copies the current region to a temporary region with "g.region save=", then sets WIND_OVERRIDE to refer to that region.
def	python.core.del_temp_region
	Unsets WIND_OVERRIDE and removes any region named by it.
def	python.core.find_file
	Returns the output from running g.findfile as a dictionary.
def	python.core.list_grouped
	List elements grouped by mapsets.
def	python.core.list_pairs
	List of elements as tuples.
def	python.core.list_strings
	List of elements as strings.
def	python.core.mlist_strings
	List of elements as strings.
def	python.core.mlist_pairs
	List of elements as pairs.
def	python.core.mlist_grouped
	List of elements grouped by mapsets.
def	python.core.parse_color
	Parses the string "val" as a GRASS colour, which can be either one of the named colours or an R:G:B tuple e.g.
def	python.core.overwrite
	Return True if existing files may be overwritten.
def	python.core.verbosity
	Return the verbosity level selected by GRASS_VERBOSE.
def	python.core.basename
	various utilities, not specific to GRASS
def	python.core.find_program
	Attempt to run a program, with optional arguments.
def	python.core.try_remove
	Attempt to remove a file; no exception is generated if the attempt fails.
def	python.core.try_rmdir
	Attempt to remove a directory; no exception is generated if the attempt fails.
def	python.core.float_or_dms
	Convert DMS to float.
def	python.core.mapsets
	List available mapsets.
def	python.core.create_location
	Create new location.
def	python.core.version
	Get GRASS version as dictionary.
Variables
	python.core.PIPE = subprocess.PIPE
	python.core.STDOUT = subprocess.STDOUT
	python.core.raise_on_error = False
int	python.core.debug_level = 0
list	python.core._popen_args
dictionary	python.core.named_colors