sbol3.toplevel
Module Contents
Classes
TopLevel is an abstract class that is extended by any Identified |
Functions
|
|
- class TopLevel(identity: str, type_uri: str, *, namespace: str | None = None, attachments: sbol3.typing.refobj_list_arg | None = None, name: str | None = None, description: str | None = None, derived_from: sbol3.typing.Union[str, Sequence[str]] | None = None, generated_by: sbol3.typing.refobj_list_arg | None = None, measures: sbol3.typing.ownedobj_list_arg | None = None)
Bases:
Identified
TopLevel is an abstract class that is extended by any Identified class that can be found at the top level of an SBOL document or file. In other words, TopLevel objects are not nested inside any other object via composite aggregation. Instead of nesting, composite TopLevel objects refer to subordinate TopLevel objects by their URIs using shared aggregation.
- copy(target_doc=None, target_namespace=None)
- static default_namespace(namespace: sbol3.typing.Union[None, str], identity: str) str
- remove_from_document()
- set_identity(new_identity: str) Any
Sets the identity of the object.
USE WITH EXTREME CAUTION!
This method can break a tree of objects, and invalid a document. Only use this method if you understand the ramifications of changing the identity of a top level object.
- Parameters:
new_identity – the new identity
- Returns:
Nothing
- split_identity() tuple[str, str, str]
Split this object’s identity into three components: namespace, path, and display_id.
- Returns:
A tuple of namespace, path, and display_id
- update_all_dependents(identity_map: dict[str, Identified]) Any
Update all dependent objects based on the provided identity map.
Dependent objects are reparented and references are updated according to the identities and objects in identity_map.
USE WITH CAUTION!
- Parameters:
identity_map – map of identity to Identified
- Returns:
Nothing
- validate(report: ValidationReport = None) ValidationReport
- validate_identity(report: ValidationReport) None
- make_erase_identity_traverser(identity_map: Dict[str, Identified]) Callable[[Identified], None]
- make_update_references_traverser(identity_map: Dict[str, Identified]) Callable[[Identified], None]