Merge branch 'main' into 118-fix-lru-cache-in-env-loading

Author: chenkins

flatland/envs/rail_env.py

@@ -77,7 +77,7 @@ class RailEnv(Environment):
 
     Every time an agent stops, an agent has a certain probability of malfunctioning. Malfunctions of trains follow a
     poisson process with a certain rate. Not all trains will be affected by malfunctions during episodes to keep
-    complexity managable.
+    complexity manageable.
 
     TODO: currently, the parameters that control the stochasticity of the environment are hard-coded in init().
     For Round 2, they will be passed to the constructor as arguments, to allow for more flexibility.
@@ -140,7 +140,7 @@ def __init__(self,
             vectors for each agent.
         remove_agents_at_target : bool
             If remove_agents_at_target is set to true then the agents will be removed by placing to
-            RailEnv.DEPOT_POSITION when the agent has reach it's target position.
+            RailEnv.DEPOT_POSITION when the agent has reached its target position.
         random_seed : int or None
             if None, then its ignored, else the random generators are seeded with this number to ensure
             that stochastic operations are replicable across multiple operations
@@ -441,7 +441,7 @@ def preprocess_action(self, action, agent):
 
         action = action_preprocessing.preprocess_moving_action(action, self.rail, current_position, current_direction)
 
-        # Check transitions, bounts for executing the action in the given position and directon
+        # Check transitions, bounts for executing the action in the given position and direction
         if action.is_moving_action() and not check_valid_action(action, self.rail, current_position, current_direction):
             action = RailEnvActions.STOP_MOVING
 
@@ -674,7 +674,7 @@ def get_valid_directions_on_grid(self, row: int, col: int) -> List[int]:
     def _exp_distirbution_synced(self, rate: float) -> float:
         """
         Generates sample from exponential distribution
-        We need this to guarantee synchronity between different instances with same seed.
+        We need this to guarantee synchronicity between different instances with the same seed.
         :param rate:
         :return:
         """
@@ -684,7 +684,7 @@ def _exp_distirbution_synced(self, rate: float) -> float:
 
     def _is_agent_ok(self, agent: EnvAgent) -> bool:
         """
-        Check if an agent is ok, meaning it can move and is not malfuncitoinig
+        Checks if an agent is ok, meaning it can move and is not malfunctioning.
         Parameters
         ----------
         agent
@@ -706,7 +706,7 @@ def render(self, mode="rgb_array", gl="PGL", agent_render_variant=AgentRenderVar
                show_observations=False, show_predictions=False,
                show_rowcols=False, return_image=True):
         """
-        This methods provides the option to render the
+        Provides the option to render the
         environment's behavior as an image or to a window.
         Parameters
         ----------
@@ -764,7 +764,7 @@ def update_renderer(self, mode, show, show_observations, show_predictions,
 
     def close(self):
         """
-        This methods closes any renderer window.
+        Closes any renderer window.
         """
         if hasattr(self, "renderer") and self.renderer is not None:
             try:

pyproject.toml

@@ -19,7 +19,7 @@ classifiers = [
     'Programming Language :: Python :: 3.12',
 ]
 dependencies = [
-    "attr",
+    "attrs",
     "boto3",
     "click",
     "crowdai_api",
@@ -42,6 +42,8 @@ dependencies = [
     "recordtype",
     "redis",
     "seaborn",
+    # https://docs.python.org/3/whatsnew/3.12.html: Python 3.12 has removed pkg_resources from the standard library (moved to setuptools):
+    "setuptools",
     "svgutils",
     "timeout_decorator",
 ]

requirements-dev.txt

@@ -24,11 +24,10 @@ async-lru==2.0.4
     # via jupyterlab
 async-timeout==5.0.1
     # via redis
-attr==0.3.2
-    # via flatland-rl (pyproject.toml)
 attrs==25.1.0
     # via
     #   flake8-eradicate
+    #   flatland-rl (pyproject.toml)
     #   jsonschema
     #   referencing
 babel==2.17.0

requirements-ml.txt

@@ -24,11 +24,10 @@ async-timeout==5.0.1
     # via
     #   aiohttp
     #   redis
-attr==0.3.2
-    # via flatland-rl (pyproject.toml)
 attrs==25.1.0
     # via
     #   aiohttp
+    #   flatland-rl (pyproject.toml)
     #   jsonschema
     #   referencing
 boto3==1.36.20

requirements.txt

@@ -8,7 +8,7 @@ asttokens==3.0.0
     # via stack-data
 async-timeout==5.0.1
     # via redis
-attr==0.3.2
+attrs==25.1.0
     # via flatland-rl (pyproject.toml)
 boto3==1.36.20
     # via flatland-rl (pyproject.toml)

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-env_list = py{310,311,312},notebooks,py{310,311,312}-ml
+env_list = py{310,311,312},notebooks,py{310,311,312}-ml,py{310,311,312}-verify-install
 
 [gh-actions]
 python =
@@ -123,3 +123,10 @@ deps =
     -r requirements-dev.txt
 commands =
     python -m build
+
+[testenv:py{310,311,312}-verify-install]
+# install flatland-rl without additional dependencies
+skip_install = false
+commands =
+    python --version
+    python -c 'from flatland.evaluators.service import FlatlandRemoteEvaluationService'