Fix android detection when python4android is present #277

tmolitor-stud-tu · 2024-04-28T20:06:07Z

When using platformdirs in an android app located on adopted storage, _android_folder() in android.py returned None which lead platformdirs to believe that it doesn't run on android and use the Unix flavor instead.

In android.py#L126 autoclass("android.content.Context") returns a class instead of an instance, which throws an exception on the next line trying to access an instance method named getFilesDir().

That exception is catched and a fallback implementation invoked, that uses a regular expression to search in sys.path for an import path rooted in /data. Apps installed on adopted storage don't have such paths but begin with /mnt/expand/ instead.
The regular expression therefore fails and _android_folder() returns None.

This pull request fixes the issue at least for cases where python4android is available, by first trying to import the android module and using it's mActivity export to get hold of the main activity. That activity is then used to get a proper application context upon which getFilesDir() can be invoked.

If that fails with an exception the original codepath is taken, trying the autoclassapproach next and if that fails resorting to the regular expression.

gaborbernat

Test and fix typecheker.

tmolitor-stud-tu · 2024-05-10T03:48:31Z

done

Use the builtin mActivity of python4android to get hold of our main activity, which is capable of generating a proper application context.

gaborbernat

Please add tests 👍

for more information, see https://pre-commit.ci

tmolitor-stud-tu · 2024-05-14T11:54:55Z

I've added a test with a mocked android import (test_android_folder_from_p4a) and I also added an adopted storage path to test_android_folder_from_sys_path and adapted the implementation to do a regex fallback for adopted storage, too.

tests/test_android.py

src/platformdirs/android.py

