118 Add test_lru_cache_problem.py.

[chenkins]

Changes

• Add test getting correct transitions with load_new and load.
• Use methodtools.lru_cache for proper instance method caching. Keep GridTransitionMap object lifecycle in sync with cache lifecycle.](118 Add test_lru_cache_problem.py. #119
• benchmarking showing lru caching still works -> see results 78 Extract performance profiling cli. #88
• add tests verifying cache contents directly

Related issues

Fixes #118.
First steps for #104

Checklist

• Tests are included for relevant behavior changes.
• Documentation is added in the flatland-book repo for relevant behavior changes.
• If you made important user-facing changes, describe them under the [Unreleased] tag in CHANGELOG.md.
• New package dependencies are declared in the pyproject.toml file.
  Requirement files have been updated by running tox -e requirements.
• Code works with all supported Python versions (3.10, 3.11 and 3.12). Checks run with all three version and are
  required to run successfully.
• Code is formatted according to PEP 8 (an IDE like PyCharm can do this for you).
• Technical guidelines listed in CONTRIBUTING.md are followed.

[aiAdrian]

This solution looks good - unfortunately, I haven't been able to test it at runtime yet. However, I understand the fix.

[chenkins]

@aiAdrian thx for your comment. Rest coming with #104

[aiAdrian]

I checked out this branch. I am not sure whether we will encounter future issues. See the below log – of course, this is not yet adapted to the latest version (in this branch), but I am just wondering if the problem can be fixed when we inherit the RailEnv.

(flatland-rl-test) u216993@K57156:~/flatland/test/flatland_solver_policy$ python example/flatland_dynamics/example_flatland_dynamics.py
Traceback (most recent call last):
File "example/flatland_dynamics/example_flatland_dynamics.py", line 4, in
from environment.flatland_railway_extension.flatland_dynamics import FlatlandDynamicsEnvironment
File "/home/u216993/flatland/test/flatland_solver_policy/environment/flatland_railway_extension/flatland_dynamics.py", line 3, in
from flatland_railway_extension.FlatlandEnvironmentHelper import FlatlandEnvironmentHelper
File "/home/u216993/flatland/test/flatland_railway_extension/flatland_railway_extension/FlatlandEnvironmentHelper.py", line 6, in
from flatland.envs.malfunction_generators import MalfunctionParameters, ParamMalfunctionGen
File "/home/u216993/flatland/test/flatland-rl/flatland/envs/malfunction_generators.py", line 10, in
from flatland.envs import persistence
File "/home/u216993/flatland/test/flatland-rl/flatland/envs/persistence.py", line 10, in
from flatland.envs import rail_env
File "/home/u216993/flatland/test/flatland-rl/flatland/envs/rail_env.py", line 34, in
class RailEnv(Environment):
File "/home/u216993/flatland/test/flatland-rl/flatland/envs/rail_env.py", line 244, in RailEnv
def action_required(agent_state, is_cell_entry):
File "/etc/pyenv/.pyenv/versions/3.8.6/lib/python3.8/functools.py", line 526, in decorating_function
wrapper = _lru_cache_wrapper(user_function, maxsize, typed, _CacheInfo)
TypeError: the first argument must be callable

[chenkins]

@aiAdrian you're using 3.8. There were changes to lru_cache in 3.9, see https://docs.python.org/3.13/library/functools.html#functools.lru_cache. Please use one of the supported Python versions 3.10, 3.11, 3.12, see https://github.com/flatland-association/flatland-rl/blob/main/CONTRIBUTING.md#get-started. Does it go away?