The plist module

The plist module contains the Plist, and BinaryPlist classes.

These classes are designed to encapsulate a plist object, and be able to convert a standard plist into a binary formatted plist.

The Utf class

class pysiriproxy.plist.Utf

The Utf class provides a dictionary of UTF strings that should be replaced with ASCII equivalent strings.

Replacements

The Replacements property contains a dictionary mapping UTF strings to the ASCII equivalent strings which they will be replaced with.

classmethod replaceUtf(utfString)

Replace all of the UTF strings in the Replacements property with their ASCII equivalent strings.

• utfString – The string containing UTF characters

The BinaryPlist class

class pysiriproxy.plist.BinaryPlist(data, logger, logFile='/dev/null')

The BinaryPlist class takes in a dictionary containing data and provides the ability to convert the dictionary into a binary plist.

Note

This class uses the biplist module to convert a Python dictionary into a binary plist.

toBinary()

Convert the data into a binary plist.

The Keys class

class pysiriproxy.plist.Keys

The Keys class defines various properties which contain strings which are keys to the dictionary objects sent between the iPhone and the Guzzoni server.

AceId

The aceId key.

AssistantId

The key for the AssistantId property of an object.

Birthday

The birthday key for an object.

Class

The key for the class name property of an object.

Data

The key for the data property of an object.

Date

The date key for an object.

DateSent

The key for the dateSent property of an object.

DisplayText

The key for the displayText property of an object.

DueDate

The due date key for an object.

FirstName

The key for the firstName property of an object.

FullName

The key for the fullName property of an object.

Group

The group for the object.

Identifier

The key for the identifier property of an object.

Interpretations

The interpretations key for an object.

LastName

The key for the lastName property of an object.

MsgSender

The key for the msgSender property of an object.

Number

The key for the number property of an object.

OrderedContext

The key for the orderedContext property of an object.

Outgoing

The key for the outgoing property of an object.

Phones

The key for the phones property of an object.

Phrases

The phrases key for an object.

Properties

The properties key for the object.

Recognition

The recognition key for an object.

RefId

The refId for the object.

RemoveSpaceAfter

The removeSpaceAfter key for an object.

RemoveSpaceBefore

The removeSpaceBefore key for an object.

SessionValidationData

The key for the SessionValidationData property of an object.

SpeakableText

The speakable text key for an object.

SpeechId

The key for the SpeechId property of an object.

Text

The text key for an object.

Tokens

The tokens key for an object.

Utterance

The utterance key for an object.

The Plist class

class pysiriproxy.plist.Plist

The Plist class contains methods pertaining to converting objects to plist objects and manipulating them.

classmethod convert(objectData)

Convert the given object into a plist.

• objectData – The data for this object

classmethod toBinary(data, logger, logFile='/dev/null')

Convert an object into a binary plist.

• data – The data to convert into a binary plist
• logger – The logger
• logFile – The file to which output will be logged