Enable windows/arm64 platform #22429

niyas-sait · 2022-02-08T13:22:56Z

The patch adds support for building matplotlib for windows on arm64 platforms with FreeType 2.11.

Changes to compile with FreeType 2.11.1
Add MSBuild platform selection for ARM64
Add support for static builds for FreeType versions 2.10 and above

Few tests fail on windows on arm target due to minor mismatches in reference images used for the test. This seems to be due to the FreeType version upgrade required for win/arm64 platform. Similar tests are failing for win/x64 as well with the latest FreeType. Reference images probably need to be upgraded with the latest FreeType for all of them to pass correctly.

PR Summary

PR Checklist

Tests and Styling

Has pytest style unit tests (and pytest passes).
Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

tacaswell · 2022-02-09T17:37:36Z

Why does ARM require freetype 2.11.0?

I would quible a bit with the wording of "support", we have always supported newer versions of freetype (and the linux distributions regularly ship Matplotlib with newer versions), but due to changes in the text layout, many of our tests will fail if you do not user FT2.6.1.

niyas-sait · 2022-02-09T17:51:57Z

Why does ARM require freetype 2.11.0?

Freetype cannot be built for arm64 for earlier versions. MSBuild configurations were missing.

I would quible a bit with the wording of "support", we have always supported newer versions of freetype (and the linux distributions regularly ship Matplotlib with newer versions), but due to changes in the text layout, many of our tests will fail if you do not user FT2.6.1.

Yes, Freetype 2.11.0 seems to generate libraries in a slightly different place, and had to tweak the matplotlib scripts a bit to fix it. That's why I have used the wording supported :-) Happy to change it

niyas-sait · 2022-02-14T17:19:12Z

@tacaswell CI failures seem to be unrelated (looks like a known issue around ghost scripts based on the discussion on gitter). Could you review the patch please?

tacaswell · 2022-02-17T16:15:04Z

lib/matplotlib/__init__.py

@@ -1199,7 +1200,9 @@ def is_interactive():
 def _init_tests():
    # The version of FreeType to install locally for running the
    # tests.  This must match the value in `setupext.py`
-    LOCAL_FREETYPE_VERSION = '2.6.1'
+    win_arm64 = sys.platform.startswith('win') and \


Can you drop this change? Even if the default freetype we will try to build on arm64 in 2.11.1, it is still true that the tests will fail (due to changes in the font rendering) so we should still provide this warning.

I suspect that this (local) variable should have been called VERSION_OF_FREETYPE_THE_TESTS_WORK_WITH ;)

Yes that make sense 👍

Pushed a commit to revert that part.

setupext.py

tacaswell · 2022-02-18T04:03:20Z

@QuLogic Any reason to not pull this back for 3.5.2?

setupext.py

lib/matplotlib/__init__.py

setupext.py

lib/matplotlib/__init__.py

- Add FreeType 2.11.1 support - Add MSBuild platform selection for ARM64 - Add support for static builds for FreeType versions 2.10 and above

Co-authored-by: Thomas A Caswell <[email protected]>

niyas-sait · 2022-02-18T12:53:29Z

codecov tests don't seem happy now! It is not flagging any particular lines. Could it be a rebase issue?

tacaswell · 2022-02-18T17:21:36Z

codecov can lag a bit based on when CI jobs finish. We need all of the jobs to get the full coverage, but codecov will update the issue when it gets most of them.

QuLogic · 2022-02-25T04:18:31Z

Freetype cannot be built for arm64 for earlier versions. MSBuild configurations were missing.

What exactly is the failure? We don't use MSBuild to build bundled FreeType.

niyas-sait · 2022-02-25T06:25:03Z

Freetype cannot be built for arm64 for earlier versions. MSBuild configurations were missing.

What exactly is the failure? We don't use MSBuild to build bundled FreeType.

Previous FreeType versions didn't have the ARM64 specific build configurations.

Don't we use freetype.sln to build FreeType as part of building extensions ? (ref:setupext.py, line 594, do_custom_build)

