A provider for checkbox jobs when used in development mode.
This provider is only likely to be used when developing checkbox inside a
virtualenv environment. It assumes the particular layout of code and data
(relative to the code directory) directories.
Unlike normal v1 providers it has two legacy quirks that should not be
changed before we can stop using the old checkbox codebase.
- The location for provider-specific executables is ‘$base/scripts’. This
is implemented by custom bin_dir.
- The location for whitelists is ‘$base/data/whitelists’. This is
implemented by custom whitelists_dir.
It also has some quirks which might be revisited and dropped:
- To ensure that old checkbox library codebase can be imported (whitout
installing or developing checkbox) it implements
extra_PYTHONPATH.
- It has an utility method called exists() that makes one piece of
code shorter (save the time it takes to create CheckBoxSrcProvider and
catch-ignore ProviderNotFound).
-
bin_dir[source]
Return an absolute path of the scripts directory
Note
The scripts may not work without setting PYTHONPATH and
CHECKBOX_SHARE.
-
static exists()[source]
Check if the source provider exists and can be actually used
Return additional entry for PYTHONPATH
This entry is required for CheckBox scripts to import the correct
CheckBox python libraries.
-
whitelists_dir[source]
Return an absolute path of the whitelist directory