reven2.bookmark.Bookmark class documentationreven2.bookmark
(View In Hierarchy)
A Bookmark saved on the REVEN server for this project.
Bookmarks allow to bookmark a specific trace.Transition and
can have an associated textual description. Bookmarks appear in Axion and
can be useful to save the location of points of interest in the trace.
| Method | __init__ | Undocumented |
| Method | transition | Property: The bookmarked transition |
| Method | description | Property: The description of this bookmark |
| Method | edit | Attempts to modify the description of the bookmark on the server. |
| Method | id | Property: The internal id of a bookmark. |
| Method | refresh | Requests a fresh view of this bookmark from the server. |
| Method | __repr__ | Undocumented |
| Method | __str__ | Undocumented |
| Method | format_as_html | This method gets an html formatting string representation for this class instance. |
| Method | _bookmark | Undocumented |
| Method | _repr_html_ | Representation used by Jupyter Notebook when an instance of this class is displayed in a cell. |
Attempts to modify the description of the bookmark on the server.
| Parameters | description | A str that will replace the current description of this
bookmark. |
| Raises | ValueError | If called on a bookmark that has been deleted server-side. This can happen
if the bookmark was deleted since the last call to Bookmarks.refresh. |
| RuntimeError | If called on a bookmark that is being edited or have been edited since the last refresh by another client (e.g. Axion). |
Property: The internal id of a bookmark.
For two bookmarks of a given project, the bookmark with the lowest id has been added the earliest, chronologically.
Requests a fresh view of this bookmark from the server.
This will retrieve changes made by other clients to this bookmark (Axion, or another script). You should call this method when you know other clients modified the bookmarks of this project.