[GRASS-git] [OSGeo/grass] a92a3a: grass.app: Separate env modification from path ret...

[Vaclav Petras]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: a92a3a018ace6833bc2f13cf0031ae2178d8e5ea
      https://github.com/OSGeo/grass/commit/a92a3a018ace6833bc2f13cf0031ae2178d8e5ea
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2025-10-10 (Fri, 10 Oct 2025)

  Changed paths:
    M lib/init/grass.py
    M python/grass/app/runtime.py
    A python/grass/app/tests/grass_app_runtime.py
    M python/grass/script/setup.py

  Log Message:
  -----------
  grass.app: Separate env modification from path retrieval (#6469)

The RuntimePaths object would also modify the environment while a variable is being retrieved. This is unexpected side effect of an attribute access. It was also the way how the GISBASE environment variable was set in the main grass executable which is a very opaque way of setting it. The environment modification is now removed, and the caller code must set GISBASE explicitly.

The main grass executable code now first gets the compile-time determined runtime path from RuntimePaths. Then it passes that to get_install_path which will evaluate if it is an existing (valid) path, and will find a fallback if it is not. Previously, the main grass executable fully relied on the compile-time determined path. Now, it can find a path itself the same way the Python API (grass.script.setup.init) does that, but the executable uses the compile-time determined path as a starting point.

If the search for a install path fallback is successful in the main executable, it will hide issues with the path in the installation. To compensate for that, the get_install_path function is now tested for consistency with the compile-time determined runtime install path coming from a RuntimePaths object in pytest-based tests. This will allow a GRASS process to run even with a broken installation (some broken installations to be exect), but running the test will show that there is an issue. To further facilitate debugging, the get_install_path returns the originally provided path if none of the tested ways was successful.

The get_install_path function now guarantees that the paths it returns exists except when none exists, then it returns whatever was the path provided as a parameter. This makes it possible to pass an invalid compile-time determined path, but fall back to path determined in some other way, while behaving consistently with other cases (some were already using existence as a test). The function now also always returns a string assuming the primary usage is to set an environment variable.

The path for the main executable is now set in the same way as for the init function. Both are in the library, although still at two different places and with a slight difference of what is used as the starting point (compile-time determined runtime path and user-provided path or, usually, None).



To unsubscribe from these emails, change your notification settings at https://github.com/OSGeo/grass/settings/notifications