GRASS Programmer's Manual  6.4.4(2014)-r
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

 python.core
 
 grass.script.core
 GRASS Python scripting module (core functions)
 

Functions

def python.core.call (args, kwargs)
 
def python.core.decode (string)
 
def python.core.make_command (prog, flags="", overwrite=False, quiet=False, verbose=False, options)
 Return a list of strings suitable for use as the args parameter to Popen() or call(). More...
 
def python.core.start_command (prog, flags="", overwrite=False, quiet=False, verbose=False, kwargs)
 Returns a Popen object with the command created by make_command. More...
 
def python.core.run_command (args, kwargs)
 Passes all arguments to start_command(), then waits for the process to complete, returning its exit code. More...
 
def python.core.pipe_command (args, kwargs)
 Passes all arguments to start_command(), but also adds "stdout = PIPE". More...
 
def python.core.feed_command (args, kwargs)
 Passes all arguments to start_command(), but also adds "stdin = PIPE". More...
 
def python.core.read_command (args, kwargs)
 Passes all arguments to pipe_command, then waits for the process to complete, returning its stdout (i.e. More...
 
def python.core.parse_command (args, kwargs)
 Passes all arguments to read_command, then parses the output by parse_key_val(). More...
 
def python.core.write_command (args, kwargs)
 Passes all arguments to feed_command, with the string specified by the 'stdin' argument fed to the process' stdin. More...
 
def python.core.exec_command (prog, flags="", overwrite=False, quiet=False, verbose=False, env=None, kwargs)
 Interface to os.execvpe(), but with the make_command() interface. More...
 
def python.core.message
 Display a message using g.message More...
 
def python.core.debug
 Display a debugging message using g.message -d More...
 
def python.core.verbose (msg)
 Display a verbose message using g.message -v More...
 
def python.core.info (msg)
 Display an informational message using g.message -i More...
 
def python.core.percent (i, n, s)
 Display a progress info message using g.message -p More...
 
def python.core.warning (msg)
 Display a warning message using g.message -w More...
 
def python.core.error (msg)
 Display an error message using g.message -e More...
 
def python.core.fatal (msg)
 Display an error message using g.message -e, then abort. More...
 
def python.core.set_raise_on_error
 Define behaviour on error (error() called) More...
 
def python.core.parser ()
 Interface to g.parser, intended to be run from the top-level, e.g. More...
 
def python.core.tempfile ()
 Returns the name of a temporary file, created with g.tempfile. More...
 
def python.core.tempdir ()
 Returns the name of a temporary dir, created with g.tempfile. More...
 
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: `=') More...
 
def python.core.gisenv ()
 Returns the output from running g.gisenv (with no arguments), as a dictionary. More...
 
def python.core.locn_is_latlong ()
 Tests if location is lat/long. More...
 
def python.core.region
 Returns the output from running "g.region -g", as a dictionary. More...
 
def python.core.region_env (region3d=False, kwargs)
 Returns region settings as a string which can used as GRASS_REGION environmental variable. More...
 
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. More...
 
def python.core.del_temp_region ()
 Unsets WIND_OVERRIDE and removes any region named by it. More...
 
def python.core.find_file
 Returns the output from running g.findfile as a dictionary. More...
 
def python.core.list_grouped
 List elements grouped by mapsets. More...
 
def python.core.list_pairs (type)
 List of elements as tuples. More...
 
def python.core.list_strings (type)
 List of elements as strings. More...
 
def python.core.mlist_strings
 List of elements as strings. More...
 
def python.core.mlist_pairs
 List of elements as pairs. More...
 
def python.core.mlist_grouped
 List of elements grouped by mapsets. More...
 
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. More...
 
def python.core.overwrite ()
 Return True if existing files may be overwritten. More...
 
def python.core.verbosity ()
 Return the verbosity level selected by GRASS_VERBOSE. More...
 
def python.core.basename
 various utilities, not specific to GRASS More...
 
def python.core.find_program
 Attempt to run a program, with optional arguments. More...
 
def python.core.try_remove (path)
 Attempt to remove a file; no exception is generated if the attempt fails. More...
 
def python.core.try_rmdir (path)
 Attempt to remove a directory; no exception is generated if the attempt fails. More...
 
def python.core.float_or_dms (s)
 Convert DMS to float. More...
 
def python.core.mapsets
 List available mapsets. More...
 
def python.core.create_location
 Create new location. More...
 
def python.core.version ()
 Get GRASS version as dictionary. More...
 
def python.core.legal_name (s)
 Checks if the string contains only allowed characters. More...
 

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