/
base.py
143 lines (117 loc) · 5.36 KB
/
base.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
"""
Provides base RecordStore class.
:copyright: Copyright 2006-2015 by the Sumatra team, see doc/authors.txt
:license: BSD 2-clause, see LICENSE for details.
"""
from __future__ import unicode_literals
from builtins import object
from sumatra.recordstore import serialization
from sumatra.formatting import get_formatter
from ..core import component_type
@component_type
class RecordStore(object):
"""
Base class for record store implementations.
"""
required_attributes = ("list_projects", "save", "get", "list", "labels", "delete",
"delete_all", "delete_by_tag", "most_recent", "has_project")
def list_projects(self):
"""Return the names of all projects that have records in this store."""
raise NotImplementedError
def save(self, project_name, record):
"""Store the given record under the given project."""
raise NotImplementedError
def get(self, project_name, label):
"""Retrieve the record with the given label from the given project."""
raise NotImplementedError
def list(self, project_name, tags=None):
"""
Return a list of records for the given project.
If *tags* is not provided, list all records, otherwise list only records
that have been tagged with one or more of the tags.
"""
raise NotImplementedError
def labels(self, project_name):
"""Return the labels of all records in the given project."""
raise NotImplementedError
def delete(self, project_name, label):
"""Delete the record with the given label from the given project."""
raise NotImplementedError
def delete_all(self):
"""Delete all records from the store."""
raise NotImplementedError
def delete_by_tag(self, project_name, tag):
"""Delete all records from the given project that have been tagged with the given tag."""
raise NotImplementedError
def most_recent(self, project_name):
"""Return the most recent record from the given project."""
raise NotImplementedError
def export_records(self, records, indent=2):
"""Returns a string with a JSON representation of the given records."""
json_formatter = get_formatter('json')(records)
return json_formatter.long()
def export(self, project_name, indent=2):
"""Returns a string with a JSON representation of the project record store."""
records = self.list(project_name)
return self.export_records(records, indent=indent)
def import_(self, project_name, content):
"""Import records in JSON format."""
records = serialization.decode_records(content)
for record in records:
# need to check for duplicate record labels?
self.save(project_name, record)
def sync(self, other, project_name):
"""
Synchronize two record stores so that they contain the same records for
a given project.
Where the two stores have the same label (within a project) for
different records, those records will not be synced. The method
returns a list of non-synchronizable records (empty if the sync worked
perfectly).
"""
# what to do about syncing different Sumatra versions? Need to think about
# schema versioning
self_labels = set(self.labels(project_name))
other_labels = set(other.labels(project_name))
only_in_self = self_labels.difference(other_labels)
only_in_other = other_labels.difference(self_labels)
in_both = self_labels.intersection(other_labels)
non_synchronizable = []
for label in in_both:
if self.get(project_name, label) != other.get(project_name, label):
non_synchronizable.append(label)
for label in only_in_self:
other.save(project_name, self.get(project_name, label))
for label in only_in_other:
self.save(project_name, other.get(project_name, label))
return non_synchronizable
def sync_all(self, other):
"""Synchronize all records from all projects between two record stores."""
all_projects = set(self.list_projects()).union(other.list_projects())
for project_name in all_projects:
self.sync(other, project_name)
def has_project(self, project_name):
"""Does the store contain any records for the given project?"""
raise NotImplementedError
def update(self, project_name, field, value, tags=None):
"""
Modify the records for a given project.
Arguments:
*field*: the name of a record attribute, e.g. "datastore.root"
*value*:
"""
# there is only a limited number of attributes that should be
# modifiable, otherwise the whole point of using Sumatra for
# reproducibility is lost. Should we perhaps mark only certain
# attributes as modifiable?
# Note: this default implementation is likely to be slow. For most
# subclasses it would be best to override this method.
for record in self.list(project_name, tags):
parts = field.split(".")
obj = record
for part in parts[:-1]:
obj = getattr(obj, part)
setattr(obj, parts[-1], value)
self.save(project_name, record)
class RecordStoreAccessError(OSError):
pass