obspy.core.inventory.util.Comment
- class Comment(value, id=None, begin_effective_time=None, end_effective_time=None, authors=None, subject=None)[source]
Bases:
ComparingObject- From the StationXML definition:
Container for a comment or log entry. Corresponds to SEED blockettes 31, 51 and 59.
Attributes
Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
Special Methods
- Comment.__delattr__(name, /)
Implement delattr(self, name).
- Comment.__dir__()
Default dir() implementation.
- Comment.__eq__(other)
- Comment.__format__(format_spec, /)
Default object formatter.
- Comment.__ge__(value, /)
Return self>=value.
- Comment.__getattribute__(name, /)
Return getattr(self, name).
- Comment.__gt__(value, /)
Return self>value.
- Comment.__init__(value, id=None, begin_effective_time=None, end_effective_time=None, authors=None, subject=None)[source]
- Parameters:
value (str) – The actual comment string
id (int) – ID of comment, must be 0 or greater.
begin_effective_time (
UTCDateTime, optional) – The effective start date.end_effective_time (
UTCDateTime, optional) – The effective end date.authors (list of
Person, optional) – The authors of this comment.subject (str, optional) – Subject for relating comment, optional
- Comment.__init_subclass__()
This method is called when a class is subclassed.
The default implementation does nothing. It may be overridden to extend subclasses.
- Comment.__le__(value, /)
Return self<=value.
- Comment.__lt__(value, /)
Return self<value.
- Comment.__ne__(other)
- Comment.__new__(**kwargs)
- Comment.__reduce__()
Helper for pickle.
- Comment.__reduce_ex__(protocol, /)
Helper for pickle.
- Comment.__repr__()
Return repr(self).
- Comment.__setattr__(name, value, /)
Implement setattr(self, name, value).
- Comment.__sizeof__()
Size of object in memory, in bytes.
- Comment.__subclasshook__()
Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).