From 88bcf78439b66b5fcba9f4d3a1c56307f98dbf1d Mon Sep 17 00:00:00 2001 From: Evgeny Prigorodov Date: Thu, 26 May 2022 21:12:36 +0200 Subject: [PATCH 1/3] instance_path for namespace packages uses path closest to submodule --- CHANGES.rst | 2 ++ src/flask/scaffold.py | 39 ++++++++++++++++++++++++----------- tests/test_instance_config.py | 19 +++++++++++++++++ 3 files changed, 48 insertions(+), 12 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index a181badc..d423aba9 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -8,6 +8,8 @@ Unreleased - Inline some optional imports that are only used for certain CLI commands. :pr:`4606` - Relax type annotation for ``after_request`` functions. :issue:`4600` +- ``instance_path`` for namespace packages uses the path closest to + the imported submodule. :issue:`4600` Version 2.1.2 diff --git a/src/flask/scaffold.py b/src/flask/scaffold.py index 8ca804a6..147d9827 100644 --- a/src/flask/scaffold.py +++ b/src/flask/scaffold.py @@ -780,30 +780,46 @@ def _matching_loader_thinks_module_is_package(loader, mod_name): ) -def _find_package_path(root_mod_name): +def _find_package_path(import_name): """Find the path that contains the package or module.""" - try: - spec = importlib.util.find_spec(root_mod_name) + root_mod_name, _, _ = import_name.partition(".") - if spec is None: + try: + root_spec = importlib.util.find_spec(root_mod_name) + + if root_spec is None: raise ValueError("not found") # ImportError: the machinery told us it does not exist # ValueError: # - the module name was invalid # - the module name is __main__ - # - *we* raised `ValueError` due to `spec` being `None` + # - *we* raised `ValueError` due to `root_spec` being `None` except (ImportError, ValueError): pass # handled below else: # namespace package - if spec.origin in {"namespace", None}: - return os.path.dirname(next(iter(spec.submodule_search_locations))) + if root_spec.origin in {"namespace", None}: + package_spec = importlib.util.find_spec(import_name) + if package_spec is not None and package_spec.submodule_search_locations: + # Pick the path in the namespace that contains the submodule. + package_path = os.path.commonpath( + package_spec.submodule_search_locations + ) + search_locations = ( + location + for location in root_spec.submodule_search_locations + if package_path.startswith(location) + ) + else: + # Pick the first path. + search_locations = iter(root_spec.submodule_search_locations) + return os.path.dirname(next(search_locations)) # a package (with __init__.py) - elif spec.submodule_search_locations: - return os.path.dirname(os.path.dirname(spec.origin)) + elif root_spec.submodule_search_locations: + return os.path.dirname(os.path.dirname(root_spec.origin)) # just a normal module else: - return os.path.dirname(spec.origin) + return os.path.dirname(root_spec.origin) # we were unable to find the `package_path` using PEP 451 loaders loader = pkgutil.get_loader(root_mod_name) @@ -845,8 +861,7 @@ def find_package(import_name: str): for import. If the package is not installed, it's assumed that the package was imported from the current working directory. """ - root_mod_name, _, _ = import_name.partition(".") - package_path = _find_package_path(root_mod_name) + package_path = _find_package_path(import_name) py_prefix = os.path.abspath(sys.prefix) # installed to the system diff --git a/tests/test_instance_config.py b/tests/test_instance_config.py index ee573664..d7fe6191 100644 --- a/tests/test_instance_config.py +++ b/tests/test_instance_config.py @@ -59,6 +59,25 @@ def test_uninstalled_package_paths(modules_tmpdir, purge_module): assert app.instance_path == str(modules_tmpdir.join("instance")) +def test_uninstalled_namespace_paths(tmpdir, monkeypatch, purge_module): + def create_namespace(package): + project = tmpdir.join(f"project-{package}") + monkeypatch.syspath_prepend(str(project)) + project.join("namespace").join(package).join("__init__.py").write( + "import flask\napp = flask.Flask(__name__)\n", ensure=True + ) + return project + + _ = create_namespace("package1") + project2 = create_namespace("package2") + purge_module("namespace.package2") + purge_module("namespace") + + from namespace.package2 import app + + assert app.instance_path == str(project2.join("instance")) + + def test_installed_module_paths( modules_tmpdir, modules_tmpdir_prefix, purge_module, site_packages, limit_loader ): From 3ba37d2afe6511c3f3153248f7342174bea5b131 Mon Sep 17 00:00:00 2001 From: David Lord Date: Mon, 6 Jun 2022 08:24:05 -0700 Subject: [PATCH 2/3] fix uninstalled package tests under tox --- src/flask/scaffold.py | 18 ++++++++++++++---- tests/test_instance_config.py | 3 --- tox.ini | 1 + 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/src/flask/scaffold.py b/src/flask/scaffold.py index 147d9827..80084a19 100644 --- a/src/flask/scaffold.py +++ b/src/flask/scaffold.py @@ -1,5 +1,6 @@ import importlib.util import os +import pathlib import pkgutil import sys import typing as t @@ -780,6 +781,15 @@ def _matching_loader_thinks_module_is_package(loader, mod_name): ) +def _path_is_relative_to(path: pathlib.PurePath, base: str) -> bool: + # Path.is_relative_to doesn't exist until Python 3.9 + try: + path.relative_to(base) + return True + except ValueError: + return False + + def _find_package_path(import_name): """Find the path that contains the package or module.""" root_mod_name, _, _ = import_name.partition(".") @@ -802,13 +812,13 @@ def _find_package_path(import_name): package_spec = importlib.util.find_spec(import_name) if package_spec is not None and package_spec.submodule_search_locations: # Pick the path in the namespace that contains the submodule. - package_path = os.path.commonpath( - package_spec.submodule_search_locations + package_path = pathlib.Path( + os.path.commonpath(package_spec.submodule_search_locations) ) search_locations = ( location for location in root_spec.submodule_search_locations - if package_path.startswith(location) + if _path_is_relative_to(package_path, location) ) else: # Pick the first path. @@ -865,7 +875,7 @@ def find_package(import_name: str): py_prefix = os.path.abspath(sys.prefix) # installed to the system - if package_path.startswith(py_prefix): + if _path_is_relative_to(pathlib.PurePath(package_path), py_prefix): return py_prefix, package_path site_parent, site_folder = os.path.split(package_path) diff --git a/tests/test_instance_config.py b/tests/test_instance_config.py index d7fe6191..53e98042 100644 --- a/tests/test_instance_config.py +++ b/tests/test_instance_config.py @@ -15,7 +15,6 @@ def test_explicit_instance_paths(modules_tmpdir): assert app.instance_path == str(modules_tmpdir) -@pytest.mark.xfail(reason="weird interaction with tox") def test_main_module_paths(modules_tmpdir, purge_module): app = modules_tmpdir.join("main_app.py") app.write('import flask\n\napp = flask.Flask("__main__")') @@ -27,7 +26,6 @@ def test_main_module_paths(modules_tmpdir, purge_module): assert app.instance_path == os.path.join(here, "instance") -@pytest.mark.xfail(reason="weird interaction with tox") def test_uninstalled_module_paths(modules_tmpdir, purge_module): app = modules_tmpdir.join("config_module_app.py").write( "import os\n" @@ -42,7 +40,6 @@ def test_uninstalled_module_paths(modules_tmpdir, purge_module): assert app.instance_path == str(modules_tmpdir.join("instance")) -@pytest.mark.xfail(reason="weird interaction with tox") def test_uninstalled_package_paths(modules_tmpdir, purge_module): app = modules_tmpdir.mkdir("config_package_app") init = app.join("__init__.py") diff --git a/tox.ini b/tox.ini index 077d66f2..ee4d40f6 100644 --- a/tox.ini +++ b/tox.ini @@ -9,6 +9,7 @@ envlist = skip_missing_interpreters = true [testenv] +envtmpdir = {toxworkdir}/tmp/{envname} deps = -r requirements/tests.txt min: -r requirements/tests-pallets-min.txt From b06df0a792ceb5506da47e0c8fea09902c1058f9 Mon Sep 17 00:00:00 2001 From: David Lord Date: Mon, 6 Jun 2022 09:17:53 -0700 Subject: [PATCH 3/3] remove outdated instance path test --- tests/test_instance_config.py | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/tests/test_instance_config.py b/tests/test_instance_config.py index 53e98042..c8cf0bf7 100644 --- a/tests/test_instance_config.py +++ b/tests/test_instance_config.py @@ -1,4 +1,3 @@ -import os import sys import pytest @@ -15,17 +14,6 @@ def test_explicit_instance_paths(modules_tmpdir): assert app.instance_path == str(modules_tmpdir) -def test_main_module_paths(modules_tmpdir, purge_module): - app = modules_tmpdir.join("main_app.py") - app.write('import flask\n\napp = flask.Flask("__main__")') - purge_module("main_app") - - from main_app import app - - here = os.path.abspath(os.getcwd()) - assert app.instance_path == os.path.join(here, "instance") - - def test_uninstalled_module_paths(modules_tmpdir, purge_module): app = modules_tmpdir.join("config_module_app.py").write( "import os\n"