ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-22 20:00:29 +03:00
Code Issues Projects Releases Wiki Activity

PLUGINS: Document better config forwards compatibility code

Browse Source
This commit is contained in:
Athanasius 2021-05-11 21:48:03 +01:00
parent e5bbf73acb
commit 682c48e5ac
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
PLUGINS.md
View File

@ -331,18 +331,24 @@ set and two get methods, the new methods provide better type safety.
If you want to maintain compatibility with pre-5.0.0 versions of this
application (please encourage plugin users to update!) then you'll need to
do something like:
include this code in at least once in your plugin (no harm in putting it in
all modules/files):
```python
from config import config
config_getstring = getattr(config, 'get_str', getattr(config, 'get'))
config_getbool = getattr(config, 'get_bool', getattr(config, 'get'))
config_getlist = getattr(config, 'get_list', getattr(config, 'get'))
config_getinteger = getattr(config, 'get_int', getattr(config, 'getint'))
# For compatibility with pre-5.0.0
if not hasattr(config, 'get_int'):
config.get_int = config.getint
...
somebool = config_getbool('myplugin_bool')
if not hasattr(config, 'get_str'):
config.get_str = config.get
if not hasattr(config, 'get_bool'):
config.get_bool = config.get
if not hasattr(config, 'get_list'):
config.get_list = config.get
```
**Be sure to use a unique prefix for any settings you save so as not to clash