Added support for aab

Author: misl6

README.md

@@ -9,7 +9,7 @@ python-for-android
 
 python-for-android is a packaging tool for Python apps on Android. You can
 create your own Python distribution including the modules and
-dependencies you want, and bundle it in an APK along with your own code.
+dependencies you want, and bundle it in an APK or AAB along with your own code.
 
 Features include:
 
@@ -20,6 +20,7 @@ Features include:
    sqlalchemy.
 -  Multiple architecture targets, for APKs optimised on any given
    device.
+-  AAB: Android App Bundle support.
 
 For documentation and support, see:
 
@@ -31,7 +32,7 @@ For documentation and support, see:
 
 Follow the [quickstart
 instructions](<https://python-for-android.readthedocs.org/en/latest/quickstart/>)
-to install and begin creating APKs.
+to install and begin creating APKs and AABs.
 
 **Quick instructions**: install python-for-android with:
 
@@ -53,6 +54,8 @@ With everything installed, build an APK with SDL2 with e.g.:
 
     p4a apk --requirements=kivy --private /home/username/devel/planewave_frozen/ --package=net.inclem.planewavessdl2 --name="planewavessdl2" --version=0.5 --bootstrap=sdl2
 
+**If you need to deploy your app on Google Play, Android App Bundle (aab) is required since 1 August 2021:**
+
 **For full instructions and parameter options,** see [the
 documentation](https://python-for-android.readthedocs.io/en/latest/quickstart/#usage).
 

doc/source/quickstart.rst

@@ -213,6 +213,24 @@ You can also replace flask with another web framework.
 Replace ``--port=5000`` with the port on which your app will serve a
 website. The default for Flask is 5000.
 
+Exporting the Android App Bundle (aab) for distributing it on Google Play
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Starting from August 2021 for new apps and from November 2021 for updates to existings apps,
+Google Play Console will require the Android App Bundle instead of the long lived apk.
+
+python-for-android handles by itself the needed work to accomplish the new requirements:
+
+    p4a aab --private $HOME/code/myapp --package=org.example.myapp --name="My App" --version 0.1 --bootstrap=sdl2 --requirements=python3,kivy --arch=arm64-v8a --arch=armeabi-v7a --release
+
+This `p4a aab ...` command builds a distribution with `python3`,
+`kivy`, and everything else you specified in the requirements.
+It will be packaged using a SDL2 bootstrap, and produce
+an `.aab` file that contains binaries for both `armeabi-v7a` and `arm64-v8a` ABIs.
+
+The Android App Bundle, is supposed to be used for distributing your app.
+If you need to test it locally, on your device, you can use `bundletool <https://developer.android.com/studio/command-line/bundletool>`
+
 Other options
 ~~~~~~~~~~~~~
 

pythonforandroid/archs.py

@@ -133,7 +133,7 @@ def get_env(self, with_flags_in_cc=True):
             ctx=self.ctx,
             command_prefix=self.command_prefix,
             python_includes=join(
-                self.ctx.get_python_install_dir(),
+                self.ctx.get_python_install_dir(self.arch),
                 'include/python{}'.format(self.ctx.python_recipe.version[0:3]),
             ),
         )

pythonforandroid/bootstrap.py

@@ -374,7 +374,7 @@ def strip_libraries(self, arch):
         if len(tokens) > 1:
             strip = strip.bake(tokens[1:])
 
-        libs_dir = join(self.dist_dir, '_python_bundle',
+        libs_dir = join(self.dist_dir, f'_python_bundle__{arch.arch}',
                         '_python_bundle', 'modules')
         filens = shprint(sh.find, libs_dir, join(self.dist_dir, 'libs'),
                          '-iname', '*.so', _env=env).stdout.decode('utf-8')

pythonforandroid/bootstraps/common/build/build.py

@@ -267,7 +267,7 @@ def make_package(args):
     # Package up the private data (public not supported).
     use_setup_py = get_dist_info_for("use_setup_py",
                                      error_if_missing=False) is True
-    tar_dirs = [env_vars_tarpath]
+    private_tar_dirs = [env_vars_tarpath]
     _temp_dirs_to_clean = []
     try:
         if args.private:
@@ -277,7 +277,7 @@ def make_package(args):
                     ):
                 print('No setup.py/pyproject.toml used, copying '
                       'full private data into .apk.')
-                tar_dirs.append(args.private)
+                private_tar_dirs.append(args.private)
             else:
                 print("Copying main.py's ONLY, since other app data is "
                       "expected in site-packages.")
@@ -309,10 +309,7 @@ def make_package(args):
                             )
 
                 # Append directory with all main.py's to result apk paths:
