Implementation¶

class pyffi.formats.esp.EspFormat[source]¶

Bases: pyffi.object_models.xml.FileFormat

This class implements the ESP format.

class Data[source]¶

Bases: pyffi.object_models.Data

A class to contain the actual esp data.

get_detail_child_names(edge_filter=(True, True))[source]¶

Generator which yields all child names of this item in the detail view.

Override this method if the node has children.

Returns

Generator for detail tree child names.

Return type

generator yielding strs

get_detail_child_nodes(edge_filter=(True, True))[source]¶

Generator which yields all children of this item in the detail view (by default, all acyclic and active ones).

Override this method if the node has children.

Parameters

edge_filter (EdgeFilter or type(None)) – The edge type to include.

Returns

Generator for detail tree child nodes.

Return type

generator yielding DetailNodes

get_global_child_nodes(edge_filter=(True, True))[source]¶

Generator which yields all children of this item in the global view, of given edge type (default is edges of type 0).

Override this method.

Returns

Generator for global node children.

inspect(stream)[source]¶

Quickly checks if stream contains ESP data, and reads the header.

Parameters

stream (file) – The stream to inspect.

inspect_quick(stream)[source]¶

Quickly checks if stream contains ESP data, and gets the version, by looking at the first 8 bytes.

Parameters

stream (file) – The stream to inspect.

read(stream)[source]¶

Read a esp file.

Parameters

stream (file) – The stream from which to read.

write(stream)[source]¶

Write a esp file.

Parameters

stream (file) – The stream to which to write.

class GRUP[source]¶

Bases: pyffi.formats.esp._GRUP, object

get_global_child_nodes(edge_filter=(True, True))[source]¶

Generator which yields all children of this item in the global view, of given edge type (default is edges of type 0).

Override this method.

Returns

Generator for global node children.

read(stream, data)[source]¶

Read structure from stream.

write(stream, data)[source]¶

Write structure to stream.

class Record[source]¶

Bases: pyffi.formats.esp._Record, object

get_global_child_nodes(edge_filter=(True, True))[source]¶

Generator which yields all children of this item in the global view, of given edge type (default is edges of type 0).

Override this method.

Returns

Generator for global node children.

get_sub_record(sub_record_type)[source]¶

Find first subrecord of given type.

read(stream, data)[source]¶

Read structure from stream.

write(stream, data)[source]¶

Write structure to stream.

class RecordType(**kwargs)[source]¶

Bases: pyffi.object_models.common.FixedString

class SubRecord(template=None, argument=None, parent=None)¶

Bases: pyffi.object_models.xml.struct_.StructBase

A subrecord.

class ZString(**kwargs)¶

Bases: pyffi.object_models.xml.basic.BasicBase, pyffi.object_models.editable.EditableLineEdit

String of variable length (null terminated).

>>> from tempfile import TemporaryFile
>>> f = TemporaryFile()
>>> s = ZString()
>>> if f.write('abcdefghijklmnopqrst\x00'.encode("ascii")): pass # b'abc...'
>>> if f.seek(0): pass # ignore result for py3k
>>> s.read(f)
>>> str(s)
'abcdefghijklmnopqrst'
>>> if f.seek(0): pass # ignore result for py3k
>>> s.set_value('Hi There!')
>>> s.write(f)
>>> if f.seek(0): pass # ignore result for py3k
>>> m = ZString()
>>> m.read(f)
>>> str(m)
'Hi There!'

get_hash(data=None)¶

Return a hash value for this string.

Returns

An immutable object that can be used as a hash.

get_size(data=None)¶

Return number of bytes this type occupies in a file.

Returns

Number of bytes.

get_value()¶

Return the string.

Returns

The stored string.

Return type

C{bytes}

read(stream, data=None)¶

Read string from stream.

Parameters

stream (file) – The stream to read from.

set_value(value)¶

Set string to C{value}.

Parameters

value (str (will be encoded as default) or C{bytes}) – The value to assign.

write(stream, data=None)¶

Write string to stream.

Parameters

stream (file) – The stream to write to.

byte¶

alias of pyffi.object_models.common.Byte

char¶

alias of pyffi.object_models.common.Char

float¶

alias of pyffi.object_models.common.Float

int¶

alias of pyffi.object_models.common.Int

short¶

alias of pyffi.object_models.common.Short

ubyte¶

alias of pyffi.object_models.common.UByte

uint¶

alias of pyffi.object_models.common.UInt

uint64¶

alias of pyffi.object_models.common.UInt64

ushort¶

alias of pyffi.object_models.common.UShort

static version_number(version_str)[source]¶

Converts version string into an integer.

Parameters

version_str (str) – The version string.

Returns

A version integer.

>>> hex(EspFormat.version_number('1.2'))
'0x102'

Regression tests¶

>>> # check and read esp file
>>> from os.path import dirname
>>> dirpath = __file__
>>> for i in range(4): #recurse up to root repo dir
...     dirpath = dirname(dirpath)
>>> repo_root = dirpath
>>> format_root = os.path.join(repo_root, 'tests', 'formats', 'esp')
>>> file = os.path.join(format_root, 'test.esp')
>>> stream = open(file, 'rb')
>>> data = EspFormat.Data()
>>> data.inspect(stream)
>>> # do some stuff with header?
>>> #data.header....
>>> data.read(stream)
>>> # do some stuff...

>>> for stream, data in EspFormat.walkData(format_root):
...     try:
...         # the replace call makes the doctest also pass on windows
...         os_path = stream.name
...         split = (os_path.split(os.sep))[-4:]
...         rejoin = os.path.join(*split).replace(os.sep, "/")
...         print("reading %s" % rejoin)
...     except Exception:
...         print(
...             "Warning: read failed due corrupt file,"
...             " corrupt format description, or bug.") 
reading tests/formats/esp/test.esp

>>> data = EspFormat.Data()
>>> from tempfile import TemporaryFile
>>> stream = TemporaryFile()
>>> data.write(stream)