gaborbernat

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [coverage](https://togithub.com/nedbat/coveragepy) | `==7.5.1` -> `==7.5.3` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/coverage/7.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/coverage/7.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/coverage/7.5.1/7.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/coverage/7.5.1/7.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [cryptography](https://togithub.com/pyca/cryptography) ([changelog](https://cryptography.io/en/latest/changelog/)) | `==42.0.7` -> `==42.0.8` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/cryptography/42.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/cryptography/42.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/cryptography/42.0.7/42.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/cryptography/42.0.7/42.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [freezegun](https://togithub.com/spulec/freezegun) ([changelog](https://togithub.com/spulec/freezegun/blob/master/CHANGELOG)) | `==1.5.0` -> `==1.5.1` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/freezegun/1.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/freezegun/1.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/freezegun/1.5.0/1.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/freezegun/1.5.0/1.5.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [platformdirs](https://togithub.com/platformdirs/platformdirs) | `==4.2.1` -> `==4.2.2` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/platformdirs/4.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/platformdirs/4.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/platformdirs/4.2.1/4.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/platformdirs/4.2.1/4.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>nedbat/coveragepy (coverage)</summary> ### [`v7.5.3`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-753--2024-05-28) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.5.2...7.5.3) - Performance improvements for combining data files, especially when measuring line coverage. A few different quadratic behaviors were eliminated. In one extreme case of combining 700+ data files, the time dropped from more than three hours to seven minutes. Thanks for Kraken Tech for funding the fix. - Performance improvements for generating HTML reports, with a side benefit of reducing memory use, closing `issue 1791`\_. Thanks to Daniel Diniz for helping to diagnose the problem. .. \_issue 1791:[nedbat/coveragepy#1791 .. \_changes\_7-5-2: ### [`v7.5.2`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-752--2024-05-24) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.5.1...7.5.2) - Fix: nested matches of exclude patterns could exclude too much code, as reported in `issue 1779`\_. This is now fixed. - Changed: previously, coverage.py would consider a module docstring to be an executable statement if it appeared after line 1 in the file, but not executable if it was the first line. Now module docstrings are never counted as executable statements. This can change coverage.py's count of the number of statements in a file, which can slightly change the coverage percentage reported. - In the HTML report, the filter term and "hide covered" checkbox settings are remembered between viewings, thanks to `Daniel Diniz <pull 1776_>`\_. - Python 3.13.0b1 is supported. - Fix: parsing error handling is improved to ensure bizarre source files are handled gracefully, and to unblock oss-fuzz fuzzing, thanks to `Liam DeVoe <pull 1788_>`*. Closes `issue 1787`*. .. \_pull 1776:[nedbat/coveragepy#1776 .. \_issue 1779[nedbat/coveragepy#1779 .. \_issue 178[nedbat/coveragepy#1787 .. \_pull 17[nedbat/coveragepy#1788 .. \_changes\_7-5-1: </details> <details> <summary>pyca/cryptography (cryptography)</summary> ### [`v42.0.8`](https://togithub.com/pyca/cryptography/compare/42.0.7...42.0.8) [Compare Source](https://togithub.com/pyca/cryptography/compare/42.0.7...42.0.8) </details> <details> <summary>spulec/freezegun (freezegun)</summary> ### [`v1.5.1`](https://togithub.com/spulec/freezegun/blob/HEAD/CHANGELOG#151) [Compare Source](https://togithub.com/spulec/freezegun/compare/1.5.0...1.5.1) - Fix the typing of the `tick()` method, and improve it's behaviour. </details> <details> <summary>platformdirs/platformdirs (platformdirs)</summary> ### [`v4.2.2`](https://togithub.com/platformdirs/platformdirs/releases/tag/4.2.2) [Compare Source](https://togithub.com/platformdirs/platformdirs/compare/4.2.1...4.2.2)  #### What's Changed - Fix android detection when python4android is present by [@tmolitor-stud-tu](https://togithub.com/tmolitor-stud-tu) in [platformdirs/platformdirs#277 #### New Contributors - [@tmolitor-stud-tu](https://togithub.com/tmolitor-stud-tu) made their first contribution in [platformdirs/platformdirs#277 **Full Changelog**: platformdirs/platformdirs@4.2.1...4.2.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/canonical/charmcraft).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

tmolitor-stud-tu requested review from gaborbernat, ofek, Julian and RonnyPfannschmidt as code owners April 28, 2024 20:06

gaborbernat requested changes May 3, 2024

View reviewed changes

tmolitor-stud-tu force-pushed the main branch 4 times, most recently from d4b9c33 to 9be26e1 Compare May 10, 2024 03:41

tmolitor-stud-tu requested a review from gaborbernat May 10, 2024 03:48

Fix android detection when python4android is present

70abe62

Use the builtin mActivity of python4android to get hold of our main activity, which is capable of generating a proper application context.

tmolitor-stud-tu force-pushed the main branch from 9be26e1 to 70abe62 Compare May 10, 2024 03:49

gaborbernat requested changes May 13, 2024

View reviewed changes

gaborbernat and others added 4 commits May 13, 2024 10:14

Merge branch 'main' into main

c72dcab

Add pcre implementation covering android adopted storage

3222282

Implement tests

bfcc352

[pre-commit.ci] auto fixes from pre-commit.com hooks

9ea77af

for more information, see https://pre-commit.ci

tmolitor-stud-tu force-pushed the main branch from ec185b0 to cb4784a Compare May 14, 2024 12:02

Make stupid linter happy

9cd764c

tmolitor-stud-tu force-pushed the main branch from cb4784a to 9cd764c Compare May 14, 2024 12:03

tmolitor-stud-tu requested a review from gaborbernat May 14, 2024 12:05

Merge branch 'main' into main

f4d9c9c

gaborbernat requested changes May 14, 2024

View reviewed changes

tests/test_android.py Outdated Show resolved Hide resolved

Change casing once again

4ba6376

tmolitor-stud-tu force-pushed the main branch from 4737807 to 4ba6376 Compare May 14, 2024 15:37

gaborbernat requested changes May 14, 2024

View reviewed changes

src/platformdirs/android.py Outdated Show resolved Hide resolved

tmolitor-stud-tu added 2 commits May 14, 2024 21:18

Realign comment

c13e130

Realign other comments, too

0e71fa9

gaborbernat approved these changes May 15, 2024

View reviewed changes

gaborbernat merged commit 5ec69d8 into platformdirs:main May 15, 2024
28 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix android detection when python4android is present #277

Fix android detection when python4android is present #277

tmolitor-stud-tu commented Apr 28, 2024 •

edited

Loading

gaborbernat left a comment

tmolitor-stud-tu commented May 10, 2024

gaborbernat left a comment

tmolitor-stud-tu commented May 14, 2024

gaborbernat left a comment

Fix android detection when python4android is present #277

Fix android detection when python4android is present #277

Conversation

tmolitor-stud-tu commented Apr 28, 2024 • edited Loading

gaborbernat left a comment

Choose a reason for hiding this comment

tmolitor-stud-tu commented May 10, 2024

gaborbernat left a comment

Choose a reason for hiding this comment

tmolitor-stud-tu commented May 14, 2024

gaborbernat left a comment

Choose a reason for hiding this comment

tmolitor-stud-tu commented Apr 28, 2024 •

edited

Loading