Gsf.OutputCsv

g GObject.Object GObject.Object Gsf.Output Gsf.Output GObject.Object->Gsf.Output Gsf.OutputCsv Gsf.OutputCsv Gsf.Output->Gsf.OutputCsv

Subclasses:

None

Methods

Inherited:

Gsf.Output (18), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

write_eol ()

write_field (field, len)

Virtual Methods

Inherited:

Gsf.Output (3), GObject.Object (7)

Properties

Inherited:

Gsf.Output (6)

Name

Type

Flags

Short Description

eol

str

r/w/c

The end-of-line marker

quote

str

r/w/c

The string used for quoting fields

quoting-mode

Gsf.OutputCsvQuotingMode

r/w/c

When to quote fields

quoting-on-whitespace

bool

r/w

Does initial or terminal whitespace force quoting?

quoting-triggers

str

r/w

Characters that cause field quoting

separator

str

r/w/c

The field separator

sink

Gsf.Output

r/w

Where the formatted output is written

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

buf

GLib.String

r

eol

str

r

eol_len

int

r

fields_on_line

bool

r

output

Gsf.Output

r

quote

str

r

quote_len

int

r

quoting_mode

Gsf.OutputCsvQuotingMode

r

quoting_triggers

str

r

separator

str

r

separator_len

int

r

sink

Gsf.Output

r

Class Details

class Gsf.OutputCsv(**kwargs)
Bases:

Gsf.Output

Abstract:

No

Structure:

Gsf.OutputCsvClass

write_eol()
Return type:

bool

write_field(field, len)
Parameters:
  • field (str) –

  • len (int) –

Return type:

bool

Property Details

Gsf.OutputCsv.props.eol
Name:

eol

Type:

str

Default Value:

'\n'

Flags:

READABLE, WRITABLE, CONSTRUCT

The end-of-line marker

Gsf.OutputCsv.props.quote
Name:

quote

Type:

str

Default Value:

'"'

Flags:

READABLE, WRITABLE, CONSTRUCT

The string used for quoting fields

Gsf.OutputCsv.props.quoting_mode
Name:

quoting-mode

Type:

Gsf.OutputCsvQuotingMode

Default Value:

Gsf.OutputCsvQuotingMode.NEVER

Flags:

READABLE, WRITABLE, CONSTRUCT

When to quote fields

Gsf.OutputCsv.props.quoting_on_whitespace
Name:

quoting-on-whitespace

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE

Does initial or terminal whitespace force quoting?

Gsf.OutputCsv.props.quoting_triggers
Name:

quoting-triggers

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Characters that cause field quoting

Gsf.OutputCsv.props.separator
Name:

separator

Type:

str

Default Value:

','

Flags:

READABLE, WRITABLE, CONSTRUCT

The field separator

Gsf.OutputCsv.props.sink
Name:

sink

Type:

Gsf.Output

Default Value:

None

Flags:

READABLE, WRITABLE

Where the formatted output is written