Overview

Path	PyPoE/poe/file/specification/errors.py
Version	1.0.0a0
Revision	$Id: f6326cad694308d3e29df140770f94a9d48129ce $
Author	Omega_K2

Description

Agreement

See PyPoE/LICENSE

Documentation

class PyPoE.poe.file.specification.errors.SpecificationError(code, msg)

Bases: ValueError

SpecificationErrors are raised to indicate there is a problem with the specification compared to the data.

Unlike most errors, they are raised with an error code and the error message. The error code can be used to capture specific errors more accurately.

class ERRORS

Bases: enum.IntEnum

Numeric meaning:

• 1xxx - indicates issues with format of fields
• 2xxx - indicates issues with format of virtual fields
• 3xxx - indicates issues at runtime

Variables:

• INVALID_FOREIGN_KEY_FILE – Foreign key file does not exist
• INVALID_FOREIGN_KEY_ID – Foreign key with the specified id does not exist
• INVALID_ARGUMENT_COMBINATION – Invalid combination of multiple arguments; i.e. when they can’t be used together
• INVALID_ENUM_NAME – Enum does not exist in PyPoE.poe.constants
• VIRTUAL_KEY_EMPTY – Virtual key does not have fields defined
• VIRTUAL_KEY_DUPLICATE – Virtual key is a duplicate of a regular key
• VIRTUAL_KEY_INVALID_KEY – Invalid fields specified for the virtual key
• VIRTUAL_KEY_INVALID_DATA_TYPE – Invalid data type(s) in the target fields
• RUNTIME_MISSING_SPECIFICATION – No specification found in the specification format used for the function call
• RUNTIME_MISSING_FOREIGN_KEY – A single foreign key reference could not be resolved
• RUNTIME_ROWSIZE_MISMATCH – The row size in the specification doesn’t match the real data row size

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class PyPoE.poe.file.specification.errors.SpecificationWarning

Bases: UserWarning

__init__

Initialize self. See help(type(self)) for accurate signature.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.