ps: Deprecate the psDefs module-level variable

QuLogic · QuLogic · commit e39d792bb3e7 · 2023-04-25T20:58:18.000-04:00
This is just a bunch of shortcut procedure definitions for Matplotlib's
internal use; there's not much use for them externally.
diff --git a/doc/api/next_api_changes/deprecations/25742-ES.rst b/doc/api/next_api_changes/deprecations/25742-ES.rst
@@ -0,0 +1,5 @@
+``backend_ps.psDefs``
+~~~~~~~~~~~~~~~~~~~~~
+
+The ``psDefs`` module-level variable in ``backend_ps`` is deprecated with no
+replacement.
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -49,6 +49,7 @@ class __getattr__:
     # module-level deprecations
     ps_backend_helper = _api.deprecated("3.7", obj_type="")(
         property(lambda self: PsBackendHelper()))
+    psDefs = _api.deprecated("3.8", obj_type="")(property(lambda self: _psDefs))
 
 
 papersize = {'letter': (8.5, 11),
@@ -921,13 +922,13 @@ def print_figure_impl(fh):
                   f"%%EndComments\n",
                   end="", file=fh)
 
-            Ndict = len(psDefs)
+            Ndict = len(_psDefs)
             print("%%BeginProlog", file=fh)
             if not mpl.rcParams['ps.useafm']:
                 Ndict += len(ps_renderer._character_tracker.used)
             print("/mpldict %d dict def" % Ndict, file=fh)
             print("mpldict begin", file=fh)
-            print("\n".join(psDefs), file=fh)
+            print("\n".join(_psDefs), file=fh)
             if not mpl.rcParams['ps.useafm']:
                 for font_path, chars \
                         in ps_renderer._character_tracker.used.items():
@@ -1030,9 +1031,9 @@ def _print_figure_tex(
 {get_bbox_header(bbox)[0]}
 %%EndComments
 %%BeginProlog
-/mpldict {len(psDefs)} dict def
+/mpldict {len(_psDefs)} dict def
 mpldict begin
-{"".join(psDefs)}
+{"".join(_psDefs)}
 end
 %%EndProlog
 mpldict begin
@@ -1297,7 +1298,7 @@ def pstoeps(tmpfile, bbox=None, rotated=False):
 
 # The usage comments use the notation of the operator summary
 # in the PostScript Language reference manual.
-psDefs = [
+_psDefs = [
     # name proc  *_d*  -
     # Note that this cannot be bound to /d, because when embedding a Type3 font
     # we may want to define a "d" glyph using "/d{...} d" which would locally
