ogstools.definitions module#

ogstools.definitions.usr_tmp_dir(id='')[source]#

Create a user-specific temporary directory for a given identifier.

Parameters:

id (str) – Optional subdirectory name.

Return type:

Path

Returns:

The pathlib.Path to the created directory.

ogstools.definitions.temp_file(suffix, dir='', prefix='')[source]#

A file path in the ogstools user tmp directory.

Parameters:
  • suffix (str) – file extension/suffix.

  • dir (str) – Subdirectory name under the user temp path.

  • prefix (str) – filename prefix.

Return type:

Path

ogstools.definitions.temp_dir(prefix='', dir='', suffix='')[source]#

A folder path in the ogstools user tmp directory.

Parameters:
  • prefix (str) – directory prefix.

  • dir (str) – Subdirectory name under the user temp path.

  • suffix (str) – directory suffix.

Return type:

Path