Skip to content

Adds pre-commit to declare isaacsim.core.utils as banned-api #3926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+14 −0
Open

Adds pre-commit to declare isaacsim.core.utils as banned-api #3926

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b40fa1
add banned api check
pascal-roth Nov 3, 2025
0927191
update version
pascal-roth Nov 3, 2025
f3ec976
Merge branch 'main' into feature/banned-api
ooctipus Nov 5, 2025
5796ce6
Merge branch 'main' into feature/banned-api
pascal-roth Nov 14, 2025
2b8a12a
Merge branch 'main' into feature/banned-api
pascal-roth Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,8 @@ repos:
- id: rst-backticks
- id: rst-directive-colons
- id: rst-inline-touching-normal
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.14.3
hooks:
- id: ruff
args: ["--fix", "--exit-non-zero-on-fix"]
9 changes: 9 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,12 @@ quiet-level = 0
ignore-words-list = "haa,slq,collapsable,buss,reacher"
# todo: this is hack to deal with incorrect spelling of "Environment" in the Isaac Sim grid world asset
exclude-file = "source/isaaclab/isaaclab/sim/spawners/from_files/from_files.py"


[tool.ruff.lint]
select = ["TID251"] # Enables the banned-api rule

[tool.ruff.lint.flake8-tidy-imports.banned-api]
"isaacsim.core.utils".msg = "Do not import from isaacsim.core.utils; use internal framework utilities instead."
"isaacsim.core.utils.prims".msg = "Do not import from isaacsim.core.utils.prims; use isaaclab.sim.utils.prims instead."
"isaacsim.core.utils.stage".msg = "Do not import from isaacsim.core.utils.stage; use isaaclab.sim.utils.stage instead."
Comment on lines +107 to +109
Copy link
Contributor

@greptile-apps greptile-apps bot Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: missing isaacsim.core.utils.torch - 9 files import this submodule and won't be caught

Suggested change
"isaacsim.core.utils".msg = "Do not import from isaacsim.core.utils; use internal framework utilities instead."
"isaacsim.core.utils.prims".msg = "Do not import from isaacsim.core.utils.prims; use isaaclab.sim.utils.prims instead."
"isaacsim.core.utils.stage".msg = "Do not import from isaacsim.core.utils.stage; use isaaclab.sim.utils.stage instead."
"isaacsim.core.utils".msg = "Do not import from isaacsim.core.utils; use internal framework utilities instead."
"isaacsim.core.utils.prims".msg = "Do not import from isaacsim.core.utils.prims; use isaaclab.sim.utils.prims instead."
"isaacsim.core.utils.stage".msg = "Do not import from isaacsim.core.utils.stage; use isaaclab.sim.utils.stage instead."
"isaacsim.core.utils.torch".msg = "Do not import from isaacsim.core.utils.torch; use isaaclab.utils.torch instead."

Loading