-                tar_dirs.append(main_py_only_dir)
-        for python_bundle_dir in ('private', '_python_bundle'):
-            if exists(python_bundle_dir):
-                tar_dirs.append(python_bundle_dir)
+                private_tar_dirs.append(main_py_only_dir)
         if get_bootstrap_name() == "webview":
             for asset in listdir('webview_includes'):
                 shutil.copy(join('webview_includes', asset), join(assets_dir, asset))
@@ -326,8 +323,13 @@ def make_package(args):
                 shutil.copytree(realpath(asset_src), join(assets_dir, asset_dest))
 
         if args.private or args.launcher:
+            for arch in get_dist_info_for("archs"):
+                libs_dir = f"libs/{arch}"
+                make_tar(
+                    join(libs_dir, 'libpybundle.so'), [f'_python_bundle__{arch}'], args.ignore_path,
+                    optimize_python=args.optimize_python)
             make_tar(
-                join(assets_dir, 'private.mp3'), tar_dirs, args.ignore_path,
+                join(assets_dir, 'private.tar'), private_tar_dirs, args.ignore_path,
                 optimize_python=args.optimize_python)
     finally:
         for directory in _temp_dirs_to_clean:
@@ -358,9 +360,6 @@ def make_package(args):
         print("WARNING: Received an --icon_fg or an --icon_bg argument, but not both. "
               "Ignoring.")
 
-    if args.enable_androidx:
-        shutil.copy('templates/gradle.properties', 'gradle.properties')
-
     if get_bootstrap_name() != "service_only":
         lottie_splashscreen = join(res_dir, 'raw/splashscreen.json')
         if args.presplash_lottie:
@@ -410,7 +409,6 @@ def make_package(args):
     version_code = 0
     if not args.numeric_version:
         # Set version code in format (arch-minsdk-app_version)
-        arch = get_dist_info_for("archs")[0]
         arch_dict = {"x86_64": "9", "arm64-v8a": "8", "armeabi-v7a": "7", "x86": "6"}
         arch_code = arch_dict.get(arch, '1')
         min_sdk = args.min_sdk_version
@@ -549,6 +547,12 @@ def make_package(args):
         is_library=(get_bootstrap_name() == 'service_library'),
         )
 
