Import SysML

class Import

Implementation of Import defined in the KerML specification.

Specification:

An Import is an Relationship between its import_owning_namespace and either a Membership (for a MembershipImport) or another Namespace (for a NamespaceImport), which determines a set of Memberships that become imported_memberships of the import_owning_namespace. If is_import_all = false (the default), then only public Memberships are considered “visible”. If is_import_all = true, then all Memberships are considered “visible”, regardless of their declared visibility. If is_recursive = true, then visible Memberships are also recursively imported from owned sub-Namespaces.

For language description, see section 7.2.5.4 of the KerML specification. For more details on the model, see section 8.3.2.4.2 of the KerML specification.

Inheritance:

• AstNode

• Element

• Relationship

• Import

Children

• Expose

• MembershipImport

  • MembershipExpose

• NamespaceImport

  • NamespaceExpose

Members defined in Import (11 members)

	STD	R	All subtypes of Import according to the specification.
	children	R	The elements enclosed by curly brackets in textual syntax.
	import_owning_namespace	R SysML	Implementation of import_owning_namespace defined in the KerML specification.
	import_target	R	The target element of this Import.
	imported_element	R SysML	Implementation of imported_element defined in the KerML specification.
	is_import_all	RW SysML	Implementation of is_import_all defined in the KerML specification.
	is_recursive	RW SysML	Implementation of is_recursive defined in the KerML specification.
	owning_related_element	R SysML	Implementation of owning_related_element defined in the KerML specification.
	sources	R SysML	Implementation of source defined in the KerML specification.
	targets	R SysML	Implementation of target defined in the KerML specification.
	try_set_is_import_all		Try setting is_import_all. For Expose elements, this will return False instead of throwing TypeError when using is_import_all setter.

Members inherited from Relationship (9 members)

	first_source	R	Convenience method for sources[0].
	first_target	R	Convenience method for targets[0].
	is_implied	RW SysML	Implementation of is_implied defined in the KerML specification.
	is_visibility_implied	R	Returns True if this Relationship is using implicit visibility.
	owned_related_elements	R SysML	Implementation of owned_related_element defined in the KerML specification.
	related_elements	R SysML	Implementation of related_element defined in the KerML specification.
	visibility	RW	The visibility level of the related elements from this Relationship relative to the owning_related_element.
	reset_visibility		Reset visibility to its implicit value.
	try_set_visibility		Non-throwing alternative to visibility setter.

Members inherited from Element (25 members)

	alias_ids	R SysML	Implementation of alias_ids defined in the KerML specification.
	comments	R	The owned Comments related by owned_relationships.
	declared_name	RW SysML	Implementation of declared_name defined in the KerML specification.
	declared_short_name	RW SysML	Implementation of declared_short_name defined in the KerML specification.
	documentation	R SysML	Implementation of documentation defined in the KerML specification.
	element_id	RW SysML	Implementation of element_id defined in the KerML specification.
	is_implied_included	R SysML	Implementation of is_implied_included defined in the KerML specification.
	is_library_element	R SysML	Implementation of is_library_element defined in the KerML specification.
	metadata	R	The owned metadata related by owned_relationships.
	name	R SysML	Implementation of name defined in the KerML specification.
	owned_annotations	R SysML	Implementation of owned_annotation defined in the KerML specification.
	owned_elements	R SysML	Implementation of owned_element defined in the KerML specification.
	owned_relationships	R SysML	Implementation of owned_relationship defined in the KerML specification.
	owner	R SysML	Implementation of owner defined in the KerML specification.
	owning_membership	R SysML	Implementation of owning_membership defined in the KerML specification.
	owning_namespace	R SysML	Implementation of owning_namespace defined in the KerML specification.
	owning_relationship	R SysML	Implementation of owning_relationship defined in the KerML specification.
	path	R	Return a unique description of the location of this Element in the containment structure rooted in a root Namespace. In most cases the segments will be identical to QualifiedName.
	qualified_name	R SysML	Implementation of qualified_name defined in the KerML specification.
	scoped_owner	R	The owner of this Element as the parent of owning_membership or owning_relationship otherwise.
	sema_state	RW	The state of semantic resolution for this Element. Based on this, sema may skip elements to avoid duplicate work, e.g. when resolving elements in a group of related documents.
	short_name	R SysML	Implementation of short_name defined in the KerML specification.
	textual_representations	R SysML	Implementation of textual_representation defined in the KerML specification.
	__str__
	matches_qualified_name		Check if the qualified name of this Element matches the provided segments of a qualified name.

