Format

class Format

Description

Formatter options for Syside

Members defined in Format (16 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.
	line_ending	RW	Line ends to enforce in formatted documents.
	line_width	RW	Formatter visual line-width limit.
	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.
	tab_width	RW	Number of spaces for tabs if using space indentation.
	tabs	RW	Indent using tabs instead of spaces.
	trailing_comma	RW	Options for trailing comma placement.
	__init__

Attributes

property binary: syside.conf.BinaryEndsFormat

Options for binary ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property breaks: syside.conf.BreakOptions

Options for declarations.

property decl: syside.conf.DeclFormat

Options for declaration formatting.

property empty_brackets: syside.conf.FormatPreserved[syside.conf.AlwaysNever]

Choose between {} and ; when formatting empty children blocks:

• always: empty blocks are always formatted as {}

• never: empty blocks are always formatted as a trailing ;

Note that bodies with notes on lines below the opening bracket { will be treated as having children.

property keywords: syside.conf.KeywordOptions

Options for keyword formatting, switching between keywords and tokens, or omitting keywords where possible.

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 markdown: bool

Whether to treat Comment and Documentation bodies as Markdown.

Markdown will preserve whitespace at the end of the lines since it is significant, otherwise it will be trimmed. This does not reformat paragraphs.

property package_closing_note: bool

Whether to append a note with the package name to the closing bracket.

When enabled, packages with a closing bracket on a different line will have a note attached:

package myPackage {
    package P;
} // package myPackage

property parentheses: syside.conf.ParenthesesFormat

Options for expression parentheses formatting:

• always: expression is printed with parentheses

• never: expression is printed without parentheses

• on-break: expression is printed with parentheses only if it breaks

property strip_unnecessary_quotes: bool

Whether to strip quotes from quoted identifiers where possible.

If true, quotes will be stripped from identifiers that have no restricted characters and do not clash with language keywords.

property synth: syside.conf.SynthOptions

Options for printing synthetic elements.

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.

property trailing_comma: syside.conf.CommaOptions

Options for trailing comma placement.

Methods

__init__() → None