Config
Represents a config file and it's contents
Source code in src\utils\config.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|
config_data
property
Gets all the config data from the config file.
file_path
property
writable
Gets the config file's file path.
__init__(path='./conf/bot_config.yaml')
Creates an instance of the Config class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path
|
str
|
The path to the config file. |
'./conf/bot_config.yaml'
|
Source code in src\utils\config.py
get_section_item(section_name, index)
Gets an item that is part of a specific section of the config file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
section_name
|
str
|
The section that the item is in. |
required |
index
|
str
|
The item that is being looked for in the config. |
required |
Raises:
Type | Description |
---|---|
AttributeError
|
Is raised when the specified value is not in the config file. |
Returns:
Type | Description |
---|---|
str
|
str | int | float | list | dict: The value of the specified item. |
Source code in src\utils\config.py
get_unique_item(index)
Returns the value of a unique item in the config file
Parameters:
Name | Type | Description | Default |
---|---|---|---|
index
|
str
|
The name of the item being looked for in the config. |
required |
Raises:
Type | Description |
---|---|
AttributeError
|
Is raised when the index value is not found in the config file |
Returns:
Type | Description |
---|---|
str | int | float | list | dict
|
str | int | float | list | dict: The value of the specified item. |
Source code in src\utils\config.py
update_unique_item(index, new_value)
Updates the value of a unique item in the config file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
index
|
str
|
The name of the item being looked for in the config. |
required |
new_value
|
str | int | float | list
|
The new value that the item in the config file is being set to. |
required |
Raises:
Type | Description |
---|---|
AttributeError
|
Is raised when the value could not be set due the item not existing in the config. |