gh-71042: Add `platform.android_ver` by mhsmith · Pull Request #116674 · python/cpython

mhsmith · 2024-03-12T19:22:23Z

This PR implements the platform.android_ver function specified in PEP 738.

It also uses the new function to do the following:

Implement platform.system and platform.release as specified in the PEP
Skip tests of some socket functionality which is broken on older versions of Android

📚 Documentation preview 📚: https://cpython-previews--116674.org.readthedocs.build/

willingc

@mhsmith I did a quick look over the docs and made a couple of comments.

mhsmith · 2024-03-25T18:36:25Z

Consistent with iOS in #117052, I've removed the min_api_level field, which was always a bit out of place because it isn't a property of the current device. This information is still available from sys.getandroidapilevel, and will also be added to sysconfig.get_platform in a future PR.

bedevere-bot · 2024-03-25T20:56:44Z

🤖 New build scheduled with the buildbot fleet by @FFY00 for commit 646441b 🤖

If you want to schedule another build, you need to add the 🔨 test-with-buildbots label again.

FFY00

This looks good to me. Thank you @mhsmith!

Co-authored-by: Victor Stinner <vstinner@python.org>

mhsmith · 2024-03-26T18:53:53Z

Sorry for the late change, but I've also added an is_emulator field, similar to the is_simulator field in platform.ios_ver (#117052). The names match the terminology used on each platform, which makes sense because both of them are platform-specific APIs.

Since Android emulators and physical devices use the same ABI, I didn't originally think there was any need for this flag. But I've now found two cases where small-scale timing issues prevent some emulators from running a test reliably:

One of these already had a workaround at setswitchinterval in test/support/__init__.py, so I've updated that to use the new API, and also limited the workaround to old versions of Android, based on my tests.
The other is in the timerfd tests, and will be added to #117223 after this PR is merged.

mhsmith · 2024-03-27T12:02:57Z

@vstinner: Are you able to merge this?

vstinner

The change mostly LGTM, but here is another round of review.

vstinner · 2024-03-27T12:37:57Z

+
+   * ``release`` - Android version, as a string (e.g. ``"14"``)
+
+   * ``api_level`` - API level, as an integer (e.g. ``34``)


Would you mind to repeat here the difference with https://docs.python.org/dev/library/sys.html#sys.getandroidapilevel and so add a reference to the sys function?

Good idea; done.

vstinner · 2024-03-27T12:42:20Z

+                    # a missing one.
+                    return default
+                else:
+                    return buffer.value.decode("UTF-8", "backslashreplace")


Did you consider "surrogateescape" to not lose information? The caller can then decide how to handle surrogate characters. Did you see strings which cannot be decoded from UTF-8 in practice?

I haven't seen such strings, but this function is likely to be used when building error reports, so perfect round-tripping is less important than making sure it doesn't cause any errors itself.

For that reason, I'd prefer not to use surrogateescape, because surrogates can't be turned back into bytes unless the encode call uses surrogateescape as well, which is something we have no control over, and something the programmer is very unlikely to test.

vstinner · 2024-03-27T12:44:00Z

+    if sys.platform == 'android':
+        call_func(info_add, 'platform.android_ver', platform, 'android_ver')


FYI you can just call:

Suggested change

if sys.platform == 'android':

call_func(info_add, 'platform.android_ver', platform, 'android_ver')

call_func(info_add, 'platform.android_ver', platform, 'android_ver')

It does nothing if the function doesn't exist.

Like the other platform.*_ver functions, android_ver does exist on all platforms, but returns empty values when not running on Android. There's no point in cluttering the report in that case.

Co-authored-by: Victor Stinner <vstinner@python.org>

…getandroidapilevel()

vstinner · 2024-03-27T16:53:37Z

Merged, thanks. Welcome Android :-)

Add platform.android_ver

ead6dcb

mhsmith requested review from 1st1, asvetlov, gvanrossum, kumaraditya303 and willingc as code owners March 12, 2024 19:22

bedevere-app Bot added the awaiting review label Mar 12, 2024

bedevere-app Bot mentioned this pull request Mar 12, 2024

android: add platform.android_ver() #71042

Closed

Documentation fixes

8934a4e

mhsmith commented Mar 12, 2024

View reviewed changes

Comment thread Lib/test/test_platform.py

mhsmith mentioned this pull request Mar 13, 2024

UDPLITE tests fail on android #83032

Closed

Skip UDPLITE tests before API level 29

4dca7c4

willingc reviewed Mar 13, 2024

View reviewed changes

Comment thread Doc/library/platform.rst Outdated

mhsmith added 2 commits March 25, 2024 18:02

Clarify model and device name documentation

4108dfc

Remove min_api_level field

646441b

FFY00 added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Mar 25, 2024

bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label Mar 25, 2024

FFY00 approved these changes Mar 25, 2024

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels Mar 25, 2024

mhsmith mentioned this pull request Mar 26, 2024

gh-108277: Make test_os tolerate 10 ms diff for timerfd on Android emulators #117223

Merged

vstinner reviewed Mar 26, 2024

View reviewed changes

Comment thread Lib/test/pythoninfo.py Outdated

Comment thread Lib/test/test_asyncio/test_base_events.py Outdated

Comment thread Lib/test/test_platform.py Outdated

Comment thread Lib/test/test_socket.py Outdated

Comment thread Lib/platform.py

Comment thread Lib/platform.py Outdated

mhsmith and others added 2 commits March 26, 2024 18:23

Add is_emulator field

4f65e8e

Apply suggestions from code review

9fd7f44

Co-authored-by: Victor Stinner <vstinner@python.org>

vstinner reviewed Mar 27, 2024

View reviewed changes

Apply suggestions from code review

b64f1f5

Co-authored-by: Victor Stinner <vstinner@python.org>

Clarify distinction between platform.android_ver().api_level and sys.…

53e6511

…getandroidapilevel()

mhsmith requested a review from vstinner March 27, 2024 16:14

vstinner merged commit 74c8568 into python:main Mar 27, 2024

bedevere-app Bot removed the awaiting merge label Mar 27, 2024

mhsmith mentioned this pull request Sep 20, 2024

PEP 738: Mark as Final python/peps#3982

Merged

6 tasks


		* ``release`` - Android version, as a string (e.g. ``"14"``)

		* ``api_level`` - API level, as an integer (e.g. ``34``)

		if sys.platform == 'android':
		call_func(info_add, 'platform.android_ver', platform, 'android_ver')

Uh oh!

Uh oh!

Conversation

mhsmith commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

willingc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mhsmith commented Mar 25, 2024

Uh oh!

bedevere-bot commented Mar 25, 2024

Uh oh!

FFY00 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mhsmith commented Mar 26, 2024

Uh oh!

mhsmith commented Mar 27, 2024

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

vstinner Mar 27, 2024

Choose a reason for hiding this comment

Uh oh!

mhsmith Mar 27, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vstinner Mar 27, 2024

Choose a reason for hiding this comment

Uh oh!

mhsmith Mar 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vstinner Mar 27, 2024

Choose a reason for hiding this comment

Uh oh!

mhsmith Mar 27, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vstinner commented Mar 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mhsmith commented Mar 12, 2024 •

edited

Loading

mhsmith Mar 27, 2024 •

edited

Loading