Skip to content

Commit 7e355b9

Browse files
committed
Take new_command as a list of CLI tokens
Change deprecated_task_alias(new_command=...) from a free-form string to a list[str], where each list entry is one whitespace-separated CLI token. The factory joins the list with single spaces when forming the DeprecationWarning body, so the user-facing warning text is unchanged in shape (still quoted, one command). The list form makes per-token diffs easier to scan at the gym.register call sites: each --task / --agent / presets= entry is on its own line instead of being lost inside a multi-line implicit string concat. Call-site convention: --task=... first, --agent=... next when present, presets=NAME selector at the end -- the warning body reads in that order too. Test fixtures reordered to match the new --task / --agent / presets= sequence in the warning body. All 73 cartpole deprecation tests pass.
1 parent 2595dfb commit 7e355b9

6 files changed

Lines changed: 171 additions & 117 deletions

File tree

source/isaaclab_tasks/isaaclab_tasks/direct/cartpole/__init__.py

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -68,29 +68,14 @@ def call():
6868
return call
6969

7070

71-
gym.register(
72-
id="Isaac-Cartpole-Camera-Presets-Direct-v0",
73-
entry_point=f"{__name__}.cartpole_camera_presets_env:CartpoleCameraPresetsEnv",
74-
disable_env_checker=True,
75-
kwargs={
76-
"env_cfg_entry_point": deprecated_task_alias(
77-
old_task_id="Isaac-Cartpole-Camera-Presets-Direct-v0",
78-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0",
79-
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
80-
),
81-
"rl_games_cfg_entry_point": f"{agents.__name__}:rl_games_camera_ppo_cfg.yaml",
82-
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_camera_ppo_cfg.yaml",
83-
},
84-
)
85-
8671
gym.register(
8772
id="Isaac-Cartpole-RGB-Camera-Direct-v0",
8873
entry_point=f"{__name__}.cartpole_camera_env:CartpoleCameraEnv",
8974
disable_env_checker=True,
9075
kwargs={
9176
"env_cfg_entry_point": deprecated_task_alias(
9277
old_task_id="Isaac-Cartpole-RGB-Camera-Direct-v0",
93-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0 presets=rgb",
78+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0", "presets=rgb"],
9479
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
9580
cfg_factory=_resolve_camera_variant("rgb"),
9681
),
@@ -106,7 +91,7 @@ def call():
10691
kwargs={
10792
"env_cfg_entry_point": deprecated_task_alias(
10893
old_task_id="Isaac-Cartpole-Albedo-Camera-Direct-v0",
109-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0 presets=albedo",
94+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0", "presets=albedo"],
11095
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
11196
cfg_factory=_resolve_camera_variant("albedo"),
11297
),
@@ -122,7 +107,7 @@ def call():
122107
kwargs={
123108
"env_cfg_entry_point": deprecated_task_alias(
124109
old_task_id="Isaac-Cartpole-SimpleShading-Constant-Camera-Direct-v0",
125-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0 presets=simple_shading_constant_diffuse",
110+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0", "presets=simple_shading_constant_diffuse"],
126111
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
127112
cfg_factory=_resolve_camera_variant("simple_shading_constant_diffuse"),
128113
),
@@ -138,7 +123,7 @@ def call():
138123
kwargs={
139124
"env_cfg_entry_point": deprecated_task_alias(
140125
old_task_id="Isaac-Cartpole-SimpleShading-Diffuse-Camera-Direct-v0",
141-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0 presets=simple_shading_diffuse_mdl",
126+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0", "presets=simple_shading_diffuse_mdl"],
142127
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
143128
cfg_factory=_resolve_camera_variant("simple_shading_diffuse_mdl"),
144129
),
@@ -154,7 +139,7 @@ def call():
154139
kwargs={
155140
"env_cfg_entry_point": deprecated_task_alias(
156141
old_task_id="Isaac-Cartpole-SimpleShading-Full-Camera-Direct-v0",
157-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0 presets=simple_shading_full_mdl",
142+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0", "presets=simple_shading_full_mdl"],
158143
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
159144
cfg_factory=_resolve_camera_variant("simple_shading_full_mdl"),
160145
),
@@ -170,11 +155,26 @@ def call():
170155
kwargs={
171156
"env_cfg_entry_point": deprecated_task_alias(
172157
old_task_id="Isaac-Cartpole-Depth-Camera-Direct-v0",
173-
new_command="--task=Isaac-Cartpole-Camera-Direct-v0 presets=depth",
158+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0", "presets=depth"],
174159
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
175160
cfg_factory=_resolve_camera_variant("depth"),
176161
),
177162
"rl_games_cfg_entry_point": f"{agents.__name__}:rl_games_camera_ppo_cfg.yaml",
178163
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_camera_ppo_cfg.yaml",
179164
},
180165
)
166+
167+
gym.register(
168+
id="Isaac-Cartpole-Camera-Presets-Direct-v0",
169+
entry_point=f"{__name__}.cartpole_camera_presets_env:CartpoleCameraPresetsEnv",
170+
disable_env_checker=True,
171+
kwargs={
172+
"env_cfg_entry_point": deprecated_task_alias(
173+
old_task_id="Isaac-Cartpole-Camera-Presets-Direct-v0",
174+
new_command=["--task=Isaac-Cartpole-Camera-Direct-v0"],
175+
consolidated_cfg_path=f"{__name__}.cartpole_camera_presets_env_cfg:CartpoleCameraPresetsEnvCfg",
176+
),
177+
"rl_games_cfg_entry_point": f"{agents.__name__}:rl_games_camera_ppo_cfg.yaml",
178+
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_camera_ppo_cfg.yaml",
179+
},
180+
)

source/isaaclab_tasks/isaaclab_tasks/direct/cartpole_showcase/cartpole/__init__.py

Lines changed: 71 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
kwargs={
6363
"env_cfg_entry_point": deprecated_task_alias(
6464
old_task_id="Isaac-Cartpole-Showcase-Box-Box-Direct-v0",
65-
new_command="--task=Isaac-Cartpole-Showcase-Direct-v0 presets=box_box",
65+
new_command=["--task=Isaac-Cartpole-Showcase-Direct-v0", "presets=box_box"],
6666
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
6767
),
6868
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_box_box_ppo_cfg.yaml",
@@ -76,7 +76,11 @@
7676
kwargs={
7777
"env_cfg_entry_point": deprecated_task_alias(
7878
old_task_id="Isaac-Cartpole-Showcase-Box-Discrete-Direct-v0",
79-
new_command="--task=Isaac-Cartpole-Showcase-Direct-v0 presets=box_discrete --agent=skrl_box_discrete_cfg_entry_point",
79+
new_command=[
80+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
81+
"--agent=skrl_box_discrete_cfg_entry_point",
82+
"presets=box_discrete",
83+
],
8084
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
8185
),
8286
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_box_discrete_ppo_cfg.yaml",
@@ -90,10 +94,11 @@
9094
kwargs={
9195
"env_cfg_entry_point": deprecated_task_alias(
9296
old_task_id="Isaac-Cartpole-Showcase-Box-MultiDiscrete-Direct-v0",
93-
new_command=(
94-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=box_multidiscrete"
95-
" --agent=skrl_box_multidiscrete_cfg_entry_point"
96-
),
97+
new_command=[
98+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
99+
"--agent=skrl_box_multidiscrete_cfg_entry_point",
100+
"presets=box_multidiscrete",
101+
],
97102
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
98103
),
99104
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_box_multidiscrete_ppo_cfg.yaml",
@@ -111,7 +116,11 @@
111116
kwargs={
112117
"env_cfg_entry_point": deprecated_task_alias(
113118
old_task_id="Isaac-Cartpole-Showcase-Discrete-Box-Direct-v0",
114-
new_command="--task=Isaac-Cartpole-Showcase-Direct-v0 presets=discrete_box --agent=skrl_discrete_box_cfg_entry_point",
119+
new_command=[
120+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
121+
"--agent=skrl_discrete_box_cfg_entry_point",
122+
"presets=discrete_box",
123+
],
115124
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
116125
),
117126
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_discrete_box_ppo_cfg.yaml",
@@ -125,10 +134,11 @@
125134
kwargs={
126135
"env_cfg_entry_point": deprecated_task_alias(
127136
old_task_id="Isaac-Cartpole-Showcase-Discrete-Discrete-Direct-v0",
128-
new_command=(
129-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=discrete_discrete"
130-
" --agent=skrl_discrete_discrete_cfg_entry_point"
131-
),
137+
new_command=[
138+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
139+
"--agent=skrl_discrete_discrete_cfg_entry_point",
140+
"presets=discrete_discrete",
141+
],
132142
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
133143
),
134144
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_discrete_discrete_ppo_cfg.yaml",
@@ -142,10 +152,11 @@
142152
kwargs={
143153
"env_cfg_entry_point": deprecated_task_alias(
144154
old_task_id="Isaac-Cartpole-Showcase-Discrete-MultiDiscrete-Direct-v0",
145-
new_command=(
146-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=discrete_multidiscrete"
147-
" --agent=skrl_discrete_multidiscrete_cfg_entry_point"
148-
),
155+
new_command=[
156+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
157+
"--agent=skrl_discrete_multidiscrete_cfg_entry_point",
158+
"presets=discrete_multidiscrete",
159+
],
149160
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
150161
),
151162
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_discrete_multidiscrete_ppo_cfg.yaml",
@@ -163,10 +174,11 @@
163174
kwargs={
164175
"env_cfg_entry_point": deprecated_task_alias(
165176
old_task_id="Isaac-Cartpole-Showcase-MultiDiscrete-Box-Direct-v0",
166-
new_command=(
167-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=multidiscrete_box"
168-
" --agent=skrl_multidiscrete_box_cfg_entry_point"
169-
),
177+
new_command=[
178+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
179+
"--agent=skrl_multidiscrete_box_cfg_entry_point",
180+
"presets=multidiscrete_box",
181+
],
170182
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
171183
),
172184
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_multidiscrete_box_ppo_cfg.yaml",
@@ -180,10 +192,11 @@
180192
kwargs={
181193
"env_cfg_entry_point": deprecated_task_alias(
182194
old_task_id="Isaac-Cartpole-Showcase-MultiDiscrete-Discrete-Direct-v0",
183-
new_command=(
184-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=multidiscrete_discrete"
185-
" --agent=skrl_multidiscrete_discrete_cfg_entry_point"
186-
),
195+
new_command=[
196+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
197+
"--agent=skrl_multidiscrete_discrete_cfg_entry_point",
198+
"presets=multidiscrete_discrete",
199+
],
187200
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
188201
),
189202
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_multidiscrete_discrete_ppo_cfg.yaml",
@@ -197,10 +210,11 @@
197210
kwargs={
198211
"env_cfg_entry_point": deprecated_task_alias(
199212
old_task_id="Isaac-Cartpole-Showcase-MultiDiscrete-MultiDiscrete-Direct-v0",
200-
new_command=(
201-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=multidiscrete_multidiscrete"
202-
" --agent=skrl_multidiscrete_multidiscrete_cfg_entry_point"
203-
),
213+
new_command=[
214+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
215+
"--agent=skrl_multidiscrete_multidiscrete_cfg_entry_point",
216+
"presets=multidiscrete_multidiscrete",
217+
],
204218
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
205219
),
206220
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_multidiscrete_multidiscrete_ppo_cfg.yaml",
@@ -218,7 +232,11 @@
218232
kwargs={
219233
"env_cfg_entry_point": deprecated_task_alias(
220234
old_task_id="Isaac-Cartpole-Showcase-Dict-Box-Direct-v0",
221-
new_command="--task=Isaac-Cartpole-Showcase-Direct-v0 presets=dict_box --agent=skrl_dict_box_cfg_entry_point",
235+
new_command=[
236+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
237+
"--agent=skrl_dict_box_cfg_entry_point",
238+
"presets=dict_box",
239+
],
222240
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
223241
),
224242
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_dict_box_ppo_cfg.yaml",
@@ -232,10 +250,11 @@
232250
kwargs={
233251
"env_cfg_entry_point": deprecated_task_alias(
234252
old_task_id="Isaac-Cartpole-Showcase-Dict-Discrete-Direct-v0",
235-
new_command=(
236-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=dict_discrete"
237-
" --agent=skrl_dict_discrete_cfg_entry_point"
238-
),
253+
new_command=[
254+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
255+
"--agent=skrl_dict_discrete_cfg_entry_point",
256+
"presets=dict_discrete",
257+
],
239258
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
240259
),
241260
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_dict_discrete_ppo_cfg.yaml",
@@ -249,10 +268,11 @@
249268
kwargs={
250269
"env_cfg_entry_point": deprecated_task_alias(
251270
old_task_id="Isaac-Cartpole-Showcase-Dict-MultiDiscrete-Direct-v0",
252-
new_command=(
253-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=dict_multidiscrete"
254-
" --agent=skrl_dict_multidiscrete_cfg_entry_point"
255-
),
271+
new_command=[
272+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
273+
"--agent=skrl_dict_multidiscrete_cfg_entry_point",
274+
"presets=dict_multidiscrete",
275+
],
256276
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
257277
),
258278
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_dict_multidiscrete_ppo_cfg.yaml",
@@ -270,7 +290,11 @@
270290
kwargs={
271291
"env_cfg_entry_point": deprecated_task_alias(
272292
old_task_id="Isaac-Cartpole-Showcase-Tuple-Box-Direct-v0",
273-
new_command="--task=Isaac-Cartpole-Showcase-Direct-v0 presets=tuple_box --agent=skrl_tuple_box_cfg_entry_point",
293+
new_command=[
294+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
295+
"--agent=skrl_tuple_box_cfg_entry_point",
296+
"presets=tuple_box",
297+
],
274298
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
275299
),
276300
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_tuple_box_ppo_cfg.yaml",
@@ -284,10 +308,11 @@
284308
kwargs={
285309
"env_cfg_entry_point": deprecated_task_alias(
286310
old_task_id="Isaac-Cartpole-Showcase-Tuple-Discrete-Direct-v0",
287-
new_command=(
288-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=tuple_discrete"
289-
" --agent=skrl_tuple_discrete_cfg_entry_point"
290-
),
311+
new_command=[
312+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
313+
"--agent=skrl_tuple_discrete_cfg_entry_point",
314+
"presets=tuple_discrete",
315+
],
291316
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
292317
),
293318
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_tuple_discrete_ppo_cfg.yaml",
@@ -301,10 +326,11 @@
301326
kwargs={
302327
"env_cfg_entry_point": deprecated_task_alias(
303328
old_task_id="Isaac-Cartpole-Showcase-Tuple-MultiDiscrete-Direct-v0",
304-
new_command=(
305-
"--task=Isaac-Cartpole-Showcase-Direct-v0 presets=tuple_multidiscrete"
306-
" --agent=skrl_tuple_multidiscrete_cfg_entry_point"
307-
),
329+
new_command=[
330+
"--task=Isaac-Cartpole-Showcase-Direct-v0",
331+
"--agent=skrl_tuple_multidiscrete_cfg_entry_point",
332+
"presets=tuple_multidiscrete",
333+
],
308334
consolidated_cfg_path=f"{__name__}.cartpole_env_cfg:CartpoleShowcasePresetsEnvCfg",
309335
),
310336
"skrl_cfg_entry_point": f"{agents.__name__}:skrl_tuple_multidiscrete_ppo_cfg.yaml",

0 commit comments

Comments
 (0)