Deprecate text.latex.unicode.

It is 2018 and Python3 is ruling the world; it is high time for usetex
to default to unicode support as well.

(If ``\usepackage[utf8]{inputenc}`` is irremediably breaking some users'
setup we can always revisit this decision.)

Author: anntzer

doc/api/next_api_changes/2018-02-15-AL-deprecations.rst

@@ -44,6 +44,7 @@ The following classes, methods, functions, and attributes are deprecated:
 The following rcParams are deprecated:
 - ``examples.directory`` (use ``datapath`` instead),
 - ``pgf.debug`` (the pgf backend relies on logging),
+- ``text.latex.unicode``,
 
 The following keyword arguments are deprecated:
 - passing ``verts`` to ``Axes.scatter`` (use ``marker`` instead),

doc/api/next_api_changes/2018-05-15-AL.rst

@@ -0,0 +1,8 @@
+Changes regarding the text.latex.unicode rcParam
+````````````````````````````````````````````````
+
+The rcParam now defaults to True and is deprecated (i.e., in future versions
+of Maplotlib, unicode input will always be supported).
+
+Moreover, the underlying implementation now uses ``\usepackage[utf8]{inputenc}``
+instead of ``\usepackage{ucs}\usepackage[utf8x]{inputenc}``.

examples/text_labels_and_annotations/tex_demo.py

@@ -17,7 +17,6 @@
 import numpy as np
 import matplotlib
 matplotlib.rcParams['text.usetex'] = True
-matplotlib.rcParams['text.latex.unicode'] = True
 import matplotlib.pyplot as plt
 
 

examples/text_labels_and_annotations/usetex_baseline_test.py

@@ -11,7 +11,6 @@
 
 from matplotlib import rcParams
 rcParams['text.usetex'] = True
-rcParams['text.latex.unicode'] = True
 
 
 class Axes(maxes.Axes):

lib/matplotlib/__init__.py

@@ -820,8 +820,10 @@ def gen_candidates():
     'axes.hold': ('2.1',),
     'backend.qt4': ('2.2',),
     'backend.qt5': ('2.2',),
+    'text.latex.unicde': ('3.0',),
 }
 
+
 _all_deprecated = {*_deprecated_map, *_deprecated_ignore_map}
 
 

lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle

@@ -109,8 +109,6 @@ text.usetex         : False  # use latex for all text handling. The following fo
                              # If another font is desired which can loaded using the
                              # LaTeX \usepackage command, please inquire at the
                              # matplotlib mailing list
-text.latex.unicode : False # use "ucs" and "inputenc" LaTeX packages for handling
-                           # unicode strings.
 text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURES
                            # AND IS THEREFORE UNSUPPORTED. PLEASE DO NOT ASK FOR HELP
                            # IF THIS FEATURE DOES NOT DO WHAT YOU EXPECT IT TO.

lib/matplotlib/mpl-data/stylelib/classic.mplstyle

@@ -111,8 +111,6 @@ text.usetex         : False  # use latex for all text handling. The following fo
                              # If another font is desired which can loaded using the
                              # LaTeX \usepackage command, please inquire at the
                              # matplotlib mailing list
-text.latex.unicode : False # use "ucs" and "inputenc" LaTeX packages for handling
-                           # unicode strings.
 text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURES
                            # AND IS THEREFORE UNSUPPORTED. PLEASE DO NOT ASK FOR HELP
                            # IF THIS FEATURE DOES NOT DO WHAT YOU EXPECT IT TO.

lib/matplotlib/rcsetup.py

@@ -1100,7 +1100,7 @@ def _validate_linestyle(ls):
     # text props
     'text.color':          ['black', validate_color],
     'text.usetex':         [False, validate_bool],
-    'text.latex.unicode':  [False, validate_bool],
+    'text.latex.unicode':  [True, validate_bool],
     'text.latex.preamble': [[''], validate_stringlist],
     'text.latex.preview':  [False, validate_bool],
     'text.dvipnghack':     [None, validate_bool_maybe_none],

lib/matplotlib/tests/test_backend_ps.py

@@ -32,11 +32,11 @@
     needs_ghostscript(
         ('ps', False, {'ps.usedistiller': 'ghostscript'})),
     needs_usetex(needs_ghostscript(
-        ('ps', False, {'text.latex.unicode': True, 'text.usetex': True}))),
+        ('ps', False, {'text.usetex': True}))),
     ('eps', False, {}),
     ('eps', True, {'ps.useafm': True}),
     needs_usetex(needs_ghostscript(
-        ('eps', False, {'text.latex.unicode': True, 'text.usetex': True}))),
+        ('eps', False, {'text.usetex': True}))),
 ], ids=[
     'ps',
     'ps with distiller',

lib/matplotlib/tests/test_rcparams.py

@@ -463,7 +463,8 @@ def test_if_rctemplate_is_up_to_date():
             continue
         if k in deprecated:
             continue
-        if k.startswith(("verbose.", "examples.directory")):
+        if k.startswith(
+                ("verbose.", "examples.directory", "text.latex.unicode")):
             continue
         found = False
         for line in rclines: