deprecate PDFParser

Author: cadenmyers13

src/diffpy/srfit/pdf/pdfparser.py

@@ -28,6 +28,19 @@
 
 from diffpy.srfit.exceptions import ParseError
 from diffpy.srfit.fitbase.profileparser import ProfileParser
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
+
+removal_verison = "4.0.0"
+base = "diffpy.srfit.pdf.pdfparser.PDFParser"
+new_base = "diffpy.srfit.fitbase.ProfileParser"
+
+parseFile_dep_msg = build_deprecation_message(
+    base,
+    "parseFile",
+    "parse_file",
+    removal_version=removal_verison,
+    new_base=new_base,
+)
 
 
 class PDFParser(ProfileParser):
@@ -106,6 +119,11 @@ class PDFParser(ProfileParser):
 
     _format = "PDF"
 
+    # Marking this function as deprecated because PDFParser.parseFile calls it
+    # so when people use PDFParser.parseFile, they will get a
+    # warning that it is deprecated and they should use
+    # ProfileParser.parse_file instead.
+    @deprecated(parseFile_dep_msg)
     def parseString(self, patstring):
         """Parse a string and set the _x, _y, _dx, _dy and _meta
         variables.
@@ -121,6 +139,7 @@ def parseString(self, patstring):
 
         Raises ParseError if the string cannot be parsed
         """
+
         # useful regex patterns:
         rx = {"f": r"[-+]?(\d+(\.\d*)?|\d*\.\d+)([eE][-+]?\d+)?"}
         # find where does the data start