+    # gradle properties
+    render(
+        'gradle.tmpl.properties',
+        'gradle.properties',
+        args=args)
+
     # ant build templates
     render(
         'build.tmpl.xml',

pythonforandroid/bootstraps/common/build/src/main/java/org/kivy/android/PythonUtil.java

@@ -127,7 +127,7 @@ protected static void recursiveDelete(File f) {
         f.delete();
     }
 
-    public static void unpackData(
+    public static void unpackAsset(
         Context ctx,
         final String resource,
         File target,
@@ -170,7 +170,74 @@ public static void unpackData(
             target.mkdirs();
 
             AssetExtract ae = new AssetExtract(ctx);
-            if (!ae.extractTar(resource + ".mp3", target.getAbsolutePath())) {
+            if (!ae.extractTar(resource + ".tar", target.getAbsolutePath(), "private")) {
+                String msg = "Could not extract " + resource + " data.";
+                if (ctx instanceof Activity) {
+                    toastError((Activity)ctx, msg);
+                } else {
+                    Log.v(TAG, msg);
+                }
+            }
+
+            try {
+                // Write .nomedia.
+                new File(target, ".nomedia").createNewFile();
+
+                // Write version file.
+                FileOutputStream os = new FileOutputStream(diskVersionFn);
+                os.write(dataVersion.getBytes());
+                os.close();
+            } catch (Exception e) {
+                Log.w("python", e);
+            }
+        }
+    }
+
+    public static void unpackPyBundle(
+        Context ctx,
+        final String resource,
+        File target,
+        boolean cleanup_on_version_update) {
+
+        Log.v(TAG, "Unpacking " + resource + " " + target.getName());
+
+        // The version of data in memory and on disk.
+        String dataVersion = "p4aisawesome"; // FIXME: Assets method is not usable for fake .so files bundled as a library.
+        String diskVersion = null;
+
+        Log.v(TAG, "Data version is " + dataVersion);
+
+        // If no version, no unpacking is necessary.
+        if (dataVersion == null) {
+            return;
+        }
+
+        // Check the current disk version, if any.
+        String filesDir = target.getAbsolutePath();
+        String diskVersionFn = filesDir + "/" + resource + ".version";
+
+        // FIXME: Keeping that for later. Now it is surely failing.
+        try {
+            byte buf[] = new byte[64];
+            InputStream is = new FileInputStream(diskVersionFn);
+            int len = is.read(buf);
+            diskVersion = new String(buf, 0, len);
+            is.close();
+        } catch (Exception e) {
+            diskVersion = "";
+        }
+
+        // If the disk data is out of date, extract it and write the version file.
+        if (! dataVersion.equals(diskVersion)) {
+            Log.v(TAG, "Extracting " + resource + " assets.");
+
+            if (cleanup_on_version_update) {
+                recursiveDelete(target);
+            }
+            target.mkdirs();
+
+            AssetExtract ae = new AssetExtract(ctx);
+            if (!ae.extractTar(resource + ".so", target.getAbsolutePath(), "pybundle")) {
                 String msg = "Could not extract " + resource + " data.";
                 if (ctx instanceof Activity) {
                     toastError((Activity)ctx, msg);

pythonforandroid/bootstraps/common/build/src/main/java/org/renpy/android/AssetExtract.java

@@ -13,6 +13,7 @@
 import java.io.FileOutputStream;
 import java.io.FileNotFoundException;
 import java.io.File;
+import java.io.FileInputStream;
 
 import java.util.zip.GZIPInputStream;
 
@@ -28,15 +29,20 @@ public AssetExtract(Context context) {
         mAssetManager = context.getAssets();
     }
 
-    public boolean extractTar(String asset, String target) {
+    public boolean extractTar(String asset, String target, String method) {
 
         byte buf[] = new byte[1024 * 1024];
 
         InputStream assetStream = null;
         TarInputStream tis = null;
 
         try {
-            assetStream = mAssetManager.open(asset, AssetManager.ACCESS_STREAMING);
+            if(method == "private"){
+                assetStream = mAssetManager.open(asset, AssetManager.ACCESS_STREAMING);
+            } else if (method == "pybundle") {
+                assetStream = new FileInputStream(asset);
+            }
+            
             tis = new TarInputStream(new BufferedInputStream(new GZIPInputStream(new BufferedInputStream(assetStream, 8192)), 8192));
         } catch (IOException e) {
             Log.e("python", "opening up extract tar", e);

pythonforandroid/bootstraps/common/build/templates/gradle.properties

@@ -0,0 +1,5 @@
+{% if args.enable_androidx %}
+android.useAndroidX=true
+android.enableJetifier=true
+{% endif %}
+android.bundle.enableUncompressedNativeLibs=false

pythonforandroid/bootstraps/common/build/templates/gradle.tmpl.properties

@@ -15,12 +15,7 @@ class SDL2GradleBootstrap(Bootstrap):
     def assemble_distribution(self):
         info_main("# Creating Android project ({})".format(self.name))
 
-        arch = self.ctx.archs[0]
-
-        if len(self.ctx.archs) > 1:
-            raise ValueError("SDL2/gradle support only one arch")
-
-        info("Copying SDL2/gradle build for {}".format(arch))
+        info("Copying SDL2/gradle build")
         shprint(sh.rm, "-rf", self.dist_dir)
         shprint(sh.cp, "-r", self.build_dir, self.dist_dir)
 
@@ -33,23 +28,24 @@ def assemble_distribution(self):
         with current_directory(self.dist_dir):
             info("Copying Python distribution")
 
-            python_bundle_dir = join('_python_bundle', '_python_bundle')
-
-            self.distribute_libs(arch, [self.ctx.get_libs_dir(arch.arch)])
             self.distribute_javaclasses(self.ctx.javaclass_dir,
                                         dest_dir=join("src", "main", "java"))
 
-            ensure_dir(python_bundle_dir)
-            site_packages_dir = self.ctx.python_recipe.create_python_bundle(
-                join(self.dist_dir, python_bundle_dir), arch)
+            for arch in self.ctx.archs:
+                python_bundle_dir = join(f'_python_bundle__{arch.arch}', '_python_bundle')
+                ensure_dir(python_bundle_dir)
+
+                self.distribute_libs(arch, [self.ctx.get_libs_dir(arch.arch)])
+                site_packages_dir = self.ctx.python_recipe.create_python_bundle(
+                    join(self.dist_dir, python_bundle_dir), arch)
+                if not self.ctx.with_debug_symbols:
+                    self.strip_libraries(arch)
+                self.fry_eggs(site_packages_dir)
 
             if 'sqlite3' not in self.ctx.recipe_build_order:
                 with open('blacklist.txt', 'a') as fileh:
                     fileh.write('\nsqlite3/*\nlib-dynload/_sqlite3.so\n')
 
-        if not self.ctx.with_debug_symbols:
-            self.strip_libraries(arch)
-        self.fry_eggs(site_packages_dir)
         super().assemble_distribution()
 
 

pythonforandroid/bootstraps/sdl2/__init__.py

@@ -104,7 +104,8 @@ private class UnpackFilesTask extends AsyncTask<String, Void, String> {
         protected String doInBackground(String... params) {
             File app_root_file = new File(params[0]);
             Log.v(TAG, "Ready to unpack");
-            PythonUtil.unpackData(mActivity, "private", app_root_file, true);
+            PythonUtil.unpackAsset(mActivity, "private", app_root_file, true);
+            PythonUtil.unpackPyBundle(mActivity, getApplicationInfo().nativeLibraryDir + "/" + "libpybundle", app_root_file, false);
             return null;
         }
 

pythonforandroid/bootstraps/sdl2/build/src/main/java/org/kivy/android/PythonActivity.java

@@ -37,7 +37,7 @@ def assemble_distribution(self):
             self.distribute_javaclasses(self.ctx.javaclass_dir,
                                         dest_dir=join("src", "main", "java"))
 
-            python_bundle_dir = join('_python_bundle', '_python_bundle')
+            python_bundle_dir = join(f'_python_bundle__{arch.arch}', '_python_bundle')
             ensure_dir(python_bundle_dir)
             site_packages_dir = self.ctx.python_recipe.create_python_bundle(
                 join(self.dist_dir, python_bundle_dir), arch)

pythonforandroid/bootstraps/service_only/__init__.py

@@ -74,7 +74,8 @@ protected void onCreate(Bundle savedInstanceState) {
 
         Log.v(TAG, "Ready to unpack");
         File app_root_file = new File(getAppRoot());
-        PythonUtil.unpackData(mActivity, "private", app_root_file, true);
+        PythonUtil.unpackAsset(mActivity, "private", app_root_file, true);
+        PythonUtil.unpackPyBundle(mActivity, getApplicationInfo().nativeLibraryDir + "/" + "libpybundle", app_root_file, false);
 
         Log.v(TAG, "About to do super onCreate");
         super.onCreate(savedInstanceState);

pythonforandroid/bootstraps/service_only/build/src/main/java/org/kivy/android/PythonActivity.java

@@ -34,7 +34,7 @@ def assemble_distribution(self):
             self.distribute_javaclasses(self.ctx.javaclass_dir,
                                         dest_dir=join("src", "main", "java"))
 
-            python_bundle_dir = join('_python_bundle', '_python_bundle')
+            python_bundle_dir = join(f'_python_bundle__{arch.arch}', '_python_bundle')
             ensure_dir(python_bundle_dir)
             site_packages_dir = self.ctx.python_recipe.create_python_bundle(
                 join(self.dist_dir, python_bundle_dir), arch)

pythonforandroid/bootstraps/webview/__init__.py

@@ -106,7 +106,8 @@ private class UnpackFilesTask extends AsyncTask<String, Void, String> {
         protected String doInBackground(String... params) {
             File app_root_file = new File(params[0]);
             Log.v(TAG, "Ready to unpack");
-            PythonUtil.unpackData(mActivity, "private", app_root_file, true);
+            PythonUtil.unpackAsset(mActivity, "private", app_root_file, true);
+            PythonUtil.unpackPyBundle(mActivity, getApplicationInfo().nativeLibraryDir + "/" + "libpybundle", app_root_file, false);
             return null;
         }