iter_libraries¶
Functionality for iterating through a cloned Adafruit CircuitPython Bundle to run functions on each library
Author(s): Alec Delaney
Module Contents¶
Functions¶
|
Iterate through the libraries and run a given function with the |
Attributes¶
Instruction set as a tuple of a function to run on a library, |
|
Result of function(s) run on a library as a tuple of the |
- iter_libraries.LibFunc_IterInstruction :TypeAlias¶
Instruction set as a tuple of a function to run on a library, a list of the positional arguments to be provided to it, and a dictionary of keyword arguments to be provided to it
- iter_libraries.LibFunc_IterResult :TypeAlias¶
Result of function(s) run on a library as a tuple of the path to the library modified and a list of the result(s) of the function(s)
- iter_libraries.iter_library_with_func(bundle_path: cpy_scripts.lib_funcs.StrPath, func_workflow: Iterable[LibFunc_IterInstruction]) List[LibFunc_IterResult]¶
Iterate through the libraries and run a given function with the provided arguments
- Parameters
bundle_path (StrPath) – The path to the cloned bundle
func_workflow (Iterable) – An iterable of tuples containing pairs of functions and corresponding arguments; the path to each specific library is automatically provided to the functions, so the functions must account for it
- Returns
A list containing tuples of pairs of each library path and a list with the results from each function
- Return type
list