FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Doc: tell 3.11 upgraders to remove the pre-shaping workaround by Syamjith-NK · Pull Request #32263 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Doc: tell 3.11 upgraders to remove the pre-shaping workaround #32263

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
ksunden merged 3 commits into from
Sep 4, 2026
Conversation 10 Commits 3 Checks 22 Files changed
Merged

Doc: tell 3.11 upgraders to remove the pre-shaping workaround #32263

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4e501a
Doc: note that Matplotlib shapes complex scripts itself since 3.11
Aug 30, 2026
4441b4c
Doc: tell 3.11 upgraders to remove the pre-shaping workaround
Sep 1, 2026
7a27c62
Doc: name the pre-processed string so the override snippet resolves
Syamjith-NK Sep 4, 2026
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
30 changes: 30 additions & 0 deletions doc/release/prev_whats_new/whats_new_3.11.0.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
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))

tacaswell Sep 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

do we want to include the imports? On the hand, it makes the code more understandable to people who are not already using these, but on the other hand if you do not already recognize these functions, this note is not for you.

ksunden Sep 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think it is likely fine without the imports, though get_display is a little generic of a name.

Overall, though, the context is pretty clear and this is an example of workarounds that people previously did, not a suggestion of something to do, which makes it easier to justify a shorter snippet.
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
Loading
Back | FazBrowse Home | New Git URL