entry_points.py#
Various functions for working with entry points.
- openmdao.utils.entry_points.compute_entry_points(package, dir_excludes=(), outstream=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)[source]
Display what the entry point dict should be based on classes that exist in package.
- Parameters:
- packagestr
The package name.
- dir_excludesiter of str
Glob patterns for directory exclusion.
- outstreamfile-like
Output stream. Defaults to stdout.
- Returns:
- dict
Mapping of entry point groups to entry point strings.
- openmdao.utils.entry_points.find_repos(types=None, tablefmt='tabulator')[source]
Search github for repositories containing OpenMDAO plugins.
- Parameters:
- typesiter of str or None
Sequence of entry point type names, e.g., component, group, driver, etc.
- tablefmtstr
Format for generated table. Defaults to ‘tabulator’ which generates a sortable, filterable web-based table.
- Returns:
- dict
Nested dict of the form dct[eptype] = list of URLs.
- openmdao.utils.entry_points.list_installed(types=None, includes=None, excludes=(), show_docs=False)[source]
Print a table of installed entry points.
- Parameters:
- typesiter of str or None
Sequence of entry point type names, e.g., component, group, driver, etc.
- includesiter of str or None
Sequence of packages to include.
- excludesiter of str
Sequence of packages to exclude.
- show_docsbool
If True, display docstring after each entry.
- Returns:
- dict
Nested dict of the form dct[eptype][target] = (name, module, docs).
- openmdao.utils.entry_points.split_ep(entry_point)[source]
Split an entry point string into name, module, target.
- Parameters:
- entry_pointEntryPoint
Entry point object.
- Returns:
- tuple
(entry_point_name, module_name, target_name).