Module ocd.abc
Abstract base classes.
Expand source code
"""Abstract base classes.
"""
__author__ = 'Md Jahidul Hamid <jahidulhamid@yahoo.com>'
__copyright__ = 'Copyright © Md Jahidul Hamid <https://github.com/neurobin/>'
__license__ = '[BSD](http://www.opensource.org/licenses/bsd-license.php)'
__version__ = '0.0.4'
class VarConf():
"""A base class that must be inherited by `VarConf` classes in
subclasses of `PropMixin`.
The method `get_conf` must be implemented in your `VarConf` class.
If you want automatic property configuration, create a class named
`VarConf` in your `PropMixin` subclass and make your `VarConf`
class inherit from `ocd.abc.VarConf` or a default `VarConf`
class from `ocd.defaults` and implement the `get_conf` method
to either return a `Prop` object for property conversion to happen
for the corresponding attribute name or return `None` if no
conversion is desired.
"""
def get_conf(self, name, value):
"""This method will be called on each property to get the
property configuration.
It must return a `Prop` object or `None` for the particular
property name.
Args:
name (str): name of the property
value (any): Value of the property
Returns:
Either `None` (if not to be converted) or `Prop` object if
needs to be converted to property.
"""
raise NotImplementedError("`VarConf` class must define a "
"method `get_conf` that returns "
"`Prop` object or `None`. See "
"`ocd.abc.VarConf`")
Classes
class VarConf
-
A base class that must be inherited by
VarConf
classes in subclasses ofPropMixin
.The method
get_conf
must be implemented in yourVarConf
class.If you want automatic property configuration, create a class named
VarConf
in yourPropMixin
subclass and make yourVarConf
class inherit fromVarConf
or a defaultVarConf
class fromocd.defaults
and implement theget_conf
method to either return aProp
object for property conversion to happen for the corresponding attribute name or returnNone
if no conversion is desired.Expand source code
class VarConf(): """A base class that must be inherited by `VarConf` classes in subclasses of `PropMixin`. The method `get_conf` must be implemented in your `VarConf` class. If you want automatic property configuration, create a class named `VarConf` in your `PropMixin` subclass and make your `VarConf` class inherit from `ocd.abc.VarConf` or a default `VarConf` class from `ocd.defaults` and implement the `get_conf` method to either return a `Prop` object for property conversion to happen for the corresponding attribute name or return `None` if no conversion is desired. """ def get_conf(self, name, value): """This method will be called on each property to get the property configuration. It must return a `Prop` object or `None` for the particular property name. Args: name (str): name of the property value (any): Value of the property Returns: Either `None` (if not to be converted) or `Prop` object if needs to be converted to property. """ raise NotImplementedError("`VarConf` class must define a " "method `get_conf` that returns " "`Prop` object or `None`. See " "`ocd.abc.VarConf`")
Subclasses
Methods
def get_conf(self, name, value)
-
This method will be called on each property to get the property configuration.
It must return a
Prop
object orNone
for the particular property name.Args
name
:str
- name of the property
value
:any
- Value of the property
Returns
Either
None
(if not to be converted) orProp
object if needs to be converted to property.Expand source code
def get_conf(self, name, value): """This method will be called on each property to get the property configuration. It must return a `Prop` object or `None` for the particular property name. Args: name (str): name of the property value (any): Value of the property Returns: Either `None` (if not to be converted) or `Prop` object if needs to be converted to property. """ raise NotImplementedError("`VarConf` class must define a " "method `get_conf` that returns " "`Prop` object or `None`. See " "`ocd.abc.VarConf`")