Support Native Media Gallery Indexing / scanFile API on Android (Serious Python)

Open
#226 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
android, dart, flutter
Domain
mobile

Research direction

Begin by tracing the Flutter client’s Dart-side handler and the proposed MethodChannel entry point, then inspect how Serious Python exposes services to Python. Done means a cross-platform media-scan API is exposed and Android files become visible to the native MediaStore without requiring PyJNIus workarounds.

Written by the indexing model from the issue text.

Description

Context

When building multi-platform Python applications with Flet and compiling them for Android using Serious Python, apps often need to download or save media files (videos, photos, audio) to public user directories (such as the standard Download/ folder).


The Problem

When a file is downloaded or created directly on the filesystem under public storage (e.g., /storage/emulated/0/Download/), other Android apps (like WhatsApp, Instagram, TikTok) and the native system Gallery do not show the new file automatically.

The files are technically present on disk, but they remain invisible to other apps until the user manually opens the Android system File Manager. Opening the File Manager forces a system-level ContentObserver folder scan, which finally registers the files in the Android MediaStore database.


What We Tried (And the JNI / PyJNIus Traps)

We attempted to solve this within Python code using PyJNIus (jnius) to manually trigger the Android MediaScannerConnection.scanFile() API. However, doing this from Python runs into several major JNI and Serious Python structural blocks:

1. PyJNIus Background Thread Attachment Trap

Flet events and background tasks run on Python background worker threads (like asyncio or threading loops). PyJNIus calling Java methods from a background thread fails silently or crashes unless jnius.attach_thread() is explicitly called beforehand.

import jnius
jnius.attach_thread()  # Required, but undocumented and highly prone to runtime errors
2. Changing Host Activity Class Names

To initialize MediaScannerConnection, we need the application Context. In Serious Python, finding the host activity via class lookups is brittle because class names vary between Serious Python versions:

  • Older: com.flet.serious_python_android.PythonActivity
  • Newer: com.flet.serious_python.PythonActivity
  • Fallback lookups like android.app.ActivityThread.currentApplication() frequently return null when called from Python worker threads.
3. JNI Signature Matching Failures

PyJNIus has trouble converting Python list structures to Java String[] array signatures expected by scanFile(Context, String[], String[], OnScanCompletedListener). Developers have to construct Java arrays manually via JNI reflection:

Array = autoclass('java.lang.reflect.Array')
String = autoclass('java.lang.String')
paths_arr = Array.newInstance(String, len(file_paths)) # Brittle reflection setup
4. Android 9+ Implicit Intent Blocks

Fallback intent broadcasts like android.intent.action.MEDIA_SCANNER_SCAN_FILE are ignored on Android 9+ unless explicitly targeted to the Media Provider package (-p com.android.providers.media), making shell-based workarounds highly complex and security-restricted.


Proposed Solution (Feature Request)

To make Flet a truly first-class framework for mobile development, Flet should expose a native, cross-platform media indexing API (for example, page.scan_media(path) or a new page.storage_paths.scan_file(path) service method).

How it should work under the hood:
  1. The Flet Flutter client should handle the media scanner connection natively on the Dart side.
  2. In Dart, triggering a media scan on Android is extremely simple and does not suffer from classloader or background-thread JNI issues:
    // Dart side handler
    import 'package:flutter/services.dart';
    // Native MethodChannel triggers MediaScannerConnection.scanFile on the Android Activity thread
    
  3. By delegating this to the Flutter shell, Python developers wouldn't need to write brittle PyJNIus wrappers, deal with JNI JVM thread-attachments, or worry about changing package class names between Serious Python releases.

This feature is essential for any Flet application that downloads user-facing files (photos, videos, PDF documents, audio) to public directories on Android.

Dominant language
Dart
Stars
324
Forks
47
Avg merge
7h 41m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from flet-dev/serious-python

All issues in flet-dev/serious-python

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.