[Palisade] Deprecate key 'upper_label' and issue warning.

dsavoiu · Aug 22, 2019 · bc0d1ff · bc0d1ff
1 parent 2e04759
commit bc0d1ff
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 9 deletions.
diff --git a/PostProcessing/doc/src/parts/palisade/assets/demonstration_plot.py b/PostProcessing/doc/src/parts/palisade/assets/demonstration_plot.py
@@ -100,10 +100,16 @@
           # matplotlib keywords
           'color': 'gray'
         },
+        # upper plot label (need to escape braces with `LiteralString`)
+        {
+          'text' : LiteralString(r"upper label with math: $\phi={\left(1\pm\sqrt{5}\right)}/{2}$"),
+          'xy': (1, 1),
+          'xycoords': 'axes fraction',
+          'xytext': (0, 5),
+          'textcoords': 'offset points',
+          'pad': 0
+        }
       ],
-
-      # upper plot label (need to escape braces with `LiteralString`)
-      'upper_label' : LiteralString(r"upper label with math: $\phi={\left(1\pm\sqrt{5}\right)}/{2}$"),
     }
   ],
 

diff --git a/PostProcessing/doc/src/parts/palisade/assets/demonstration_plot_2.py b/PostProcessing/doc/src/parts/palisade/assets/demonstration_plot_2.py
@@ -93,10 +93,17 @@
             'fontsize': 20,
             'pad': 1,
           },
+          # upper plot label (need to escape braces with `LiteralString`)
+          {
+            'text' : LiteralString(r"upper label with math: $\phi={\left(1\pm\sqrt{5}\right)}/{2}$"),
+            'xy': (1, 1),
+            'xycoords': 'axes fraction',
+            'xytext': (0, 5),
+            'textcoords': 'offset points',
+            'pad': 0
+          }
       ],
 
-      # upper plot label (need to escape braces with `LiteralString`)
-      'upper_label' : LiteralString(r"upper label with math: $\phi={\left(1\pm\sqrt{5}\right)}/{2}$"),
     }
   ],
 

diff --git a/PostProcessing/python/Palisade/Processors/_plot.py b/PostProcessing/python/Palisade/Processors/_plot.py
@@ -4,6 +4,7 @@
 import math
 import os
 import six
+import warnings
 import yaml
 
 from copy import deepcopy
@@ -738,12 +739,20 @@ def _plot(self, config):
         # handle figure label ("upper_label")
         _upper_label = config.pop('upper_label', None)
         if _upper_label is not None:
+
+            # keyword is deprecated
+            warnings.warn(
+                "Keyword `upper_label` is deprecated and will be removed in "
+                "the future. Replace it with the following equivalent annotation under "
+                "`texts`: dict(text='...', xy=(1, 1), xycoords='axes fraction', xytext=(0, 5), "
+                "textcoords='offset points', ha='right', pad=0).", DeprecationWarning)
+
             # place above topmost `Axes`
-            _ax_top = _pad_configs[0]['axes']
-            _ax_top.text(1.0, 1.015,
-                _upper_label,
+            _pad_configs[0]['axes'].annotate(_upper_label, xy=(1, 1),
+                xycoords='axes fraction',
+                xytext=(0, 5),
+                textcoords='offset points',
                 ha='right',
-                transform=_ax_top.transAxes
             )
 
 

diff --git a/PostProcessing/python/Palisade/_ui.py b/PostProcessing/python/Palisade/_ui.py
@@ -9,6 +9,7 @@
 import os
 import re
 import sys
+import warnings
 
 from contextlib import contextmanager
 from tqdm import tqdm
@@ -216,6 +217,9 @@ def _get_cli_args_and_task(self):
 
     def run(self):
 
+        # show deprecation warnings by default
+        warnings.simplefilter('default', DeprecationWarning)
+
         if self._task_module is None:
             raise NotImplemented
         else: