FormatOptions

class FormatOptions

Members defined in FormatOptions (93 members)

	action_node_keyword	RW	Controls action formatting in action nodes:
	allocation_usage_keyword	RW	Controls allocation formatting in allocation usages:
	assert_constraint_usage_keyword	RW	Controls constraint formatting in assert constraint usages:
	attribute_usage_reference_keyword	RW	Controls ref formatting in attribute usages:
	binary_allocation_usages	RW	Controls allocation usage ends formatting:
	binary_binding_connector_of_keyword	RW	Controls of keyword formatting in binary binding connectors:
	binary_binding_connectors	RW	Controls binding connector ends formatting:
	binary_connection_usages	RW	Controls connection usage ends formatting:
	binary_connectors	RW	Controls connector ends formatting:
	binary_connectors_from_keyword	RW	Controls from keyword formatting in binary connectors:
	binary_interface_usages	RW	Controls interface usage ends formatting:
	binary_succession_first_keyword	RW	Controls first keyword formatting in binary successions:
	binary_successions	RW	Controls succession ends formatting:
	binding_connector_as_usage_keyword	RW	Controls binding formatting in binding connectors as usages:
	comment_about_break	RW	Controls line break preceding about in Comment:
	comment_keyword	RW	Controls comment keyword formatting:
	conjugation_keyword	RW	Controls conjugation keyword formatting in conjugation members:
	connection_usage_keyword	RW	Controls connection formatting in connection usages:
	connection_usage_reference_keyword	RW	Controls ref formatting in connection usages:
	connector_as_usage_reference_keyword	RW	Controls ref formatting in connector as usages:
	declaration_conjugated_port_typing	RW	Controls conjugated port typing formatting in port declarations.
	declaration_conjugation	RW	Controls conjugation formatting. Requires KerML.
	declaration_cross_subsetting	RW	Controls cross subsetting formatting in feature declarations.
	declaration_feature_typing	RW	Controls feature typing formatting.
	declaration_redefinition	RW	Controls redefinition formatting.
	declaration_reference_subsetting	RW	Controls reference subsetting formatting in feature declarations.
	declaration_specialization	RW	Controls specialization formatting.
	declaration_subclassification	RW	Controls subclassification formatting.
	declaration_subsetting	RW	Controls subsetting formatting.
	dependency_from_keyword	RW	Controls from keyword formatting in dependencies:
	disjoining_keyword	RW	Controls disjoining keyword formatting in disjoining members:
	element_filter_parenthesize	RW	Controls filter (...) condition expression in element filter memberships formatting:
	empty_namespace_brackets	RW	Controls formatting of empty children blocks:
	enum_member_keyword	RW	Controls enum keyword formatting inside enum definitions:
	event_occurrence_keyword	RW	Controls occurrence keyword formatting in event occurrence usages:
	event_occurrence_reference_keyword	RW	Controls ref formatting in event occurrence usages:
	exhibit_state_reference_keyword	RW	Controls ref formatting in exhibit state usages:
	exhibit_state_usage_keyword	RW	Controls state formatting in exhibit state usages:
	feature_keyword	RW	Controls feature keyword formatting in KerML:
	feature_value_equals	RW	Controls feature value equals token formatting whenever it can be omitted:
	featuring_of_keyword	RW	Controls of keyword formatting in type featuring members:
	flow_from_keyword	RW	Controls from keyword formatting in flows:
	flow_usage_from_keyword	RW	Controls from keyword formatting in flow usages:
	force_break_bodies	RW	If true, any child elements inside bodies will be printed on new line.
	framed_concern_keyword	RW	Controls concern formatting in framed concern usages:
	if_parenthesize_condition	RW	Controls if (...) condition expression formatting:
	include_use_case_reference_keyword	RW	Controls ref formatting in include use case usages:
	include_use_case_usage_keyword	RW	Controls use case formatting in include use case usages:
	interface_port_keyword	RW	Controls port formatting of default interface ends:
	interface_usage_connect_keyword	RW	Controls connect formatting in interface usages:
	invariant_true_keyword	RW	Controls true keyword formatting in invariants:
	inverting_keyword	RW	Controls inverting keyword formatting in inverting members:
	literal_real	RW	Controls LiteralReal formatting. Only applies to those numbers that are not in the source text.
	markdown_comments	RW	Controls Comment and Documentation body formatting. If true, trailing whitespace is preserved on each line but last.
	merge_declaration_disjoining	RW	Controls disjoining formatting in type declarations. If true, all disjoinings are merged into a single group. Requires KerML.
	merge_declaration_type_featuring	RW	Controls type featuring formatting in feature declarations. If true, all type featurings are merged into a single group. Requires KerML.
	merge_differencing	RW	Controls differencing formatting in type declarations. If true, all differencings are merged into a single group. Requires KerML.
	merge_feature_chaining	RW	Controls feature chaining formatting in feature declarations. If true, all feature chainings are merged into a single group. Requires KerML.
	merge_intersecting	RW	Controls intersecting formatting in type declarations. If true, all intersectings are merged into a single group. Requires KerML.
	merge_unioning	RW	Controls unioning formatting in type declarations. If true, all unionings are merged into a single group. Requires KerML.
	metadata_body_feature_keyword	RW	Controls feature (KerML) and ref (SysML) keyword formatting in metadata features:
	metadata_body_feature_redefines	RW	Controls first feature redefinition formatting inside MetadataFeature bodies:
	metadata_feature_keyword	RW	Controls metadata feature keyword used.
	multiplicity_placement	RW	Controls multiplicity placement in type declarations:
	null_expression	RW	Controls NullExpression formatting:
	occurrence_keyword	RW	Controls occurrence keyword formatting in occurrence usages and definitions:
	operator_break	RW	Controls binary operator placement on line breaks.
	ordered_nonunique_priority	RW	Controls ordered and nonunique print order:
	perform_action_reference_keyword	RW	Controls ref formatting in perform action usages:
	perform_action_usage_keyword	RW	Controls action formatting in perform action usages:
	port_usage_reference_keyword	RW	Controls ref formatting in attribute usages:
	public_keyword	RW	Controls public keyword formatting:
	reference_usage_keyword	RW	Controls ref formatting in reference usages:
	satisfy_requirement_assert_keyword	RW	Controls assert formatting in satisfy requirement usages:
	satisfy_requirement_keyword	RW	Controls requirement formatting in satisfy requirement usages:
	sequence_expression_trailing_comma	RW	Controls SequenceExpression trailing comma formatting.
	specialization_keyword_feature_typing	RW	Controls specialization keyword formatting in feature typing members:
	specialization_keyword_redefinition	RW	Controls specialization keyword formatting in redefinition members:
	specialization_keyword_specialization	RW	Controls specialization keyword formatting in specialization members:
	specialization_keyword_subclassification	RW	Controls specialization keyword formatting in subclassification members:
	specialization_keyword_subsetting	RW	Controls specialization keyword formatting in subsetting members:
	strip_unnecessary_quotes	RW	Controls identifier formatting. If true, strips quotes from identifiers if the name doesn’t have restricted characters
	succession_as_usage_keyword	RW	Controls succession formatting in successions as usages:
	succession_flow_from_keyword	RW	Controls from keyword formatting in succession flows:
	succession_flow_usage_from_keyword	RW	Controls from keyword formatting in succession flow usages:
	textual_representation_keyword	RW	Controls rep keyword formatting:
	textual_representation_language_break	RW	Controls line break preceding language in TextualRepresentation:
	transition_usage_first_keyword	RW	Controls first formatting in transition usages:
	transition_usage_keyword	RW	Controls transition formatting in transition usages:
	transition_usage_parenthesize_guard	RW	Controls if (...) condition expression in transition usages formatting:
	while_loop_parenthesize_condition	RW	Controls while (...) while loop action condition expression formatting:
	while_loop_parenthesize_until	RW	Controls until (...) while loop action condition expression formatting:
	__init__

 Attributes

