README.rst

fsleyes-props

fsleyes-props is a library which is used by used by FSLeyes, and which allows you to:

• Listen for change to attributes on a python object,
• Automatically generate wxpython widgets which are bound to attributes of a python object
• Automatically generate a command line interface to set values of the attributes of a python object.

To do this, you just need to subclass the :class:`.HasProperties` class, and add some :class:`.PropertyBase` types as class attributes.

Dependencies

All of the dependencies of fsleyes-props are listed in the requirements.txt file. fsleyes-props can be used without wxPython, but GUI functionality will not be available.

Documentation

fsleyes-props is documented using sphinx. You can build the API documentation by running:

python setup.py doc

The HTML documentation will be generated and saved in the doc/html/ directory.

Example usage

>>> import fsleyes_props as props
>>>
>>> class PropObj(props.HasProperties):
>>>     myProperty = props.Boolean()
>>>
>>> myPropObj = PropObj()
>>>
>>> # Access the property value as a normal attribute:
>>> myPropObj.myProperty = True
>>> myPropObj.myProperty
True
>>>
>>> # access the props.Boolean instance:
>>> myPropObj.getProp('myProperty')
<props.prop.Boolean at 0x1045e2710>
>>>
>>> # access the underlying props.PropertyValue object
>>> # (there are caveats for List properties):
>>> myPropObj.getPropVal('myProperty')
<props.prop.PropertyValue instance at 0x1047ef518>
>>>
>>> # Receive notification of property value changes
>>> def myPropertyChanged(value, *args):
>>>     print('New property value: {}'.format(value))
>>>
>>> myPropObj.addListener(
>>>    'myProperty', 'myListener', myPropertyChanged)
>>>
>>> myPropObj.myProperty = False
New property value: False
>>>
>>> # Remove a previously added listener
>>> myPropObj.removeListener('myListener')

Contributing

If you would like to contribute to fsleyes-props, take a look at the fslpy contributing guide.