grass.pygrass.modules package — GRASS Python Library documentation

# grass.pygrass.modules package

## Subpackages

- grass.pygrass.modules.grid package
  - Submodules
  - grass.pygrass.modules.grid.grid module
    - `GridModule`
      - `GridModule.clean_location()`
      - `GridModule.define_mapset_inputs()`
      - `GridModule.estimate_tile_size()`
      - `GridModule.get_works()`
      - `GridModule.patch()`
      - `GridModule.rm_tiles()`
      - `GridModule.run()`
      - `GridModule.split()`
    - `cmd_exe()`
    - `copy_groups()`
    - `copy_mapset()`
    - `copy_rasters()`
    - `copy_special_mapset_files()`
    - `copy_vectors()`
    - `get_cmd()`
    - `get_mapset()`
    - `read_gisrc()`
    - `select()`
    - `set_region()`
  - grass.pygrass.modules.grid.patch module
    - `get_start_end_index()`
    - `rpatch_map()`
    - `rpatch_map_r_patch_backend()`
    - `rpatch_row()`
  - grass.pygrass.modules.grid.split module
    - `get_bbox()`
    - `get_overlap_region_tiles()`
    - `get_tile_start_end_row_col()`
    - `split_region_in_overlapping_tiles()`
    - `split_region_tiles()`
- grass.pygrass.modules.interface package
  - Submodules
  - grass.pygrass.modules.interface.docstring module
    - `DocstringProperty`
    - `docstring_property()`
  - grass.pygrass.modules.interface.env module
    - `G_debug()`
    - `get_debug_level()`
    - `get_env()`
  - grass.pygrass.modules.interface.flag module
    - `Flag`
      - `Flag.get_bash()`
      - `Flag.get_python()`
  - grass.pygrass.modules.interface.module module
    - `Module`
      - `Module.check()`
      - `Module.get_bash()`
      - `Module.get_dict()`
      - `Module.get_python()`
      - `Module.make_cmd()`
      - `Module.run()`
      - `Module.update()`
      - `Module.wait()`
    - `MultiModule`
      - `MultiModule.get_modules()`
      - `MultiModule.run()`
      - `MultiModule.wait()`
    - `ParallelModuleQueue`
      - `ParallelModuleQueue.get()`
      - `ParallelModuleQueue.get_finished_modules()`
      - `ParallelModuleQueue.get_max_num_procs()`
      - `ParallelModuleQueue.get_num_run_procs()`
      - `ParallelModuleQueue.put()`
      - `ParallelModuleQueue.set_max_num_procs()`
      - `ParallelModuleQueue.wait()`
    - `run_modules()`
    - `run_modules_in_temp_region()`
  - grass.pygrass.modules.interface.parameter module
    - `Parameter`
      - `Parameter.get_bash()`
      - `Parameter.get_python()`
      - `Parameter.rawvalue`
      - `Parameter.value`
  - grass.pygrass.modules.interface.read module
    - `do_nothing()`
    - `element2dict()`
    - `get_None()`
    - `get_dict()`
    - `get_values()`
    - `read_keydesc()`
    - `read_text()`
  - grass.pygrass.modules.interface.typedict module
    - `TypeDict`
      - `TypeDict.used()`

## Submodules

## grass.pygrass.modules.shortcuts module

class grass.pygrass.modules.shortcuts.MetaModule(prefix, cls=None)

  Bases: `object`

  Example how to use MetaModule

      >>> g = MetaModule('g')
      >>> g_list = g.list
      >>> g_list.name
      'g.list'
      >>> g_list.required
      ['type']
      >>> g_list.inputs.type = 'raster'
      >>> g_list.inputs.mapset = 'PERMANENT'
      >>> g_list.stdout_ = -1
      >>> g_list.run()
      Module('g.list')
      >>> g_list.outputs.stdout
      '...basin...elevation...'

      >>> r = MetaModule('r')
      >>> what = r.what
      >>> what.description
      'Queries raster maps on their category values and category labels.'
      >>> what.inputs.map = 'elevation'
      >>> what.inputs.coordinates = [640000,220500]
      >>> what.run()
      >>> v = MetaModule('v')
      >>> v.import
      Traceback (most recent call last):
        File ".../doctest.py", line 1315, in __run
         compileflags, 1) in test.globs
        File "<doctest grass.pygrass.modules.shortcuts.MetaModule[16]>", line 1
         v.import
              ^
      SyntaxError: invalid syntax
      >>> v.import_
      Module('v.import')

Help Index | Topics Index | Keywords Index | Full Index

© 2003-2026 GRASS Development Team, GRASS GIS 8.4.3dev Reference Manual