property action_node_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls action formatting in action nodes:

• always: action is always printed

• as-needed: action is printed only if required by the grammar

property allocation_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls allocation formatting in allocation usages:

• always: allocation is always printed

• as-needed: allocation is only printed when required by the grammar

property assert_constraint_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls constraint formatting in assert constraint usages:

• always: constraint is always printed

• as-needed: constraint is only printed when required by the grammar

property attribute_usage_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in attribute usages:

• always: ref is always printed

• never: ref is never printed

property binary_allocation_usages: syside.FormatPreserved[syside.AlwaysNever]

Controls allocation usage ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property binary_binding_connector_of_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls of keyword formatting in binary binding connectors:

• always: of is always printed

• as-needed: of is only printed when required by the grammar

property binary_binding_connectors: syside.FormatPreserved[syside.AlwaysNever]

Controls binding connector ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property binary_connection_usages: syside.FormatPreserved[syside.AlwaysNever]

Controls connection usage ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property binary_connectors: syside.FormatPreserved[syside.AlwaysNever]

Controls connector ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property binary_connectors_from_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls from keyword formatting in binary connectors:

• always: from is always printed

• as-needed: from is only printed when required by the grammar

property binary_interface_usages: syside.FormatPreserved[syside.AlwaysNever]

Controls interface usage ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property binary_succession_first_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls first keyword formatting in binary successions:

• always: first is always printed

• as-needed: first is only printed when required by the grammar

property binary_successions: syside.FormatPreserved[syside.AlwaysNever]

Controls succession ends formatting:

• always: binary ends are printed as binary declaration

• never: binary ends are printed as nary declaration

property binding_connector_as_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls binding formatting in binding connectors as usages:

• always: binding is always printed

• as-needed: binding is only printed when required by the grammar

property comment_about_break: syside.OptionalKw

Controls line break preceding about in Comment:

• always: about list is always on a new line

• as-needed: printer tries to fit about list on the previous line

property comment_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls comment keyword formatting:

• always: comment will always be printed

• as-needed: comment will only be printed as needed

property conjugation_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls conjugation keyword formatting in conjugation members:

• always: conjugation will always be printed.

• as-needed: conjugation will be printed only if required by the grammar

property connection_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls connection formatting in connection usages:

• always: connection is always printed

• as-needed: connection is only printed when required by the grammar

property connection_usage_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in connection usages:

• always: ref is always printed

• never: ref is never printed

property connector_as_usage_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in connector as usages:

• always: ref is always printed

• never: ref is never printed

property declaration_conjugated_port_typing: syside.FormatPreserved[syside.KwToken]

Controls conjugated port typing formatting in port declarations.

property declaration_conjugation: syside.FormatPreserved[syside.KwToken]

Controls conjugation formatting. Requires KerML.

property declaration_cross_subsetting: syside.FormatPreserved[syside.KwToken]

Controls cross subsetting formatting in feature declarations.

property declaration_feature_typing: syside.FormatPreserved[syside.KwToken]

Controls feature typing formatting.

property declaration_redefinition: syside.FormatPreserved[syside.KwToken]

Controls redefinition formatting.

property declaration_reference_subsetting: syside.FormatPreserved[syside.KwToken]

Controls reference subsetting formatting in feature declarations.

property declaration_specialization: syside.FormatPreserved[syside.KwToken]

Controls specialization formatting.

property declaration_subclassification: syside.FormatPreserved[syside.KwToken]

Controls subclassification formatting.

property declaration_subsetting: syside.FormatPreserved[syside.KwToken]

Controls subsetting formatting.

property dependency_from_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls from keyword formatting in dependencies:

• always: from will always be printed.

• as-needed: from will be printed only if required by the grammar

property disjoining_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls disjoining keyword formatting in disjoining members:

• always: disjoining will always be printed.

• as-needed: disjoining will be printed only if required by the grammar

property element_filter_parenthesize: syside.OptionalToken

Controls filter (...) condition expression in element filter memberships 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 empty_namespace_brackets: syside.FormatPreserved[syside.AlwaysNever]

Controls formatting of empty children blocks:

• always: empty blocks are always formatted as {}

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

property enum_member_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls enum keyword formatting inside enum definitions:

• always: enum is always printed

• never: enum is never printed

property event_occurrence_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls occurrence keyword formatting in event occurrence usages:

• always: occurrence is always printed

• as-needed: occurrence is only printed when required by the grammar

property event_occurrence_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in event occurrence usages:

• always: ref is always printed

• never: ref is never printed

property exhibit_state_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in exhibit state usages:

