Only some Tools warn

Is there “bailout” code that could be added as a “Useful snippet” in the Gramps API sphinx docs? There are some tools that make en masse changes to a tree without warning. If there was a standard snippet, more tools might support the standard where having “ellipsis” meant a dialog.

Example: The SyncAssociations addon tool performs changes on the tree with not bailout option. The Tools → Database Processing → Check and Repair warns:

Note Cleanup tool:

Possible the Warnings tab of Preferences could have an option to suppress the “Tree will be changed” warning? And that option might also suppress the ellipsis in the Tools menu. And add a warning to the Tools dialog.

There is a BatchTool class which is a subclass of the Tool class. It should be used for all tools that make batch changes that cannot be undone.

Would it make sense to add a Warnings preference for suppressing the warnings of the BatchTool class?


Such an override would defuse any objections about ‘extra steps’ for power users.

Also, perhaps it would also be good to have a Backup button to the far left of the Proceed with the tool and Stop buttons. This could allow a user to trigger a backup without exiting the dialog, then return the workflow of using the tool… without any backtracking.

Feature request filed: 0013070: extend the BatchTool class features - Gramps - Bugtracker – Free Genealogy Software

Or a Backup and proceed button

Here’s a list of the Tools that do batch changes to the Tree without benefit of the BatchTool class’ warning or an options dialog:

  • Isotammi
    • Generate source citations from notes…
    • SuperTool… when “Commit changes” selected
  • Family Tree Processing
    • Sync Associations… resolved in PR 580
  • Family Tree Repair
    • Rebuild Gender Statistics…
    • Rebuild Reference Maps…
  • Utilities
    • Thumbnail Generator…

On the flipside, these tool give that BatchTool class warning but have configuration dialogs. So the warning adds to the aggravating sense of recursive dialogs:

  • Family Tree Processing
    • Add/Remove Tag tool…
    • Attach Source…
    • Avatar Generator Tool…
    • Calculate Estimated Dates…
    • Event Description Editor…
    • Extract Information from Names…
    • Family Relationship Tool…
    • Fix Capitalization of Family Names…
    • Fix Capitalization of Given Names…
    • Gramps Web Sync…
    • Import and Merge tool…
    • Merge Citations…
    • Rename Event Types…
    • Reorder Gramps IDs…
    • Set Attribute…
    • Set Privacy Tool…
    • Sorts events…