bpo-33710: Deprecate l*gettext() and related functions in the gettext module. (GH-10139)
They return encoded bytes and are Python 2 artifacts.
diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst
index 93748a2..0a9456a 100644
--- a/Doc/library/gettext.rst
+++ b/Doc/library/gettext.rst
@@ -53,6 +53,8 @@
and :func:`ldngettext` functions.
If *codeset* is omitted, then the current binding is returned.
+ .. deprecated-removed:: 3.8 3.10
+
.. function:: textdomain(domain=None)
@@ -112,9 +114,9 @@
Unicode strings instead, since most Python applications will want to
manipulate human readable text as strings instead of bytes. Further,
it's possible that you may get unexpected Unicode-related exceptions
- if there are encoding problems with the translated strings. It is
- possible that the ``l*()`` functions will be deprecated in future Python
- versions due to their inherent problems and limitations.
+ if there are encoding problems with the translated strings.
+
+ .. deprecated-removed:: 3.8 3.10
Note that GNU :program:`gettext` also defines a :func:`dcgettext` method, but
@@ -192,6 +194,9 @@
.. versionchanged:: 3.3
:exc:`IOError` used to be raised instead of :exc:`OSError`.
+ .. deprecated-removed:: 3.8 3.10
+ The *codeset* parameter.
+
.. function:: install(domain, localedir=None, codeset=None, names=None)
@@ -212,6 +217,9 @@
builtins namespace, so it is easily accessible in all modules of your
application.
+ .. deprecated-removed:: 3.8 3.10
+ The *codeset* parameter.
+
The :class:`NullTranslations` class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -272,6 +280,8 @@
These methods should be avoided in Python 3. See the warning for the
:func:`lgettext` function.
+ .. deprecated-removed:: 3.8 3.10
+
.. method:: info()
@@ -288,11 +298,15 @@
Return the encoding used to return translated messages in :meth:`.lgettext`
and :meth:`.lngettext`.
+ .. deprecated-removed:: 3.8 3.10
+
.. method:: set_output_charset(charset)
Change the encoding used to return translated messages.
+ .. deprecated-removed:: 3.8 3.10
+
.. method:: install(names=None)
@@ -393,6 +407,8 @@
These methods should be avoided in Python 3. See the warning for the
:func:`lgettext` function.
+ .. deprecated-removed:: 3.8 3.10
+
Solaris message catalog support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/Doc/whatsnew/3.8.rst b/Doc/whatsnew/3.8.rst
index a094921..05b7d23 100644
--- a/Doc/whatsnew/3.8.rst
+++ b/Doc/whatsnew/3.8.rst
@@ -295,6 +295,23 @@
versions. :class:`~ast.Constant` should be used instead.
(Contributed by Serhiy Storchaka in :issue:`32892`.)
+* The following functions and methods are deprecated in the :mod:`gettext`
+ module: :func:`~gettext.lgettext`, :func:`~gettext.ldgettext`,
+ :func:`~gettext.lngettext` and :func:`~gettext.ldngettext`.
+ They return encoded bytes, and it's possible that you will get unexpected
+ Unicode-related exceptions if there are encoding problems with the
+ translated strings. It's much better to use alternatives which return
+ Unicode strings in Python 3. These functions have been broken for a long time.
+
+ Function :func:`~gettext.bind_textdomain_codeset`, methods
+ :meth:`~gettext.NullTranslations.output_charset` and
+ :meth:`~gettext.NullTranslations.set_output_charset`, and the *codeset*
+ parameter of functions :func:`~gettext.translation` and
+ :func:`~gettext.install` are also deprecated, since they are only used for
+ for the ``l*gettext()`` functions.
+
+ (Contributed by Serhiy Storchaka in :issue:`33710`.)
+
Removed
=======