Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Backport PR #32263 on branch v3.11.0-doc (Doc: tell 3.11 upgraders to remove the pre-shaping workaround) #32299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
QuLogic merged 1 commit into from
Sep 5, 2026
+30 −0
Merged

Backport PR #32263 on branch v3.11.0-doc (Doc: tell 3.11 upgraders to remove the pre-shaping workaround) #32299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions doc/release/prev_whats_new/whats_new_3.11.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -774,6 +774,36 @@ Text support has been extended to include complex text layout. This support incl
Note, all advanced features require corresponding font support, and may require
additional fonts over the builtin DejaVu Sans.

.. admonition:: Remove any pre-shaping workaround
:class: important

Because Matplotlib did not previously reorder text, the usual workaround for
Arabic, Persian, Urdu and Hebrew was to reorder the string before passing it in,
typically with ``arabic_reshaper`` and ``python-bidi``::

preprocessed = get_display(arabic_reshaper.reshape(text))
ax.set_title(preprocessed)

Matplotlib now reorders the string itself, so a string that arrives already in
visual order is reordered a second time and is drawn backwards. Nothing is
raised, and to a reader who does not read the script the result still looks
like correct text, so this is easy to ship without noticing.

- If you can require Matplotlib 3.11, pass the logical string and delete the
pre-processing.
- If you support older versions as well, branch on the Matplotlib version and
pre-process only on the older one.
- If you cannot change the call at all, because the text is handed to a
third-party library that calls Matplotlib for you, wrap the pre-processed
string in ``LEFT-TO-RIGHT OVERRIDE`` and ``POP DIRECTIONAL FORMATTING``::

text = ('\N{LEFT-TO-RIGHT OVERRIDE}' + preprocessed +
'\N{POP DIRECTIONAL FORMATTING}')

That reads correctly on every version. It does not always render
identically, because it draws the font's presentation-form glyphs rather
than the font's own shaping, and some fonts space those differently.

Specifying font feature tags
----------------------------

Expand Down