QuLogic · 2022-02-25T07:01:29Z

No, you're right, I forgot that happens on Windows.

niyas-sait · 2022-03-08T14:02:20Z

Can this be merged?

doc/users/next_whats_new/windows_arm64.rst

setupext.py

tacaswell · 2022-03-10T18:06:47Z

@nsait-linaro I do not fully understand what is going on at the bottom? It looks like it will grab the last path that last path that matches? Do we expect there to ever be more than one path that matches and/or can that path be directly constructed again?

niyas-sait · 2022-03-10T20:42:37Z

@nsait-linaro I do not fully understand what is going on at the bottom? It looks like it will grab the last path that last path that matches? Do we expect there to ever be more than one path that matches and/or can that path be directly constructed again?

@tacaswell There should be only one match as we are building only specific platform at a time. I have done a bit of refactoring to reflect that.

tacaswell · 2022-03-10T21:15:49Z

setupext.py

-            msbuild_platform = (
-                'x64' if platform.architecture()[0] == '64bit' else 'Win32')
-            base_path = Path("build/freetype-2.6.1/builds/windows")
+            is_x64 = platform.architecture()[0] == '64bit'


This is much clearer 👍🏻

tacaswell · 2022-03-10T21:16:28Z

Thank you @nsait-linaro !

I'll merge this as soon as CI finishes.

tacaswell · 2022-03-10T22:59:05Z

@QuLogic do you have any idea what is going on with the flake8 linter?

niyas-sait · 2022-03-11T09:40:08Z

@QuLogic do you have any idea what is going on with the flake8 linter?

Is the 79 character limit per line intentional? I think changes used to pass CI before so I guess a new restriction.

tacaswell · 2022-03-11T17:47:29Z

Is the 79 character limit per line intentional?

Yes and this has been our standard for longer than I have been with the project.

niyas-sait · 2022-03-11T19:13:04Z

Is the 79 character limit per line intentional?

Yes and this has been our standard for longer than I have been with the project.

OK. Fixed that. Good to go

tacaswell · 2022-03-14T16:20:24Z

Thank you @nsait-linaro !

Congratulations on what I think is your first merged Matplotlib PR 🎉 Hopefully we will hear from you again.

niyas-sait · 2022-03-14T16:21:56Z

Thank you @nsait-linaro !

Congratulations on what I think is your first merged Matplotlib PR 🎉 Hopefully we will hear from you again.

Thanks @tacaswell !

…429-on-v3.5.x Backport PR #22429 on branch v3.5.x (Enable windows/arm64 platform)

niyas-sait force-pushed the windows-arm64 branch from 5305ba6 to dc3153b Compare February 8, 2022 13:25

github-actions bot reviewed Feb 8, 2022

View reviewed changes

niyas-sait force-pushed the windows-arm64 branch from 1f3e178 to f394b0b Compare February 15, 2022 12:10

tacaswell reviewed Feb 17, 2022

View reviewed changes

setupext.py Outdated Show resolved Hide resolved

oscargus added status: needs workflow approval For PRs from new contributors, from which GitHub blocks workflows by default. OS: Microsoft labels Feb 17, 2022

tacaswell added this to the v3.5.2 milestone Feb 18, 2022

tacaswell reviewed Feb 18, 2022

View reviewed changes

setupext.py Outdated Show resolved Hide resolved

tacaswell approved these changes Feb 18, 2022

View reviewed changes

anntzer reviewed Feb 18, 2022

View reviewed changes

lib/matplotlib/__init__.py Outdated Show resolved Hide resolved

anntzer reviewed Feb 18, 2022

View reviewed changes

setupext.py Outdated Show resolved Hide resolved

oscargus reviewed Feb 18, 2022

View reviewed changes

lib/matplotlib/__init__.py Outdated Show resolved Hide resolved

niyas-sait and others added 8 commits February 18, 2022 11:09

Enable windows arm64 targets

c32dcc8

- Add FreeType 2.11.1 support - Add MSBuild platform selection for ARM64 - Add support for static builds for FreeType versions 2.10 and above

