module documentation
Undocumented
| Function | find |
Find all paths which match the search criteria. |
| Function | _get |
Compare param collection of search dirs with valid names, raises ValueError if invalid. |
def find_in_workspaces(search_dirs=None, project=None, path=None, _workspaces=None, considered_paths=None, first_matching_workspace_only=False, first_match_only=False, workspace_to_source_spaces=None, source_path_to_packages=None):
¶
Find all paths which match the search criteria.
All workspaces are searched in order. Each workspace, each search_in subfolder, the project name and the path are concatenated to define a candidate path. If the candidate path exists it is appended to the result list. Note: the search might return multiple paths for 'share' from devel- and source-space.
| Parameters | |
| search | Undocumented |
| project | The project name to search for (optional, not possible with the global search_in folders 'bin' and 'lib'), str |
| path | The path, str |
| _workspaces | (optional, used for unit tests), the list of workspaces to use. |
| considered | If not None, function will append all path that were searched |
| first | if True returns all results found for first workspace with results |
| first | if True returns first path found (supercedes first_matching_workspace_only) |
| workspace | the dictionary is populated with mappings from workspaces to source paths, pass in the same dictionary to avoid repeated reading of the catkin marker file |
| source | the dictionary is populated with mappings from source paths to packages, pass in the same dictionary to avoid repeated crawling |
| search | The list of subfolders to search in (default contains all valid values: 'bin', 'etc', 'lib', 'libexec', 'share'), list |
| Returns | |
| List of paths | |
| Raises | |
ValueError | if search_dirs contains an invalid folder name |
Compare param collection of search dirs with valid names, raises ValueError if invalid.
Maintains the order of param if any. If project is given other names are allowed than without.
| Parameters | |
| search | collection of foldernames (basename) to search for |
| project | the project to search in or None |
| Raises | |
Unknown exception | ValueError |