Figure.text: Support non-ASCII characters in the 'text' parameter #2638

seisman · 2023-08-21T15:15:37Z

Description of proposed changes

Address #2204 following #2584.

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
If adding new functionality, add an example to docstrings or tutorials.
Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

seisman · 2023-08-21T15:18:05Z

Here is the baseline image generated by the new test:

I'm having some technical difficulties when running dvc push so can't push it to DAGsHub.

github-actions · 2023-08-22T23:41:45Z

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status	Path
added	pygmt/tests/baseline/test_text_nonascii.png

Image diff(s)

Added images

test_text_nonascii.png

Modified images

Path	Old	New

Report last updated at commit 05f2299

seisman · 2023-08-22T23:43:23Z

I'm having some technical difficulties when running dvc push so can't push it to DAGsHub.

Suddenly it works for me. It may be some network issues yesterday.

pygmt/src/text.py

Co-authored-by: Yvonne Fröhlich <[email protected]>

weiji14 · 2023-08-25T00:35:28Z

pygmt/src/text.py

@@ -223,7 +230,9 @@ def text_(

    # Append text at last column. Text must be passed in as str type.
    if kind == "vectors":
-        extra_arrays.append(np.atleast_1d(text).astype(str))
+        extra_arrays.append(
+            list(map(non_ascii_to_octal, np.atleast_1d(text).astype(str)))


This would be a list of numpy arrays, instead of being just a numpy array? Is there a way to keep it as a numpy array?

Changed to np.vectorize in 85a0926.

weiji14 · 2023-08-25T00:38:42Z

pygmt/tests/test_text.py

+    fig.text(position="TL", text="position-text:°α")
+    fig.text(x=1, y=1, text="xytext:°α")
+    fig.text(x=[5, 5], y=[3, 5], text=["xytext1:°α", "xytext2:°α"])


Mix in some Symbol and ZapfDingbats characters too from https://docs.generic-mapping-tools.org/latest/cookbook/octal-codes.html#octal-codes-symbol-zap?

Done in adf6eda.

seisman · 2023-08-25T01:24:32Z

The new test fails, because I generated the baseline image using gs 9.56.1 but our CI is still using gs 9.54, but why can't the CI use gs 9.56.1?

weiji14 · 2023-08-25T01:51:49Z

The new test fails, because I generated the baseline image using gs 9.56.1 but our CI is still using gs 9.54, but why can't the CI use gs 9.56.1?

Ghostscript 9.56.1 was just released 3 days ago on conda-forge - https://anaconda.org/conda-forge/ghostscript/files?version=9.56.1. I can also install 9.56.1 on my system, so not sure why CI still uses gs 9.54, let me check the dependency graph.

weiji14 · 2023-08-25T02:09:32Z

Actually, maybe we don't want gs 9.56.1 for now 😅 I just ran make test locally with gs 9.56.1 and got 180 failed unit tests, pretty much all due to tiny image differences...

seisman · 2023-08-25T02:24:22Z

Actually, maybe we don't want gs 9.56.1 for now 😅 I just ran make test locally with gs 9.56.1 and got 193 failed unit tests, pretty much all due to tiny image differences...

OK. I think we can use gs 9.54 now.

FYI, gs 10.02.0 is likely the next gs version that doesn't have serious bugs (GenericMappingTools/gmt#7336 (comment)) and it's likely to be released soon (rc1 is already been released). I think we should only update these baseline images when gs 10.02.0 is out.

weiji14 · 2023-08-25T02:34:20Z

Actually, maybe we don't want gs 9.56.1 for now 😅 I just ran make test locally with gs 9.56.1 and got 193 failed unit tests, pretty much all due to tiny image differences...

OK. I think we can use gs 9.54 now.

FYI, gs 10.02.0 is likely the next gs version that doesn't have serious bugs (GenericMappingTools/gmt#7336 (comment)) and it's likely to be released soon (rc1 is already been released). I think we should only update these baseline images when gs 10.02.0 is out.

Sounds good, better to update the baseline images once for gs 10.02 rather than twice, we can track the ghostscript 10.0 release on conda-forge at conda-forge/ghostscript-feedstock#26. Just realized that you put out the gs 9.56.1 package 😆

weiji14

Looks good to me. The 16 failing tests on CI will be fixed in #2636, so can safely ignore.

Tenth minor release of PyGMT. * Add changelog entry to version switcher * Update compatibility table * Update citation * Add draft changelog * Add full names of contributors to changelog * Add two highlight bullet points * Combine non-ASCII character PRs #2638 and #2584 into one highlight point * Swap author positions for Dongdong and Leo * Change release date to 20230902 * Move Yvonne up a few spots --------- Co-authored-by: Yvonne Fröhlich <[email protected]> Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Michael Grund <[email protected]>

Figure.text: Support non-ASCII characters in the 'text' parameter

547f51b

seisman added the feature Brand new feature label Aug 21, 2023

seisman added this to the 0.10.0 milestone Aug 21, 2023

seisman added the needs review This PR has higher priority and needs review. label Aug 22, 2023

michaelgrund approved these changes Aug 22, 2023

View reviewed changes

Merge branch 'main' into text-non-ascii

d823169

Add docstrings to emphasize the support of non-ASCII characters

30ae4c1

seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Aug 22, 2023

yvonnefroehlich reviewed Aug 23, 2023

View reviewed changes

pygmt/src/text.py Outdated Show resolved Hide resolved

Fix a typo

73b919f

Co-authored-by: Yvonne Fröhlich <[email protected]>

weiji14 mentioned this pull request Aug 25, 2023

Release PyGMT v0.10.0 #2640

Closed

35 tasks

weiji14 reviewed Aug 25, 2023

View reviewed changes

seisman added 2 commits August 25, 2023 08:51

Use np.vectorize to make non_ascii_to_octal work with numpy arrays

85a0926

Update the test with more characters from Symbol and ZapfDingbats

adf6eda

Regenerate the baseline image using gs 9.54

05f2299

weiji14 approved these changes Aug 25, 2023

View reviewed changes

seisman merged commit 604d077 into main Aug 25, 2023

seisman deleted the text-non-ascii branch August 25, 2023 02:53

seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 25, 2023

seisman mentioned this pull request Aug 25, 2023

Support non-ASCII characters in PyGMT arguments and text in Figure.text #2204

Closed

weiji14 added a commit that referenced this pull request Sep 1, 2023

Combine non-ASCII character PRs #2638 and #2584 into one highlight point

81dfe9d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Figure.text: Support non-ASCII characters in the 'text' parameter #2638

Figure.text: Support non-ASCII characters in the 'text' parameter #2638

seisman commented Aug 21, 2023 •

edited

Loading

seisman commented Aug 21, 2023

github-actions bot commented Aug 22, 2023 •

edited

Loading

Added images

Modified images

seisman commented Aug 22, 2023

weiji14 Aug 25, 2023

seisman Aug 25, 2023

weiji14 Aug 25, 2023

seisman Aug 25, 2023

seisman commented Aug 25, 2023

weiji14 commented Aug 25, 2023

weiji14 commented Aug 25, 2023 •

edited

Loading

seisman commented Aug 25, 2023

weiji14 commented Aug 25, 2023 •

edited

Loading

weiji14 left a comment

Figure.text: Support non-ASCII characters in the 'text' parameter #2638

Figure.text: Support non-ASCII characters in the 'text' parameter #2638

Conversation

seisman commented Aug 21, 2023 • edited Loading

seisman commented Aug 21, 2023

github-actions bot commented Aug 22, 2023 • edited Loading

Summary of changed images

Image diff(s)

Added images

Modified images

seisman commented Aug 22, 2023

weiji14 Aug 25, 2023

Choose a reason for hiding this comment

seisman Aug 25, 2023

Choose a reason for hiding this comment

weiji14 Aug 25, 2023

Choose a reason for hiding this comment

seisman Aug 25, 2023

Choose a reason for hiding this comment

seisman commented Aug 25, 2023

weiji14 commented Aug 25, 2023

weiji14 commented Aug 25, 2023 • edited Loading

seisman commented Aug 25, 2023

weiji14 commented Aug 25, 2023 • edited Loading

weiji14 left a comment

Choose a reason for hiding this comment

seisman commented Aug 21, 2023 •

edited

Loading

github-actions bot commented Aug 22, 2023 •

edited

Loading

weiji14 commented Aug 25, 2023 •

edited

Loading

weiji14 commented Aug 25, 2023 •

edited

Loading