Code completion works but Pylance still shows warning

[songlin]

Hi Author,

Thanks for sharing the great tool.

After I installed the tool, code completion works fine, but VSCode still complains about the import. E.g.,

import omni.isaac.core.world.world import World # not works 

from isaacsim.core.api.world.world import World # Works!

import omni.replicator.core as rep # not works 
import carb.settings # not works 
import omni.usd # not works 
import omni.kit.commands # not works 

I installed Issacsim-4.5.0 in a local virtual environment managed by uv.

Do you know how to fix it?

Thanks
Songlin

[SevenFo]

@songlin
Hi!

Thanks for trying out the tool! I'm glad to hear that the code completion is working for the isaacsim packages.

What you're observing is actually the expected behavior based on the tool's default configuration. Let me explain why.

The tool works by creating symbolic links based on a prefix setting in the configuration file (isaacsim_links/core.py). By default, I have only enabled the "isaacsim." prefix for most paths. The reason for this is that adding symlinks for core omni.*, carb.*, etc., packages can sometimes interfere with Isaac Sim's internal module discovery logic when it starts up. This can lead to runtime errors, as noted in the comments of the config file.

However, if you need code completion for those other packages and are willing to accept the potential risk of startup errors (which may or may not affect your simulation's functionality), you can manually change the configuration.

Here are the steps to do that:

1. Remove the existing links to start fresh:

   isaacsim-links --remove

2. Modify the configuration file: Navigate to the source code and open isaacsim_links/core.py. In the get_ext_configs() function, you can add "omni.", "carb.", etc., to the prefix lists for the relevant configurations. For example:

   # Before
   "prefix": ["isaacsim."],
   
   # After
   "prefix": ["isaacsim.", "omni."],

3. Re-install your modified version of the tool:

   pip install .  # or pip install -e . if you want to edit it further

4. Create the new links with the updated configuration:

   isaacsim-links --create

I want to be transparent that this tool is a temporary "hack" to make development easier for Isaac Sim 4.5. If you encounter any functional problems after adding the extra links, the first troubleshooting step should always be to run isaacsim-links --remove and see if the issue is resolved.

The good news is that NVIDIA seems to have addressed this code completion issue in the Isaac Sim 5.0 release. Therefore, the most stable and recommended long-term solution would be to upgrade to the latest version when you get the chance.

Hope this helps clarify things!