Heritage

class Heritage

An accessor for type specializations and conjugations

Members defined in Heritage (7 members)

	all		A depth-first recursive tree iterator to all (in)direct heritage relationships.
	append		Append a new owned or referenced element, inferred from the relationship type and this container. Returns a pair of (relationship, element), only the relationship is newly constructed.
	append_chain		Append a relationship with an owned chaining. Raises TypeError if the relationship type cannot have owned chaining in the textual syntax.
	insert		Insert a relationship and a related element at the specified index. The related element may be owned or referenced depending on the relationship type and this container, see append for more details.
	insert_chain		Insert a relationship with an owned chaining at the specified index. Raises TypeError if the relationship type cannot have owned chaining in the textual syntax.
	replace		Replace the relationship and its related element at the specified index. The relationship may be reused if its type matches the current relationship at that index. The related element may be owned or referenced depending on the relationship type and this container, see append for more details.
	replace_chain_at		Replace the relationship and its related element at the specified index with an owned chaining. The relationship may be reused if its type matches the current relationship at that index. Raises TypeError if the relationship type cannot have owned chaining in the textual syntax.

Members inherited from ChainedChildrenNodes (0 members)

Members inherited from ChildrenNodes (8 members)

	clear		Clear all nodes from this container. Size is reset to 0 afterwards.
	extract		Extracts and returns the element from this container at the specified index without clearing its subtree. The relationship may be reused internally when constructing a new relationship of the same type, while the related element will not.
	extract_element		Extracts a related element from this container without clearing its subtree.
	extract_with_relationship		Removes a relationship and extracts its related element from this container without clearing its subtree.
	pop		Removes and returns a pair (relationship, element) from this container at the specified index. The relationship may be reused internally when constructing a new relationship of the same type, while the related element will only be reused if it was and owned related element. In this case, the related element may be assigned to a new owner in the same document. Note that removed owned related elements will have all the elements in the subtree removed as well.
	remove_element		Removes a related element from this container. Returns True if the related element was removed, and False otherwise. Note that removed owned related elements will have all the elements in the subtree removed as well.
	remove_relationship		Removes a relationship and its related element from this container. Returns True if the relationship was removed, and False otherwise. Note that removed owned related elements will have all the elements in the subtree removed as well.
	reserve		Increase the capacity of the container. Size is not changed.

Members inherited from ChildrenNodesView (6 members)

	elements	R	The related elements in this container.
	relationships	R	The relationships in this container.
	__bool__
	__getitem__
	__len__
	at		Get tuple of (relationship, element) at index.

 Methods

all(include_implicit: bool = True, unwrap_chaining: bool = True, unique: bool = True) → syside.HeritageStream

A depth-first recursive tree iterator to all (in)direct heritage relationships.

Traversal has options:

• include_implicit - whether to include implicitly constructed relationships in the traversal. This is True for name and inherited member resolution but can be used to quickly discard entire swaths of implicit standard library types and their members. This will also affect other implicit specializations, such as those to end features and parameters.

• unwrap_chaining - whether to unwrap feature chain targets, i.e. Feature.feature_target. This is what is used internally for name and inherited member resolution.

• unique - whether to prune already visited supertypes (not relationships). Note that cycles are explicitly permitted by the specification thus this will likely require manual iterator.prune() calls or breaks to avoid infinite loops.

Note that this does not include the root Type itself.

append(relationship: type[syside.Heritage.append.R], element: syside.Heritage.append.M, name: syside.NameID = ...) → tuple[syside.Heritage.append.R, syside.Heritage.append.M]

Append a new owned or referenced element, inferred from the relationship type and this container. Returns a pair of (relationship, element), only the relationship is newly constructed.

append_chain(relationship: type[syside.Heritage.append_chain.R], features: Sequence[syside.Feature]) → tuple[syside.Heritage.append_chain.R, syside.Feature]

Append a relationship with an owned chaining. Raises TypeError if the relationship type cannot have owned chaining in the textual syntax.

insert(index: int, relationship: type[syside.Heritage.insert.R], element: syside.Heritage.insert.M, name: syside.NameID = ...) → tuple[syside.Heritage.insert.R, syside.Heritage.insert.M]

Insert a relationship and a related element at the specified index. The related element may be owned or referenced depending on the relationship type and this container, see append for more details.

insert_chain(index: int, relationship: type[syside.Heritage.insert_chain.R], features: Sequence[syside.Feature]) → tuple[syside.Heritage.insert_chain.R, syside.Feature]

Insert a relationship with an owned chaining at the specified index. Raises TypeError if the relationship type cannot have owned chaining in the textual syntax.

replace(index: int, relationship: type[syside.Heritage.replace.R], element: syside.Heritage.replace.M, name: syside.NameID = ...) → tuple[syside.Heritage.replace.R, syside.Heritage.replace.M]

Replace the relationship and its related element at the specified index. The relationship may be reused if its type matches the current relationship at that index. The related element may be owned or referenced depending on the relationship type and this container, see append for more details.

replace_chain_at(index: int, relationship: type[syside.Heritage.replace_chain_at.R], features: Sequence[syside.Feature]) → tuple[syside.Heritage.replace_chain_at.R, syside.Feature]

Replace the relationship and its related element at the specified index with an owned chaining. The relationship may be reused if its type matches the current relationship at that index. Raises TypeError if the relationship type cannot have owned chaining in the textual syntax.

 Used in

• syside.Type

  • heritage