Skip to content

ReadOptions

Source code in docs_src/capo_omics/types/read_options.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ReadOptions(TypedDict, closed=True):
    sep: NotRequired["capo_omics.types.separator.Separator"]
    """<p>The file's field separator.</p>"""
    encoding: NotRequired["capo_omics.types.encoding.Encoding"]
    """<p>The file's encoding.</p>"""
    quote: NotRequired["capo_omics.types.quote.Quote"]
    """<p>The file's quote character.</p>"""
    quote_all: "capo_omics.types.quote_all.QuoteAll"
    """<p>Whether all values need to be quoted, or just those that contain quotes.</p>"""
    escape: NotRequired["capo_omics.types.escape_char.EscapeChar"]
    """<p>A character for escaping quotes in the file.</p>"""
    escape_quotes: "capo_omics.types.escape_quotes.EscapeQuotes"
    """<p>Whether quotes need to be escaped in the file.</p>"""
    comment: NotRequired["capo_omics.types.comment_char.CommentChar"]
    """<p>The file's comment character.</p>"""
    header: "capo_omics.types.header.Header"
    """<p>Whether the file has a header row.</p>"""
    line_sep: NotRequired["capo_omics.types.line_sep.LineSep"]
    """<p>A line separator for the file.</p>"""

comment instance-attribute 

comment: NotRequired[CommentChar]

The file's comment character.

encoding instance-attribute 

encoding: NotRequired[Encoding]

The file's encoding.

escape instance-attribute 

escape: NotRequired[EscapeChar]

A character for escaping quotes in the file.

escape_quotes instance-attribute 

escape_quotes: EscapeQuotes

Whether quotes need to be escaped in the file.

header instance-attribute 

header: Header

Whether the file has a header row.

line_sep instance-attribute 

line_sep: NotRequired[LineSep]

A line separator for the file.

quote instance-attribute 

quote: NotRequired[Quote]

The file's quote character.

quote_all instance-attribute 

quote_all: QuoteAll

Whether all values need to be quoted, or just those that contain quotes.

sep instance-attribute 

sep: NotRequired[Separator]

The file's field separator.