cddm.decorators

Decorators

Module Contents

class cddm.decorators.DocInherit(mthd)

Bases: object

Docstring inheriting method descriptor

The class itself is also used as a decorator (doc_inherit)

Example

>>> class Foo(object):
...     def foo(self):
...         "Frobber"
...         pass

>>> class Bar(Foo):
...     @doc_inherit
...     def foo(self):
...         pass

>>> Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == "Frobber"
True

cddm.decorators.skip_runtime_error(f)

A decorator to disable messages due to runtime error in matplotlib

cddm.decorators.deprecated(info='')

This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted when the function is used.