1
|
|
|
"""Holder |
2
|
|
|
|
3
|
|
|
A class to represent a owner of subjects. |
4
|
|
|
|
5
|
|
|
https://github.com/rochars/trade |
6
|
|
|
License: MIT |
7
|
|
|
|
8
|
|
|
Copyright (c) 2015-2018 Rafael da Silva Rocha |
9
|
|
|
|
10
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy |
11
|
|
|
of this software and associated documentation files (the "Software"), to deal |
12
|
|
|
in the Software without restriction, including without limitation the rights |
13
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
14
|
|
|
copies of the Software, and to permit persons to whom the Software is |
15
|
|
|
furnished to do so, subject to the following conditions: |
16
|
|
|
|
17
|
|
|
The above copyright notice and this permission notice shall be included in |
18
|
|
|
all copies or substantial portions of the Software. |
19
|
|
|
|
20
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
21
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
22
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
23
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
24
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
25
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
26
|
|
|
THE SOFTWARE. |
27
|
|
|
""" |
28
|
|
|
|
29
|
|
|
|
30
|
|
|
class Holder(object): |
|
|
|
|
31
|
|
|
"""A class to represent a owner of subjects. |
32
|
|
|
|
33
|
|
|
A Holder object is created with a initial state. The state of Holder |
34
|
|
|
is then updated by Occurrence objects by calling Holder.trade(occurrence). |
35
|
|
|
|
36
|
|
|
trade apps should define the Holder.state signature according to |
37
|
|
|
their needs. |
38
|
|
|
|
39
|
|
|
Classes that inherit from Occurrence may add and manipulate new |
40
|
|
|
items on the Holder.state dictionary. |
41
|
|
|
|
42
|
|
|
Attributes: |
43
|
|
|
state: A dict representing the state of the Holder. |
44
|
|
|
The example implementation uses the following signature: |
45
|
|
|
{ |
46
|
|
|
"SUBJECT SYMBOL": { |
47
|
|
|
"quantity": 0, |
48
|
|
|
"value": 0 |
49
|
|
|
}, |
50
|
|
|
... |
51
|
|
|
} |
52
|
|
|
""" |
53
|
|
|
|
54
|
|
|
def __init__(self, state=None): |
55
|
|
|
self.state = {} |
56
|
|
|
if state: |
57
|
|
|
self.state = state |
58
|
|
|
|
59
|
|
|
def trade(self, occurrence): |
60
|
|
|
"""Update the state of the Holder with an occurrence.""" |
61
|
|
|
occurrence.update_holder(self) |
62
|
|
|
|