Fix failing tests and documentation

CHANGELOG.rst

@@ -25,6 +25,9 @@ changes
 -  The ``wx_property_tag`` validator now also accepts lists of different tags. [:pull:`670`]
    When multiple tags are passed, validation will fail if *none* of the supplied patterns match.
 
+- Due to a `pandas` update, using the + operator with `Time` and either a `pandas.TimedeltaIndex` or `pandas.DatetimeIndex`
+  now only works if the `Time` instance is on the left-hand side. [:pull:`684`]
+
 fixes
 =====
 

doc/nitpick_ignore

@@ -51,6 +51,7 @@ py:class k3d.plot
 py:class np.ndarray
 py:class DataArray
 py:class InitVar
+py:class dataclasses.InitVar
 py:class Time
 
 # inherited -------------------------------------------------------------------

tutorials/01_02_time_dependent_data.ipynb

@@ -347,9 +347,9 @@
    "source": [
     "What remains now is to divide the result by the process duration.\n",
     "We can get the time data either from the voltage or the current data as they were both measured simultaneously.\n",
-    "It can be accessed with `.time` which returns a `weldx.Time` instance.\n",
+    "It can be accessed with `.time` which returns a `weldx.time.Time` instance.\n",
     "We will talk a bit more about this class in another tutorial.\n",
-    "For now it is sufficient to know, that it provides a `.duration` method to get the duration of the contained time data as a new `weldx.Time` instance and that we can turn it into a quantity using `.as_quantity`.\n",
+    "For now it is sufficient to know, that it provides a `.duration` method to get the duration of the contained time data as a new `weldx.time.Time` instance and that we can turn it into a quantity using `.as_quantity`.\n",
     "So let's finally calculate the electrical power:"
    ]
   },

weldx/asdf/cli/welding_schema.py