• always: ref is always printed

• never: ref is never printed

property exhibit_state_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls state formatting in exhibit state usages:

• always: state is always printed

• as-needed: state is only printed when required by the grammar

property feature_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls feature keyword formatting in KerML:

• always: feature keyword is always printed

• as-needed: feature keyword is printed only when required by the grammar

property feature_value_equals: syside.FormatPreserved[syside.OptionalKw]

Controls feature value equals token formatting whenever it can be omitted:

• as-needed: = will only be printed if it is required by the grammar

• always: = will be always printed when it is acceptable by the grammar

property featuring_of_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls of keyword formatting in type featuring members:

• always: of will always be printed.

• as-needed: of will be printed only if required by the grammar

property flow_from_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls from keyword formatting in flows:

• always: from is always printed

• as-needed: from is only printed when required by the grammar

property flow_usage_from_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls from keyword formatting in flow usages:

• always: from is always printed

• as-needed: from is only printed when required by the grammar

property force_break_bodies: bool

If true, any child elements inside bodies will be printed on new line.

property framed_concern_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls concern formatting in framed concern usages:

• always: concern is always printed

• as-needed: concern is only printed if required by the grammar

property if_parenthesize_condition: syside.OptionalToken

Controls if (...) condition expression 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 include_use_case_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in include use case usages:

• always: ref is always printed

• never: ref is never printed

property include_use_case_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls use case formatting in include use case usages:

• always: use case is always printed

• as-needed: use case is only printed when required by the grammar

property interface_port_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls port formatting of default interface ends:

• always: port is always printed

• never: port is never printed

property interface_usage_connect_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls connect formatting in interface usages:

• always: connect is always printed

• as-needed: connect is only printed when required by the grammar

property invariant_true_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls true keyword formatting in invariants:

• never: true is never printed

• always: true is always printed if invariant is not negated

property inverting_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls inverting keyword formatting in inverting members:

• always: inverting will always be printed.

• as-needed: inverting will be printed only if required by the grammar

property literal_real: syside.FloatFormat

Controls LiteralReal formatting. Only applies to those numbers that are not in the source text.

property markdown_comments: bool

Controls Comment and Documentation body formatting. If true, trailing whitespace is preserved on each line but last.

property merge_declaration_disjoining: bool

Controls disjoining formatting in type declarations. If true, all disjoinings are merged into a single group. Requires KerML.

property merge_declaration_type_featuring: bool

Controls type featuring formatting in feature declarations. If true, all type featurings are merged into a single group. Requires KerML.

property merge_differencing: bool

Controls differencing formatting in type declarations. If true, all differencings are merged into a single group. Requires KerML.

property merge_feature_chaining: bool

Controls feature chaining formatting in feature declarations. If true, all feature chainings are merged into a single group. Requires KerML.

property merge_intersecting: bool

Controls intersecting formatting in type declarations. If true, all intersectings are merged into a single group. Requires KerML.

property merge_unioning: bool

Controls unioning formatting in type declarations. If true, all unionings are merged into a single group. Requires KerML.

property metadata_body_feature_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls feature (KerML) and ref (SysML) keyword formatting in metadata features:

• always: keywords are always printed

• never: keywords are never printed

property metadata_body_feature_redefines: syside.FormatPreserved[syside.OptionalKwToken]

Controls first feature redefinition formatting inside MetadataFeature bodies:

• keyword: redefines is printed

• token: :>> is printed

• none: nothing is printed

property metadata_feature_keyword: syside.FormatPreserved[syside.KwToken]

Controls metadata feature keyword used.

property multiplicity_placement: syside.MultiPlacement

Controls multiplicity placement in type declarations:

• first: multiplicity is printed before any specializations

• first-specialization: multiplicity is printed after the first specialization

• last: multiplicity is printed after all specializations

property null_expression: syside.FormatPreserved[syside.NullFormat]

Controls NullExpression formatting:

• null: always formatted as null

• brackets: always formatted as ()

property occurrence_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls occurrence keyword formatting in occurrence usages and definitions:

• always: occurrence is always printed

• as-needed: occurrence is only printed when required by the grammar

property operator_break: syside.OperatorBreak

Controls binary operator placement on line breaks.

