/
core.py
79 lines (62 loc) · 2.15 KB
/
core.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
""" Tool for managing licenses through environment variables
:Author: Jonathan Karr <karr@mssm.edu>
:Date: 2021-09-1
:Copyright: 2021, Center for Reproducible Biomedical Modeling
:License: MIT
"""
import abc
import contextlib
import os
class LicenseManager(contextlib.AbstractContextManager):
""" Base singleton class for managing setting up licenses for software packages from environment variables """
__instance = None
def __new__(cls):
if cls.__instance is None:
cls.__instance = super(LicenseManager, cls).__new__(cls)
return cls.__instance
@property
@classmethod
@abc.abstractmethod
def ENV_VAR_PREFIX(cls):
""" Get the prefix for environment variables
Returns:
:obj:`str`: prefix for environment variables
"""
pass # pragma: no cover
@abc.abstractmethod
def is_package_available(self):
""" Determine whether the package is installed and available
Returns:
:obj:`bool`: whether the package is installed and available
"""
pass # pragma: no cover
def get_keys_from_env_vars(self):
""" Get the license keys for the software package from environment variables
Returns:
:obj:`dict`: environment license variables for a software package
"""
keys = {}
for key, val in os.environ.items():
if key.startswith(self.ENV_VAR_PREFIX + '_') and len(key) > len(self.ENV_VAR_PREFIX) + 1:
key = key[len(self.ENV_VAR_PREFIX) + 1:]
keys[key] = val
return keys
@abc.abstractmethod
def start(self):
""" Initialize the usage of the software package with license keys """
pass # pragma: no cover
@abc.abstractmethod
def end(self):
""" Terminate usage of the software package with license keys """
pass # pragma: no cover
def __enter__(self):
""" Enter a context """
self.start()
def __exit__(self, exc_type, exc_value, traceback):
""" Exit a context
Args:
exc_type
exc_value
traceback
"""
self.end()