Revert the removal of sphinx.util:force_decode()

After the release of 4.0.0, some 3rd party extensions have became not
working with the latest Sphinx because `force_decode()` function was
removed.  It was deprecated since Sphinx-2.0 and warned for the removal
since 3.0.

This reverts the removal and extends its deprecation period to 5.0.0.  I
hope it helps users of these extensions.
This commit is contained in:
Takeshi KOMIYA 2021-06-13 15:46:22 +09:00
parent b7c05a2f5a
commit 519cc078fd
3 changed files with 21 additions and 1 deletions

View File

@ -13,6 +13,9 @@ Deprecated
Features added
--------------
* Revert the removal of ``sphinx.util:force_decode()`` to become some 3rd party
extensions available again during 5.0
Bugs fixed
----------

View File

@ -1015,7 +1015,7 @@ The following is a list of deprecated interfaces.
* - ``sphinx.util.force_decode()``
- 2.0
- 4.0
- 5.0
- N/A
* - ``sphinx.util.get_matching_docs()``

View File

@ -337,6 +337,23 @@ def parselinenos(spec: str, total: int) -> List[int]:
return items
def force_decode(string: str, encoding: str) -> str:
"""Forcibly get a unicode string out of a bytestring."""
warnings.warn('force_decode() is deprecated.',
RemovedInSphinx50Warning, stacklevel=2)
if isinstance(string, bytes):
try:
if encoding:
string = string.decode(encoding)
else:
# try decoding with utf-8, should only work for real UTF-8
string = string.decode()
except UnicodeError:
# last resort -- can't fail
string = string.decode('latin1')
return string
def rpartition(s: str, t: str) -> Tuple[str, str]:
"""Similar to str.rpartition from 2.5, but doesn't return the separator."""
warnings.warn('rpartition() is now deprecated.', RemovedInSphinx50Warning, stacklevel=2)