-
Notifications
You must be signed in to change notification settings - Fork 11
/
resources.py
84 lines (66 loc) · 2.83 KB
/
resources.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
# Copyright (c) 2020 ING Wholesale Banking Advanced Analytics
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
# the Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Resources lookup file for histogrammar
import pathlib
from pkg_resources import resource_filename
import histogrammar as hg
# data files that are shipped with histogrammar.
_DATA = {
_.name: _
for _ in pathlib.Path(resource_filename(hg.__name__, "test_data")).glob("*")
}
# Tutorial notebooks
_NOTEBOOK = {
_.name: _
for _ in pathlib.Path(resource_filename(hg.__name__, "notebooks")).glob("*.ipynb")
}
# Resource types
_RESOURCES = dict(data=_DATA, notebook=_NOTEBOOK)
def _resource(resource_type, name: str) -> str:
"""Return the full path filename of a resource.
:param str resource_type: The type of the resource.
:param str name: The name of the resource.
:returns: The full path filename of the fixture data set.
:rtype: str
:raises FileNotFoundError: If the resource cannot be found.
"""
full_path = _RESOURCES[resource_type].get(name, None)
if full_path and full_path.exists():
return str(full_path)
raise FileNotFoundError(
'Could not find {resource_type} "{name!s}"! Does it exist?'.format(
resource_type=resource_type, name=name
)
)
def data(name: str) -> str:
"""Return the full path filename of a shipped data file.
:param str name: The name of the data.
:returns: The full path filename of the data.
:rtype: str
:raises FileNotFoundError: If the data cannot be found.
"""
return _resource("data", name)
def notebook(name: str) -> str:
"""Return the full path filename of a tutorial notebook.
:param str name: The name of the notebook.
:returns: The full path filename of the notebook.
:rtype: str
:raises FileNotFoundError: If the notebook cannot be found.
"""
return _resource("notebook", name)