Module Expr Str ImportFrom alias ImportFrom alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign AttributeStore NameLoad attr Call NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr ListLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If Call NameLoad NameLoad NameLoad body Assign NameStore Call NameLoad NameLoad If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr Str Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If AttributeLoad NameLoad attr body Return SubscriptLoad AttributeLoad NameLoad attr Index Num orelse Return Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign AttributeStore NameLoad attr BinOpAdd ListLoad NameLoad AttributeLoad NameLoad attr decorator_list Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad AttributeLoad NameLoad attr attr decorator_list Assign NameStore Call NameLoad keyword NameLoad FunctionDef arguments args NameParam defaults body Expr Str If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str Str body Assign AttributeStore NameLoad attr Str If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str Str body Assign AttributeStore NameLoad attr Str If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str Str body Assign AttributeStore NameLoad attr Str If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str Str body Assign AttributeStore NameLoad attr Str If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr Str Str body Assign AttributeStore NameLoad attr Str decorator_list decorator_list
N/A N/A 
Role
====

Encapsulate a plugin instance as well as some metadata.

API
===
 compat ConfigParser distutils.version StrictVersion PluginInfo N/A object N/A N/A Representation of the most basic set of information related to a
    given plugin such as its name, author, description...

    Any additional information can be stored ad retrieved in a
    PluginInfo, when this one is created with a
    ``ConfigParser.ConfigParser`` instance.

    This typically means that when metadata is read from a text file
    (the original way for yapsy to describe plugins), all info that is
    not part of the basic variables (name, path, version etc), can
    still be accessed though the ``details`` member variables that
    behaves like Python's ``ConfigParser.ConfigParser``.

    Warning: the instance associated with the ``details`` member
    variable is never copied and used to store all plugin infos. If
    you set it to a custom instance, it will be modified as soon as
    another member variale of the plugin info is
    changed. Alternatively, if you change the instance "outside" the
    plugin info, it will also change the plugin info.
     __init__ N/A N/A self plugin_name plugin_path N/A N/A N/A 
        Set the basic information (at least name and path) about the
        plugin as well as the default values for other usefull
        variables.

        *plugin_name* is  a simple string describing the name of
         the plugin.

        *plugin_path* describe the location where the plugin can be
         found.
        
        .. warning:: The ``path`` attribute is the full path to the
                     plugin if it is organised as a directory or the
                     full path to a file without the ``.py`` extension
                     if the plugin is defined by a simple file. In the
                     later case, the actual plugin is reached via
                     ``plugin_info.path+'.py'``.
         N/A N/A self __details N/A ConfigParser N/A N/A self name plugin_name N/A N/A self path plugin_path N/A N/A N/A self _ensureDetailsDefaultsAreBackwardCompatible N/A N/A self plugin_object None N/A N/A self categories N/A N/A N/A self error None N/A __setDetails N/A N/A self cfDetails N/A N/A N/A 
        Fill in all details by storing a ``ConfigParser`` instance.

        .. warning: The values for ``plugin_name`` and
                    ``plugin_path`` given a init time will superseed
                    any value found in ``cfDetails`` in section
                    'Core' for the options 'Name' and 'Module' (this
                    is mostly for backward compatibility).
         N/A bkp_name N/A self name N/A bkp_path N/A self path N/A N/A self __details cfDetails N/A N/A self name bkp_name N/A N/A self path bkp_path N/A N/A N/A self _ensureDetailsDefaultsAreBackwardCompatible N/A __getDetails N/A N/A self N/A N/A N/A N/A self __details N/A __getName N/A N/A self N/A N/A N/A N/A N/A N/A self details get Core Name N/A __setName N/A N/A self name N/A N/A N/A N/A N/A N/A N/A self details has_section Core N/A N/A N/A N/A N/A self details add_section Core N/A N/A N/A N/A self details set Core Name name N/A __getPath N/A N/A self N/A N/A N/A N/A N/A N/A self details get Core Module N/A __setPath N/A N/A self path N/A N/A N/A N/A N/A N/A N/A self details has_section Core N/A N/A N/A N/A N/A self details add_section Core N/A N/A N/A N/A self details set Core Module path N/A __getVersion N/A N/A self N/A N/A N/A N/A StrictVersion N/A N/A N/A self details get Documentation Version N/A setVersion N/A N/A self vstring N/A N/A N/A 
        Set the version of the plugin.

        Used by subclasses to provide different handling of the
        version number.
         N/A N/A isinstance vstring StrictVersion N/A N/A vstring N/A str vstring N/A N/A N/A N/A N/A self details has_section Documentation N/A N/A N/A N/A N/A self details add_section Documentation N/A N/A N/A N/A self details set Documentation Version vstring N/A __getAuthor N/A N/A self N/A N/A N/A N/A N/A N/A self details get Documentation Author N/A __setAuthor N/A N/A self author N/A N/A N/A N/A N/A N/A N/A self details has_section Documentation N/A N/A N/A N/A N/A self details add_section Documentation N/A N/A N/A N/A self details set Documentation Author author N/A __getCopyright N/A N/A self N/A N/A N/A N/A N/A N/A self details get Documentation Copyright N/A __setCopyright N/A N/A self copyrightTxt N/A N/A N/A N/A N/A N/A N/A self details has_section Documentation N/A N/A N/A N/A N/A self details add_section Documentation N/A N/A N/A N/A self details set Documentation Copyright copyrightTxt N/A __getWebsite N/A N/A self N/A N/A N/A N/A N/A N/A self details get Documentation Website N/A __setWebsite N/A N/A self website N/A N/A N/A N/A N/A N/A N/A self details has_section Documentation N/A N/A N/A N/A N/A self details add_section Documentation N/A N/A N/A N/A self details set Documentation Website website N/A __getDescription N/A N/A self N/A N/A N/A N/A N/A N/A self details get Documentation Description N/A __setDescription N/A N/A self description N/A N/A N/A N/A N/A N/A N/A self details has_section Documentation N/A N/A N/A N/A N/A self details add_section Documentation N/A N/A N/A N/A self details set Documentation Description description N/A __getCategory N/A N/A self N/A N/A N/A 
        DEPRECATED (>1.9): Mimic former behaviour when what is
        noz the first category was considered as the only one the
        plugin belonged to.
         N/A N/A self categories N/A N/A N/A N/A self categories N/A 0 N/A N/A UnknownCategory N/A __setCategory N/A N/A self c N/A N/A N/A 
        DEPRECATED (>1.9): Mimic former behaviour by making so
        that if a category is set as it it was the only category to
        which the plugin belongs, then a __getCategory will return
        this newly set category.
         N/A N/A self categories N/A N/A c N/A self categories N/A N/A name N/A property fget __getName fset __setName N/A path N/A property fget __getPath fset __setPath N/A version N/A property fget __getVersion fset setVersion N/A author N/A property fget __getAuthor fset __setAuthor N/A copyright N/A property fget __getCopyright fset __setCopyright N/A website N/A property fget __getWebsite fset __setWebsite N/A description N/A property fget __getDescription fset __setDescription N/A details N/A property fget __getDetails fset __setDetails N/A category N/A property fget __getCategory fset __setCategory _getIsActivated N/A N/A self N/A N/A N/A 
        Return the activated state of the plugin object.
        Makes it possible to define a property.
         N/A N/A N/A self plugin_object is_activated N/A N/A is_activated N/A property fget _getIsActivated _ensureDetailsDefaultsAreBackwardCompatible N/A N/A self N/A N/A N/A 
        Internal helper function.
         N/A N/A N/A N/A N/A self details has_option Documentation Author N/A N/A N/A self author Unknown N/A N/A N/A N/A N/A self details has_option Documentation Version N/A N/A N/A self version 0.0 N/A N/A N/A N/A N/A self details has_option Documentation Website N/A N/A N/A self website None N/A N/A N/A N/A N/A self details has_option Documentation Copyright N/A N/A N/A self copyright Unknown N/A N/A N/A N/A N/A self details has_option Documentation Description N/A N/A N/A self description N/A N/A