join

join(key, *subkeys, name=None, ensure_exists=True)

Return the home data directory for the given module.

Parameters:

• key (str) – The name of the module. No funny characters. The envvar <key>_HOME where key is uppercased is checked first before using the default home directory.

• subkeys (str) – A sequence of additional strings to join

• name (Optional[str]) – The name of the file (optional) inside the folder

• ensure_exists (bool) – Should all directories be created automatically? Defaults to true.

Return type:

Path

Returns:

The path of the directory or subdirectory for the given module.