guibot.fileresolver module

Cached and reused paths for target files to search in and load target data from.

SUMMARY

INTERFACE

class guibot.fileresolver.FileResolver

Bases: object

Handler for currently used target paths or sources of targets with a desired name.

The methods of this class are shared among all of its instances.

add_path(directory: str) → None

Add a path to the list of currently accessible paths if it wasn’t already added.

Parameters:

directory – path to add

remove_path(directory: str) → bool

Remove a path from the list of currently accessible paths.

Parameters:

directory – path to add

Returns:

whether the removal succeeded

clear() → None

Clear all currently accessible paths.

search(filename: str, restriction: str = '', silent: bool = False) → str | None

Search for a filename in the currently accessible paths.

Parameters:

• filename – filename of the target to search for

• restriction – simple string to restrict the number of paths

• silent – whether to return None instead of error out

Returns:

the full name of the found target file or None if silent and no file was found

Raises:

FileNotFoundError if no such file was found and not silent

class guibot.fileresolver.CustomFileResolver(*paths: tuple[type, ...])

Bases: object

Class to be used to search for files inside certain paths.

Inside the context of an instance of this class, the paths in the shared list in FileResolver will be temporarily replaced by the paths passed to the constructor of this class. This means that any call to FileResolver.search() will take only these paths into account.