Deprecate helpers.py and sn_curve.py

Signed-off-by: Johannes Mueller <[email protected]>
boschresearch · Feb 22, 2022 · 53fa73b · 53fa73b
1 parent 45f5cbf
commit 53fa73b
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 225 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -2,12 +2,13 @@
 [run]
 branch = True
 source = pylife
-# omit = bad_file.py
+omit =
+     src/pylife/strength/helpers.py
+     src/pylife/strength/sn_curve.py
 
 [paths]
 source =
     src/
-    */site-packages/
 
 [report]
 # Regexes for lines to exclude from consideration

diff --git a/docs/reference.rst b/docs/reference.rst
@@ -31,8 +31,6 @@ Strength
    strength/meanstress
    strength/failure_probability
    strength/miner
-   strength/sn_curve
-   strength/helpers
 
 Materiallaws
 ------------

diff --git a/docs/strength/helpers.rst b/docs/strength/helpers.rst
diff --git a/docs/strength/sn_curve.rst b/docs/strength/sn_curve.rst
diff --git a/src/pylife/strength/helpers.py b/src/pylife/strength/helpers.py
@@ -21,8 +21,16 @@
 __author__ = "Cedric Philip Wagner"
 __maintainer__ = "Johannes Mueller"
 
+import warnings
+
 import numpy as np
 
+warnings.warn(
+    FutureWarning(
+        "The module pylife.strength.helpers is deprecated and no longer under test. "
+        "We will restore the functionality in another module if needed."
+    )
+)
 
 class StressRelations:
     """Namespace for simple relations of stress / amplitude / R-ratio

diff --git a/src/pylife/strength/sn_curve.py b/src/pylife/strength/sn_curve.py
@@ -24,6 +24,12 @@
 import pylife.strength.fatigue
 import pylife.stress
 
+warnings.warn(
+    FutureWarning(
+        "The module pylife.strength.helpers is deprecated and no longer under test. "
+        "The functionality is now avaliable in the pylife.materiallaws.WoehlerCurve."
+    )
+)
 
 class FiniteLifeBase:
     """Base class for SN curve calculations - either in logarithmic or regular scale"""

diff --git a/tests/strength/test_helpers.py b/tests/strength/test_helpers.py
diff --git a/tests/strength/test_meanstress.py b/tests/strength/test_meanstress.py
@@ -14,7 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import sys, os, copy
 import warnings
 import pytest
 
@@ -23,7 +22,6 @@
 import numpy.testing as testing
 
 import pylife.strength.meanstress as MST
-from pylife.strength.sn_curve import FiniteLifeCurve
 
 
 def goodman_signal_sm():

diff --git a/tests/strength/test_sn_curve.py b/tests/strength/test_sn_curve.py