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

plugintest: Document core version code & add to PLUGINS.md

Browse Source 
* New PLUGINS.md section 'Checking core EDMC version'.
* And the same comments might as well be in the plugintest/load.py.
This commit is contained in:
Athanasius 2021-03-28 12:01:05 +01:00
parent dc920fdc6a
commit b841d434e5
2 changed files with 40 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
PLUGINS.md
View File

@ -170,6 +170,40 @@ functions, in the output.
---
### Checking core EDMC version
If you have code that needs to act differently under different versions of
this application then you can check the core version using:
```python
import semantic_version
from config import appversion
...
if isinstance(appversion, str):
core_version = appversion # Up until 5.0.0-beta1 this is a string
elif callable(appversion):
core_version = appversion() # From 5.0.0-beta1 it's a function
else:
core_version = '<UNKNOWN!>' # Paranoia
# Either way you now have a string
logger.info(f'Core EDMC version: {core_version}')
# The easiest way to compare is using semantic_version, so convert
core_version_sv = semantic_version.Version(core_version)
# And then compare like this
if core_version_sv < semantic_version.Version('5.0.0-beta1'):
logger.info('EDMC core version is before 5.0.0-beta1')
else:
logger.info('EDMC core version is at least 5.0.0-beta1')
```
---
### Startup
EDMC will import the `load.py` file as a module and then call the

9
docs/examples/plugintest/load.py
View File

@ -94,16 +94,19 @@ def plugin_start3(plugin_dir: str) -> str:
:return: 'Pretty' name of this plugin.
"""
if isinstance(appversion, str):
core_version = appversion
core_version = appversion # Up until 5.0.0-beta1 this is a string
elif callable(appversion):
core_version = appversion()
core_version = appversion() # From 5.0.0-beta1 it's a function
else:
core_version = '<UNKNOWN!>'
core_version = '<UNKNOWN!>' # Paranoia
# Either way you now have a string
logger.info(f'Core EDMC version: {core_version}')
# The easiest way to compare is using semantic_version, so convert
core_version_sv = semantic_version.Version(core_version)
# And then compare like this
if core_version_sv < semantic_version.Version('5.0.0-beta1'):
logger.info('EDMC core version is before 5.0.0-beta1')