@@ -26,21 +26,23 @@ def single_pass_weld_example(
     import pandas as pd
     from asdf.tags.core import Software
 
-    # importing the weldx package with prevalent default abbreviations
-    import weldx
     import weldx.geometry as geo
     import weldx.measurement as msm
-    from weldx import Q_, GmawProcess
-    from weldx import LocalCoordinateSystem as lcs
-    from weldx import TimeSeries, WXRotation, get_groove
-    from weldx.asdf.util import get_schema_path, write_buffer
-    from weldx.constants import META_ATTR
-    from weldx.core import MathematicalExpression
+
+    # importing the weldx package with prevalent default abbreviations
+    import weldx.transformations as tf
+    from weldx.asdf.util import get_schema_path, write_buffer, write_read_buffer
+    from weldx.constants import META_ATTR, Q_
+    from weldx.core import MathematicalExpression, TimeSeries
     from weldx.tags.aws.process.gas_component import GasComponent
     from weldx.tags.aws.process.shielding_gas_for_procedure import (
         ShieldingGasForProcedure,
     )
     from weldx.tags.aws.process.shielding_gas_type import ShieldingGasType
+    from weldx.tags.processes.process import GmawProcess
+    from weldx.transformations.local_cs import LocalCoordinateSystem as lcs
+    from weldx.transformations.rotation import WXRotation
+    from weldx.welding.groove.iso_9692_1 import get_groove
     from weldx.welding.util import sine
 
     # Timestamp
@@ -71,7 +73,7 @@ def single_pass_weld_example(
 
     # Setup the Coordinate System Manager (CSM)
     # crete a new coordinate system manager with default base coordinate system
-    csm = weldx.transformations.CoordinateSystemManager("base")
+    csm = tf.CoordinateSystemManager("base")
 
     # add the workpiece coordinate system
     csm.add_cs(
@@ -296,7 +298,7 @@ def single_pass_weld_example(
     model_path = get_schema_path("single_pass_weld-0.1.0.yaml")
 
     # pre-validate?
-    weldx.asdf.util.write_read_buffer(
+    write_read_buffer(
         tree,
         asdffile_kwargs=dict(custom_schema=str(model_path)),
     )

weldx/asdf/file.py

@@ -435,7 +435,7 @@ def software_history_entry(self):
     def software_history_entry(self, value: dict):
         """Set the software used for making history entries."""
         if value is None:
-            from weldx import __version__ as version
+            from weldx._version import __version__ as version
 
             self._DEFAULT_SOFTWARE_ENTRY = {
                 "name": "weldx",

weldx/asdf/util.py

@@ -126,7 +126,7 @@ def show(wx):
 
     if _use_weldx_file:
         write_kwargs = dict(all_array_storage="inline")
-        from weldx import WeldxFile
+        from weldx.asdf.file import WeldxFile
 
         with WeldxFile(
             tree=tree,
@@ -181,7 +181,7 @@ def read_buffer(
     if _use_weldx_file is None:
         _use_weldx_file = _USE_WELDX_FILE
     if _use_weldx_file:
-        from weldx import WeldxFile
+        from weldx.asdf.file import WeldxFile
 
         return WeldxFile(buffer, asdffile_kwargs=open_kwargs)
 

weldx/constants.py

@@ -43,7 +43,7 @@
 
 Examples
 --------
->>> from weldx import Q_
+>>> from weldx.constants import Q_
 >>> length = Q_(10, "mm")
 >>> length
 <Quantity(10, 'millimeter')>

weldx/core.py

@@ -909,7 +909,8 @@ def __init__(
         Create a `GenericSeries` representing a translation with 3 m/s in x-direction
         starting at point ``[0, 2 ,2] cm``
 
-        >>> from weldx import GenericSeries, Q_
+        >>> from weldx.core import GenericSeries
+        >>> from weldx.constants import Q_
         >>> GenericSeries(  # doctest: +NORMALIZE_WHITESPACE
         ...     "a*t + b",
         ...     parameters=dict(a=Q_([3, 0, 0], "mm/s"), b=Q_([0, 2, 2], "cm")),

weldx/geometry.py

@@ -16,7 +16,6 @@
 import weldx.util as ut
 from weldx.constants import Q_
 from weldx.constants import WELDX_UNIT_REGISTRY as UREG
-from weldx.time import Time
 from weldx.types import QuantityLike
 
 _DEFAULT_LEN_UNIT = UREG.millimeters
@@ -2530,8 +2529,8 @@ class SpatialData:
         Shape should be [time * n, 3]."""
     attributes: Dict[str, np.ndarray] = None
     """optional dictionary with additional attributes to store alongside data."""
-    time: InitVar[Time] = None
-    """Time axis if data is time dependent."""
+    time: InitVar = None
+    """The time axis if data is time dependent."""
 
     def __post_init__(self, time):
         """Convert and check input values."""

weldx/measurement.py

@@ -238,7 +238,7 @@ def __init__(
 
         Examples
         --------
-        >>> from weldx import Q_
+        >>> from weldx.constants import Q_
         >>> from weldx.measurement import Error, MeasurementChain, Signal, SignalSource
 
         Create a signal source
@@ -324,7 +324,7 @@ def from_equipment(
 
         Examples
         --------
-        >>> from weldx import Q_
+        >>> from weldx.constants import Q_
         >>> from weldx.measurement import Error, MeasurementChain,\
         MeasurementEquipment, Signal, SignalSource
 
@@ -399,7 +399,7 @@ def from_parameters(
 
         Examples
         --------
-        >>> from weldx import Q_
+        >>> from weldx.constants import Q_
         >>> from weldx.measurement import Error, MeasurementChain
 
         >>> mc = MeasurementChain.from_parameters(
@@ -613,7 +613,7 @@ def add_transformation(
 
         Examples
         --------
-        >>> from weldx import Q_
+        >>> from weldx.constants import Q_
         >>> from weldx.core import MathematicalExpression
         >>> from weldx.measurement import Error, MeasurementChain, SignalTransformation
 
@@ -689,7 +689,7 @@ def add_transformation_from_equipment(
 
         Examples
         --------
-        >>> from weldx import Q_
+        >>> from weldx.constants import Q_
         >>> from weldx.core import MathematicalExpression
         >>> from weldx.measurement import Error, MeasurementChain,\
         MeasurementEquipment, SignalTransformation
@@ -789,7 +789,7 @@ def create_transformation(
 
         Examples
         --------
-        >>> from weldx import Q_
+        >>> from weldx.constants import Q_
         >>> from weldx.core import MathematicalExpression
         >>> from weldx.measurement import Error, MeasurementChain, SignalTransformation
 

weldx/tags/debug/test_shape_validator.py

@@ -4,8 +4,9 @@
 import pandas as pd
 import pint
 
-from weldx import Q_, TimeSeries
 from weldx.asdf.util import dataclass_serialization_class
+from weldx.constants import Q_
+from weldx.core import TimeSeries
 
 __all__ = ["ShapeValidatorTestClass", "ShapeValidatorTestClassConverter"]
 

weldx/tags/debug/test_unit_validator.py

@@ -3,8 +3,8 @@
 import numpy as np
 import pint
 
-from weldx import Q_
 from weldx.asdf.util import dataclass_serialization_class
+from weldx.constants import Q_
 
 __all__ = ["UnitValidatorTestClass", "UnitValidatorTestClassConverter"]
 

weldx/tests/asdf_tests/test_asdf_gmaw_process.py

@@ -2,8 +2,8 @@
 
 import pytest
 
-from weldx import Q_
 from weldx.asdf.util import write_read_buffer
+from weldx.constants import Q_
 from weldx.core import TimeSeries
 from weldx.welding.processes import GmawProcess
 

weldx/tests/asdf_tests/test_asdf_measurement.py

@@ -1,7 +1,7 @@
 import pytest
 
-from weldx import Q_
 from weldx.asdf.util import write_read_buffer
+from weldx.constants import Q_
 from weldx.core import MathematicalExpression
 from weldx.measurement import (
     Error,

weldx/tests/asdf_tests/test_asdf_time.py

@@ -3,8 +3,8 @@
 import pandas as pd
 import pytest
 
-from weldx import Time
 from weldx.asdf.util import write_buffer, write_read_buffer
+from weldx.time import Time
 
 
 @pytest.mark.parametrize(

weldx/tests/asdf_tests/test_asdf_util.py

@@ -6,7 +6,7 @@
 import numpy as np
 import pytest
 
-from weldx import WeldxFile
+from weldx.asdf.file import WeldxFile
 from weldx.asdf.util import (
     dataclass_serialization_class,
     get_highest_tag_version,

weldx/tests/asdf_tests/test_asdf_validators.py

@@ -4,10 +4,11 @@
 import pytest
 from asdf import ValidationError
 
-from weldx import Q_, TimeSeries
 from weldx.asdf.types import WxSyntaxError
 from weldx.asdf.util import write_buffer, write_read_buffer
 from weldx.asdf.validators import _custom_shape_validator
+from weldx.constants import Q_
+from weldx.core import TimeSeries
 from weldx.tags.debug.test_property_tag import PropertyTagTestClass
 from weldx.tags.debug.test_shape_validator import ShapeValidatorTestClass
 from weldx.tags.debug.test_unit_validator import UnitValidatorTestClass

weldx/tests/asdf_tests/test_weldx_file.py

@@ -12,9 +12,8 @@
 import xarray as xr
 from jsonschema import ValidationError
 
-from weldx import WeldxFile
 from weldx.asdf.cli.welding_schema import single_pass_weld_example
-from weldx.asdf.file import _PROTECTED_KEYS, DEFAULT_ARRAY_INLINE_THRESHOLD
+from weldx.asdf.file import _PROTECTED_KEYS, DEFAULT_ARRAY_INLINE_THRESHOLD, WeldxFile
 from weldx.asdf.util import get_schema_path
 from weldx.constants import META_ATTR
 from weldx.types import SupportsFileReadWrite

weldx/tests/test_config.py

@@ -4,7 +4,7 @@
 import asdf
 import pytest
 
-from weldx import WeldxFile
+from weldx.asdf.file import WeldxFile
 from weldx.config import QualityStandard, add_quality_standard, enable_quality_standard
 from weldx.constants import META_ATTR
 from weldx.measurement import MeasurementEquipment

weldx/tests/test_geometry.py

@@ -14,9 +14,10 @@
 import weldx.geometry as geo
 import weldx.tests._helpers as helpers
 import weldx.transformations as tf
-from weldx import Q_, CoordinateSystemManager
+from weldx.constants import Q_
 from weldx.geometry import SpatialData
 from weldx.transformations import WXRotation
+from weldx.transformations.cs_manager import CoordinateSystemManager
 
 from ._helpers import matrix_is_close, vector_is_close
 

weldx/tests/test_time.py

@@ -12,8 +12,10 @@
 from pandas import Timestamp, date_range
 from pint import DimensionalityError
 
-from weldx import Q_, LocalCoordinateSystem, TimeSeries
+from weldx.constants import Q_
+from weldx.core import TimeSeries
 from weldx.time import Time, types_time_like
+from weldx.transformations.local_cs import LocalCoordinateSystem
 
 
 def _initialize_delta_type(cls_type, values, unit):
@@ -336,6 +338,8 @@ def test_add_timedelta(
             np.ndarray,
             np.timedelta64,
             np.datetime64,
+            DTI,
+            TDI,
         ):
             return
 
@@ -419,7 +423,7 @@ def test_add_datetime(
             return
 
         # skip __radd__ cases where we got conflicts with the other types' __add__
-        if not other_on_rhs and other_type in (Q_, np.ndarray, np.timedelta64):
+        if not other_on_rhs and other_type in (Q_, np.ndarray, np.timedelta64, TDI):
             return
 
         # setup rhs
@@ -535,6 +539,8 @@ def test_sub(
             np.ndarray,
             np.timedelta64,
             np.datetime64,
+            DTI,
+            TDI,
         ):
             return
 

weldx/tests/transformations/test_cs_manager.py

@@ -12,8 +12,9 @@
 from pandas import Timestamp as TS  # noqa
 
 import weldx.transformations as tf
-from weldx import Q_, SpatialData
+from weldx.constants import Q_
 from weldx.core import MathematicalExpression, TimeSeries
+from weldx.geometry import SpatialData
 from weldx.tests._helpers import get_test_name, matrix_is_close
 from weldx.time import Time, types_time_like, types_timestamp_like
 from weldx.transformations import CoordinateSystemManager as CSM  # noqa

weldx/tests/transformations/test_local_cs.py

@@ -14,7 +14,7 @@
 
 import weldx.transformations as tf
 import weldx.util as ut
-from weldx import Q_
+from weldx.constants import Q_
 from weldx.core import MathematicalExpression, TimeSeries
 from weldx.tests._helpers import get_test_name
 from weldx.time import Time