❭ API reference ❭ config ❭

file_locking¶

Default values for file locking.

This module allows the user to set default fallback values for file locking. This default fallback value is only used when the env variable "ISF_DISTRIBUTED_LOCK_CONFIG" is unset. It is recommended to make use of this env variable when setting up your environment, especially for HPC contexts.

For example, to use the zookeeper locking configuration:

• launch a zookeeper server

• write out the configuration for your session:

  config = [{
      'config': {
          'hosts': 'ip:port'
      },
      'type': 'zookeeper'
  }]
  

• set "ISF_DISTRIBUTED_LOCK_CONFIG" to the filepath pointing to this config file.

Attributes¶