Avoid some DRY issues + minor fixes + version bump

Author: misl6

pythonforandroid/bootstrap.py

@@ -14,6 +14,8 @@
     rmdir, move)
 from pythonforandroid.recipe import Recipe
 
+SDL_BOOTSTRAPS = ("sdl2", "sdl3")
+
 
 def copy_files(src_root, dest_root, override=True, symlink=False):
     for root, dirnames, filenames in walk(src_root):
@@ -150,7 +152,7 @@ def get_bootstrap_dirs(self):
         return bootstrap_dirs
 
     def _copy_in_final_files(self):
-        if self.name in ["sdl2", "sdl3"]:
+        if self.name in SDL_BOOTSTRAPS:
             # Get the paths for copying SDL's java source code:
             sdl_recipe = Recipe.get_recipe(self.name, self.ctx)
             sdl_build_dir = sdl_recipe.get_jni_dir()
@@ -193,7 +195,7 @@ def assemble_distribution(self):
     @classmethod
     def all_bootstraps(cls):
         '''Find all the available bootstraps and return them.'''
-        forbidden_dirs = ('__pycache__', 'common')
+        forbidden_dirs = ('__pycache__', 'common', '_sdl_common')
         bootstraps_dir = join(dirname(__file__), 'bootstraps')
         result = set()
         for name in listdir(bootstraps_dir):

pythonforandroid/bootstraps/_sdl_common/__init__.py

@@ -0,0 +1,49 @@
+from os.path import join
+
+import sh
+
+from pythonforandroid.toolchain import (
+    Bootstrap, shprint, current_directory, info, info_main)
+from pythonforandroid.util import ensure_dir, rmdir
+
+
+class SDLGradleBootstrap(Bootstrap):
+    name = "_sdl_common"
+
+    recipe_depends = []
+
+    def assemble_distribution(self):
+        info_main("# Creating Android project ({})".format(self.name))
+
+        rmdir(self.dist_dir)
+        info("Copying SDL/gradle build")
+        shprint(sh.cp, "-r", self.build_dir, self.dist_dir)
+
+        # either the build use environment variable (ANDROID_HOME)
+        # or the local.properties if exists
+        with current_directory(self.dist_dir):
+            with open('local.properties', 'w') as fileh:
+                fileh.write('sdk.dir={}'.format(self.ctx.sdk_dir))
+
+        with current_directory(self.dist_dir):
+            info("Copying Python distribution")
+
+            self.distribute_javaclasses(self.ctx.javaclass_dir,
+                                        dest_dir=join("src", "main", "java"))
+
+            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')
+
+        super().assemble_distribution()

pythonforandroid/bootstraps/sdl2/build/.gitignore renamed to pythonforandroid/bootstraps/_sdl_common/build/.gitignore

@@ -20,6 +20,7 @@
 from fnmatch import fnmatch
 import jinja2
 
+from pythonforandroid.bootstrap import SDL_BOOTSTRAPS
 from pythonforandroid.util import rmdir, ensure_dir, max_build_tool_version
 
 
@@ -220,6 +221,10 @@ def compile_py_file(python_file, optimize_python=True):
     return ".".join([os.path.splitext(python_file)[0], "pyc"])
 
 
+def is_sdl_bootstrap():
+    return get_bootstrap_name() in SDL_BOOTSTRAPS
+
+
 def make_package(args):
     # If no launcher is specified, require a main.py/main.pyc:
     if (get_bootstrap_name() != "sdl" or args.launcher is None) and \
@@ -541,7 +546,7 @@ def make_package(args):
         "debug": "debug" in args.build_mode,
         "native_services": args.native_services
     }
-    if get_bootstrap_name() in ["sdl2", "sdl3"]:
+    if is_sdl_bootstrap():
         render_args["url_scheme"] = url_scheme
 
     render(
@@ -596,7 +601,7 @@ def make_package(args):
         "args": args,
         "private_version": hashlib.sha1(private_version.encode()).hexdigest()
     }
-    if get_bootstrap_name() in ["sdl2", "sdl3"]:
+    if is_sdl_bootstrap():
         render_args["url_scheme"] = url_scheme
     render(
         'strings.tmpl.xml',
@@ -769,7 +774,7 @@ def create_argument_parser():
     ap.add_argument('--private', dest='private',
                     help='the directory with the app source code files' +
                          ' (containing your main.py entrypoint)',
-                    required=(get_bootstrap_name() not in ["sdl2", "sdl3"]))
+                    required=(not is_sdl_bootstrap()))
     ap.add_argument('--package', dest='package',
                     help=('The name of the java package the project will be'
                           ' packaged under.'),
@@ -787,7 +792,7 @@ def create_argument_parser():
                           'same number of groups of numbers as previous '
                           'versions.'),
                     required=True)
