Addon:Python Shell Gramplet

From Gramps
Revision as of 21:26, 2 January 2018 by Jsherring (talk | contribs) (Added example for accessing a Gramplet object in Gramps4)
Jump to: navigation, search

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager

Python Gramplet - Interactive shell example output

The Python Gramplet brings up an interactive Python Shell for interpreting python expressions.


You can type most any (single line) Python expression.

In addition, the environment has been populated with some useful variables, including

  • self - (this Python gramplet)
  • Date - a date object constructor, that can be used for date arithmetic.
  • db - Interact with the Database
  • dbstate - Information about the Database
  • gc - the Python "garbage collector" preloaded with the same flags as the Debug Tool.
  • uistate - Interact with the GUI

When the Python Gramplet is detached you can use select Help to see this page.


The Date entry is a date object constructor, and can be used for date arithmetic. For example, you might be interested in questions like:

What was the date 56 years before a given date:

> Date(2007, 12, 31) - 56

How old was someone on Sept 3, 1955 who was born on June 7, 1922:

> Date(1955, 9, 3) - Date(1922, 5, 7) 33 years, 3 months

When did they turn 21 years old?

> Date(1922, 5, 7) + 21

You can also add years, months, and days:

> Date(1980) + (0, 0, 25)

You can convert one date into another calendar, which returns a new date object:

> Date(1703, 6, 1).to_calendar("hebrew")
5463-10-17 (Hebrew)


Another use for this Gramplet is for debugging. This gramplet makes a nice interface to the running Gramps system. You can inspect, and alter the system by entering Python commands. As a simple example, you can:

> self.clear_text()     # clear the text in this window
> self.set_wrap(False)  # turn word wrap off
> self.set_wrap(True)   # turn word wrap on

The Python Gramplet also has the Python "garbage collector" preloaded with the same flags as the Debug Tool. To use:

> gc.collect()
> gc.garbage[0]
<cell at 0x9f9089c: function object at 0x9f89dbc>
> gc.get_referents(self)
> gc.get_referrers(self)

Please update or expand this section.

You can use the Python Shell to interact with people from your database and test Gramps functions:

Gramps 3.x
 > person = db.get_person_from_gramps_id("I01284")
 > from Utils import probably_alive
 > probably_alive(person, db, Date(1776, 7, 4))
Gramps 4.x
 > person = db.get_person_from_gramps_id("I01284")
 > from gen.utils.alive import probably_alive
 > probably_alive(person, db, Date(1776, 7, 4))

You can also interact with the GUI:

This following returns the Gtk Frame of the first Gramplet in the first column.

Gramps 3.x
 > uistate.viewmanager.pages
 [<DataViews.GrampletView.GrampletView instance at 0xa0bd0ac>, 
  <DataViews.PersonView.PersonView instance at 0xa8f542c>, 
  <DataViews.RelationView.RelationshipView instance at 0xa8f562c>, 
  <DataViews.FamilyList.FamilyListView instance at 0xa8f5f8c>, 
  <DataViews.PedigreeView.PedigreeView instance at 0xa8fc5cc>, 
  <DataViews.EventView.EventView instance at 0xa8fc88c>, 
  <DataViews.SourceView.SourceView instance at 0xa8fcdcc>, 
  <DataViews.PlaceView.PlaceView instance at 0xa9070ec>, 
  <DataViews.MediaView.MediaView instance at 0xa9074ac>, 
  <DataViews.RepositoryView.RepositoryView instance at 0xa9077ac>, 
  <DataViews.NoteView.NoteView instance at 0xa907d8c>, 
  <DataViews.GeoView.GeoView instance at 0xa90d0cc>]
 > uistate.viewmanager.pages[0]
 <DataViews.GrampletView.GrampletView instance at 0xa0bd0ac>
 > uistate.viewmanager.pages[0].columns[0].get_children()[0].get_children()[0]
Gramps 4.x

This following returns a reference to a loaded Gramplet object on the Event view - useful when developing Gramplets. Note that the Events view must be navigated first, as main views are lazy loading in Gramps 4.

Gramps 4.x
> evtview = uistate.viewmanager.pages[uistate.viewmanager.page_lookup.get((5,0))]
> # list all TabGramplet objects loaded for Events view
> [child.get_title() for child in evtview.bottombar.get_children()]
['Gallery', 'Citations', 'Notes', 'Attributes', 'References', 'Event PlaceTitle Compare Gramplet']
> get a reference to my custom Gramplet object
> eptcGramplet = evtview.bottombar.get_children()[5].pui