1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
/*! \page pythonlib GRASS Python Scripting Library
by GRASS Development Team (http://grass.osgeo.org)
\section pythonIntro Introduction
The code in <a
href="http://svn.osgeo.org/grass/grass/branches/develbranch_6/lib/python/">lib/python/</a>
provides <b>grass.script</b> in order to support GRASS scripts written
in Python. The <a
href="http://svn.osgeo.org/grass/grass/trunk/scripts">scripts/</a>
directory of GRASS 7 contains a series of examples actually provided
to the end users.
See code in:
- python::core
- python::db
- python::raster
- python::vector
- python::setup
- python::array
<b>Table of content</b>
- \subpage pythonScripting
- \subpage pythonModules
- \subpage pythonCore
- \subpage pythonDb
- \subpage pythonRaster
- \subpage pythonVector
- \subpage pythonSetup
- \subpage pythonArray
\section pythonScripting GRASS scripting tasks for Python provided by "grass.script"
The statement
\code
import grass.script as grass
\endcode
imports core.py, db.py, raster.py and vector.py modules.
To import only selected module
\code
from grass.script import core as grass
\endcode
Sample script (See the GRASS Wiki at
<a href="http://grass.osgeo.org/wiki/GRASS_and_Python">http://grass.osgeo.org/wiki/GRASS_and_Python</a> for more examples)
\code
#!/usr/bin/env python
#%module
#% description: Checks if vector map is 3D
#% keywords: vector
#%end
#%option
#% key: map
#% type: string
#% gisprompt: old,vector,vector
#% key_desc: name
#% description: Name of vector map
#% required: yes
#%end
import sys
import grass.script as grass
def main():
info = grass.parse_command('v.info',
flags = 't',
map = options['map'])
if info['map3d'] == '1':
print 'Vector map is 3D'
else:
print 'Vector map is 2D'
return 0
if __name__ == "__main__":
options, flags = grass.parser()
sys.exit(main())
\endcode
\section pythonModules List of modules
\subsection pythonCore Core
<b>GRASS-oriented interface to subprocess module</b>
- python::core::exec_command()
- python::core::feed_command()
- python::core::make_command()
- python::core::parse_command()
- python::core::pipe_command()
- python::core::read_command()
- python::core::run_command()
- python::core::start_command()
- python::core::write_command()
<b>Interface to g.message</b>
These all run g.message, differing only in which flag (if any) is
used. fatal() is error(), but also calls sys.exit(1).
- python::core::debug()
- python::core::error()
- python::core::fatal()
- python::core::info()
- python::core::message()
- python::core::verbose()
- python::core::warning()
<b>Interface to g.parser</b>
Interface to g.parser, intended to be run from the top-level, e.g.
\code
if __name__ == "__main__":
options, flags = grass.parser()
main()
\endcode
- python::core::parser()
<b>Interface to g.tempfile</b>
Returns the name of a temporary file, created with g.tempfile.
- python::core::tempfile()
<b>Key-value parsers</b>
- python::core::parse_key_val()
<b>Interface to g.gisenv</b>
- python::core::gisenv()
<b>Interface to g.region</b>
- python::core::del_temp_region()
- python::core::region()
- python::core::region_env()
- python::core::use_temp_region()
<b>Interface to g.findfile</b>
- python::core::find_file()
<b>Interface to g.list</b>
- python::core::list_grouped()
- python::core::list_pairs()
- python::core::list_strings()
- python::core::mlist_grouped()
<b>Interface to g.mapsets</b>
- python::core::mapsets()
<b>Interface to g.version</b>
- python::core::version()
<b>Color parsing</b>
- python::core::parse_color()
<b>Check GRASS environment variables</b>
- python::core::overwrite()
- python::core::verbosity()
<b>Create new GRASS location</b>
- python::core::create_location()
<b>Various utilities, not specific to GRASS</b>
- python::core::basename()
- python::core::find_program()
- python::core::try_remove()
- python::core::try_rmdir()
- python::core::float_or_dms()
\section pythonDb Database
Interface for <tt>db.*</tt> modules.
\code
from grass.script import db as grass
\endcode
- python::db::db_connection()
- python::db::db_describe()
- python::db::db_select()
\section pythonRaster Raster
Interface for <tt>r.*</tt> modules.
\code
from grass.script import raster as grass
\endcode
- python::raster::raster_history()
- python::raster::raster_info()
- python::raster::mapcalc()
\section pythonVector Vector
Interface for <tt>v.*</tt> modules.
\code
from grass.script import vector as grass
\endcode
- python::vector::vector_columns()
- python::vector::vector_db()
- python::vector::vector_db_select()
- python::vector::vector_history()
- python::vector::vector_info_topo()
- python::vector::vector_layer_db()
\section pythonSetup Setup
\code
from grass.script import setup as gsetup
\endcode
- python::setup::init()
\section pythonArray Array
\code
from grass.script import array as garray
\endcode
- python::array::array
\section pythonAuthors Authors
Glynn Clements
Martin Landa <landa.martin gmail.com>
*/
|