class Comment(force_resource_id=True, *args, **kwargs)[source]

Bases: obspy.core.event.base.__Comment

Comment holds information on comments to a resource as well as author and creation time information.

  • text (str) Text of comment.
  • resource_id (ResourceIdentifier, optional) Resource identifier of comment.
  • force_resource_id (bool, optional) If set to False, the automatic initialization of resource_id attribute in case it is not specified will be skipped.
  • creation_info (CreationInfo, optional) Creation info for the comment.
>>> comment = Comment(text="Some comment")
>>> print(comment)  
Comment(text='Some comment', resource_id=ResourceIdentifier(...))
>>> comment = Comment(text="Some comment", force_resource_id=False)
>>> print(comment)
Comment(text='Some comment')
>>> comment.resource_id = "comments/obspy-comment-123456"
>>> print(comment) 
Comment(text='Some comment', resource_id=ResourceIdentifier(...))
>>> comment.creation_info = {"author": "obspy.org"}
>>> print(comment.creation_info)


For handling additional information not covered by the QuakeML standard and how to output it to QuakeML see the ObsPy Tutorial.


__abstractmethods__ frozenset() -> empty frozenset object
__doc__ str(object=’‘) -> str
__module__ str(object=’‘) -> str
__slots__ tuple() -> empty tuple
__weakref__ list of weak references to the object (if defined)
defaults dict() -> new empty dictionary
do_not_warn_on list() -> new empty list
item tuple() -> empty tuple
key str(object=’‘) -> str
readonly list() -> new empty list
warn_on_non_default_key bool(x) -> bool

Public Methods

pop If key is not found, d is returned if given, otherwise KeyError is raised.
popitem as a 2-tuple; but raise KeyError if D is empty.

Private Methods


Private methods are mainly for internal/developer use and their API might change without notice.

_pretty_str Return better readable string representation of AttribDict object.

Special Methods

__deepcopy__ reset resource_id’s object_id after deep copy to allow the
__dir__ default dir() implementation
__eq__ Two instances are considered equal if all attributes and all lists
__format__ default object formatter
__getattr__ Py3k hasattr() expects an AttributeError no KeyError to be
__new__ Create and return a new object.
__reduce__ helper for pickle
__reduce_ex__ helper for pickle
__setattr__ Custom property implementation that works if the class is
__sizeof__ size of object in memory, in bytes
__str__ Fairly extensive in an attempt to cover several use cases.