.. _f-kindofcompletion: module ``ipythonhelper.kindofcompletion`` ========================================= .. inheritance-diagram:: pyquickhelper.ipythonhelper.kindofcompletion Short summary +++++++++++++ module ``pyquickhelper.ipythonhelper.kindofcompletion`` A custom way to add auto completion to IPython :githublink:`%|py|5` Classes +++++++ +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +===============================================================================================+=========================================================================================================================+ | :class:`AutoCompletion ` | You can add auto completion object to IPython by adding member to an instance of this class. All members must begin ... | +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :class:`AutoCompletionFile ` | builds a tree based on a list of files, the class adds ``A__`` before every folder or file starting with ``_`` | +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +------------------------------------------------------------------------------------------------+-------------------------+ | property | truncated documentation | +================================================================================================+=========================+ | :py:meth:`_ ` | return the value | +------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_ ` | return the value | +------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_members ` | returns all the members | +------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_members ` | returns all the members | +------------------------------------------------------------------------------------------------+-------------------------+ Methods +++++++ +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +==================================================================================================+=========================================================================================================================+ | :py:meth:`__init__ ` | constructor | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | constructor | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | returns the number of elements | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | returns the number of elements | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | returns a string | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | returns a string | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add ` | add a member to this class, add an ``AutoCompletion`` instance, creates one if value is not from ``AutoCompletion`` ... | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add ` | add a member to this class, add an ``AutoCompletion`` instance, creates one if value is not from ``AutoCompletion`` ... | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_filter ` | Removes unexpected characters for a file name. | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_populate ` | populate the class with files and folder in the folder this class holds | +--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.ipythonhelper.kindofcompletion :members: :special-members: __init__ :show-inheritance: