Table of Contents

Class: PluginKeys ./src/peak/binding/components.py

Component key that finds the keys of plugins matching a given key

Usage:

        # get a sorted list of the keys to all 'foo.bar' plugins
        pluginNames = binding.Obtain( binding.PluginKeys('foo.bar') )

        # get an unsorted list of the keys to all 'foo.bar' plugins
        pluginNames = binding.Obtain(
            binding.PluginKeys('foo.bar', sortBy=None)
        )

sortBy is either a false value or a callable that will be applied to each key to get a value for sorting purposes. If set to a false value, the keys will be in the same order as yielded by config.iterKeys(). sortBy defaults to str, which means the keys will be sorted based on their string form.

Base Classes   
object
Methods   
__init__
findComponent
  __init__ 
__init__ (
        self,
        configKey,
        sortBy=str,
        )

  findComponent 
findComponent (
        self,
        component,
        default=NOT_GIVEN,
        )


Table of Contents

This document was automatically generated on Mon May 6 01:11:02 2024 by HappyDoc version 2.1