refactor to skip codecov

df7f8c0

fix linting errors

5d79ce5

revert changes in lib/matplotlib/__init__.py

5595d34

Update setupext.py

1f54d47

Co-authored-by: Thomas A Caswell <[email protected]>

STY: remove trailing whitespace

b509068

Minor clean up to keep the line length bit short

76d2e02

restore empty line missed in __init__.py

af3a7af

niyas-sait force-pushed the windows-arm64 branch from a5b4592 to af3a7af Compare February 18, 2022 11:10

minor refactoring

08cb182

oscargus approved these changes Feb 22, 2022

View reviewed changes

tacaswell reviewed Mar 10, 2022

View reviewed changes

doc/users/next_whats_new/windows_arm64.rst Outdated Show resolved Hide resolved

DOC: tweak tense

a0cb369

tacaswell reviewed Mar 10, 2022

View reviewed changes

setupext.py Outdated Show resolved Hide resolved

tacaswell reviewed Mar 10, 2022

View reviewed changes

setupext.py Outdated Show resolved Hide resolved

tacaswell reviewed Mar 10, 2022

View reviewed changes

setupext.py Outdated Show resolved Hide resolved

niyas-sait added 2 commits March 10, 2022 20:34

Minor clean up and refactoring for freetype lib finding part

4865259

remove next and do a simple list unpacking

e773f93

tacaswell reviewed Mar 10, 2022

View reviewed changes

tacaswell approved these changes Mar 10, 2022

View reviewed changes

fix line length: keep < 79 char

4e05fa3

tacaswell merged commit d7828f3 into matplotlib:main Mar 14, 2022

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 14, 2022

Backport PR matplotlib#22429: Enable windows/arm64 platform

8488139

meeseeksmachine mentioned this pull request Mar 14, 2022

Backport PR #22429 on branch v3.5.x (Enable windows/arm64 platform) #22647

Merged

This was referenced Mar 14, 2022

Add packaging to setup_requires? #22648

Closed

BLD: require packaging in setup_requires #22649

Closed

QuLogic pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 16, 2022

Backport PR matplotlib#22429: Enable windows/arm64 platform

d324055

tacaswell added a commit that referenced this pull request Mar 17, 2022

Merge pull request #22647 from meeseeksmachine/auto-backport-of-pr-22…

560681c

…429-on-v3.5.x Backport PR #22429 on branch v3.5.x (Enable windows/arm64 platform)

Uh oh!

Enable windows/arm64 platform #22429

Enable windows/arm64 platform #22429

Uh oh!

Conversation

niyas-sait commented Feb 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Feb 9, 2022

Uh oh!

niyas-sait commented Feb 9, 2022

Uh oh!

niyas-sait commented Feb 14, 2022

Uh oh!

tacaswell Feb 17, 2022

Choose a reason for hiding this comment

Uh oh!

niyas-sait Feb 17, 2022

Choose a reason for hiding this comment

Uh oh!

niyas-sait Feb 17, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tacaswell commented Feb 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

niyas-sait commented Feb 18, 2022

Uh oh!

tacaswell commented Feb 18, 2022

Uh oh!

QuLogic commented Feb 25, 2022

Uh oh!

niyas-sait commented Feb 25, 2022

Uh oh!

QuLogic commented Feb 25, 2022

Uh oh!

niyas-sait commented Mar 8, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tacaswell commented Mar 10, 2022

Uh oh!

niyas-sait commented Mar 10, 2022

Uh oh!

tacaswell Mar 10, 2022

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Mar 10, 2022

Uh oh!

tacaswell commented Mar 10, 2022

Uh oh!

niyas-sait commented Mar 11, 2022

Uh oh!

tacaswell commented Mar 11, 2022

Uh oh!

niyas-sait commented Mar 11, 2022

Uh oh!

tacaswell commented Mar 14, 2022

Uh oh!

niyas-sait commented Mar 14, 2022

Uh oh!

Uh oh!

niyas-sait commented Feb 8, 2022 •

edited

Loading