• after: operators are placed on the same line as the LHS expression

• before: operators are placed on the same line as the RHS expression

property ordered_nonunique_priority: syside.FormatPreserved[syside.MultiOrder]

Controls ordered and nonunique print order:

• ordered: ordered is printed first

• nonunique: nonunique is printed first

property perform_action_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in perform action usages:

• always: ref is always printed

• never: ref is never printed

property perform_action_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls action formatting in perform action usages:

• always: action is always printed

• as-needed: action is only printed when required by the grammar

property port_usage_reference_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls ref formatting in attribute usages:

• always: ref is always printed

• never: ref is never printed

property public_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls public keyword formatting:

• always: public will always be printed

• never: public will never be printed

property reference_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls ref formatting in reference usages:

• always: ref is always printed

• as-needed: ref is only printed if required by the grammar

property satisfy_requirement_assert_keyword: syside.FormatPreserved[syside.AlwaysNever]

Controls assert formatting in satisfy requirement usages:

• always: assert is always printed

• never: assert is never printed

property satisfy_requirement_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls requirement formatting in satisfy requirement usages:

• always: requirement is always printed

• as-needed: requirement is only printed when required by the grammar

property sequence_expression_trailing_comma: syside.OptionalToken

Controls SequenceExpression trailing comma formatting.

property specialization_keyword_feature_typing: syside.FormatPreserved[syside.OptionalKw]

Controls specialization keyword formatting in feature typing members:

• always: specialization will always be printed.

• as-needed: specialization will be printed only if required by the grammar

property specialization_keyword_redefinition: syside.FormatPreserved[syside.OptionalKw]

Controls specialization keyword formatting in redefinition members:

• always: specialization will always be printed.

• as-needed: specialization will be printed only if required by the grammar

property specialization_keyword_specialization: syside.FormatPreserved[syside.OptionalKw]

Controls specialization keyword formatting in specialization members:

• always: specialization will always be printed.

• as-needed: specialization will be printed only if required by the grammar

property specialization_keyword_subclassification: syside.FormatPreserved[syside.OptionalKw]

Controls specialization keyword formatting in subclassification members:

• always: specialization will always be printed.

• as-needed: specialization will be printed only if required by the grammar

property specialization_keyword_subsetting: syside.FormatPreserved[syside.OptionalKw]

Controls specialization keyword formatting in subsetting members:

• always: specialization will always be printed.

• as-needed: specialization will be printed only if required by the grammar

property strip_unnecessary_quotes: bool

Controls identifier formatting. If true, strips quotes from identifiers if the name doesn’t have restricted characters

property succession_as_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls succession formatting in successions as usages:

• always: succession is always printed

• as-needed: succession is only printed when required by the grammar

property succession_flow_from_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls from keyword formatting in succession flows:

• always: from is always printed

• as-needed: from is only printed when required by the grammar

property succession_flow_usage_from_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls from keyword formatting in succession flow usages:

• always: from is always printed

• as-needed: from is only printed when required by the grammar

property textual_representation_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls rep keyword formatting:

• always: rep will always be printed

• as-needed: rep will only be printed as needed

property textual_representation_language_break: syside.OptionalKw

Controls line break preceding language in TextualRepresentation:

• always: language is always on a new line

• as-needed: printer tries to fit language on the previous line

property transition_usage_first_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls first formatting in transition usages:

• always: first is always printed if permitted by the grammar

• as-needed: first is only printed if required by the grammar

property transition_usage_keyword: syside.FormatPreserved[syside.OptionalKw]

Controls transition formatting in transition usages:

• always: transition is always printed if permitted by the grammar

• as-needed: transition is only printed if required by the grammar

property transition_usage_parenthesize_guard: syside.OptionalToken

Controls if (...) condition expression in transition usages 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 while_loop_parenthesize_condition: syside.OptionalToken

Controls while (...) while loop action condition expression 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 while_loop_parenthesize_until: syside.OptionalToken

Controls until (...) while loop action condition expression formatting:

• always: expression is printed with parentheses

• never: expression is printed without parentheses

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

 Methods

__init__() → None

 Used in

• syside.ModelPrinter

  • format

  • kerml

  • sysml