Skip to content

Commit 0975ef0

Browse files
committed
doc string update and added is_custom_property func.
1 parent 0d83e16 commit 0975ef0

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

NodeGraphQt/base/model.py

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ def __repr__(self):
114114
def add_property(self, name, value, items=None, range=None,
115115
widget_type=None, tab=None):
116116
"""
117-
add custom property.
117+
add custom property or raises an error if the property name is already
118+
taken.
118119
119120
Args:
120121
name (str): name of the property.
@@ -159,6 +160,11 @@ def add_property(self, name, value, items=None, range=None,
159160
self._graph_model.set_node_common_properties(attrs)
160161

161162
def set_property(self, name, value):
163+
"""
164+
Args:
165+
name (str): property name.
166+
value (object): property value.
167+
"""
162168
if name in self.properties.keys():
163169
setattr(self, name, value)
164170
elif name in self._custom_prop.keys():
@@ -167,17 +173,48 @@ def set_property(self, name, value):
167173
raise NodePropertyError('No property "{}"'.format(name))
168174

169175
def get_property(self, name):
176+
"""
177+
Args:
178+
name (str): property name.
179+
180+
Returns:
181+
object: property value.
182+
"""
170183
if name in self.properties.keys():
171184
return self.properties[name]
172185
return self._custom_prop.get(name)
173186

187+
def is_custom_property(self, name):
188+
"""
189+
Args:
190+
name (str): property name.
191+
192+
Returns:
193+
bool: true if custom property.
194+
"""
195+
return name in self._custom_prop
196+
174197
def get_widget_type(self, name):
198+
"""
199+
Args:
200+
name (str): property name.
201+
202+
Returns:
203+
int: node property widget type.
204+
"""
175205
model = self._graph_model
176206
if model is None:
177207
return self._TEMP_property_widget_types.get(name)
178208
return model.get_node_common_properties(self.type_)[name]['widget_type']
179209

180210
def get_tab_name(self, name):
211+
"""
212+
Args:
213+
name (str): property name.
214+
215+
Returns:
216+
str: name of the tab for the properties bin.
217+
"""
181218
model = self._graph_model
182219
if model is None:
183220
attrs = self._TEMP_property_attrs.get(name)

0 commit comments

Comments
 (0)