Ignores Python 2 import_recipe() warnings

AndreMiras · AndreMiras · commit 7b21c46e9b6c · 2019-04-07T14:19:20.000+02:00
Python 2 raises warnings on `imp.load_source()` when the module name
contains dots. Ignoring this warning makes p4a output/logs more
readable.
Also refactors to make the code more readable.
Note that for some reason the regression test will only catch the
regression if ran isolated, e.g. via:
```sh
tox -e py27 -- tests/test_recipe.py::TestRecipe::test_import_recipe
```
diff --git a/pythonforandroid/recipe.py b/pythonforandroid/recipe.py
@@ -1,5 +1,4 @@
 from os.path import basename, dirname, exists, isdir, isfile, join, realpath, split
-import importlib
 import glob
 from shutil import rmtree
 from six import PY2, with_metaclass
@@ -21,22 +20,27 @@
 from pythonforandroid.util import (urlretrieve, current_directory, ensure_dir,
                                    BuildInterruptingException)
 
-# this import is necessary to keep imp.load_source from complaining :)
-if PY2:
-    import imp
-    import_recipe = imp.load_source
-else:
-    import importlib.util
-    if hasattr(importlib.util, 'module_from_spec'):
-        def import_recipe(module, filename):
+
+def import_recipe(module, filename):
+    if PY2:
+        import imp
+        import warnings
+        with warnings.catch_warnings():
+            # ignores warnings raised by hierarchical module names
+            # (names containing dots) on Python 2
+            warnings.simplefilter("ignore", RuntimeWarning)
+            return imp.load_source(module, filename)
+    else:
+        # Python 3.5+
+        import importlib.util
+        if hasattr(importlib.util, 'module_from_spec'):
             spec = importlib.util.spec_from_file_location(module, filename)
             mod = importlib.util.module_from_spec(spec)
             spec.loader.exec_module(mod)
             return mod
-    else:
-        from importlib.machinery import SourceFileLoader
-
-        def import_recipe(module, filename):
+        else:
+            # Python 3.3 and 3.4:
+            from importlib.machinery import SourceFileLoader
             return SourceFileLoader(module, filename).load_module()
 
 
diff --git a/tests/test_recipe.py b/tests/test_recipe.py
@@ -1,7 +1,9 @@
+import os
 import types
 import unittest
+import warnings
 from pythonforandroid.build import Context
-from pythonforandroid.recipe import Recipe
+from pythonforandroid.recipe import Recipe, import_recipe
 
 
 class TestRecipe(unittest.TestCase):
@@ -41,3 +43,18 @@ def test_get_recipe(self):
             Recipe.get_recipe(recipe_name, ctx)
         self.assertEqual(
             e.exception.args[0], 'Recipe does not exist: {}'.format(recipe_name))
+
+    def test_import_recipe(self):
+        """
+        Verifies we can dynamically import a recipe without warnings.
+        """
+        p4a_root_dir = os.path.dirname(os.path.dirname(__file__))
+        name = 'pythonforandroid.recipes.python3'
+        pathname = os.path.join(
+            *([p4a_root_dir] + name.split('.') + ['__init__.py'])
+        )
+        with warnings.catch_warnings(record=True) as recorded_warnings:
+            warnings.simplefilter("always")
+            module = import_recipe(name, pathname)
+        assert module is not None
+        assert recorded_warnings == []
