optional_packages¶
- sbpy.utils.optional_packages(*packages, message=None)[source]¶
Decorator that warns if the arguments are not valid packages.
- Parameters:
- *modulesstr
The names of packages to test.
- messagestr
An additional note to show the user, e.g., a description of the fallback behavior.
- Returns:
- successbool
True
if all optional packages are available.
Warning
Examples
>>> from sbpy.utils import optional_packages >>> optional_packages("unavailable_package") OptionalPackageUnavailable: Optional package `unavailable_package` is unavailable.