API

Generator API

Generator Class

Provides an API for accessing the file system and controlling the generator

FileSystem Class

class qface.generator.FileSystem

Bases: object

QFace helper functions to work with the file system

static merge_annotations(system, document)

Read a YAML document and for each root symbol identifier updates the tag information of that symbol

static parse(input, identifier: str = None, use_cache=False, clear_cache=True, pattern='*.qface', profile=<EProfile.FULL: 'full'>)

Input can be either a file or directory or a list of files or directory. A directory will be parsed recursively. The function returns the resulting system. Stores the result of the run in the domain cache named after the identifier.

Parameters:

• path – directory to parse
• identifier – identifies the parse run. Used to name the cache
• clear_cache – clears the domain cache (defaults to true)

strict = False

enables strict parsing

class qface.generator.Generator(search_path, context={}, force=False)

Bases: object

Manages the templates and applies your context data

destination

destination prefix for generator write

get_template(name)

Retrieves a single template file from the template loader

register_filter(name, callback)

Register your custom template filter

render(name, context)

Returns the rendered text from a single template file from the template loader using the given context data

source

source prefix for template lookup

strict = False

enables strict code generation

write(file_path, template, context={}, preserve=False, force=False)

Using a template file name it renders a template into a file given a context

Template Domain API

This API is exposed to the Jinja template system.

High Level Classes

class qface.idl.domain.System

Bases: object

The root entity which consist of modules

lookup(name: str)

lookup a symbol by fully qualified name.

modules

returns ordered list of module symbols

class qface.idl.domain.Module(name: str, system: qface.idl.domain.System)

Bases: qface.idl.domain.Symbol

Module is a namespace for types, e.g. interfaces, enums, structs

enums

returns ordered list of enum symbols

imports

returns ordered list of import symbols

interfaces

returns ordered list of interface symbols

lookup(name: str, fragment: str = None)

lookup a symbol by name. If symbol is not local it will be looked up system wide

majorVersion

returns the major version number of the version information

minorVersion

returns the minor version number of the version information

module_name

returns the last part of the module uri

name_parts

return module name splitted by ‘.’ in parts

structs

returns ordered list of struct symbols

Interface Related Classes

class qface.idl.domain.Interface(name: str, module: qface.idl.domain.Module)

Bases: qface.idl.domain.Symbol

A interface is an object with operations, properties and signals

extends

returns the symbol defined by the extends interface attribute

operations

returns ordered list of operations

properties

returns ordered list of properties

signals

returns ordered list of signals

class qface.idl.domain.Operation(name: str, interface: qface.idl.domain.Interface)

Bases: qface.idl.domain.Symbol

An operation inside a interface

interface = None

the interface the operation is part of

is_const = None

reflects is the operation was declared as const operation

parameters

returns ordered list of parameters

qualified_name

return the fully qualified name (<module>.<interface>#<operation>)

class qface.idl.domain.Parameter(name: str, operation: qface.idl.domain.Operation)

Bases: qface.idl.domain.Symbol

An operation parameter

class qface.idl.domain.Property(name: str, interface: qface.idl.domain.Interface)

Bases: qface.idl.domain.Symbol

A typed property inside a interface

is_complex_model

true if type is a model of nested complex types

is_model

true if type is a model

is_primitive_model

true if type is a model of nested primitive types

qualified_name

return the fully qualified name (<module>.<interface>#<property>)

Struct Related Classes

class qface.idl.domain.Struct(name: str, module: qface.idl.domain.Module)

Bases: qface.idl.domain.Symbol

Represents a data container

fields

returns ordered list of members

class qface.idl.domain.Field(name: str, struct: qface.idl.domain.Struct)

Bases: qface.idl.domain.Symbol

A member in a struct

qualified_name

return the fully qualified name (<module>.<struct>#<field>)

Enum/Flag Related Classes

class qface.idl.domain.Enum(name: str, module: qface.idl.domain.Module)

Bases: qface.idl.domain.Symbol

An enum (flag) inside a module

members

returns ordered list of members

class qface.idl.domain.EnumMember(name: str, enum: qface.idl.domain.Enum)

Bases: qface.idl.domain.Symbol

A enum value

qualified_name()

return the fully qualified name (<module>.<enum>#<member>)

Base Classes

class qface.idl.domain.NamedElement(name, module: qface.idl.domain.Module)

Bases: object

module = None

module the symbol belongs to

name = None

symbol name

qualified_name

return the fully qualified name (<module>.<name>)

class qface.idl.domain.Symbol(name: str, module: qface.idl.domain.Module)

Bases: qface.idl.domain.NamedElement

A symbol represents a base class for names elements

add_attribute(tag, name, value)

add an attribute (nam, value pair) to the named tag

add_tag(tag)

add a tag to the tag list

attribute(tag, name)

return attribute by tag and attribute name

comment = None

comment which appeared in QFace right before symbol

contents

return general list of symbol contents

kind = None

the associated type information

system

returns reference to system

tag(name)

return tag by name

class qface.idl.domain.TypeSymbol(name: str, parent: qface.idl.domain.NamedElement)

Bases: qface.idl.domain.NamedElement

Defines a type in the system

is_bool

checks if type is primitive and bool

is_complex = None

if type represents a complex type

is_enum

checks if type is an enumeration and reference is enum

is_enumeration

checks if type is complex and instance of type Enum

is_flag

checks if type is an enumeration and reference is flag

is_int

checks if type is primitive and int

is_interface

checks if type is interface

is_list = None

if type represents a list of nested types

is_map = None

if type represents a map of nested types. A key type is not defined

is_model = None

if type represents a model of nested types

is_primitive = None

if type represents a primitive type

is_real

checks if type is primitive and real

is_string

checks if type is primitive and string

is_struct

checks if type is complex and struct

is_valid

checks if type is a valid type

is_var

checks if type is primitive and var

is_void = None

if type represents the void type

nested = None

nested type if symbol is list or model

parent = None

the parent symbol of this type

reference

returns the symbol reference of the type name

type

return the type information. In this case: self

Utility Modules

qface.watch.monitor(args, watch)

reloads the script given by argv when src files changes

qface.shell.sh(args, **kwargs)

runs the given cmd as shell command