obspy.core.event.Comment

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

Bases: obspy.core.event.__Comment

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

Parameters:
  • 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)
CreationInfo(author='obspy.org')

Note

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

Attributes

__abstractmethods__ frozenset() -> empty frozenset object
__dict__
__doc__ unicode(string [, encoding[, errors]]) -> object
__hash__
__module__ str(object) -> string
__weakref__ list of weak references to the object (if defined)
defaults dict() -> new empty dictionary
item tuple() -> empty tuple
key unicode(string [, encoding[, errors]]) -> object
readonly list() -> new empty list

Public Methods

clear
copy
get
items
iteritems
iterkeys
itervalues
keys
pop
popitem
setdefault
update
values

Private Methods

_pretty_str Return better readable string representation of AttribDict object.
_repr_pretty_

Special Methods

__bool__
__contains__
__deepcopy__
__delattr__
__delitem__
__eq__ Two instances are considered equal if all attributes and all lists
__getattr__ Py3k hasattr() expects an AttributeError no KeyError to be
__getitem__
__getstate__
__init__
__iter__
__len__
__ne__
__nonzero__
__repr__
__setattr__ Custom property implementation that works if the class is
__setitem__
__setstate__
__str__ Fairly extensive in an attempt to cover several use cases.
__subclasshook__