platform_db

Platform database.

Submodules

Package Contents

Classes

KnowledgeBase

Container for platform detection knowledge base entries.

PlatformDBPlugin

Plugin API to extend the platform knowledge base.

AmberCPUSupport

Plugin example adding support for Amber CPUs.

Functions

get_knowledge_base(→ KnowledgeBase)

Load the knowledge base, including all content from plugins.

Attributes

PlatformDBEntry

platform_db.PlatformDBEntry
class platform_db.KnowledgeBase

Container for platform detection knowledge base entries.

cpu_info: PlatformDBEntry
os_info: PlatformDBEntry
platform_info: PlatformDBEntry
build_targets: PlatformDBEntry
host_guess: PlatformDBEntry
class platform_db.PlatformDBPlugin

Bases: KnowledgeBase

Plugin API to extend the platform knowledge base.

To create a plugin, override this class and the method update_db. In update_db modify the values of self.cpu_info, self.os_info, self.platform_info, self.build_targets, and self.host_guess.

Then add an entry points in your package in the group e3.platform_db and reference your new class. e.g.:

entry_points={
    'e3.platform_db': [
        'my_db = e3.mypackage.platform_db:MyPlatformDBPlugin']}
abstract update_db() None

Update database with current state.

class platform_db.AmberCPUSupport

Bases: PlatformDBPlugin

Plugin example adding support for Amber CPUs.

update_db() None

Add support for Amber CPUs.

platform_db.get_knowledge_base() KnowledgeBase

Load the knowledge base, including all content from plugins.

Returns:

The knowledge base with the keys (cpu_info, os_info, platform_info, build_targets, host_guess)