.. _fbf.lib.examples:

examples
~~~~~~~~

.. automodule:: fbf.lib.examples
        :show-inheritance:
        :members:
        :undoc-members:

CODE
----

    ::

        # fbf/lib/examples.py
        #
        #
        
        """ examples is a dict of example objects. """
        
.. _fbf.lib.examples_fbf_imports:

fbf imports
--------------

    ::

        
        from fbf.utils.trace import whichplugin
        
.. _fbf.lib.examples_basic_imports:

basic imports
----------------

    ::

        
        import re
        
.. _fbf.lib.examples_Example_class:

Example class
----------------

    ::

        
        class Example(object):
        
            """ an example. """
        
            def __init__(self, descr, ex, url=False, modname=None):
                self.descr = descr
                self.example = ex
                self.url = url
                self.modname = modname or whichplugin(2)
        
.. _fbf.lib.examples_Collection_of_exanples:

Collection of exanples
-------------------------

    ::

        
        class Examples(dict):
        
            """ examples holds all the examples. """
        
            def add(self, name, descr, ex, url=False):
                """ add description and example. """
                self[name.lower()] = Example(descr, ex, url)
        
            def size(self):
                """ return size of examples dict. """
                return len(list(self.keys()))
        
            def getexamples(self, disabled=None):
                """ get all examples in list. """
                result = []
                for i in list(self.values()):
                    if disabled:
                        for d in disabled:
                            if d in i.modname: continue
                    ex = i.example.lower()
                    exampleslist = re.split('\d\)', ex)
                    for example in exampleslist:
                        if example: result.append(example.strip())
                return result
        
.. _fbf.lib.examples_global_examples_object:

global examples object
-------------------------

    ::

        
        examples = Examples()
        
        def size():
            return examples.size()