Source Code for Module paramz.core.parentable

 1  #=============================================================================== 
 2  # Copyright (c) 2015, Max Zwiessele 
 3  # All rights reserved. 
 4  #  
 5  # Redistribution and use in source and binary forms, with or without 
 6  # modification, are permitted provided that the following conditions are met: 
 7  #  
 8  # * Redistributions of source code must retain the above copyright notice, this 
 9  #   list of conditions and the following disclaimer. 
10  #  
11  # * Redistributions in binary form must reproduce the above copyright notice, 
12  #   this list of conditions and the following disclaimer in the documentation 
13  #   and/or other materials provided with the distribution. 
14  #  
15  # * Neither the name of paramz.core.parentable nor the names of its 
16  #   contributors may be used to endorse or promote products derived from 
17  #   this software without specific prior written permission. 
18  #  
19  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
20  # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
21  # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
22  # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
23  # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
24  # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
25  # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
26  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
27  # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
28  # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
29  #=============================================================================== 
30   
31 -class Parentable(object): 
32      """ 
33      Enable an Object to have a parent. 
34   
35      Additionally this adds the parent_index, which is the index for the parent 
36      to look for in its parameter list. 
37      """ 
38      _parent_ = None 
39      _parent_index_ = None 
40 -    def __init__(self, *args, **kwargs): 
41          super(Parentable, self).__init__() 
42   
43 -    def has_parent(self): 
44          """ 
45          Return whether this parentable object currently has a parent. 
46          """ 
47          return self._parent_ is not None 
48   
49 -    def _parent_changed(self): 
50          """ 
51          Gets called, when the parent changed, so we can adjust our 
52          inner attributes according to the new parent. 
53          """ 
54          raise NotImplementedError("shouldnt happen, Parentable objects need to be able to change their parent") 
55   
56 -    def _disconnect_parent(self, *args, **kw): 
57          """ 
58          Disconnect this object from its parent 
59          """ 
60          raise NotImplementedError("Abstract superclass") 
61   
62      @property 
63 -    def _highest_parent_(self): 
64          """ 
65          Gets the highest parent by traversing up to the root node of the hierarchy. 
66          """ 
67          if self._parent_ is None: 
68              return self 
69          return self._parent_._highest_parent_ 
70   
71 -    def _notify_parent_change(self): 
72          """ 
73          Dont do anything if in leaf node 
74          """ 
75          pass 
76