diff --git a/abstract_syntax/declarations.py b/abstract_syntax/declarations.py index 16345183..edade986 100644 --- a/abstract_syntax/declarations.py +++ b/abstract_syntax/declarations.py @@ -1731,7 +1731,7 @@ def collect_exports(self, export_env: UniquifyEnv, importing_module: str) -> Non def find_file(loc: Meta, name: str) -> str: folder = get_workspace_folder() - for dir in ([folder] if folder else []) + list(get_import_directories()): + for dir in ([folder] if folder else []) + get_import_directories(): filename = os.path.join(dir, name + ".pf") if os.path.isfile(filename): return filename diff --git a/flags.py b/flags.py index fdde4700..ceac16a7 100644 --- a/flags.py +++ b/flags.py @@ -94,27 +94,31 @@ def set_expect_static_fail(b: bool) -> None: # flag for import directories -import_directories: set[str] = set() +# Searched in the order added. A directory already present under another +# spelling (e.g. `lib` and its absolute path) is not added again, so the +# file an import resolves to, and the path errors print, do not change +# between runs (#1246). +import_directories: list[str] = [] def init_import_directories() -> None: - import_directories.add(".") + add_import_directory(".") lib_config_path = Path(os.path.expanduser("~/.config/deduce/libraries")) if lib_config_path.exists() and lib_config_path.is_file(): with open(lib_config_path, 'r') as lib_config_file: for line in lib_config_file: - import_directories.add(line.strip()) + add_import_directory(line.strip()) -def get_import_directories() -> set[str]: - global import_directories +def get_import_directories() -> list[str]: if (get_verbose()): print("import directories: ", import_directories) return import_directories def add_import_directory(dir: str) -> None: - global import_directories - import_directories.add(dir) + real = os.path.realpath(dir) + if all(os.path.realpath(d) != real for d in import_directories): + import_directories.append(dir) # The LSP workspace folder that holds the file being checked, if any # (#1225). Its imports resolve there first, ahead of the import diff --git a/test/lsp/test_hole_checks.py b/test/lsp/test_hole_checks.py index f547aa56..19e2596f 100644 --- a/test/lsp/test_hole_checks.py +++ b/test/lsp/test_hole_checks.py @@ -82,7 +82,7 @@ def test_a_check_of_an_import_refreshes_its_importers(tmp_path, monkeypatch): import flags monkeypatch.setattr( - flags, "import_directories", flags.import_directories | {str(tmp_path)} + flags, "import_directories", [*flags.import_directories, str(tmp_path)] ) dep = tmp_path / "HoleCheckDep.pf" dep.write_text("union Color {\n red\n green\n}\n") diff --git a/test/lsp/test_snapshot.py b/test/lsp/test_snapshot.py index 740da0e5..ffe5f9a4 100644 --- a/test/lsp/test_snapshot.py +++ b/test/lsp/test_snapshot.py @@ -47,7 +47,7 @@ def prelude_dir(tmp_path, monkeypatch): lib = tmp_path / "lib" lib.mkdir() (lib / "Mini.pf").write_text(MINI) - monkeypatch.setattr(flags, "import_directories", flags.import_directories | {str(lib)}) + monkeypatch.setattr(flags, "import_directories", [*flags.import_directories, str(lib)]) library.set_snapshot_dir(str(tmp_path / "snapshots")) library.reset_prelude_cache() yield lib @@ -119,7 +119,7 @@ def test_editing_a_dependency_in_another_directory_invalidates_the_snapshot( (prelude_dir / "Mini.pf").write_text( "public import Dep\n" + MINI.replace("union Bit { o i }\n", "") ) - monkeypatch.setattr(flags, "import_directories", flags.import_directories | {str(deps)}) + monkeypatch.setattr(flags, "import_directories", [*flags.import_directories, str(deps)]) bootstraps = _bootstraps(monkeypatch) assert library.check_file("user.pf", content=USER, prelude=("Mini",)).ok diff --git a/test/lsp/test_warm_check.py b/test/lsp/test_warm_check.py index 23979525..e9024be8 100644 --- a/test/lsp/test_warm_check.py +++ b/test/lsp/test_warm_check.py @@ -49,7 +49,7 @@ def mini_prelude(tmp_path, monkeypatch): a fresh prelude state.""" (tmp_path / "Mini.pf").write_text(MINI) monkeypatch.setattr( - flags, "import_directories", flags.import_directories | {str(tmp_path)} + flags, "import_directories", [*flags.import_directories, str(tmp_path)] ) library.reset_prelude_cache() yield @@ -131,7 +131,7 @@ def test_user_inductive_does_not_leak_into_later_checks(tmp_path, monkeypatch): does in a fresh process (issue #1249 review).""" (tmp_path / "MiniInd.pf").write_text(MINI_IND) monkeypatch.setattr( - flags, "import_directories", flags.import_directories | {str(tmp_path)} + flags, "import_directories", [*flags.import_directories, str(tmp_path)] ) full = (REPO_ROOT / "test" / "should-validate" / "custom_induction.pf").read_text() without = full.replace("inductive TwoList by tl_induction\n", "") diff --git a/test/unit/test_import_directories.py b/test/unit/test_import_directories.py new file mode 100644 index 00000000..7856c45f --- /dev/null +++ b/test/unit/test_import_directories.py @@ -0,0 +1,32 @@ +"""Unit tests for the import-directory search path (issue #1246). + +The same directory added under two spellings used to stay on the path +twice, in a ``set`` whose order changed between runs, so error messages +named library files sometimes by the relative and sometimes by the +absolute spelling. +""" + +from __future__ import annotations + +import os + +import pytest + +import flags + + +def test_same_directory_under_two_spellings_is_added_once( + monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setattr(flags, "import_directories", []) + flags.add_import_directory("lib") + flags.add_import_directory(os.path.abspath("lib")) + flags.add_import_directory("./lib/") + assert flags.get_import_directories() == ["lib"] + + +def test_directories_are_searched_in_the_order_added( + monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setattr(flags, "import_directories", []) + for d in ["test/test-imports", ".", "lib"]: + flags.add_import_directory(d) + assert flags.get_import_directories() == ["test/test-imports", ".", "lib"]