Mercurial > hg > WSGraph
annotate wsgraph/model.py @ 28:4bed1424bb3f
more notes to self
| author | Jeff Hammel <jhammel@mozilla.com> |
|---|---|
| date | Wed, 12 Dec 2012 18:58:08 -0800 |
| parents | d1a8c1436ded |
| children | 5f14a4183bf2 |
| rev | line source |
|---|---|
| 28 | 1 |
| 2 import sys | |
| 0 | 3 from abc import abstractmethod |
|
9
0affca1f4dc0
start using deepcopy since lord knows we cant trust users
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
4 from copy import deepcopy |
| 15 | 5 from utils import isiterable |
| 0 | 6 |
| 25 | 7 class Graph(object): |
| 28 | 8 """ |
| 9 abstract base class for WSGraph model of a graph | |
| 10 | |
| 11 WSGraph is interacted with by implementing | |
| 12 wsgraph.model.Graph object for a desired interface | |
| 13 """ | |
| 0 | 14 |
| 15 @abstractmethod | |
| 16 def node(self, name, **values): | |
|
10
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
17 """ |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
18 get or set a node |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
19 |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
20 When setting a node, a value of `None` will pop the value from |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
21 the nodal values |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
22 """ |
| 11 | 23 # TODO: values should not be **kwargs as you could conceivably want |
| 24 # to set a node or edge to an empty dict | |
| 25 # Instead, should be (self, name, values=None) | |
| 0 | 26 |
| 27 @abstractmethod | |
| 28 def nodes(self): | |
| 29 """returns a list of all nodes""" | |
| 30 | |
| 31 @abstractmethod | |
|
10
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
32 def edge(self, node1, node2, **values): |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
33 """ |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
34 get or set edge from node1 to node2 |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
35 """ |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
36 |
|
81d68388ec97
some nonsense about how this model is full of holes and how it should be better
Jeff Hammel <jhammel@mozilla.com>
parents:
9
diff
changeset
|
37 @abstractmethod |
| 0 | 38 def edges(self): |
| 39 """returns a list of all edges""" | |
| 40 | |
|
23
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
41 def __call__(self): |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
42 """ |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
43 returns JSGN format of graph: |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
44 {'nodes': {'node1': {}, |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
45 'node2': {}, ...}, |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
46 'edges': {'node1': {'node2': {}, |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
47 'node3': {}, ...}, |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
48 'node2': {'node1': {}, ...}} |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
49 } |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
50 """ |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
51 retval = {'nodes': {}, 'edges': {}} |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
52 for node in self.nodes(): |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
53 retval['nodes'][node] = self.node(node) |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
54 for node1, node2 in self.edges(): |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
55 retval['edges'].setdefault(node1, {})[node2] = self.edge(node1, node2) |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
56 return retval |
|
24d57daaca21
well, now the request dispatches
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
57 |
| 0 | 58 def __getitem__(self, key): |
| 59 """ | |
| 60 if key is a basestring, return the node of that name; | |
| 61 if key is a 2-tuple/list, return the edge of that name | |
| 62 """ | |
| 63 | |
| 15 | 64 if isinstance(key, basestring) or (not isiterable(key)): |
| 8 | 65 return self.node(key) |
| 66 else: | |
| 67 return self.edge(*key) | |
| 68 | |
| 69 def __contains__(self, key): | |
| 70 """ | |
| 71 if key is ..., returns if that node is in the graph | |
| 72 if key is a 2-tuple/list, returns if the edge is in the graph | |
| 73 """ | |
| 74 # XXX not necessarily the best implementation! | |
| 15 | 75 if isinstance(key, basestring) or (not isiterable(key)): |
| 8 | 76 return key in self.nodes() |
| 77 else: | |
| 78 return tuple(key) in self.edges() | |
| 0 | 79 |
| 15 | 80 |
| 25 | 81 class MemoryCache(Graph): |
| 15 | 82 """volatile in-memory representation of a graph""" |
| 0 | 83 |
| 84 def __init__(self): | |
| 85 self._edges = {} | |
| 86 self._nodes = {} | |
| 87 | |
| 88 def node(self, name, **values): | |
| 89 if values: | |
| 90 # setter | |
|
9
0affca1f4dc0
start using deepcopy since lord knows we cant trust users
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
91 self._nodes[name] = deepcopy(values) |
| 0 | 92 else: |
| 93 # getter | |
|
9
0affca1f4dc0
start using deepcopy since lord knows we cant trust users
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
94 # TODO: deepcopy |
| 0 | 95 return self._nodes.get(name, None) |
| 96 | |
| 97 def nodes(self): | |
| 98 return self._nodes.keys() | |
| 99 | |
| 100 def edge(self, node1, node2, **values): | |
| 101 if values: | |
| 102 # setter | |
|
9
0affca1f4dc0
start using deepcopy since lord knows we cant trust users
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
103 self._edges[(node1, node2)] = deepcopy(values) |
| 0 | 104 else: |
| 105 # getter | |
|
9
0affca1f4dc0
start using deepcopy since lord knows we cant trust users
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
106 # TODO: deepcopy |
| 0 | 107 return self._edges.get((node1, node2), None) |
| 108 | |
| 109 def edges(self): | |
| 110 return self._edges.keys() | |
| 25 | 111 |
| 112 class FileCache(MemoryCache): | |
| 113 """on-disk JSON file cache""" | |
| 114 | |
| 115 def __init__(self, filename): | |
| 116 self.filename = filename | |
| 117 raise NotImplementedError | |
| 118 | |
| 119 # TODO: CLI entry point to convert from one model to another | |
| 28 | 120 # def main(args=sys.argv[1:]): |