Skip to main content

PyLineErrorSerializer

No overview available.

Attributes

AttributeTypeDescription
pyPythonThe Python interpreter instance used for managing object references and memory during serialization.
line_error[PyLineError](pylineerror.md?sid=errors_validation_exception_pylineerror)The specific validation error instance containing the details to be serialized.
url_prefixstringAn optional string prepended to documentation links within the error output.
include_contextbooleanA flag determining whether to include additional metadata and context variables in the error report.
include_inputbooleanA flag determining whether the original input value that caused the error should be included in the output.
state[SerializationState](../../../serializers/extra/serializationstate.md?sid=serializers_extra_serializationstate)A mutable reference to the current serialization state used to track recursion and shared configuration.
input_type[InputType](../../../input/input/abstract/inputtype.md?sid=input_input_abstract_inputtype)The classification of the input data being validated, such as Python objects or JSON data.

Constructor

Signature

def PyLineErrorSerializer(
py: Python< 'py >,
line_error: &'py PyLineError,
url_prefix: Option< &'py str >,
include_context: bool,
include_input: bool,
state: RefCell< &'slf mut SerializationState< 'py > >,
input_type: &'py InputType
)

Parameters

NameTypeDescription
pyPython< 'py >The Python interpreter instance.
line_error&'py PyLineErrorThe specific line error to be serialized.
url_prefixOption< &'py str >An optional URL prefix for documentation links.
include_contextboolWhether to include context information in the output.
include_inputboolWhether to include the input data that caused the error.
stateRefCell< &'slf mut SerializationState< 'py > >The current state of the serialization process.
input_type&'py InputTypeThe type of input being processed.