Descriptors | PyF, flow-based python programming Descriptors

Descriptors

class pyf.services.model.Descriptor(**kwargs)

Descriptor model objects are basically containers for pyjon.descriptors.Descriptor objects.

default_encoding

Default encoding to use with this descriptor

description

Full text description explaining what the descriptor does (what file format is it for)

display_name

Display name (will be used in link text, or drop downs)

get_descriptor_object(encoding=None)

returns the pyjon.descriptors.Descriptor instance based on the XML schema of the descriptor stored in the database. This is NOT the descriptor orm object but the real pyjon descriptor.

Parameters:
  • encoding (string) – the encoding used by the data flow. This is really important for us because we transcode the flow in unicode. If no encoding is provided, use default_encoding.
id

Unique ID (auto increment primary key)

name

Unique name for descriptor (no spaces, not special chars)

payload_xml

pyjon.descriptors.Descriptor XML payload (TEXT type). It shouldn’t contain an encoding declaration but directly the first level xml node.