90 lines
2.6 KiB
Python
90 lines
2.6 KiB
Python
# Copyright (c) 2022-2025, The Isaac Lab Project Developers (https://github.com/isaac-sim/IsaacLab/blob/main/CONTRIBUTORS.md).
|
|
# All rights reserved.
|
|
#
|
|
# SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
"""Sub-module with utility for importing all modules in a package recursively."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import importlib
|
|
import pkgutil
|
|
import sys
|
|
|
|
|
|
def import_packages(package_name: str, blacklist_pkgs: list[str] | None = None):
|
|
"""Import all sub-packages in a package recursively.
|
|
|
|
It is easier to use this function to import all sub-packages in a package recursively
|
|
than to manually import each sub-package.
|
|
|
|
It replaces the need of the following code snippet on the top of each package's ``__init__.py`` file:
|
|
|
|
.. code-block:: python
|
|
|
|
import .locomotion.velocity
|
|
import .manipulation.reach
|
|
import .manipulation.lift
|
|
|
|
Args:
|
|
package_name: The package name.
|
|
blacklist_pkgs: The list of blacklisted packages to skip. Defaults to None,
|
|
which means no packages are blacklisted.
|
|
"""
|
|
# Default blacklist
|
|
if blacklist_pkgs is None:
|
|
blacklist_pkgs = []
|
|
# Import the package itself
|
|
package = importlib.import_module(package_name)
|
|
# Import all Python files
|
|
for _ in _walk_packages(
|
|
package.__path__, package.__name__ + ".", blacklist_pkgs=blacklist_pkgs
|
|
):
|
|
pass
|
|
|
|
|
|
def _walk_packages(
|
|
path: str | None = None,
|
|
prefix: str = "",
|
|
onerror: callable | None = None,
|
|
blacklist_pkgs: list[str] | None = None,
|
|
):
|
|
"""Yields ModuleInfo for all modules recursively on path, or, if path is None, all accessible modules.
|
|
|
|
Note:
|
|
This function is a modified version of the original ``pkgutil.walk_packages`` function. It adds
|
|
the `blacklist_pkgs` argument to skip blacklisted packages. Please refer to the original
|
|
``pkgutil.walk_packages`` function for more details.
|
|
"""
|
|
if blacklist_pkgs is None:
|
|
blacklist_pkgs = []
|
|
|
|
def seen(p, m={}):
|
|
if p in m:
|
|
return True
|
|
m[p] = True # noqa: R503
|
|
|
|
for info in pkgutil.iter_modules(path, prefix):
|
|
# check blacklisted
|
|
if any([black_pkg_name in info.name for black_pkg_name in blacklist_pkgs]):
|
|
continue
|
|
|
|
# yield the module info
|
|
yield info
|
|
|
|
if info.ispkg:
|
|
try:
|
|
__import__(info.name)
|
|
except Exception:
|
|
if onerror is not None:
|
|
onerror(info.name)
|
|
else:
|
|
raise
|
|
else:
|
|
path = getattr(sys.modules[info.name], "__path__", None) or []
|
|
|
|
# don't traverse path items we've seen before
|
|
path = [p for p in path if not seen(p)]
|
|
|
|
yield from _walk_packages(path, info.name + ".", onerror, blacklist_pkgs)
|