Resource id refactor

obspy/core/event/__init__.py

@@ -25,7 +25,8 @@
 
 from .base import (
     Comment, CompositeTime, ConfidenceEllipsoid, CreationInfo, DataUsed,
-    QuantityError, ResourceIdentifier, TimeWindow, WaveformStreamID)
+    QuantityError, TimeWindow, WaveformStreamID)
+from obspy.core.event.resourceid import ResourceIdentifier
 from .catalog import Catalog, read_events
 from .event import Event, EventDescription
 from .magnitude import (

obspy/core/event/catalog.py

@@ -34,12 +34,12 @@
 from obspy.core.util import NamedTemporaryFile, _read_from_plugin
 from obspy.core.util.base import (ENTRY_POINTS, download_to_file,
                                   sanitize_filename)
-from obspy.core.util.decorator import (map_example_filename, rlock,
-                                       uncompress_file)
+from obspy.core.util.decorator import map_example_filename, uncompress_file
 from obspy.core.util.misc import buffered_load_entry_point
 from obspy.imaging.cm import obspy_sequential
 
-from .base import CreationInfo, ResourceIdentifier
+from .base import CreationInfo
+from obspy.core.event import ResourceIdentifier
 
 from .event import Event
 
@@ -53,7 +53,7 @@ class Catalog(object):
 
     :type events: list of :class:`~obspy.core.event.event.Event`, optional
     :param events: List of events
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of the catalog.
     :type description: str, optional
     :param description: Description string that can be assigned to the
@@ -84,12 +84,22 @@ def _get_resource_id(self):
         return self.__dict__['resource_id']
 
     def _set_resource_id(self, value):
-        if type(value) == dict:
+        if isinstance(value, dict):
             value = ResourceIdentifier(**value)
         elif type(value) != ResourceIdentifier:
             value = ResourceIdentifier(value)
+        value.set_referred_object(self, warn=False)
         self.__dict__['resource_id'] = value
 
+    def __setstate__(self, state):
+        """
+        Reset the resource id after being unpickled to ensure they are
+        bound to the correct object.
+        """
+        state['resource_id'].set_referred_object(self, warn=False,
+                                                 parent=self)
+        self.__dict__.update(state)
+
     resource_id = property(_get_resource_id, _set_resource_id)
 
     def _get_creation_info(self):
@@ -765,7 +775,6 @@ def plot(self, projection='global', resolution='l',
         return fig
 
 
-@rlock
 @map_example_filename("pathname_or_url")
 def read_events(pathname_or_url=None, format=None, **kwargs):
     """
@@ -845,7 +854,6 @@ def read_events(pathname_or_url=None, format=None, **kwargs):
         if len(pathnames) > 1:
             for filename in pathnames[1:]:
                 catalog.extend(_read(filename, format, **kwargs).events)
-        ResourceIdentifier.bind_resource_ids()
         return catalog
 
 

obspy/core/event/event.py

@@ -20,16 +20,17 @@
 from __future__ import (absolute_import, division, print_function,
                         unicode_literals)
 from future.builtins import *  # NOQA
+
 import copy
 
 from obspy.core.event.header import (
     EventType, EventTypeCertainty, EventDescriptionType)
-from obspy.core.util.decorator import rlock
+from obspy.core.event.resourceid import ResourceIdentifier
+from obspy.core.util.misc import _yield_resource_id_parent_attr
 from obspy.imaging.source import plot_radiation_pattern, _setup_figure_and_axes
 
 
-from .base import (_event_type_class_factory,
-                   CreationInfo, ResourceIdentifier)
+from .base import _event_type_class_factory, CreationInfo
 
 
 __Event = _event_type_class_factory(
@@ -57,7 +58,7 @@ class Event(__Event):
     event is usually associated with one or more magnitudes, and with one or
     more focal mechanism determinations.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of Event.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
@@ -102,6 +103,10 @@ class Event(__Event):
     """
     do_not_warn_on = ["_format", "extra"]
 
+    def __init__(self, *args, **kwargs):
+        super(Event, self).__init__(*args, **kwargs)
+        self.scope_resource_ids()
+
     def short_str(self):
         """
         Returns a short string representation of the current Event.
@@ -275,7 +280,6 @@ def plot(self, kind=[['ortho', 'beachball'], ['p_sphere', 's_sphere']],
 
         return fig
 
-    @rlock
     def __deepcopy__(self, memodict=None):
         """
         reset resource_id's object_id after deep copy to allow the
@@ -287,9 +291,13 @@ def __deepcopy__(self, memodict=None):
         memodict[id(self)] = result
         for k, v in self.__dict__.items():
             setattr(result, k, copy.deepcopy(v, memodict))
-        result.resource_id.bind_resource_ids()  # bind all resource_ids
+        result.scope_resource_ids()
         return result
 
+    def __setstate__(self, state_dict):
+        super(Event, self).__setstate__(state_dict)
+        self.scope_resource_ids()
+
     def write(self, filename, format, **kwargs):
         """
         Saves event information into a file.
@@ -311,6 +319,23 @@ def write(self, filename, format, **kwargs):
         from .catalog import Catalog
         Catalog(events=[self]).write(filename, format, **kwargs)
 
+    def scope_resource_ids(self):
+        """
+        Ensure all resource_ids in event instance are event-scoped.
+
+        This will ensure the resource_ids refer to objects in the event
+        structure when possible.
+        """
+        gen = _yield_resource_id_parent_attr(self)
+
+        for resource_id, parent, attr in gen:
+            if attr == 'resource_id':
+                resource_id.set_referred_object(parent, parent=self,
+                                                warn=False)
+            else:
+                resource_id._parent_key = self
+                resource_id._object_id = None
+
 
 __EventDescription = _event_type_class_factory(
     "__EventDescription",

obspy/core/event/magnitude.py

@@ -23,8 +23,9 @@
 
 from obspy import UTCDateTime
 from obspy.core.event.base import (
-    _event_type_class_factory, ResourceIdentifier, CreationInfo,
+    _event_type_class_factory, CreationInfo,
     WaveformStreamID, TimeWindow)
+from obspy.core.event import ResourceIdentifier
 from obspy.core.event.header import (
     AmplitudeCategory, AmplitudeUnit, EvaluationMode, EvaluationStatus,
     ATTRIBUTE_HAS_ERRORS)
@@ -54,7 +55,7 @@ class Magnitude(__Magnitude):
     originID. It is either a combination of different magnitude estimations, or
     it represents the reported magnitude for the given event.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of Magnitude.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
@@ -80,11 +81,11 @@ class Magnitude(__Magnitude):
         * coda magnitude (``'Mc'``)
         * ``'MH'``, ``'Mwp'``, ``'M50'``, ``'M100'``, etc.
 
-    :type origin_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
+    :type origin_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`,
         optional
     :param origin_id: Reference to an origin’s resource_id if the magnitude has
         an associated Origin.
-    :type method_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
+    :type method_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`,
         optional
     :param method_id: Identifies the method of magnitude estimation. Users
         should avoid to give contradictory information in method_id and
@@ -138,14 +139,13 @@ class StationMagnitude(__StationMagnitude):
     """
     This class describes the magnitude derived from a single waveform stream.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type resource_id:
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of StationMagnitude.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
         `resource_id` attribute in case it is not specified will be skipped.
-    :type origin_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type origin_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param origin_id: Reference to an origin’s ``resource_id`` if the
         StationMagnitude has an associated :class:`~obspy.core.event.Origin`.
     :type mag: float
@@ -155,13 +155,12 @@ class StationMagnitude(__StationMagnitude):
     :type station_magnitude_type: str, optional
     :param station_magnitude_type: See
         :class:`~obspy.core.event.magnitude.Magnitude`
-    :type amplitude_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type amplitude_id:
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param amplitude_id: Identifies the data source of the StationMagnitude.
         For magnitudes derived from amplitudes in waveforms (e.g., local
         magnitude ML), amplitudeID points to publicID in class Amplitude.
-    :type method_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type method_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param method_id: See :class:`~obspy.core.event.magnitude.Magnitude`
     :type waveform_id: :class:`~obspy.core.event.base.WaveformStreamID`,
         optional
@@ -196,7 +195,7 @@ class StationMagnitudeContribution(__StationMagnitudeContribution):
     StationMagnitude objects for computing a network magnitude estimation.
 
     :type station_magnitude_id:
-        :class:`~obspy.core.event.base.ResourceIdentifier`, optional
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param station_magnitude_id: Refers to the resource_id of a
         StationMagnitude object.
     :type residual: float, optional
@@ -244,7 +243,7 @@ class Amplitude(__Amplitude):
     single amplitude measurement or a measurement of the visible signal
     duration for duration magnitudes.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of Amplitude.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
@@ -292,8 +291,7 @@ class Amplitude(__Amplitude):
         combinations of SI base units.
         See :class:`~obspy.core.event.header.AmplitudeUnit` for allowed
         values.
-    :type method_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type method_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param method_id: Describes the method of amplitude determination.
     :type period: float, optional
     :param period: Dominant period in the timeWindow in case of amplitude
@@ -304,15 +302,13 @@ class Amplitude(__Amplitude):
     :type time_window: :class:`~obspy.core.event.base.TimeWindow`, optional
     :param time_window: Description of the time window used for amplitude
         measurement. Recommended for duration magnitudes.
-    :type pick_id: :class:`~obspy.core.event.base.ResourceIdentifier`, optional
+    :type pick_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param pick_id: Refers to the ``resource_id`` of an associated
         :class:`~obspy.core.event.origin.Pick` object.
-    :type waveform_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type waveform_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param waveform_id: Identifies the waveform stream on which the amplitude
         was measured.
-    :type filter_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type filter_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param filter_id: Identifies the filter or filter setup used for filtering
         the waveform stream referenced by ``waveform_id``.
     :type scaling_time: :class:`~obspy.core.utcdatetime.UTCDateTime`, optional

obspy/core/event/origin.py

@@ -23,8 +23,9 @@
 
 from obspy import UTCDateTime
 from obspy.core.event.base import (
-    _event_type_class_factory, ResourceIdentifier, CreationInfo,
+    _event_type_class_factory, CreationInfo,
     WaveformStreamID, ConfidenceEllipsoid)
+from obspy.core.event import ResourceIdentifier
 from obspy.core.event.header import (
     EvaluationMode, EvaluationStatus, OriginDepthType, OriginType,
     OriginUncertaintyDescription, PickOnset, PickPolarity,
@@ -183,7 +184,7 @@ class Origin(__Origin):
     earthquake hypocenter, as well as additional meta-information. Origin can
     have objects of type OriginUncertainty and Arrival as child elements.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of Origin.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
@@ -223,16 +224,15 @@ class Origin(__Origin):
     :param epicenter_fixed: True if epicenter was kept fixed for computation of
         Origin.
     :type reference_system_id:
-        :class:`~obspy.core.event.base.ResourceIdentifier`, optional
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param reference_system_id: Identifies the reference system used for
         hypocenter determination. This is only necessary if a modified version
         of the standard (with local extensions) is used that provides a
         non-standard coordinate system.
-    :type method_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type method_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param method_id: Identifies the method used for locating the event.
-    :type earth_model_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type earth_model_id:
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param earth_model_id: Identifies the earth model used in method_id.
     :type arrivals: list of :class:`~obspy.core.event.origin.Arrival`, optional
     :param arrivals: List of arrivals associated with the origin.
@@ -326,7 +326,7 @@ class Pick(__Pick):
     A pick is the observation of an amplitude anomaly in a seismogram at a
     specific point in time. It is not necessarily related to a seismic event.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of Pick.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
@@ -337,12 +337,10 @@ class Pick(__Pick):
     :param time_errors: AttribDict containing error quantities.
     :type waveform_id: :class:`~obspy.core.event.base.WaveformStreamID`
     :param waveform_id: Identifies the waveform stream.
-    :type filter_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type filter_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param filter_id: Identifies the filter or filter setup used for filtering
         the waveform stream referenced by waveform_id.
-    :type method_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type method_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param method_id: Identifies the picker that produced the pick. This can be
         either a detection software program or a person.
     :type horizontal_slowness: float, optional
@@ -357,7 +355,7 @@ class Pick(__Pick):
     :type backazimuth_errors: :class:`~obspy.core.event.base.QuantityError`
     :param backazimuth_errors: AttribDict containing error quantities.
     :type slowness_method_id:
-        :class:`~obspy.core.event.base.ResourceIdentifier`, optional
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param slowness_method_id: Identifies the method that was used to determine
         the slowness.
     :type onset: str, optional
@@ -423,12 +421,12 @@ class Arrival(__Arrival):
     slowness and backazimuth of the observed wave—especially if derived from
     array data—may further constrain the nature of the arrival.
 
-    :type resource_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type resource_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param resource_id: Resource identifier of Arrival.
     :type force_resource_id: bool, optional
     :param force_resource_id: If set to False, the automatic initialization of
         `resource_id` attribute in case it is not specified will be skipped.
-    :type pick_id: :class:`~obspy.core.event.base.ResourceIdentifier`
+    :type pick_id: :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param pick_id: Refers to the resource_id of a Pick.
     :type phase: str
     :param phase: Phase identification. For possible values, please refer to
@@ -471,8 +469,8 @@ class Pick).
     :param backazimuth_weight: Weight of the backazimuth for computation of the
         associated Origin. Note that the sum of all weights is not required to
         be unity.
-    :type earth_model_id: :class:`~obspy.core.event.base.ResourceIdentifier`,
-        optional
+    :type earth_model_id:
+        :class:`~obspy.core.event.resourceid.ResourceIdentifier`
     :param earth_model_id: Earth model which is used for the association of
         Arrival to Pick and computation of the residuals.
     :type comments: list of :class:`~obspy.core.event.base.Comment`, optional