TextFormat Class

The data stored in text format.

All required parameters must be populated in order to send to Azure.

Constructor

TextFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer: MutableMapping[str, Any] | None = None, column_delimiter: MutableMapping[str, Any] | None = None, row_delimiter: MutableMapping[str, Any] | None = None, escape_char: MutableMapping[str, Any] | None = None, quote_char: MutableMapping[str, Any] | None = None, null_value: MutableMapping[str, Any] | None = None, encoding_name: MutableMapping[str, Any] | None = None, treat_empty_as_null: MutableMapping[str, Any] | None = None, skip_line_count: MutableMapping[str, Any] | None = None, first_row_as_header: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection. Default value: None
serializer	<xref:JSON> Serializer. Type: string (or Expression with resultType string). Default value: None
deserializer	<xref:JSON> Deserializer. Type: string (or Expression with resultType string). Default value: None
column_delimiter	<xref:JSON> The column delimiter. Type: string (or Expression with resultType string). Default value: None
row_delimiter	<xref:JSON> The row delimiter. Type: string (or Expression with resultType string). Default value: None
escape_char	<xref:JSON> The escape character. Type: string (or Expression with resultType string). Default value: None
quote_char	<xref:JSON> The quote character. Type: string (or Expression with resultType string). Default value: None
null_value	<xref:JSON> The null value string. Type: string (or Expression with resultType string). Default value: None
encoding_name	<xref:JSON> The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). Default value: None
treat_empty_as_null	<xref:JSON> Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean). Default value: None
skip_line_count	<xref:JSON> The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer). Default value: None
first_row_as_header	<xref:JSON> When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). Default value: None

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Type of dataset storage format. Required.
serializer	<xref:JSON> Serializer. Type: string (or Expression with resultType string).
deserializer	<xref:JSON> Deserializer. Type: string (or Expression with resultType string).
column_delimiter	<xref:JSON> The column delimiter. Type: string (or Expression with resultType string).
row_delimiter	<xref:JSON> The row delimiter. Type: string (or Expression with resultType string).
escape_char	<xref:JSON> The escape character. Type: string (or Expression with resultType string).
quote_char	<xref:JSON> The quote character. Type: string (or Expression with resultType string).
null_value	<xref:JSON> The null value string. Type: string (or Expression with resultType string).
encoding_name	<xref:JSON> The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).
treat_empty_as_null	<xref:JSON> Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).
skip_line_count	<xref:JSON> The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
first_row_as_header	<xref:JSON> When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

Methods

as_dict	Return a dict that can be serialized using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	Default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. Default value: None
key_extractors	Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes Default value: False

Returns

Type	Description
dict	A dict JSON compatible object