/
crud.py
282 lines (187 loc) · 6.91 KB
/
crud.py
1
2
3
4
5
6
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# Standard Library
from typing import Mapping
# Third Party
import cachetools
import semver
from loguru import logger
# Local
import bel.core.settings as settings
import bel.db.arangodb as arangodb
from bel.belspec.enhance import create_ebnf_parser, create_enhanced_specification
from bel.schemas.belspec import BelSpec, BelSpecVersions
# ArangoDB handles
bel_db = arangodb.bel_db
bel_config_name = arangodb.bel_config_name
bel_config_coll = arangodb.bel_config_coll
""" Notes
belspec_versions = {doc_type: belspec_versions, versions: List[], latest: str}
belspec_{version} = {doc_type: belspec, belspec: <belspec>, enhanced_belspec: <enhanced_belspec>}
belhelp_{version} = {doc_type: belhelp, belhelp: <belhelp>}
"""
def get_latest_version() -> str:
"""Get latest version of BEL installed"""
doc = bel_config_coll.get("belspec_versions")
return doc["latest"]
def get_default_version() -> str:
"""Get default BEL version"""
return settings.BEL_DEFAULT_VERSION
def max_semantic_version(version_strings) -> str:
"""Return max semantic version from list"""
versions = []
for version_str in version_strings:
if version_str == "latest":
continue
try:
versions.append(semver.VersionInfo.parse(version_str))
except Exception:
pass # Skip non-semantic versioned belspecs for latest version
max_version = str(max(versions))
return max_version
def update_belspec_versions():
"""Update BEL Spec versions record
And adding the latest version
"""
query = f"""
FOR doc IN {bel_config_name}
FILTER doc.doc_type == "belspec"
RETURN doc.orig_belspec.version
"""
version_strings = sorted(list(bel_db.aql.execute(query)), reverse=True)
latest = max_semantic_version(version_strings)
doc = {
"_key": "belspec_versions",
"doc_type": "belspec_versions",
"latest": latest,
"default": settings.BEL_DEFAULT_VERSION,
"versions": version_strings,
}
bel_config_coll.insert(doc, overwrite=True)
@cachetools.cached(cachetools.TTLCache(maxsize=1, ttl=600))
def get_belspec_versions() -> dict:
doc = bel_config_coll.get(f"belspec_versions")
doc["versions"].insert(0, "latest")
if "latest" in doc:
return BelSpecVersions(**doc).dict()
else:
return {}
def get_best_match(query_str, belspec_versions: BelSpecVersions):
"""Get best match to query version in versions or return latest"""
try:
query = semver.VersionInfo.parse(query_str)
except Exception as e:
logger.warning(
f"Could not parse belspec version {query_str} - returning latest version instead"
)
return belspec_versions["latest"]
versions = []
for version_str in sorted(belspec_versions["versions"], reverse=True):
if version_str == "latest":
continue
try:
versions.append(semver.VersionInfo.parse(version_str))
except Exception:
pass # Skip non-semantic versioned belspecs for latest version
match = None
matches = 0
for version in versions:
if (
query.major == version.major
and query.minor == version.minor
and query.patch == version.patch
):
if matches < 3:
match = version
matches = 3
elif query.major == version.major and query.minor == version.minor:
if matches < 2:
match = version
matches = 2
elif query.major == version.major:
if matches < 1:
match = version
matches = 1
if not match:
return belspec_versions["latest"]
return str(match)
def check_version(version: str = "latest", versions: BelSpecVersions = None) -> str:
""" Check if version is valid and if not return default or latest """
if not version:
version = settings.BEL_DEFAULT_VERSION
if versions is None:
versions = get_belspec_versions()
if version == "latest":
version = versions["latest"]
elif version not in versions["versions"]:
original_version = version
version = get_best_match(version, versions)
# logger.debug(f"BEL version {original_version} out of date using {version}")
return version
def get_belspec(version: str = "latest") -> dict:
"""Get original/unenhanced belspec"""
if version == "latest":
version = get_latest_version()
doc = bel_config_coll.get(f"belspec_{version}")
if "orig_belspec" in doc:
return doc["orig_belspec"]
else:
return {}
@cachetools.cached(cachetools.TTLCache(maxsize=10, ttl=600))
def get_enhanced_belspec(version: str = "latest") -> dict:
"""Get enhanced belspec"""
if version == "latest":
version = get_latest_version()
doc = bel_config_coll.get(f"belspec_{version}")
if doc is not None and "enhanced_belspec" in doc:
return doc["enhanced_belspec"]
else:
return {}
def get_ebnf(version) -> str:
"""Generate EBNF from BEL Specification"""
if version == "latest":
version = get_latest_version()
doc = bel_config_coll.get(f"belspec_{version}")
if "orig_belspec" in doc:
ebnf = create_ebnf_parser(doc["orig_belspec"])
return ebnf
else:
return f"No Specification found for {version}"
def update_belspec(belspec: BelSpec):
"""Create or update belspec"""
belspec = belspec.dict()
version = belspec["version"]
enhanced_belspec = create_enhanced_specification(belspec)
doc = {
"_key": f"belspec_{version}",
"doc_type": "belspec",
"orig_belspec": belspec,
"enhanced_belspec": enhanced_belspec,
}
result = bel_config_coll.insert(doc, overwrite=True)
logger.info("Result of loading belspec", version=version, result=result)
update_belspec_versions()
def delete_belspec(version: str):
"""Delete BEL specification"""
if version == "latest":
raise ValueError("Cannot delete `latest` version")
bel_config_coll.delete(f"belspec_{version}")
update_belspec_versions()
def get_belhelp(version: str = "latest") -> dict:
"""Get BELspec Help
This document contains supporting documentation for functions and relations
for the BELSpec
"""
if version == "latest":
version = get_latest_version()
doc = bel_config_coll.get(f"belhelp_{version}")
return doc["belhelp"]
def update_belhelp(belhelp: dict):
"""Create or update belhelp"""
version = belhelp["version"]
doc = {"_key": f"belhelp_{version}", "doc_type": "belhelp", "belhelp": belhelp}
bel_config_coll.insert(doc, overwrite=True)
return {"msg": "Loaded belspec help"}
def delete_belhelp(version: str):
"""Delete BEL specification help"""
if version == "latest":
raise ValueError("Cannot delete `latest` version")
r = bel_config_coll.delete(f"belhelp_{version}")