Members inherited from AstNode (7 members)

	cst_node	R	The source CST node of self if one exists.
	document	R	The document that owns this node.
	parent	R	The parent node of self.
	__hash__		Identity based hash of this node.
	cast		cast(self, *type: type[TNode]) -> TNode
	isinstance		Chainable equivalent to isintance(self, type)
	try_cast		Checked cast to type.

Attributes

STD: tuple[type[syside.Import], ...] = Ellipsis

All subtypes of Import according to the specification.

This is needed because the implementation does not use multiple inheritance like the standard metamodel. However, all would-be inherited attributes are implemented explicitly on classes in Import.Std.

When working with standard metamodel types, use:

if isinstance(element, Import.STD):
    ...

For type hints, instead use Import.Std:

def function(element: Element) -> Import.Std:
    ...

Note that Import.Std is only defined during TYPE_CHECKING, depending on the Python version used either from __future__ import annotations or def function(...) -> "Import.Std" may be required to ensure that annotations are resolved lazily without an actual object present.

property children: syside.RelationshipBody

The elements enclosed by curly brackets in textual syntax.

property import_owning_namespace: syside.Namespace | None

Implementation of import_owning_namespace defined in the KerML specification.

Specification:

The Namespace into which Memberships are imported by this Import, which must be the owning_related_element of the Import.

See section 8.3.2.4.2 of the KerML specification for more details.

property import_target: syside.Membership | syside.Namespace | None

The target element of this Import.

property imported_element: syside.Element | None

Implementation of imported_element defined in the KerML specification.

Specification:

The effectively imported Element for this Import. For a MembershipImport, this is the member_element of the imported_membership. For a NamespaceImport, it is the imported_namespace.

See section 8.3.2.4.2 of the KerML specification for more details.

property is_import_all: bool

Implementation of is_import_all defined in the KerML specification.

Specification:

Whether to import memberships without regard to declared visibility.

See section 8.3.2.4.2 of the KerML specification for more details.

The setter will throw TypeError on Expose elements which are always is_import_all. Use try_set_is_import_all instead for a non-throwing behaviour.

property is_recursive: bool

Implementation of is_recursive defined in the KerML specification.

Specification:

Whether to recursively import Memberships from visible, owned sub-Namespaces.

See section 8.3.2.4.2 of the KerML specification for more details.

property owning_related_element: syside.Element | None

Implementation of owning_related_element defined in the KerML specification.

Specification:

The related_element of this Relationship that owns the Relationship, if any.

See section 8.3.2.1.3 of the KerML specification for more details.

property sources: syside.ContainerView[syside.Element]

Implementation of source defined in the KerML specification.

Specification:

The related_elements from which this Relationship is considered to be directed.

See section 8.3.2.1.3 of the KerML specification for more details.

property targets: syside.ContainerView[syside.Element]

Implementation of target defined in the KerML specification.

Specification:

The related_elements to which this Relationship is considered to be directed.

See section 8.3.2.1.3 of the KerML specification for more details.

Methods

try_set_is_import_all(arg: bool, /) → bool

Try setting is_import_all. For Expose elements, this will return False instead of throwing TypeError when using is_import_all setter.

Used in

• syside.Import

  • STD

• syside.Namespace

  • owned_imports