-    if get_bootstrap_name() in ["sdl2", "sdl3"]:
+    if is_sdl_bootstrap():
         ap.add_argument('--launcher', dest='launcher', action='store_true',
                         help=('Provide this argument to build a multi-app '
                               'launcher, rather than a single app.'))
@@ -1044,7 +1049,7 @@ def _read_configuration():
         args.orientation, args.manifest_orientation
     )
 
-    if get_bootstrap_name() in ["sdl2", "sdl3"]:
+    if is_sdl_bootstrap():
         args.sdl_orientation_hint = get_sdl_orientation_hint(args.orientation)
 
     if args.res_xmls and isinstance(args.res_xmls[0], list):
@@ -1073,8 +1078,7 @@ def _read_configuration():
                         if x.strip() and not x.strip().startswith('#')]
         WHITELIST_PATTERNS += patterns
 
-    if args.private is None and \
-            get_bootstrap_name() in ['sdl2', 'sdl3'] and args.launcher is None:
+    if args.private is None and is_sdl_bootstrap() and args.launcher is None:
         print('Need --private directory or ' +
               '--launcher (SDL2/SDL3 bootstrap only)' +
               'to have something to launch inside the .apk!')

pythonforandroid/bootstraps/sdl2/build/blacklist.txt renamed to pythonforandroid/bootstraps/_sdl_common/build/blacklist.txt

@@ -1,54 +1,12 @@
-from os.path import join
+from pythonforandroid.bootstraps._sdl_common import SDLGradleBootstrap
 
-import sh
 
-from pythonforandroid.toolchain import (
-    Bootstrap, shprint, current_directory, info, info_main)
-from pythonforandroid.util import ensure_dir, rmdir
-
-
-class SDL2GradleBootstrap(Bootstrap):
-    name = 'sdl2'
+class SDL2GradleBootstrap(SDLGradleBootstrap):
+    name = "sdl2"
 
     recipe_depends = list(
-        set(Bootstrap.recipe_depends).union({'sdl2'})
+        set(SDLGradleBootstrap.recipe_depends).union({"sdl2"})
     )
 
-    def assemble_distribution(self):
-        info_main("# Creating Android project ({})".format(self.name))
-
-        rmdir(self.dist_dir)
-        info("Copying SDL2/gradle build")
-        shprint(sh.cp, "-r", self.build_dir, self.dist_dir)
-
-        # either the build use environment variable (ANDROID_HOME)
-        # or the local.properties if exists
-        with current_directory(self.dist_dir):
-            with open('local.properties', 'w') as fileh:
-                fileh.write('sdk.dir={}'.format(self.ctx.sdk_dir))
-
-        with current_directory(self.dist_dir):
-            info("Copying Python distribution")
-
-            self.distribute_javaclasses(self.ctx.javaclass_dir,
-                                        dest_dir=join("src", "main", "java"))
-
-            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')
-
-        super().assemble_distribution()
-
 
 bootstrap = SDL2GradleBootstrap()

pythonforandroid/bootstraps/sdl2/build/jni/Application.mk renamed to pythonforandroid/bootstraps/_sdl_common/build/jni/Application.mk

@@ -1,56 +1,12 @@
-from os.path import join
+from pythonforandroid.bootstraps._sdl_common import SDLGradleBootstrap
 
-import sh
 
-from pythonforandroid.toolchain import (
-    Bootstrap, shprint, current_directory, info, info_main)
-from pythonforandroid.util import ensure_dir, rmdir
-
-
-class SDL3GradleBootstrap(Bootstrap):
-    name = 'sdl3'
-
-    conflicts = ['sdl2']
+class SDL3GradleBootstrap(SDLGradleBootstrap):
+    name = "sdl3"
 
     recipe_depends = list(
-        set(Bootstrap.recipe_depends).union({'sdl3'})
+        set(SDLGradleBootstrap.recipe_depends).union({"sdl3"})
     )
 
-    def assemble_distribution(self):
-        info_main("# Creating Android project ({})".format(self.name))
-
-        rmdir(self.dist_dir)
-        info("Copying SDL3/gradle build")
-        shprint(sh.cp, "-r", self.build_dir, self.dist_dir)
-
-        # either the build use environment variable (ANDROID_HOME)
-        # or the local.properties if exists
-        with current_directory(self.dist_dir):
-            with open('local.properties', 'w') as fileh:
-                fileh.write('sdk.dir={}'.format(self.ctx.sdk_dir))
-
-        with current_directory(self.dist_dir):
-            info("Copying Python distribution")
-
-            self.distribute_javaclasses(self.ctx.javaclass_dir,
-                                        dest_dir=join("src", "main", "java"))
-
-            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')
-
-        super().assemble_distribution()
-
 
 bootstrap = SDL3GradleBootstrap()