pygrass_messages.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. PyGRASS message interface
  2. =========================
  3. The PyGRASS message interface is a fast and exit-safe
  4. interface to the `GRASS C-library message functions <http://grass.osgeo.org/programming7/gis_2error_8c.html>`_.
  5. This class implements a fast and exit-safe interface to the GRASS
  6. C-library message functions like: G_message(), G_warning(),
  7. G_important_message(), G_verbose_message(), G_percent() and G_debug().
  8. Usage:
  9. >>> msgr = Messenger()
  10. >>> msgr.debug(0, "debug 0")
  11. >>> msgr.verbose("verbose message")
  12. >>> msgr.message("message")
  13. >>> msgr.important("important message")
  14. >>> msgr.percent(1, 1, 1)
  15. >>> msgr.warning("Ohh")
  16. >>> msgr.error("Ohh no")
  17. >>> msgr = Messenger()
  18. >>> msgr.fatal("Ohh no no no!")
  19. Traceback (most recent call last):
  20. File "__init__.py", line 239, in fatal
  21. sys.exit(1)
  22. SystemExit: 1
  23. >>> msgr = Messenger(raise_on_error=True)
  24. >>> msgr.fatal("Ohh no no no!")
  25. Traceback (most recent call last):
  26. File "__init__.py", line 241, in fatal
  27. raise FatalError(message)
  28. FatalError: Ohh no no no!
  29. >>> msgr = Messenger(raise_on_error=True)
  30. >>> msgr.set_raise_on_error(False)
  31. >>> msgr.fatal("Ohh no no no!")
  32. Traceback (most recent call last):
  33. File "__init__.py", line 239, in fatal
  34. sys.exit(1)
  35. SystemExit: 1
  36. >>> msgr = Messenger(raise_on_error=False)
  37. >>> msgr.set_raise_on_error(True)
  38. >>> msgr.fatal("Ohh no no no!")
  39. Traceback (most recent call last):
  40. File "__init__.py", line 241, in fatal
  41. raise FatalError(message)
  42. FatalError: Ohh no no no!