Skip to main content

data.exporters.project_exporter

ProjectExporter Objects​

class ProjectExporter(abc.ABC)

Base class for project exporters.

__init__​

def __init__(exporter_id: ProjectExporterID,
             *,
             name: str,
             description: str,
             extension: str,
             scope: ProjectExporterScope,
             capabilities: ProjectExporterDescriptor.
             Capabilities = ProjectExporterDescriptor.Capabilities.NONE,
             default_scope: ProjectFeatureID | None = None,
             default_filename: str = "")

Arguments:

  • exporter_id - The unique ID of the exporter.
  • name - The name.
  • description - The description.
  • extension - The extension of exported files.
  • scope - The scope the exporter applies to.
  • default_scope - A default scope when exporting if none is given.
  • default_filename - A default filename used when none is given.

descriptor​

@property
def descriptor() -> ProjectExporterDescriptor

The exporter descriptor.

exporter_id​

@property
def exporter_id() -> ProjectExporterID

The ID of the exporter.

name​

@property
def name() -> str

The exporter name.

description​

@property
def description() -> str

The exporter description.

extension​

@property
def extension() -> str

The extension of exported files.

scope​

@property
def scope() -> ProjectExporterScope

The exporter's scope.

capabilities​

@property
def capabilities() -> ProjectExporterDescriptor.Capabilities

The exporter's capabilities.

default_scope​

@property
def default_scope() -> ProjectFeatureID | None

The default scope when exporting if none is given.

default_filename​

@property
def default_filename() -> str

The default filename used when none is given.