Format

class Format

Description

Formatter options for Syside

Inheritance:

• FormatOptions

• Format

Members defined in Format (5 members)

	line_ending	RW	Line ends to enforce in formatted documents.
	line_width	RW	Formatter visual line-width limit.
	tab_width	RW	Number of spaces for tabs if using space indentation.
	tabs	RW	Indent using tabs instead of spaces.
	__init__

Members inherited from FormatOptions (11 members)

	binary	RW	Options for binary ends formatting:
	breaks	RW	Options for declarations.
	decl	RW	Options for declaration formatting.
	empty_brackets	RW	Choose between {} and ; when formatting empty children blocks:
	keywords	RW	Options for keyword formatting, switching between keywords and tokens, or omitting keywords where possible.
	markdown	RW	Whether to treat Comment and Documentation bodies as Markdown.
	package_closing_note	RW	Whether to append a note with the package name to the closing bracket.
	parentheses	RW	Options for expression parentheses formatting:
	strip_unnecessary_quotes	RW	Whether to strip quotes from quoted identifiers where possible.
	synth	RW	Options for printing synthetic elements.
	trailing_comma	RW	Options for trailing comma placement.

Attributes

property line_ending: syside.conf.LineEnding | None

Line ends to enforce in formatted documents.

When set to auto, and the document has mixed line ends, choice between lf and crlf is an implementation detail. Documents without line ends default to lf.

native selects line ending based on the platform Syside runs on, lf on Unix, and crlf on Windows.

property line_width: int

Formatter visual line-width limit.

Formatter will attempt to fit formatted lines into this number of visual columns.

property tab_width: int | None

Number of spaces for tabs if using space indentation.

Takes priority over editor settings if set. Defaults to 4 otherwise.

property tabs: bool | None

Indent using tabs instead of spaces.

Takes priority over editor settings if set. Defaults to false otherwise.

Methods

__init__() → None