Skip to content

CSVInput

Source code in docs_src/capo_glacier/types/csv_input.py
class CSVInput(TypedDict, closed=True):
    file_header_info: NotRequired["capo_glacier.types.file_header_info.FileHeaderInfo"]
    """<p>Describes the first line of input. Valid values are <code>None</code>, <code>Ignore</code>, and <code>Use</code>.</p>"""
    comments: NotRequired["capo_glacier.types.string.string"]
    """<p>A single character used to indicate that a row should be ignored when the character is present at the start of that row.</p>"""
    quote_escape_character: NotRequired["capo_glacier.types.string.string"]
    """<p>A single character used for escaping the quotation-mark character inside an already escaped value.</p>"""
    record_delimiter: NotRequired["capo_glacier.types.string.string"]
    """<p>A value used to separate individual records from each other.</p>"""
    field_delimiter: NotRequired["capo_glacier.types.string.string"]
    """<p>A value used to separate individual fields from each other within a record.</p>"""
    quote_character: NotRequired["capo_glacier.types.string.string"]
    """<p>A value used as an escape character where the field delimiter is part of the value.</p>"""

comments instance-attribute

comments: NotRequired[string]

A single character used to indicate that a row should be ignored when the character is present at the start of that row.

field_delimiter instance-attribute

field_delimiter: NotRequired[string]

A value used to separate individual fields from each other within a record.

file_header_info instance-attribute

file_header_info: NotRequired[FileHeaderInfo]

Describes the first line of input. Valid values are None, Ignore, and Use.

quote_character instance-attribute

quote_character: NotRequired[string]

A value used as an escape character where the field delimiter is part of the value.

quote_escape_character instance-attribute

quote_escape_character: NotRequired[string]

A single character used for escaping the quotation-mark character inside an already escaped value.

record_delimiter instance-attribute

record_delimiter: NotRequired[string]

A value used to separate individual records from each other.