Fixes to remove the usage of deprecated functions

Author: szymonlopaciuk

pyproject.toml

@@ -48,7 +48,7 @@ include-package-data = true
 [project.entry-points.xobjects]
 include = "xfields"
 
-[pytest]
+[tool.pytest]
 markers = [
     "context_dependent: marks test as one that depends on the execution context",
 ]

tests/test_ibs_kicks.py

@@ -37,8 +37,8 @@ def test_line_configuration_providing_element(update_every, name):
     # Configure and check flags are set as they should be
     line.configure_intrabeam_scattering(
         element=ibskick,
-        name=name,  # kwarg given to .insert_element()
-        at_s=100,  # kwarg given to .insert_element()
+        what=name,  # kwarg given to .insert_element()
+        at=100,  # kwarg given to .insert_element()
         update_every=update_every,
     )
     assert ibskick.update_every == update_every
@@ -63,7 +63,7 @@ def test_line_configuration_manual_insertion(update_every, name):
     # -----------------------------------------------------
     # Create element, check flags and manually insert it
     ibskick = IBSAnalyticalKick(formalism="b&m", num_slices=50)  # same for IBSKineticKick
-    line.insert_element(element=ibskick, index=-1, name=name)
+    line.insert(name, obj=ibskick, at=0)
     assert ibskick.update_every is None
     assert ibskick._name is None
     assert ibskick._twiss is None
@@ -93,7 +93,7 @@ def test_configuration_raises_if_not_one_element(num_insertions):
     # -----------------------------------------------------
     # Inserting element(s) in the line 'num_insertions' times
     for i in range(num_insertions):
-        line.insert_element(element=ibskick, index=-1, name=f"ibskick{i}")
+        line.insert(f"ibskick{i}", obj=ibskick, at=0)
     # -----------------------------------------------------
     # Attempting configuration and checking it raises
     with pytest.raises(AssertionError):
@@ -120,7 +120,7 @@ def test_configuration_raises_on_below_transition_analytical_kick():
     ibskick = IBSAnalyticalKick(formalism="B&M", num_slices=50)
     # -----------------------------------------------------
     # Insert element in the line and attempt configuration
-    line.insert_element(element=ibskick, index=10, name="ibskick")
+    line.insert("ibskick", obj=ibskick, at=line.get_table().rows[10].s[0])
     with pytest.raises(AssertionError):
         line.configure_intrabeam_scattering(update_every=10)
 
@@ -147,7 +147,7 @@ def test_kick_coefficients(test_context, formalism):
     ibskick = IBSAnalyticalKick(formalism=formalism, num_slices=50)
     # -----------------------------------------------------
     # Configure in line and generate particles distribution
-    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", index=0, update_every=1)
+    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", at=0, update_every=1)
     particles = xp.generate_matched_gaussian_bunch(
         num_particles=250_000,
         nemitt_x=1.2e-5,
@@ -187,7 +187,7 @@ def test_kinetic_coefficients(test_context):
     ibskick = IBSKineticKick(num_slices=50)
     # -----------------------------------------------------
     # Configure in line and generate particles distribution
-    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", index=0, update_every=1)
+    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", at=0, update_every=1)
     particles = xp.generate_matched_gaussian_bunch(
         num_particles=250_000,
         nemitt_x=1.2e-5,
@@ -236,7 +236,7 @@ def test_track_analytical_kick(test_context):
     cavities = [element for element in line.elements if isinstance(element, xt.Cavity)]
     for cavity in cavities:
         cavity.lag = 180
-    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", index=-1, update_every=100)
+    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", at=0, update_every=100)
     tw = line.twiss(method="4d")
     particles = xp.generate_matched_gaussian_bunch(
         num_particles=2000,
@@ -286,7 +286,7 @@ def test_track_kinetic_kick(test_context):
     cavities = [element for element in line.elements if isinstance(element, xt.Cavity)]
     for cavity in cavities:
         cavity.lag = 180
-    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", index=-1, update_every=100)
+    line.configure_intrabeam_scattering(element=ibskick, name="ibskick", at=0, update_every=100)
     tw = line.twiss(method="4d")
     particles = xp.generate_matched_gaussian_bunch(
         num_particles=2000,

xfields/ibs/_api.py

@@ -6,6 +6,7 @@
 
 from logging import getLogger
 from typing import TYPE_CHECKING
+from warnings import warn
 
 import numpy as np
 
@@ -175,7 +176,10 @@ def configure_intrabeam_scattering(
             line.discard_tracker()
         else:
             _buffer = None
-        line.insert_element(element=element, **kwargs)
+        if 'name' in kwargs:
+            # Support the previous API that used the deprecated `insert_element(name=...)`
+            kwargs['what'] = kwargs.pop('name')
+        line.insert(obj=element, **kwargs)
         if _buffer is not None:
             line.build_tracker(_buffer=_buffer)
     # ----------------------------------------------------------------------------------------------