obspy.core.event.base.Comment¶
-
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.
- 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) # doctest:+ELLIPSIS 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) # doctest:+ELLIPSIS 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__
__dict__
__doc__
__hash__
__module__
__reversed__
__slots__
__weakref__
list of weak references to the object (if defined)
defaults
do_not_warn_on
item
key
readonly
warn_on_non_default_key
Public Methods
If key is not found, d is returned if given, otherwise KeyError is raised.
as a 2-tuple; but raise KeyError if D is empty.
If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
Return better readable string representation of AttribDict object.
Special Methods
reset resource_id’s object_id after deep copy to allow the object specific behavior of get_referred_object
Default dir() implementation.
Two instances are considered equal if all attributes and all lists are identical.
Default object formatter.
Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found.
This method is called when a class is subclassed.
Create and return a new object.
Helper for pickle.
Helper for pickle.
Custom property implementation that works if the class is inheriting from AttribDict.
Size of object in memory, in bytes.
Fairly extensive in an attempt to cover several use cases.
Abstract classes can override this to customize issubclass().