Reference

Contents

• Reference

  • Public Methods

  • Public Properties

---

Public Methods

classmethod is_locked()

Helper method which is used to check if the configuration is

being used by the client.session decorator. Any attempt

to change the configuration while the session is open will cause

a RuntimeError to be thrown.

Returns

Value of the config lock status.

Return type

bool

---

Public Properties

class property file

The full path to the configuration file which should be used by the client and the server objects.

Can be assigned either a pathlib.Path or a str object.

Raises

TypeError – on attempt to delete the property.

Returns

Full path to the config file to be used.

Return type

pathlib.Path

class property settings

Deep copied dictionary of the currently loaded configuration.

This property is READ ONLY.

Raises

• TypeError – on attempt to modify the property.

• TypeError – on attempt to delete the property.

Return type

dict