rcmpy.paths package — docs

Skip to main content
`Ctrl`+`K`

# rcmpy.paths package

## Module contents

Common path lookups used by the package.

rcmpy.paths.default_cache_directory() → Path

  Returns the default cache directory used by the package.

rcmpy.paths.default_config_directory() → Path

  Returns the default config directory used by the package.

rcmpy.paths.default_state_directory() → Path

  Returns the default user-state directory used by the package.

rcmpy.paths.override_environ(key: str, value: Path | str) → Iterator[None]

  Override an environment variable as a managed context.

rcmpy.paths.override_environ_tempdir(key: str) → Iterator[Path]

  Set an environment variable to a temporary directory while it exists in the managed context.