diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000000..e69de29bb2d diff --git a/404.html b/404.html new file mode 100644 index 00000000000..38b308d320b --- /dev/null +++ b/404.html @@ -0,0 +1,1221 @@ + + + + + + + + + + + + + + + + + + + + + The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ +

404 - Not found

+ +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/base_ontology/index.html b/api/base_ontology/index.html new file mode 100644 index 00000000000..c18b785566f --- /dev/null +++ b/api/base_ontology/index.html @@ -0,0 +1,6395 @@ + + + + + + + + + + + + + + + + + + + + + + + + + BaseOntology - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

BaseOntology

+ +

Here we provide base data models that can be used to define new ontologies. The base data models are classes which inherit from pydantic.BaseModel and define fields as annotated attributes.

+ + +
+ + + + +
+ + + + + + + + +
+ + + + + + + +
+ + + +

+ T + + + + module-attribute + + +

+
T = TypeVar('T')
+
+ +
+ +

A type variable to represent any type in Python. This is used as placeholder for any concept in the ontologies.

+
+ +
+ + +
+ + + +

+ KnowledgeGraph + + +

+ + +
+

+ Bases: BaseModel

+ + +

This class is used to represent a knowledge graph consists of Pydantic objects in the Python memory.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ontology_lookup + Dict[str, BaseOntology] + +
+

A class variable to store the lookup dictionary of ontologies

+
+
class_lookup + Dict[str, BaseClass] + +
+

A class variable to store the lookup dictionary of classes

+
+
property_lookup + Dict[str, BaseProperty] + +
+

A class variable to store the lookup dictionary of properties

+
+
+ + + + + + + + + +
+ + + + + + + + + +
+ + +

+ graph + + + + classmethod + + +

+
graph() -> Graph
+
+ +
+ +

This method is used to retrieve the knowledge graph in Python memory.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Graph + Graph + +
+

The rdflib.Graph object of the knowledge graph

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
@classmethod
+def graph(cls) -> Graph:
+    """
+    This method is used to retrieve the knowledge graph in Python memory.
+
+    Returns:
+        Graph: The rdflib.Graph object of the knowledge graph
+    """
+    g = Graph()
+    for iri, o in cls.construct_object_lookup().items():
+        g += o.graph()
+    return g
+
+
+
+ +
+ +
+ + +

+ all_triples_of_nodes + + + + classmethod + + +

+
all_triples_of_nodes(iris: Union[str, list]) -> Graph
+
+ +
+ +

This method is used to retrieve all (in-coming and out-going) triples of the given nodes in the knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iris + + str or list + +
+

The IRI of the nodes to be retrieved

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Graph + Graph + +
+

The rdflib.Graph object of the triples of the given nodes

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
@classmethod
+def all_triples_of_nodes(cls, iris: Union[str, list]) -> Graph:
+    """
+    This method is used to retrieve all (in-coming and out-going) triples of the given nodes in the knowledge graph.
+
+    Args:
+        iris (str or list): The IRI of the nodes to be retrieved
+
+    Returns:
+        Graph: The rdflib.Graph object of the triples of the given nodes
+    """
+    # ensure iris is a list
+    if isinstance(iris, str):
+        iris = [iris]
+
+    # convert strings to URIRef if necessary
+    iris = [URIRef(iri) if isinstance(iri, str) else iri for iri in iris]
+
+    source_g = cls.graph()
+    result_g = Graph()
+
+    # add triples to result_graph
+    for iri in iris:
+        for triple in source_g.triples((iri, None, None)):
+            result_g.add(triple)
+        for triple in source_g.triples((None, None, iri)):
+            result_g.add(triple)
+    return result_g
+
+
+
+ +
+ +
+ + +

+ construct_object_lookup + + + + classmethod + + +

+
construct_object_lookup() -> Dict[str, BaseClass]
+
+ +
+ +

This method is used to retrieve all BaseClass (pydantic) objects created in Python memory.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, BaseClass] + +
+

A dictionary of BaseClass (pydantic) objects with their IRIs as keys

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
@classmethod
+def construct_object_lookup(cls) -> Dict[str, BaseClass]:
+    """
+    This method is used to retrieve all BaseClass (pydantic) objects created in Python memory.
+
+    Returns:
+        A dictionary of BaseClass (pydantic) objects with their IRIs as keys
+    """
+    if cls.class_lookup is None:
+        return {}
+    return {i: o for clz in cls.class_lookup.values() if bool(clz.object_lookup) for i, o in clz.object_lookup.items()}
+
+
+
+ +
+ +
+ + +

+ get_object_from_lookup + + + + classmethod + + +

+
get_object_from_lookup(iri: str) -> Union[BaseClass, None]
+
+ +
+ +

This method is used to retrieve an object from Python memory given its IRI.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iri + + str + +
+

IRI of the object to be retrieved

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Union[BaseClass, None] + +
+

The pydantic object of the given IRI if exist, otherwise return None.

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
@classmethod
+def get_object_from_lookup(cls, iri: str) -> Union[BaseClass, None]:
+    """
+    This method is used to retrieve an object from Python memory given its IRI.
+
+    Args:
+        iri (str): IRI of the object to be retrieved
+
+    Returns:
+        The pydantic object of the given IRI if exist, otherwise return None.
+    """
+    return cls.construct_object_lookup().get(iri, None)
+
+
+
+ +
+ +
+ + +

+ clear_object_lookup + + + + classmethod + + +

+
clear_object_lookup()
+
+ +
+ +

This method is used to clear the object lookup dictionary in Python memory.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
113
+114
+115
+116
+117
@classmethod
+def clear_object_lookup(cls):
+    """ This method is used to clear the object lookup dictionary in Python memory. """
+    for cls in cls.class_lookup.values():
+        cls.clear_object_lookup()
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ BaseOntology + + +

+ + +
+

+ Bases: BaseModel

+ + +

This class is used to represent an ontology which consists of a list of BaseClass and ObjectProperty/DatatypeProperty.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
base_url + str + +
+

The base URL to be used to construct the namespace IRI, the default value is 'https://www.theworldavatar.com/kg/'

+
+
namespace + str + +
+

The namespace of the ontology, e.g. 'ontolab'

+
+
namespace_iri + str + +
+

The namespace IRI of the ontology, e.g. 'https://www.theworldavatar.com/kg/ontolab'

+
+
class_lookup + Dict[str, BaseClass] + +
+

A dictionary of BaseClass classes with their rdf:type as keys

+
+
object_property_lookup + Dict[str, ObjectProperty] + +
+

A dictionary of ObjectProperty classes with their predicate IRI as keys

+
+
data_property_lookup + Dict[str, DatatypeProperty] + +
+

A dictionary of DatatypeProperty classes with their predicate IRI as keys

+
+
rdfs_comment + Set[str] + +
+

The comment of the ontology

+
+
owl_versionInfo + str + +
+

The version of the ontology

+
+
+ + + + + + + + + +
+ + + + + + + + + +
+ + +

+ is_dev_mode + + + + classmethod + + +

+
is_dev_mode()
+
+ +
+ +

This method returns whether the KnowledgeGraph is in development mode.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
280
+281
+282
+283
@classmethod
+def is_dev_mode(cls):
+    """This method returns whether the KnowledgeGraph is in development mode."""
+    return cls._dev_mode
+
+
+
+ +
+ +
+ + +

+ set_dev_mode + + + + classmethod + + +

+
set_dev_mode()
+
+ +
+ +

This method sets the KnowledgeGraph to development mode, where duplicate class or property registration will be allowed that the existing ones will be overwritten.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
285
+286
+287
+288
@classmethod
+def set_dev_mode(cls):
+    """This method sets the KnowledgeGraph to development mode, where duplicate class or property registration will be allowed that the existing ones will be overwritten."""
+    cls._dev_mode = True
+
+
+
+ +
+ +
+ + +

+ set_prod_mode + + + + classmethod + + +

+
set_prod_mode()
+
+ +
+ +

This method sets the KnowledgeGraph to production mode, where duplicate class or property registration will raise an error.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
290
+291
+292
+293
@classmethod
+def set_prod_mode(cls):
+    """This method sets the KnowledgeGraph to production mode, where duplicate class or property registration will raise an error."""
+    cls._dev_mode = False
+
+
+
+ +
+ +
+ + +

+ export_to_graph + + + + classmethod + + +

+
export_to_graph(g: Graph = None) -> Graph
+
+ +
+ +

This method is used to export the ontology to a rdflib.Graph object. +It operates at the TBox level, i.e. it only exports the classes and properties of the ontology.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ g + + Graph + +
+

The rdflib.Graph object to which the ontology will be exported

+
+ 		+ None +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
@classmethod
+def export_to_graph(cls, g: Graph = None) -> Graph:
+    """
+    This method is used to export the ontology to a rdflib.Graph object.
+    It operates at the TBox level, i.e. it only exports the classes and properties of the ontology.
+
+    Args:
+        g (Graph): The rdflib.Graph object to which the ontology will be exported
+    """
+    if g is None:
+        g = Graph()
+    # metadata
+    g.add((URIRef(cls.namespace_iri), RDF.type, OWL.Ontology))
+    g.add((URIRef(cls.namespace_iri), DC.date, Literal(datetime.now().isoformat())))
+    if bool(cls.rdfs_comment):
+        if isinstance(cls.rdfs_comment, str):
+            g.add((URIRef(cls.namespace_iri), RDFS.comment, Literal(cls.rdfs_comment)))
+        elif isinstance(cls.rdfs_comment, set):
+            for comment in cls.rdfs_comment:
+                g.add((URIRef(cls.namespace_iri), RDFS.comment, Literal(comment)))
+    if bool(cls.owl_versionInfo):
+        g.add((URIRef(cls.namespace_iri), OWL.versionInfo, Literal(cls.owl_versionInfo)))
+    # handle all classes
+    if bool(cls.class_lookup):
+        for clz in cls.class_lookup.values():
+            g = clz._export_to_owl(g)
+    # handle all object and data properties
+    property_domain_range_lookup = KnowledgeGraph._construct_property_domain_range_lookup()
+    if bool(cls.object_property_lookup):
+        for prop in cls.object_property_lookup.values():
+            g = prop._export_to_owl(
+                g,
+                property_domain_range_lookup.get(prop.predicate_iri, {'rdfs_domain': set()})['rdfs_domain'],
+                property_domain_range_lookup.get(prop.predicate_iri, {'rdfs_range': set()})['rdfs_range'],
+            )
+    # handle all data properties
+    if bool(cls.data_property_lookup):
+        for prop in cls.data_property_lookup.values():
+            g = prop._export_to_owl(
+                g,
+                property_domain_range_lookup.get(prop.predicate_iri, {'rdfs_domain': set()})['rdfs_domain'],
+                property_domain_range_lookup.get(prop.predicate_iri, {'rdfs_range': set()})['rdfs_range'],
+            )
+
+    return g
+
+
+
+ +
+ +
+ + +

+ export_to_triple_store + + + + classmethod + + +

+
export_to_triple_store(sparql_client: PySparqlClient)
+
+ +
+ +

This method is used to export the ontology to a triplestore. +It operates at the TBox level, i.e. it only exports the classes and properties of the ontology.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ sparql_client + + PySparqlClient + +
+

The PySparqlClient object that connects to the triplestore

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
@classmethod
+def export_to_triple_store(cls, sparql_client: PySparqlClient):
+    """
+    This method is used to export the ontology to a triplestore.
+    It operates at the TBox level, i.e. it only exports the classes and properties of the ontology.
+
+    Args:
+        sparql_client (PySparqlClient): The PySparqlClient object that connects to the triplestore
+    """
+    g = cls.export_to_graph()
+
+    # upload to triplestore
+    sparql_client.upload_graph(g)
+
+
+
+ +
+ +
+ + +

+ export_to_owl + + + + classmethod + + +

+
export_to_owl(file_path: str, format: str = 'ttl')
+
+ +
+ +

This method is used to export the ontology to an ontology file. +It operates at the TBox level, i.e. it only exports the classes and properties of the ontology.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ file_path + + str + +
+

The path of the ontology file to be exported to

+
+ 		+ required +
+ format + + str + +
+

The format of the ontology file, the default value is 'ttl'

+
+ 		+ 'ttl' +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
@classmethod
+def export_to_owl(cls, file_path: str, format: str = 'ttl'):
+    """
+    This method is used to export the ontology to an ontology file.
+    It operates at the TBox level, i.e. it only exports the classes and properties of the ontology.
+
+    Args:
+        file_path (str): The path of the ontology file to be exported to
+        format (str): The format of the ontology file, the default value is 'ttl'
+    """
+    g = cls.export_to_graph()
+
+    # serialize
+    g.serialize(destination=file_path, format=format)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ BaseProperty + + +

+
BaseProperty(*args, **kwargs)
+
+ +
+

+ Bases: set, Generic[T]

+ + +

Base class that is inherited by ObjectProperty and DatatypeProperty.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rdfs_isDefinedBy + Type[BaseOntology] + +
+

The ontology that defines the property

+
+
predicate_iri + str + +
+

The predicate IRI of the property

+
+
owl_minQualifiedCardinality + int + +
+

The minimum qualified cardinality of the property (default is 0)

+
+
owl_maxQualifiedCardinality + int + +
+

The maximum qualified cardinality of the property (default is None, meaning infinite)

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
461
+462
def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ retrieve_cardinality + + + + classmethod + + +

+
retrieve_cardinality() -> Tuple[int, int]
+
+ +
+ +

This method is used to retrieve the cardinality of the property.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Tuple[int, int] + +
+

Tuple[int, int]: The minimum and maximum cardinality of the property

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
580
+581
+582
+583
+584
+585
+586
+587
+588
@classmethod
+def retrieve_cardinality(cls) -> Tuple[int, int]:
+    """
+    This method is used to retrieve the cardinality of the property.
+
+    Returns:
+        Tuple[int, int]: The minimum and maximum cardinality of the property
+    """
+    return cls.owl_minQualifiedCardinality, cls.owl_maxQualifiedCardinality
+
+
+
+ +
+ +
+ + +

+ create_from_base + + + + classmethod + + +

+
create_from_base(class_name: str, ontology: Type[BaseOntology], min_cardinality: Optional[int] = 0, max_cardinality: Optional[int] = None) -> Type[BaseProperty]
+
+ +
+ +

This method is used to create a new property class from the calling class. +The new property class will inherit the min and max cardinality from the calling class if not specified.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ class_name + + str + +
+

The name of the new property class

+
+ 		+ required +
+ ontology + + Type[BaseOntology] + +
+

The ontology that defines the property

+
+ 		+ required +
+ min_cardinality + + Optional[int] + +
+

The minimum qualified cardinality of the property (defaults to 0)

+
+ 		+ 0 +
+ max_cardinality + + Optional[int] + +
+

The maximum qualified cardinality of the property (defaults to None meaning infinite)

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Type[BaseProperty] + +
+

Type[BaseProperty]: The new property class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
@classmethod
+def create_from_base(
+    cls,
+    class_name: str,
+    ontology: Type[BaseOntology],
+    min_cardinality: Optional[int] = 0,
+    max_cardinality: Optional[int] = None,
+) -> Type[BaseProperty]:
+    """
+    This method is used to create a new property class from the calling class.
+    The new property class will inherit the min and max cardinality from the calling class if not specified.
+
+    Args:
+        class_name (str): The name of the new property class
+        ontology (Type[BaseOntology]): The ontology that defines the property
+        min_cardinality (Optional[int], optional): The minimum qualified cardinality of the property (defaults to 0)
+        max_cardinality (Optional[int], optional): The maximum qualified cardinality of the property (defaults to None meaning infinite)
+
+    Returns:
+        Type[BaseProperty]: The new property class
+    """
+    # NOTE we inherit cardinality from the calling cls if not specified
+    return type(class_name, (cls,), {
+        'rdfs_isDefinedBy': ontology,
+        'owl_minQualifiedCardinality': min_cardinality if bool(min_cardinality) else cls.owl_minQualifiedCardinality,
+        'owl_maxQualifiedCardinality': max_cardinality if bool(max_cardinality) else cls.owl_maxQualifiedCardinality,
+    })
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ BaseClass + + +

+
BaseClass(**data)
+
+ +
+

+ Bases: BaseModel

+ + +

Base class for all the Python classes that are used to define the classes in ontology.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rdfs_isDefinedBy + BaseOntology + +
+

The ontology that defines the class

+
+
rdf_type + str + +
+

The rdf:type of the class

+
+
object_lookup + Dict[str, BaseClass] + +
+

A dictionary that maps the IRI of the object to the object

+
+
rdfs_comment + str + +
+

The comment of the instance

+
+
rdfs_label + str + +
+

The label of the instance

+
+
instance_iri + str + +
+

The IRI of the instance

+
+
+

Example: +class MyClass(BaseClass): + myObjectProperty: MyObjectProperty[MyOtherClass] + myDatatypeProperty: MyDatatypeProperty[str]

+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
770
+771
+772
+773
+774
+775
+776
+777
+778
+779
+780
+781
+782
def __init__(self, **data):
+    # handle the case when rdfs_comment and rdfs_label are provided as a non-set value
+    if 'rdfs_comment' in data and not isinstance(data['rdfs_comment'], set):
+        if isinstance(data['rdfs_comment'], list):
+            data['rdfs_comment'] = set(data['rdfs_comment'])
+        else:
+            data['rdfs_comment'] = {data['rdfs_comment']}
+    if 'rdfs_label' in data and not isinstance(data['rdfs_label'], set):
+        if isinstance(data['rdfs_label'], list):
+            data['rdfs_label'] = set(data['rdfs_label'])
+        else:
+            data['rdfs_label'] = {data['rdfs_label']}
+    super().__init__(**data)
+
+
+ + + +
+ + + + + + + +
+ + + +

+ rdfs_isDefinedBy + + + + class-attribute + + +

+
rdfs_isDefinedBy: BaseOntology = None
+
+ +
+ +
+

NOTE for all subclasses, one can just use rdfs_isDefinedBy = MyOntology, +see this discussion in Pydantic

+
+
+ +
+ +
+ + + +

+ rdf_type + + + + class-attribute + + +

+
rdf_type: str = OWL_BASE_URL + 'Class'
+
+ +
+ +
+

NOTE rdf_type is the automatically generated IRI of the class which can also be accessed at the instance level.

+
+
+ +
+ + + +
+ + +

+ model_post_init + + +

+
model_post_init(__context: Any) -> None
+
+ +
+ +

The post init process of the BaseClass. +It sets the instance_iri if it is not set. +It also registers the object to the lookup dictionary of the class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ __context + + Any + +
+

Any other context that is needed for the post init process

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
None + None + +
+

It calls the super().model_post_init(__context) to finish the post init process

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
790
+791
+792
+793
+794
+795
+796
+797
+798
+799
+800
+801
+802
+803
+804
+805
+806
def model_post_init(self, __context: Any) -> None:
+    """
+    The post init process of the BaseClass.
+    It sets the instance_iri if it is not set.
+    It also registers the object to the lookup dictionary of the class.
+
+    Args:
+        __context (Any): Any other context that is needed for the post init process
+
+    Returns:
+        None: It calls the super().model_post_init(__context) to finish the post init process
+    """
+    if not bool(self.instance_iri):
+        self.instance_iri = self.__class__.init_instance_iri()
+    # set new instance to the global look up table, so that we can avoid creating the same instance multiple times
+    self._register_object()
+    return super().model_post_init(__context)
+
+
+
+ +
+ +
+ + +

+ retrieve_subclass + + + + classmethod + + +

+
retrieve_subclass(iri: str) -> Type[BaseClass]
+
+ +
+ +

This function retrieves the subclass of the current class based on the IRI. +If the IRI is the same as the rdf:type of the current class, it will return the current class itself.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iri + + str + +
+

The IRI of the subclass

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Type[BaseClass] + +
+

Type[BaseClass]: The subclass of the BaseClass

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
828
+829
+830
+831
+832
+833
+834
+835
+836
+837
+838
+839
+840
+841
+842
@classmethod
+def retrieve_subclass(cls, iri: str) -> Type[BaseClass]:
+    """
+    This function retrieves the subclass of the current class based on the IRI.
+    If the IRI is the same as the rdf:type of the current class, it will return the current class itself.
+
+    Args:
+        iri (str): The IRI of the subclass
+
+    Returns:
+        Type[BaseClass]: The subclass of the BaseClass
+    """
+    if iri == cls.rdf_type:
+        return cls
+    return cls.construct_subclass_dictionary()[iri]
+
+
+
+ +
+ +
+ + +

+ construct_subclass_dictionary + + + + classmethod + + +

+
construct_subclass_dictionary() -> Dict[str, Type[BaseClass]]
+
+ +
+ +

This function constructs a dictionary that maps the rdf:type to the subclass of the BaseClass.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, Type[BaseClass]] + +
+

Dict[str, Type[BaseClass]]: The dictionary that maps the rdf:type to the subclass of the BaseClass

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
844
+845
+846
+847
+848
+849
+850
+851
+852
+853
+854
+855
+856
+857
@classmethod
+def construct_subclass_dictionary(cls) -> Dict[str, Type[BaseClass]]:
+    """
+    This function constructs a dictionary that maps the rdf:type to the subclass of the BaseClass.
+
+    Returns:
+        Dict[str, Type[BaseClass]]: The dictionary that maps the rdf:type to the subclass of the BaseClass
+    """
+    subclass_dict = {}
+    for clz in cls.__subclasses__():
+        subclass_dict[clz.rdf_type] = clz
+        # recursively add the subclass of the subclass
+        subclass_dict.update(clz.construct_subclass_dictionary())
+    return subclass_dict
+
+
+
+ +
+ +
+ + +

+ push_all_instances_to_kg + + + + classmethod + + +

+
push_all_instances_to_kg(sparql_client: PySparqlClient, recursive_depth: int = 0, force_overwrite_local: bool = False)
+
+ +
+ +

This function pushes all the instances of the class to the knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ sparql_client + + PySparqlClient + +
+

The SPARQL client that is used to push the data to the KG

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion

+
+ 		+ 0 +
+ force_overwrite_local + + bool + +
+

Whether to force overwrite the local values with the remote values

+
+ 		+ False +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
859
+860
+861
+862
+863
+864
+865
+866
+867
+868
+869
+870
+871
+872
+873
+874
+875
+876
+877
+878
+879
+880
@classmethod
+def push_all_instances_to_kg(
+    cls,
+    sparql_client: PySparqlClient,
+    recursive_depth: int = 0,
+    force_overwrite_local: bool = False,
+):
+    """
+    This function pushes all the instances of the class to the knowledge graph.
+
+    Args:
+        sparql_client (PySparqlClient): The SPARQL client that is used to push the data to the KG
+        recursive_depth (int): The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion
+        force_overwrite_local (bool): Whether to force overwrite the local values with the remote values
+    """
+    g_to_remove = Graph()
+    g_to_add = Graph()
+    cls.pull_from_kg(cls.object_lookup.keys(), sparql_client, recursive_depth, force_overwrite_local)
+    for obj in cls.object_lookup.values():
+        g_to_remove, g_to_add = obj._collect_diff_to_graph(g_to_remove, g_to_add, recursive_depth)
+    sparql_client.delete_and_insert_graphs(g_to_remove, g_to_add)
+    return g_to_remove, g_to_add
+
+
+
+ +
+ +
+ + +

+ clear_object_lookup + + + + classmethod + + +

+
clear_object_lookup()
+
+ +
+ +

This function clears the lookup dictionary of the class.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
882
+883
+884
+885
+886
+887
+888
+889
+890
@classmethod
+def clear_object_lookup(cls):
+    """
+    This function clears the lookup dictionary of the class.
+    """
+    if cls.object_lookup is not None:
+        iris = list(cls.object_lookup.keys())
+        for i in iris:
+            del cls.object_lookup[i]
+
+
+
+ +
+ +
+ + +

+ pull_from_kg + + + + classmethod + + +

+
pull_from_kg(iris: List[str], sparql_client: PySparqlClient, recursive_depth: int = 0, force_overwrite_local: bool = False) -> List[BaseClass]
+
+ +
+ +

This function pulls the objects from the KG based on the given IRIs.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iris + + List[str] + +
+

The list of IRIs of the objects that one wants to pull from the KG

+
+ 		+ required +
+ sparql_client + + PySparqlClient + +
+

The SPARQL client that is used to pull the data from the KG

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion

+
+ 		+ 0 +
+ force_overwrite_local + + bool + +
+

Whether to force overwrite the local values with the remote values

+
+ 		+ False +
+ + +

Raises:

+ + + + + + + + + + + + + +
TypeDescription
+ ValueError + +
+

The rdf:type of the IRI provided does not match the calling class

+
+
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[BaseClass] + +
+

List[BaseClass]: A list of objects that are pulled from the KG

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
 892
+ 893
+ 894
+ 895
+ 896
+ 897
+ 898
+ 899
+ 900
+ 901
+ 902
+ 903
+ 904
+ 905
+ 906
+ 907
+ 908
+ 909
+ 910
+ 911
+ 912
+ 913
+ 914
+ 915
+ 916
+ 917
+ 918
+ 919
+ 920
+ 921
+ 922
+ 923
+ 924
+ 925
+ 926
+ 927
+ 928
+ 929
+ 930
+ 931
+ 932
+ 933
+ 934
+ 935
+ 936
+ 937
+ 938
+ 939
+ 940
+ 941
+ 942
+ 943
+ 944
+ 945
+ 946
+ 947
+ 948
+ 949
+ 950
+ 951
+ 952
+ 953
+ 954
+ 955
+ 956
+ 957
+ 958
+ 959
+ 960
+ 961
+ 962
+ 963
+ 964
+ 965
+ 966
+ 967
+ 968
+ 969
+ 970
+ 971
+ 972
+ 973
+ 974
+ 975
+ 976
+ 977
+ 978
+ 979
+ 980
+ 981
+ 982
+ 983
+ 984
+ 985
+ 986
+ 987
+ 988
+ 989
+ 990
+ 991
+ 992
+ 993
+ 994
+ 995
+ 996
+ 997
+ 998
+ 999
+1000
+1001
+1002
+1003
+1004
+1005
+1006
+1007
+1008
+1009
+1010
+1011
+1012
+1013
+1014
+1015
+1016
+1017
+1018
+1019
+1020
+1021
+1022
+1023
+1024
+1025
+1026
+1027
+1028
+1029
+1030
+1031
+1032
+1033
+1034
+1035
+1036
+1037
+1038
+1039
+1040
+1041
+1042
+1043
+1044
+1045
+1046
+1047
+1048
+1049
+1050
+1051
+1052
+1053
+1054
+1055
+1056
+1057
+1058
+1059
+1060
+1061
+1062
+1063
+1064
+1065
+1066
+1067
+1068
+1069
+1070
+1071
+1072
+1073
+1074
+1075
+1076
@classmethod
+def pull_from_kg(
+    cls,
+    iris: List[str],
+    sparql_client: PySparqlClient,
+    recursive_depth: int = 0,
+    force_overwrite_local: bool = False,
+) -> List[BaseClass]:
+    """
+    This function pulls the objects from the KG based on the given IRIs.
+
+    Args:
+        iris (List[str]): The list of IRIs of the objects that one wants to pull from the KG
+        sparql_client (PySparqlClient): The SPARQL client that is used to pull the data from the KG
+        recursive_depth (int): The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion
+        force_overwrite_local (bool): Whether to force overwrite the local values with the remote values
+
+    Raises:
+        ValueError: The rdf:type of the IRI provided does not match the calling class
+
+    Returns:
+        List[BaseClass]: A list of objects that are pulled from the KG
+    """
+    if isinstance(iris, str):
+        iris = [iris]
+    iris = set(iris)
+    # if the iris are not provided, then just return empty list
+    if not bool(iris):
+        return []
+    # prepare the list to be returned
+    instance_lst = []
+
+    # check if any of the iris are loading
+    i_loading = set()
+    for i in iris:
+        if KnowledgeGraph._is_iri_been_loading(i):
+            # for those that are loading, use string here and remove it from query
+            instance_lst.append(i)
+            i_loading.add(i)
+        else:
+            # for those that are not loading, indicate they are to be loaded now
+            KnowledgeGraph._add_iri_to_loading(i)
+    iris = iris - i_loading
+
+    # behaviour of recursive_depth: 0 means no recursion, -1 means infinite recursion, n means n-level recursion
+    flag_pull = abs(recursive_depth) > 0
+    recursive_depth = max(recursive_depth - 1, 0) if recursive_depth > -1 else max(recursive_depth - 1, -1)
+    # TODO what do we do with undefined properties in python class? - write a warning message or we can add them to extra_fields https://docs.pydantic.dev/latest/concepts/models/#extra-fields
+    # return format: {iri: {predicate: {object}}}
+    node_dct = sparql_client.get_outgoing_and_attributes(iris)
+    for iri, props in node_dct.items():
+        # TODO optimise the time complexity of the following code when the number of instances is large
+        # check if the rdf:type of the instance matches the calling class or any of its subclasses
+        target_clz_rdf_types = set(props.get(RDF.type.toPython(), [])) # NOTE this supports instance instantiated with multiple rdf:type
+        if not target_clz_rdf_types:
+            raise ValueError(f"The instance {iri} has no rdf:type, retrieved outgoing links and attributes: {props}.")
+        cls_subclasses = set(cls.construct_subclass_dictionary().keys())
+        cls_subclasses.add(cls.rdf_type)
+        intersection = target_clz_rdf_types & cls_subclasses
+        if intersection:
+            if len(intersection) == 1:
+                target_clz_rdf_type = next(iter(intersection))
+            else:
+                # NOTE instead of using the first element of the intersection
+                # we find the deepest subclass as target_clz_rdf_type
+                # so that the created object could inherite all the properties of its parent classes
+                # which prevents the loss of information
+                parent_classes = set()
+                for c in intersection:
+                    if c in parent_classes:
+                        # skip if it's already a parent class
+                        continue
+                    for other in intersection:
+                        if other != c and issubclass(cls.retrieve_subclass(c), cls.retrieve_subclass(other)):
+                            parent_classes.add(other)
+                deepest_subclasses = intersection - parent_classes
+                if len(deepest_subclasses) > 1:
+                    # TODO [future] add support for allowing users to specify the target class
+                    KnowledgeGraph._remove_iri_from_loading(iri)
+                    raise ValueError(
+                        f"""The instance {iri} is of type {target_clz_rdf_types}.
+                        Amongst the pulling class {cls.__name__} ({cls.rdf_type})
+                        and its subclasses ({cls.construct_subclass_dictionary()}),
+                        there exist classes that are not in the same branch of the inheritance tree,
+                        including {deepest_subclasses},
+                        therefore it cannot be instantiated by pulling with class {cls.__name__}.
+                        Please consider pulling the instance directly with one of the class in {deepest_subclasses}
+                        Alternatively, please check the inheritance tree is correctly defined in Python.""")
+                else:
+                    target_clz_rdf_type = next(iter(deepest_subclasses))
+        else:
+            # if there's any error, remove the iri from the loading status
+            # otherwise it will block any further pulling of the same object
+            KnowledgeGraph._remove_iri_from_loading(iri)
+            raise ValueError(
+                f"""The instance {iri} is of type {target_clz_rdf_types},
+                it doesn't match the rdf:type of class {cls.__name__} ({cls.rdf_type}),
+                nor any of its subclasses ({cls.construct_subclass_dictionary()}),
+                therefore it cannot be instantiated.""")
+        inst = KnowledgeGraph.get_object_from_lookup(iri)
+        # obtain the target class in case it is a subclass
+        target_clz = cls.retrieve_subclass(target_clz_rdf_type)
+        # rebuild the model in case there're any ForwardRef that were not resolved previously
+        target_clz.model_rebuild()
+
+        # instead of calling cls.get_object_properties() and cls.get_data_properties()
+        # calling methods of target_clz ensures that all properties are correctly inherited
+        ops = target_clz.get_object_properties()
+        dps = target_clz.get_data_properties()
+        # handle object properties (where the recursion happens)
+        # the situation where two instances pointing to each other (or if there's circular nodes)
+        #   is enabled by stopping pulling at KnowledgeGraph.iri_loading_in_progress
+        # here object_properties_dict is a fetch of the remote KG
+        object_properties_dict = {}
+        for op_iri, op_dct in ops.items():
+            _set = set()
+            if op_iri in props:
+                if flag_pull:
+                    c_tp: BaseClass = get_args(op_dct['type'])[0]
+                    _set = c_tp.pull_from_kg(props[op_iri], sparql_client, recursive_depth, force_overwrite_local)
+                else:
+                    _set = set(props[op_iri])
+            object_properties_dict[op_dct['field']] = _set
+        # here we handle data properties (data_properties_dict is a fetch of the remote KG)
+        data_properties_dict = {}
+        for dp_iri, dp_dct in dps.items():
+            if dp_iri in props:
+                # here we need to convert the data property to the correct type
+                _dp_tp = get_args(dp_dct['type'])[0]
+                data_properties_dict[dp_dct['field']] = set([_dp_tp(_) for _ in props[dp_iri]])
+            else:
+                data_properties_dict[dp_dct['field']] = set()
+        # handle rdfs:label and rdfs:comment (also fetch of the remote KG)
+        rdfs_properties_dict = {}
+        if RDFS.label.toPython() in props:
+            rdfs_properties_dict['rdfs_label'] = set(list(props[RDFS.label.toPython()]))
+        if RDFS.comment.toPython() in props:
+            rdfs_properties_dict['rdfs_comment'] = set(list(props[RDFS.comment.toPython()]))
+        # instantiate the object
+        if inst is not None and type(inst) is target_clz:
+            for op_iri, op_dct in ops.items():
+                if flag_pull:
+                    # below lines pull those object properties that are NOT connected in the remote KG,
+                    # but are connected in the local python memory
+                    # e.g. object `a` has a field `to_b` that points to object `b`
+                    # but triple <a> <to_b> <b> does not exist in the KG
+                    # this code then ensures the cache of object `b` is accurate
+                    # TODO [future] below query can be combined with those connected in the KG to save amount of queries
+                    c_tp: BaseClass = get_args(op_dct['type'])[0]
+                    _o = getattr(inst, op_dct['field']) if getattr(inst, op_dct['field']) is not None else set()
+                    c_tp.pull_from_kg(
+                        set([o.instance_iri if isinstance(o, BaseClass) else o for o in _o]) - set(props.get(op_iri, [])),
+                        sparql_client, recursive_depth, force_overwrite_local)
+            # now collect all featched values
+            fetched = {
+                k: set([o.instance_iri if isinstance(o, BaseClass) else o for o in v])
+                for k, v in object_properties_dict.items()
+            } # object properties
+            fetched.update({k: set(copy.deepcopy(v)) for k, v in data_properties_dict.items()}) # data properties
+            fetched.update(rdfs_properties_dict) # rdfs properties
+            # compare it with cached values and local values for all object/data/rdfs properties
+            # if the object is already in the lookup, then update the object for those fields that are not modified in the python
+            try:
+                inst._update_according_to_fetch(fetched, flag_pull, force_overwrite_local)
+            except Exception as e:
+                # if there's any error, remove the iri from the loading status
+                # otherwise it will block any further pulling of the same object
+                KnowledgeGraph._remove_iri_from_loading(inst.instance_iri)
+                raise e
+        else:
+            # if the object is not in the lookup, create a new object
+            inst = target_clz(
+                instance_iri=iri,
+                **rdfs_properties_dict,
+                **object_properties_dict,
+                **data_properties_dict,
+            )
+            inst._create_cache()
+
+        inst._exist_in_kg = True
+        # update cache here
+        instance_lst.append(inst)
+        # remote inst from the loading status
+        KnowledgeGraph._remove_iri_from_loading(inst.instance_iri)
+    return instance_lst
+
+
+
+ +
+ +
+ + +

+ pull_all_instances_from_kg + + + + classmethod + + +

+
pull_all_instances_from_kg(sparql_client: PySparqlClient, recursive_depth: int = 0, force_overwrite_local: bool = False) -> Set[BaseClass]
+
+ +
+ +

This function pulls all instances of the calling class from the knowledge graph (triplestore). +It calls the pull_from_kg function with the IRIs of all instances of the calling class. +By default, it pulls the instances with no recursion.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ sparql_client + + PySparqlClient + +
+

The SPARQL client that is used to pull the data from the KG

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion

+
+ 		+ 0 +
+ force_overwrite_local + + bool + +
+

Whether to force overwrite the local values with the remote values

+
+ 		+ False +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Set[BaseClass] + +
+

Set[BaseClass]: A set of objects that are pulled from the KG

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1078
+1079
+1080
+1081
+1082
+1083
+1084
+1085
+1086
+1087
+1088
+1089
+1090
+1091
+1092
+1093
+1094
+1095
+1096
+1097
+1098
+1099
@classmethod
+def pull_all_instances_from_kg(
+    cls,
+    sparql_client: PySparqlClient,
+    recursive_depth: int = 0,
+    force_overwrite_local: bool = False,
+) -> Set[BaseClass]:
+    """
+    This function pulls all instances of the calling class from the knowledge graph (triplestore).
+    It calls the pull_from_kg function with the IRIs of all instances of the calling class.
+    By default, it pulls the instances with no recursion.
+
+    Args:
+        sparql_client (PySparqlClient): The SPARQL client that is used to pull the data from the KG
+        recursive_depth (int): The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion
+        force_overwrite_local (bool): Whether to force overwrite the local values with the remote values
+
+    Returns:
+        Set[BaseClass]: A set of objects that are pulled from the KG
+    """
+    iris = sparql_client.get_all_instances_of_class(cls.rdf_type)
+    return cls.pull_from_kg(iris, sparql_client, recursive_depth, force_overwrite_local)
+
+
+
+ +
+ +
+ + +

+ get_object_and_data_properties + + + + classmethod + + +

+
get_object_and_data_properties() -> Dict[str, Dict[str, Union[str, Type[BaseProperty]]]]
+
+ +
+ +

This function returns the object and data properties of the calling class. +This method calls the get_object_properties and get_data_properties functions and returns the combined dictionary.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, Dict[str, Union[str, Type[BaseProperty]]]] + +
+

Dict[str, Dict[str, Union[str, Type[BaseProperty]]]]: A dictionary containing the object and data properties of the calling class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1101
+1102
+1103
+1104
+1105
+1106
+1107
+1108
+1109
+1110
@classmethod
+def get_object_and_data_properties(cls) -> Dict[str, Dict[str, Union[str, Type[BaseProperty]]]]:
+    """
+    This function returns the object and data properties of the calling class.
+    This method calls the get_object_properties and get_data_properties functions and returns the combined dictionary.
+
+    Returns:
+        Dict[str, Dict[str, Union[str, Type[BaseProperty]]]]: A dictionary containing the object and data properties of the calling class
+    """
+    return {**cls.get_object_properties(), **cls.get_data_properties()}
+
+
+
+ +
+ +
+ + +

+ get_object_properties + + + + classmethod + + +

+
get_object_properties() -> Dict[str, Dict[str, Union[str, Type[ObjectProperty]]]]
+
+ +
+ +

This function returns the object properties of the calling class.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, Dict[str, Union[str, Type[ObjectProperty]]]] + +
+

Dict[str, Union[str, Type[ObjectProperty]]]]: A dictionary containing the object properties of the calling class +in the format of {predicate_iri: {'field': field_name, 'type': field_clz}} +e.g. {'https://twa.com/myObjectProperty': {'field': 'myObjectProperty', 'type': MyObjectProperty}}

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1112
+1113
+1114
+1115
+1116
+1117
+1118
+1119
+1120
+1121
+1122
+1123
+1124
+1125
+1126
+1127
@classmethod
+def get_object_properties(cls) -> Dict[str, Dict[str, Union[str, Type[ObjectProperty]]]]:
+    """
+    This function returns the object properties of the calling class.
+
+    Returns:
+        Dict[str, Union[str, Type[ObjectProperty]]]]: A dictionary containing the object properties of the calling class
+            in the format of {predicate_iri: {'field': field_name, 'type': field_clz}}
+            e.g. {'https://twa.com/myObjectProperty': {'field': 'myObjectProperty', 'type': MyObjectProperty}}
+    """
+    dct_op = {}
+    for f, field_info in cls.model_fields.items():
+        op = get_args(field_info.annotation)[0] if type(field_info.annotation) == _UnionGenericAlias else field_info.annotation
+        if ObjectProperty._is_inherited(op):
+            dct_op[op.predicate_iri] = {'field': f, 'type': op}
+    return dct_op
+
+
+
+ +
+ +
+ + +

+ get_data_properties + + + + classmethod + + +

+
get_data_properties() -> Dict[str, Dict[str, Union[str, Type[DatatypeProperty]]]]
+
+ +
+ +

This function returns the data properties of the calling class.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, Dict[str, Union[str, Type[DatatypeProperty]]]] + +
+

Dict[str, Dict[str, Union[str, Type[DatatypeProperty]]]]: A dictionary containing the data properties of the calling class +in the format of {predicate_iri: {'field': field_name, 'type': field_clz}} +e.g. {'https://twa.com/myDatatypeProperty': {'field': 'myDatatypeProperty', 'type': MyDatatypeProperty}}

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1129
+1130
+1131
+1132
+1133
+1134
+1135
+1136
+1137
+1138
+1139
+1140
+1141
+1142
+1143
+1144
@classmethod
+def get_data_properties(cls) -> Dict[str, Dict[str, Union[str, Type[DatatypeProperty]]]]:
+    """
+    This function returns the data properties of the calling class.
+
+    Returns:
+        Dict[str, Dict[str, Union[str, Type[DatatypeProperty]]]]: A dictionary containing the data properties of the calling class
+            in the format of {predicate_iri: {'field': field_name, 'type': field_clz}}
+            e.g. {'https://twa.com/myDatatypeProperty': {'field': 'myDatatypeProperty', 'type': MyDatatypeProperty}}
+    """
+    dct_dp = {}
+    for f, field_info in cls.model_fields.items():
+        dp = get_args(field_info.annotation)[0] if type(field_info.annotation) == _UnionGenericAlias else field_info.annotation
+        if DatatypeProperty._is_inherited(dp):
+            dct_dp[dp.predicate_iri] = {'field': f, 'type': dp}
+    return dct_dp
+
+
+
+ +
+ +
+ + +

+ revert_local_changes + + +

+
revert_local_changes()
+
+ +
+ +

This function reverts the local changes made to the python object to cached values.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1251
+1252
+1253
+1254
+1255
+1256
+1257
def revert_local_changes(self):
+    """ This function reverts the local changes made to the python object to cached values. """
+    for f, field_info in self.model_fields.items():
+        if BaseProperty._is_inherited(field_info.annotation):
+            setattr(self, f, copy.deepcopy(self._latest_cache.get(f, field_info.annotation(set()))))
+        else:
+            setattr(self, f, copy.deepcopy(self._latest_cache.get(f, None)))
+
+
+
+ +
+ +
+ + +

+ get_object_property_by_iri + + +

+
get_object_property_by_iri(iri: str) -> ObjectProperty
+
+ +
+ +

This function returns the object property by the IRI of the property.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iri + + str + +
+

IRI of the object property

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
ObjectProperty + ObjectProperty + +
+

The object property

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1332
+1333
+1334
+1335
+1336
+1337
+1338
+1339
+1340
+1341
+1342
+1343
+1344
+1345
+1346
+1347
def get_object_property_by_iri(self, iri: str) -> ObjectProperty:
+    """
+    This function returns the object property by the IRI of the property.
+
+    Args:
+        iri (str): IRI of the object property
+
+    Returns:
+        ObjectProperty: The object property
+    """
+    dct = self.__class__.get_object_properties()
+    field_name = dct.get(iri, {}).get('field', None)
+    if field_name is not None:
+        return getattr(self, field_name)
+    else:
+        return None
+
+
+
+ +
+ +
+ + +

+ push_to_kg + + +

+
push_to_kg(sparql_client: PySparqlClient, recursive_depth: int = 0, pull_first: bool = False, maximum_retry: int = 0, force_overwrite_if_pull_first: bool = False) -> Tuple[Graph, Graph]
+
+ +
+ +

This function pushes the triples of the calling object to the knowledge graph (triplestore).

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ sparql_client + + PySparqlClient + +
+

The SPARQL client object to be used to push the triples

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion

+
+ 		+ 0 +
+ pull_first + + bool + +
+

Whether to pull the latest triples from the KG before pushing the triples

+
+ 		+ False +
+ maximum_retry + + int + +
+

The number of retries if any exception was raised during SPARQL update

+
+ 		+ 0 +
+ force_overwrite_if_pull_first + + bool + +
+

Whether to force overwrite the local values with the remote values if pull_first is True

+
+ 		+ False +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Tuple[Graph, Graph] + +
+

Tuple[Graph, Graph]: A tuple of two rdflib.Graph objects containing the triples to be removed and added

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1353
+1354
+1355
+1356
+1357
+1358
+1359
+1360
+1361
+1362
+1363
+1364
+1365
+1366
+1367
+1368
+1369
+1370
+1371
+1372
+1373
+1374
+1375
+1376
+1377
+1378
+1379
+1380
+1381
+1382
+1383
+1384
+1385
+1386
+1387
+1388
+1389
+1390
+1391
+1392
+1393
+1394
+1395
+1396
+1397
+1398
def push_to_kg(
+    self,
+    sparql_client: PySparqlClient,
+    recursive_depth: int = 0,
+    pull_first: bool = False,
+    maximum_retry: int = 0,
+    force_overwrite_if_pull_first: bool = False,
+) -> Tuple[Graph, Graph]:
+    """
+    This function pushes the triples of the calling object to the knowledge graph (triplestore).
+
+    Args:
+        sparql_client (PySparqlClient): The SPARQL client object to be used to push the triples
+        recursive_depth (int): The depth of the recursion, 0 means no recursion, -1 means infinite recursion, n means n-level recursion
+        pull_first (bool): Whether to pull the latest triples from the KG before pushing the triples
+        maximum_retry (int): The number of retries if any exception was raised during SPARQL update
+        force_overwrite_if_pull_first (bool): Whether to force overwrite the local values with the remote values if `pull_first` is `True`
+
+    Returns:
+        Tuple[Graph, Graph]: A tuple of two rdflib.Graph objects containing the triples to be removed and added
+    """
+    # TODO [future] what happens when KG changed during processing in the python side? race conditions...
+    # NOTE when push, the objects in memory are loaded to collect diff and only stops when it's string (i.e. no object cached)
+    # this supports the situation where recursive_depth specified here is greater than the value used to pull the object
+
+    # pull the latest triples from the KG if needed
+    if pull_first:
+        self.__class__.pull_from_kg(self.instance_iri, sparql_client, recursive_depth, force_overwrite_if_pull_first)
+    # type of changes: remove old triples, add new triples
+    g_to_remove = Graph()
+    g_to_add = Graph()
+    g_to_remove, g_to_add = self._collect_diff_to_graph(g_to_remove, g_to_add, recursive_depth)
+
+    # retry push if any exception is raised
+    retry_delay = 2
+    for attempt in range(0, maximum_retry +1):
+        try:
+            sparql_client.delete_and_insert_graphs(g_to_remove, g_to_add)
+            # if no exception was thrown, update cache
+            self._create_cache(recursive_depth)
+            return g_to_remove, g_to_add
+        except Exception as e:
+            if attempt < maximum_retry:
+                time.sleep(retry_delay)
+            else:
+                raise e
+
+
+
+ +
+ +
+ + +

+ graph + + +

+
graph(g: Graph = None) -> Graph
+
+ +
+ +

This method adds all the outgoing triples of the calling object.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ g + + Graph + +
+

The rdflib.Graph object to which the triples should be added

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Graph + Graph + +
+

The rdflib.Graph object containing the triples added

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1482
+1483
+1484
+1485
+1486
+1487
+1488
+1489
+1490
+1491
+1492
+1493
+1494
+1495
+1496
+1497
+1498
+1499
+1500
+1501
+1502
+1503
+1504
+1505
+1506
+1507
+1508
+1509
+1510
+1511
+1512
+1513
def graph(self, g: Graph = None) -> Graph:
+    """
+    This method adds all the outgoing triples of the calling object.
+
+    Args:
+        g (Graph, optional): The rdflib.Graph object to which the triples should be added
+
+    Returns:
+        Graph: The rdflib.Graph object containing the triples added
+    """
+    if g is None:
+        g = Graph()
+    g.add((URIRef(self.instance_iri), RDF.type, URIRef(self.rdf_type)))
+    for f, field_info in self.model_fields.items():
+        tp = get_args(field_info.annotation)[0] if type(field_info.annotation) == _UnionGenericAlias else field_info.annotation
+        if ObjectProperty._is_inherited(tp):
+            tp: ObjectProperty
+            prop = getattr(self, f) if getattr(self, f) is not None else set()
+            for o in prop:
+                g.add((URIRef(self.instance_iri), URIRef(tp.predicate_iri), URIRef(o.instance_iri if isinstance(o, BaseClass) else o)))
+        elif DatatypeProperty._is_inherited(tp):
+            tp: DatatypeProperty
+            prop = getattr(self, f) if getattr(self, f) is not None else set()
+            for o in prop:
+                g.add((URIRef(self.instance_iri), URIRef(tp.predicate_iri), Literal(o)))
+        elif f == 'rdfs_comment' and bool(self.rdfs_comment):
+            for comment in self.rdfs_comment:
+                g.add((URIRef(self.instance_iri), RDFS.comment, Literal(comment)))
+        elif f == 'rdfs_label' and bool(self.rdfs_label):
+            for label in self.rdfs_label:
+                g.add((URIRef(self.instance_iri), RDFS.label, Literal(label)))
+    return g
+
+
+
+ +
+ +
+ + +

+ triples + + +

+
triples() -> str
+
+ +
+ +

This method generates the turtle representation for all outgoing triples of the calling object.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

The outgoing triples in turtle format

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1515
+1516
+1517
+1518
+1519
+1520
+1521
+1522
def triples(self) -> str:
+    """
+    This method generates the turtle representation for all outgoing triples of the calling object.
+
+    Returns:
+        str: The outgoing triples in turtle format
+    """
+    return self.graph().serialize(format='ttl')
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ ObjectProperty + + +

+
ObjectProperty(*args, **kwargs)
+
+ +
+

+ Bases: BaseProperty

+ + +

Base class for object properties. It inherits the BaseProperty class.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rdfs_isDefinedBy + +
+

The ontology that defines the property

+
+
predicate_iri + +
+

The predicate IRI of the property

+
+
owl_minQualifiedCardinality + +
+

The minimum qualified cardinality of the property (default is 0)

+
+
owl_maxQualifiedCardinality + +
+

The maximum qualified cardinality of the property (default is None, meaning infinite)

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
461
+462
def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ retrieve_cardinality + + + + classmethod + + +

+
retrieve_cardinality() -> Tuple[int, int]
+
+ +
+ +

This method is used to retrieve the cardinality of the property.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Tuple[int, int] + +
+

Tuple[int, int]: The minimum and maximum cardinality of the property

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1639
+1640
+1641
+1642
+1643
+1644
+1645
+1646
+1647
@classmethod
+def retrieve_cardinality(cls) -> Tuple[int, int]:
+    """
+    This method is used to retrieve the cardinality of the property.
+
+    Returns:
+        Tuple[int, int]: The minimum and maximum cardinality of the property
+    """
+    return super().retrieve_cardinality()
+
+
+
+ +
+ +
+ + +

+ create_from_base + + + + classmethod + + +

+
create_from_base(class_name: str, ontology: Type[BaseOntology], min_cardinality: Optional[int] = 0, max_cardinality: Optional[int] = None) -> Type[ObjectProperty]
+
+ +
+ +

This method is used to create a new property class from the calling property class. +The new property class will inherit the min and max cardinality from the calling class if not specified.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ class_name + + str + +
+

The name of the new property class

+
+ 		+ required +
+ ontology + + Type[BaseOntology] + +
+

The ontology that defines the property

+
+ 		+ required +
+ min_cardinality + + Optional[int] + +
+

The minimum qualified cardinality of the property (defaults to 0)

+
+ 		+ 0 +
+ max_cardinality + + Optional[int] + +
+

The maximum qualified cardinality of the property (defaults to None meaning infinite)

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Type[ObjectProperty] + +
+

Type[ObjectProperty]: The new property class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1649
+1650
+1651
+1652
+1653
+1654
+1655
+1656
+1657
+1658
+1659
+1660
+1661
+1662
+1663
+1664
+1665
+1666
+1667
+1668
+1669
+1670
+1671
@classmethod
+def create_from_base(
+    cls,
+    class_name: str,
+    ontology: Type[BaseOntology],
+    min_cardinality: Optional[int] = 0,
+    max_cardinality: Optional[int] = None,
+) -> Type[ObjectProperty]:
+    """
+    This method is used to create a new property class from the calling property class.
+    The new property class will inherit the min and max cardinality from the calling class if not specified.
+
+    Args:
+        class_name (str): The name of the new property class
+        ontology (Type[BaseOntology]): The ontology that defines the property
+        min_cardinality (Optional[int], optional): The minimum qualified cardinality of the property (defaults to 0)
+        max_cardinality (Optional[int], optional): The maximum qualified cardinality of the property (defaults to None meaning infinite)
+
+    Returns:
+        Type[ObjectProperty]: The new property class
+    """
+    # NOTE we inherit cardinality from the calling cls if not specified
+    return super().create_from_base(class_name, ontology, min_cardinality, max_cardinality)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ TransitiveProperty + + +

+
TransitiveProperty(*args, **kwargs)
+
+ +
+

+ Bases: ObjectProperty

+ + +

Base class for transitive object properties. It inherits the ObjectProperty class.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rdfs_isDefinedBy + +
+

The ontology that defines the property

+
+
predicate_iri + +
+

The predicate IRI of the property

+
+
owl_minQualifiedCardinality + +
+

The minimum qualified cardinality of the property (default is 0)

+
+
owl_maxQualifiedCardinality + +
+

The maximum qualified cardinality of the property (default is None, meaning infinite)

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
461
+462
def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ obtain_transitive_objects + + + + classmethod + + +

+
obtain_transitive_objects(instance: Union[BaseClass, str]) -> Set
+
+ +
+ +

This function obtains the transitive objects of the instance for the transitive object property.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ instance + + Union[BaseClass, str] + +
+

The instance for which the transitive objects are to be obtained

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Set + Set + +
+

The set that contains the transitive objects

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1686
+1687
+1688
+1689
+1690
+1691
+1692
+1693
+1694
+1695
+1696
+1697
+1698
+1699
+1700
+1701
+1702
+1703
+1704
+1705
+1706
+1707
+1708
+1709
+1710
+1711
+1712
+1713
+1714
+1715
+1716
+1717
+1718
+1719
+1720
+1721
+1722
@classmethod
+def obtain_transitive_objects(cls, instance: Union[BaseClass, str]) -> Set:
+    """
+    This function obtains the transitive objects of the instance for the transitive object property.
+
+    Args:
+        instance (Union[BaseClass, str]): The instance for which the transitive objects are to be obtained
+
+    Returns:
+        Set: The set that contains the transitive objects
+    """
+    # check if instance is a string and look it up in the knowledge graph
+    if isinstance(instance, str):
+        _inst = KnowledgeGraph.get_object_from_lookup(instance)
+        if _inst is None:
+            # warn if the instance is not found
+            # there could be further transitive objects in the remote knowledge graph
+            # but they are not looked up here
+            warnings.warn(f"Transitive objects for object property {cls.predicate_iri} not looked up beyond instance {instance} as it is not found in the Python memory.")
+            return set()
+        else:
+            instance = _inst
+
+    # get the transitive objects from the instance using the predicate IRI
+    _transitive_objects = instance.get_object_property_by_iri(cls.predicate_iri)
+    # initialise the transitive objects set with a deep copy of _transitive_objects, or an empty set if it's None
+    transitive_objects = set(copy.deepcopy(_transitive_objects)) if _transitive_objects else set()
+
+    # if there are no transitive objects, return the initialised set (which is an empty set)
+    if not _transitive_objects:
+        return transitive_objects
+
+    # recursively find and accumulate transitive objects for each object in _transitive_objects
+    for o in _transitive_objects:
+        transitive_objects = transitive_objects.union(cls.obtain_transitive_objects(o))
+
+    return transitive_objects
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ DatatypeProperty + + +

+
DatatypeProperty(*args, **kwargs)
+
+ +
+

+ Bases: BaseProperty

+ + +

Base class for data properties. It inherits the BaseProperty class.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rdfs_isDefinedBy + +
+

The ontology that defines the property

+
+
predicate_iri + +
+

The predicate IRI of the property

+
+
owl_minQualifiedCardinality + +
+

The minimum qualified cardinality of the property (default is 0)

+
+
owl_maxQualifiedCardinality + +
+

The maximum qualified cardinality of the property (default is None, meaning infinite)

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
461
+462
def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ retrieve_cardinality + + + + classmethod + + +

+
retrieve_cardinality() -> Tuple[int, int]
+
+ +
+ +

This method is used to retrieve the cardinality of the property.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Tuple[int, int] + +
+

Tuple[int, int]: The minimum and maximum cardinality of the property

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1796
+1797
+1798
+1799
+1800
+1801
+1802
+1803
+1804
@classmethod
+def retrieve_cardinality(cls) -> Tuple[int, int]:
+    """
+    This method is used to retrieve the cardinality of the property.
+
+    Returns:
+        Tuple[int, int]: The minimum and maximum cardinality of the property
+    """
+    return super().retrieve_cardinality()
+
+
+
+ +
+ +
+ + +

+ create_from_base + + + + classmethod + + +

+
create_from_base(class_name: str, ontology: Type[BaseOntology], min_cardinality: Optional[int] = 0, max_cardinality: Optional[int] = None) -> Type[DatatypeProperty]
+
+ +
+ +

This method is used to create a new property class from the calling property class. +The new property class will inherit the min and max cardinality from the calling class if not specified.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ class_name + + str + +
+

The name of the new property class

+
+ 		+ required +
+ ontology + + Type[BaseOntology] + +
+

The ontology that defines the property

+
+ 		+ required +
+ min_cardinality + + Optional[int] + +
+

The minimum qualified cardinality of the property (defaults to 0)

+
+ 		+ 0 +
+ max_cardinality + + Optional[int] + +
+

The maximum qualified cardinality of the property (defaults to None meaning infinite)

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Type[DatatypeProperty] + +
+

Type[DatatypeProperty]: The new property class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/base_ontology.py + 
1806
+1807
+1808
+1809
+1810
+1811
+1812
+1813
+1814
+1815
+1816
+1817
+1818
+1819
+1820
+1821
+1822
+1823
+1824
+1825
+1826
+1827
+1828
@classmethod
+def create_from_base(
+    cls,
+    class_name: str,
+    ontology: Type[BaseOntology],
+    min_cardinality: Optional[int] = 0,
+    max_cardinality: Optional[int] = None,
+) -> Type[DatatypeProperty]:
+    """
+    This method is used to create a new property class from the calling property class.
+    The new property class will inherit the min and max cardinality from the calling class if not specified.
+
+    Args:
+        class_name (str): The name of the new property class
+        ontology (Type[BaseOntology]): The ontology that defines the property
+        min_cardinality (Optional[int], optional): The minimum qualified cardinality of the property (defaults to 0)
+        max_cardinality (Optional[int], optional): The maximum qualified cardinality of the property (defaults to None meaning infinite)
+
+    Returns:
+        Type[DatatypeProperty]: The new property class
+    """
+    # NOTE we inherit cardinality from the calling cls if not specified
+    return super().create_from_base(class_name, ontology, min_cardinality, max_cardinality)
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/conf/index.html b/api/conf/index.html new file mode 100644 index 00000000000..2aad93f3fc3 --- /dev/null +++ b/api/conf/index.html @@ -0,0 +1,2377 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Configuration - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Configuration

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ Config + + +

+
Config(env: Mapping[str, Any])
+
+ +
+ + +

This is a generic config class that can be extended by other classes. +Map environment variables to class fields according to these rules:

+
- Field won't be parsed unless it has a type annotation
+- Field will be skipped if not in all caps
+- Class field and environment variable name are the same
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ env + + Mapping[str, Any] + +
+

A mapping of environment variables.

+
+ 		+ required +
+ + +

Raises:

+ + + + + + + + + + + + + + + + + +
TypeDescription
+ AppConfigError + +
+

Required fields are not provided

+
+
+ AppConfigError + +
+

Provided value for field does not match with the specified data type

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/conf/agent_conf.py + 
40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
def __init__(self, env: Mapping[str, Any]):
+    """
+    The constructor for the Config class.
+
+    Args:
+        env (Mapping[str, Any]): A mapping of environment variables.
+
+    Raises:
+        AppConfigError: Required fields are not provided
+        AppConfigError: Provided value for field does not match with the specified data type
+    """
+    for field in self.all_annotations(): # this ensures the annotations of all parent classes are included
+        if not field.isupper():
+            continue
+
+        # Raise AppConfigError if required field not supplied
+        default_value = getattr(self, field, None)
+        if default_value is None and env.get(field) is None:
+            raise AppConfigError('The {} field is required'.format(field))
+
+        # Cast env var value to expected type and raise AppConfigError on failure
+        try:
+            var_type = get_type_hints(self.__class__)[field]
+            if var_type == bool:
+                value = _parse_bool(env.get(field, default_value))
+            else:
+                value = var_type(env.get(field, default_value))
+
+            self.__setattr__(field, value)
+        except ValueError:
+            raise AppConfigError('Unable to cast value of "{}" to type "{}" for "{}" field'.format(
+                env[field],
+                var_type,
+                field
+            )
+        )
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ all_annotations + + + + classmethod + + +

+
all_annotations() -> ChainMap
+
+ +
+ +

Returns a dictionary-like ChainMap that includes annotations for all +attributes defined in cls or inherited from superclasses.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/conf/agent_conf.py + 
81
+82
+83
+84
+85
@classmethod
+def all_annotations(cls) -> ChainMap:
+    """Returns a dictionary-like ChainMap that includes annotations for all 
+    attributes defined in cls or inherited from superclasses."""
+    return ChainMap(*(c.__annotations__ for c in cls.__mro__ if '__annotations__' in c.__dict__) )
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ AgentConfig + + +

+
AgentConfig(env: Mapping[str, Any])
+
+ +
+

+ Bases: Config

+ + +

Configuration class for the DerivationAgent. +This class is a subclass of Config and provides custom configurations for developed agents. +It includes various fields to configure the agent's behavior and connectivity.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
DERIVATION_PERIODIC_TIMESCALE + int + +
+

The time scale of the periodic job that monitors asynchronous derivations.

+
+
DERIVATION_INSTANCE_BASE_URL + str + +
+

The base URL of the derivation instances that to be created by this agent.

+
+
SPARQL_QUERY_ENDPOINT + str + +
+

The SPARQL endpoint to be used for querying the knowledge graph.

+
+
SPARQL_UPDATE_ENDPOINT + str + +
+

The SPARQL endpoint to be used for updating the knowledge graph.

+
+
KG_USERNAME + str + +
+

The username to access the SPARQL endpoint.

+
+
KG_PASSWORD + str + +
+

The password to access the SPARQL endpoint.

+
+
FILE_SERVER_ENDPOINT + str + +
+

The endpoint of the file server.

+
+
FILE_SERVER_USERNAME + str + +
+

The username to access the file server.

+
+
FILE_SERVER_PASSWORD + str + +
+

The password to access the file server.

+
+
ONTOAGENT_OPERATION_HTTP_BASE_URL + str + +
+

The URL of the OntoAgent:Operation HTTP endpoint.

+
+
REGISTER_AGENT + bool + +
+

Whether to register the OntoAgent instance of the configured agent to knowledge graph.

+
+
MAX_THREAD_MONITOR_ASYNC_DERIVATIONS + int + +
+

The maximum number of thread can be invoked to monitor async derivations at the same time, the default value is 1.

+
+
EMAIL_RECIPIENT + str + +
+

The list of recipients of email notifications during agent operation, multiple email address should be seperated by semicolon, e.g. foo.1@bar.com;foo.2@bar.com.

+
+
EMAIL_SUBJECT_PREFIX + str + +
+

The subject prefix for email notifications, "[] " is automatically added, e.g. the prefix will be "[YourAgent] " if "YourAgent" is specified.

+
+
EMAIL_USERNAME + str + +
+

The username of the email sender, note that a gmail account is required.

+
+
EMAIL_AUTH_JSON_PATH + str + +
+

The json file path to the OAuth2 file of the gmail account defined by EMAIL_USERNAME.

+
+
EMAIL_START_END_ASYNC_DERIVATIONS + bool + +
+

The boolean flag to choose whether to send email notification at the start and end of process an async derivation, the default value is False.

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ env + + Mapping[str, Any] + +
+

A mapping of environment variables.

+
+ 		+ required +
+ + +

Raises:

+ + + + + + + + + + + + + + + + + +
TypeDescription
+ AppConfigError + +
+

Required fields are not provided

+
+
+ AppConfigError + +
+

Provided value for field does not match with the specified data type

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/conf/agent_conf.py + 
40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
def __init__(self, env: Mapping[str, Any]):
+    """
+    The constructor for the Config class.
+
+    Args:
+        env (Mapping[str, Any]): A mapping of environment variables.
+
+    Raises:
+        AppConfigError: Required fields are not provided
+        AppConfigError: Provided value for field does not match with the specified data type
+    """
+    for field in self.all_annotations(): # this ensures the annotations of all parent classes are included
+        if not field.isupper():
+            continue
+
+        # Raise AppConfigError if required field not supplied
+        default_value = getattr(self, field, None)
+        if default_value is None and env.get(field) is None:
+            raise AppConfigError('The {} field is required'.format(field))
+
+        # Cast env var value to expected type and raise AppConfigError on failure
+        try:
+            var_type = get_type_hints(self.__class__)[field]
+            if var_type == bool:
+                value = _parse_bool(env.get(field, default_value))
+            else:
+                value = var_type(env.get(field, default_value))
+
+            self.__setattr__(field, value)
+        except ValueError:
+            raise AppConfigError('Unable to cast value of "{}" to type "{}" for "{}" field'.format(
+                env[field],
+                var_type,
+                field
+            )
+        )
+
+
+ + + +
+ + + + + + + + + + + +
+ +
+ +
+ + +
+ + +

+ config_generic + + +

+
config_generic(conf_cls: Type[Config], env_file: str = None) -> Config
+
+ +
+ +

Load and return the configuration for the specified configuration class from either environment variables or a specified environment file.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ conf_cls + + Type[Config] + +
+

The configuration class to instantiate.

+
+ 		+ required +
+ env_file + + str + +
+

The path to a dotenv (.env) file containing environment variables. If not provided, environment variables will be loaded from the system environment.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Config + Config + +
+

An instance of the provided configuration class, populated with environment variables.

+
+
+ + +

Raises:

+ + + + + + + + + + + + + +
TypeDescription
+ AppConfigError + +
+

If required configuration fields are missing or cannot be cast to the specified types.

+
+
+ + +

Examples:

+ 
# Load configuration from a .env file
+config = config_generic(MyConfigClass, env_file=".env")
+
+# Load configuration from system environment variables
+config = config_generic(MyConfigClass)
+
+ + +
+ Note +

The function prioritizes loading environment variables from the provided env_file if specified. +Otherwise, it defaults to using the system environment variables.

+
+
+ Source code in JPS_BASE_LIB/python_wrapper/twa/conf/agent_conf.py + 
 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
def config_generic(conf_cls: Type[Config], env_file: str = None) -> Config:
+    """
+    Load and return the configuration for the specified configuration class from either environment variables or a specified environment file.
+
+    Args:
+        conf_cls (Type[Config]): The configuration class to instantiate.
+        env_file (str, optional): The path to a dotenv (.env) file containing environment variables. If not provided, environment variables will be loaded from the system environment.
+
+    Returns:
+        Config: An instance of the provided configuration class, populated with environment variables.
+
+    Raises:
+        AppConfigError: If required configuration fields are missing or cannot be cast to the specified types.
+
+    Examples:
+        ```
+        # Load configuration from a .env file
+        config = config_generic(MyConfigClass, env_file=".env")
+
+        # Load configuration from system environment variables
+        config = config_generic(MyConfigClass)
+        ```
+
+    Note:
+        The function prioritizes loading environment variables from the provided env_file if specified.
+        Otherwise, it defaults to using the system environment variables.
+    """
+    if env_file is not None:
+        return conf_cls(dotenv_values(env_file))
+    else:
+        return conf_cls(os.environ)
+
+
+
+ +
+ +
+ + +

+ config_derivation_agent + + +

+
config_derivation_agent(env_file: str = None) -> AgentConfig
+
+ +
+ +

Load and return the configuration for the DerivationAgent from either environment variables or a specified environment file.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ env_file + + str + +
+

The path to a dotenv file containing environment variables. If not provided, environment variables will be loaded from the system environment.

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
AgentConfig + AgentConfig + +
+

An instance of the AgentConfig class, populated with environment variables.

+
+
+ + +

Raises:

+ + + + + + + + + + + + + +
TypeDescription
+ AppConfigError + +
+

If required configuration fields are missing or cannot be cast to the specified types.

+
+
+ + +

Examples:

+ 
# Load configuration from a .env file
+config = config_derivation_agent(env_file=".env")
+
+# Load configuration from system environment variables
+config = config_derivation_agent()
+
+ + +
+ Note +

The function prioritizes loading environment variables from the provided env_file if specified. +Otherwise, it defaults to using the system environment variables.

+
+
+ Source code in JPS_BASE_LIB/python_wrapper/twa/conf/agent_conf.py + 
169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192
+193
+194
+195
def config_derivation_agent(env_file: str = None) -> AgentConfig:
+    """
+    Load and return the configuration for the DerivationAgent from either environment variables or a specified environment file.
+
+    Args:
+        env_file (str, optional): The path to a dotenv file containing environment variables. If not provided, environment variables will be loaded from the system environment.
+
+    Returns:
+        AgentConfig: An instance of the AgentConfig class, populated with environment variables.
+
+    Raises:
+        AppConfigError: If required configuration fields are missing or cannot be cast to the specified types.
+
+    Examples:
+        ```
+        # Load configuration from a .env file
+        config = config_derivation_agent(env_file=".env")
+
+        # Load configuration from system environment variables
+        config = config_derivation_agent()
+        ```
+
+    Note:
+        The function prioritizes loading environment variables from the provided env_file if specified.
+        Otherwise, it defaults to using the system environment variables.
+    """
+    return config_generic(AgentConfig, env_file)
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/derivation/index.html b/api/derivation/index.html new file mode 100644 index 00000000000..a7a958a8f3c --- /dev/null +++ b/api/derivation/index.html @@ -0,0 +1,3574 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Derivation - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Derivation

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ Derivation + + +

+
Derivation(derivation_java)
+
+ +
+ + +

Wrapper class for uk.ac.cam.cares.jps.base.derivation.Derivation.java.

+

This class provides a simplified interface for interacting with the Derivation object +returned when creating synchronous derivations for new information.

+

Only two methods are provided here, all other methods in Java can be accessed via self.derivation.nameOfJavaMethod(args).

+ + +

Methods:

+ + + + + + + + + + + + + + + + + +
NameDescription
getIri +
+

Returns the IRI of the Derivation instance

+
+
getBelongsToIris +
+

Returns the IRIs of the entities that belong to the Derivation instance

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivation_java + + +
+

The Java derivation object

+
+ 		+ required +
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
26
+27
+28
+29
+30
+31
+32
+33
def __init__(self, derivation_java):
+    """
+    Initialises the Derivation instance.
+
+    Args:
+        derivation_java: The Java derivation object
+    """
+    self.derivation = derivation_java
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ getIri + + +

+
getIri() -> str
+
+ +
+ +

Returns the IRI of the Derivation instance.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the Derivation instance

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
35
+36
+37
+38
+39
+40
+41
+42
def getIri(self) -> str:
+    """
+    Returns the IRI of the Derivation instance.
+
+    Returns:
+        str: IRI of the Derivation instance
+    """
+    return self.derivation.getIri()
+
+
+
+ +
+ +
+ + +

+ getBelongsToIris + + +

+
getBelongsToIris(outputRdfType: str) -> List[str]
+
+ +
+ +

Returns the IRIs of the entities that belongsTo the Derivation instance.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ outputRdfType + + str + +
+

IRI of the rdf:type of the entities that belongsTo the Derivation instance

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[str] + +
+

List[str]: List of IRIs of the entities that belongsTo the Derivation instance

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
def getBelongsToIris(self, outputRdfType: str) -> List[str]:
+    """
+    Returns the IRIs of the entities that belongsTo the Derivation instance.
+
+    Args:
+        outputRdfType (str): IRI of the rdf:type of the entities that belongsTo the Derivation instance
+
+    Returns:
+        List[str]: List of IRIs of the entities that belongsTo the Derivation instance
+    """
+    return self.derivation.getBelongsToIris(outputRdfType)
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ DerivationInputs + + +

+
DerivationInputs(derivationInputs)
+
+ +
+ + +

Wrapper class for uk.ac.cam.cares.jps.base.derivation.DerivationInputs.java.

+

This class provides methods to handle derivations within Python derivation agents, +referencing to the corresponding methods in the Java class. +For implementation details, please refer to the Java code.

+ + +

Methods:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
getDerivationIRI +
+

Returns the IRI of the derivation.

+
+
getInputs +
+

Returns the inputs of the derivation as a dictionary.

+
+
getIris +
+

Returns the IRIs of the inputs of the specified rdf:type.

+
+
get_inputs_ogm_by_rdf_type +
+

Returns the inputs as objects of the specified rdf:type.

+
+
get_inputs_ogm +
+

Returns the inputs as objects of the specified class.

+
+
get_inputs_ogm_assume_one +
+

Returns a single input object of the specified class.

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationInputs + + +
+

The Java DerivationInputs object

+
+ 		+ required +
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
74
+75
+76
+77
+78
+79
+80
+81
def __init__(self, derivationInputs) -> None:
+    """
+    Initialises the DerivationInputs instance.
+
+    Args:
+        derivationInputs: The Java DerivationInputs object
+    """
+    self.derivation_inputs = derivationInputs
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ getDerivationIRI + + +

+
getDerivationIRI() -> str
+
+ +
+ +

Returns the IRI of the derivation.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
83
+84
+85
+86
+87
+88
+89
+90
def getDerivationIRI(self) -> str:
+    """
+    Returns the IRI of the derivation.
+
+    Returns:
+        str: IRI of the derivation
+    """
+    return self.derivation_inputs.getDerivationIRI()
+
+
+
+ +
+ +
+ + +

+ getInputs + + +

+
getInputs() -> Dict[str, List[str]]
+
+ +
+ +

Returns the inputs of the derivation as a dictionary.

+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, List[str]] + +
+

Dict[str, List[str]]: Inputs of the derivation in the format of {rdf_type: [iris]}

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
92
+93
+94
+95
+96
+97
+98
+99
def getInputs(self) -> Dict[str, List[str]]:
+    """
+    Returns the inputs of the derivation as a dictionary.
+
+    Returns:
+        Dict[str, List[str]]: Inputs of the derivation in the format of {rdf_type: [iris]}
+    """
+    return ast.literal_eval(str(self.derivation_inputs.getInputs()))
+
+
+
+ +
+ +
+ + +

+ getIris + + +

+
getIris(rdfType) -> Union[List[str], None]
+
+ +
+ +

Returns the IRIs of the inputs of the specified rdf:type.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ rdfType + + str + +
+

IRI of the rdf:type of the inputs

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Union[List[str], None] + +
+

List[str]: List of IRIs of the inputs, or None if no inputs are found

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
def getIris(self, rdfType) -> Union[List[str], None]:
+    """
+    Returns the IRIs of the inputs of the specified rdf:type.
+
+    Args:
+        rdfType (str): IRI of the rdf:type of the inputs
+
+    Returns:
+        List[str]: List of IRIs of the inputs, or None if no inputs are found
+    """
+    iris = self.derivation_inputs.getIris(rdfType)
+    return list(iris) if iris is not None else None
+
+
+
+ +
+ +
+ + +

+ get_inputs_ogm_by_rdf_type + + +

+
get_inputs_ogm_by_rdf_type(rdf_type: str, sparql_client, recursive_depth: int = 0) -> List[BaseClass]
+
+ +
+ +

Returns the inputs as objects of the specified rdf:type (when using object graph mapper).

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ rdf_type + + str + +
+

IRI of the rdf:type

+
+ 		+ required +
+ sparql_client + + +
+

The SPARQL client to query the knowledge graph

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of recursive queries (default is 0)

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[BaseClass] + +
+

List[BaseClass]: List of objects of the specified rdf:type

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
def get_inputs_ogm_by_rdf_type(
+    self,
+    rdf_type: str,
+    sparql_client,
+    recursive_depth: int = 0
+) -> List[BaseClass]:
+    """
+    Returns the inputs as objects of the specified rdf:type (when using object graph mapper).
+
+    Args:
+        rdf_type (str): IRI of the rdf:type
+        sparql_client: The SPARQL client to query the knowledge graph
+        recursive_depth (int): The depth of recursive queries (default is 0)
+
+    Returns:
+        List[BaseClass]: List of objects of the specified rdf:type
+    """
+    return BaseClass.pull_from_kg(
+        iris=self.getIris(rdf_type),
+        sparql_client=sparql_client,
+        recursive_depth=recursive_depth
+    )
+
+
+
+ +
+ +
+ + +

+ get_inputs_ogm + + +

+
get_inputs_ogm(clz: Type[_T], sparql_client, recursive_depth: int = 0) -> List[_T]
+
+ +
+ +

Returns the inputs as objects of the specified class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ clz + + Type[_T] + +
+

The class of the objects to return

+
+ 		+ required +
+ sparql_client + + +
+

The SPARQL client to query the knowledge graph

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of recursive queries (default is 0)

+
+ 		+ 0 +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[_T] + +
+

List[_T]: List of objects of the specified class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
def get_inputs_ogm(
+    self,
+    clz: Type[_T],
+    sparql_client,
+    recursive_depth: int = 0
+) -> List[_T]:
+    """
+    Returns the inputs as objects of the specified class.
+
+    Args:
+        clz (Type[_T]): The class of the objects to return
+        sparql_client: The SPARQL client to query the knowledge graph
+        recursive_depth (int): The depth of recursive queries (default is 0)
+
+    Returns:
+        List[_T]: List of objects of the specified class
+    """
+    return clz.pull_from_kg(
+        iris=self.getIris(clz.rdf_type),
+        sparql_client=sparql_client,
+        recursive_depth=recursive_depth
+    )
+
+
+
+ +
+ +
+ + +

+ get_inputs_ogm_assume_one + + +

+
get_inputs_ogm_assume_one(clz: Type[_T], sparql_client, recursive_depth: int = 0) -> _T
+
+ +
+ +

Returns a single input object of the specified class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ clz + + Type[_T] + +
+

The class of the object to return

+
+ 		+ required +
+ sparql_client + + +
+

The SPARQL client to query the knowledge graph

+
+ 		+ required +
+ recursive_depth + + int + +
+

The depth of recursive queries (default is 0)

+
+ 		+ 0 +
+ + +

Raises:

+ + + + + + + + + + + + + +
TypeDescription
+ Exception + +
+

If the number of objects found is not exactly one

+
+
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
_T + _T + +
+

The single object of the specified class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
def get_inputs_ogm_assume_one(
+    self,
+    clz: Type[_T],
+    sparql_client,
+    recursive_depth: int = 0
+) -> _T:
+    """
+    Returns a single input object of the specified class.
+
+    Args:
+        clz (Type[_T]): The class of the object to return
+        sparql_client: The SPARQL client to query the knowledge graph
+        recursive_depth (int): The depth of recursive queries (default is 0)
+
+    Raises:
+        Exception: If the number of objects found is not exactly one
+
+    Returns:
+        _T: The single object of the specified class
+    """
+    objects = self.get_inputs_ogm(clz=clz, sparql_client=sparql_client, recursive_depth=recursive_depth)
+    if len(objects) != 1:
+        raise Exception(f"""Input type {clz.rdf_type} assumed one for derivation {self.getDerivationIRI()},
+            encounterred {len(objects)}: {' '.join([o.triples() for o in objects])}""")
+    return next(iter(objects))
+
+
+
+ +
+ + + +
+ +
+ +
+ +
+ + + +

+ DerivationOutputs + + +

+
DerivationOutputs(derivationOutputs)
+
+ +
+ + +

Wrapper class for uk.ac.cam.cares.jps.base.derivation.DerivationOutputs.java.

+

This class provides methods to handle derivations within Python derivation agents, +referencing to the corresponding methods in the Java class. +For implementation details, please refer to the Java code.

+ + +

Methods:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
createNewEntity +
+

Creates a new entity with the given IRI and rdf:type.

+
+
createNewEntityWithBaseUrl +
+

Creates a new entity with a base URL and rdf:type.

+
+
addTriple +
+

Adds a triple to the derivation outputs.

+
+
addLiteral +
+

Adds a literal to the derivation outputs.

+
+
addLiteralWithDataType +
+

Adds a literal with a specified data type to the derivation outputs.

+
+
addGraph +
+

Adds a whole rdflib.Graph to the derivation outputs.

+
+
add_outputs_ogm +
+

Adds objects of a specified class to the derivation outputs.

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationOutputs + + +
+

The Java DerivationOutputs object

+
+ 		+ required +
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
205
+206
+207
+208
+209
+210
+211
+212
def __init__(self, derivationOutputs) -> None:
+    """
+    Initialises the DerivationOutputs instance.
+
+    Args:
+        derivationOutputs: The Java DerivationOutputs object
+    """
+    self.derivation_outputs = derivationOutputs
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ createNewEntity + + +

+
createNewEntity(iri, rdfType)
+
+ +
+ +

Creates a new entity with the given IRI and rdf:type.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iri + + str + +
+

IRI of the new entity

+
+ 		+ required +
+ rdfType + + str + +
+

IRI of the rdf:type of the new entity

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
214
+215
+216
+217
+218
+219
+220
+221
+222
def createNewEntity(self, iri, rdfType):
+    """
+    Creates a new entity with the given IRI and rdf:type.
+
+    Args:
+        iri (str): IRI of the new entity
+        rdfType (str): IRI of the rdf:type of the new entity
+    """
+    self.derivation_outputs.createNewEntity(iri, rdfType)
+
+
+
+ +
+ +
+ + +

+ createNewEntityWithBaseUrl + + +

+
createNewEntityWithBaseUrl(baseUrl, rdfType)
+
+ +
+ +

Creates a new entity with the given base URL and rdf:type, adds the new entity to derivation outputs, then returns the initialised IRI.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ baseUrl + + str + +
+

Base URL for the new entity

+
+ 		+ required +
+ rdfType + + str + +
+

IRI of the rdf:type of the new entity

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + +
+

IRI of the newly created entity.

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
def createNewEntityWithBaseUrl(self, baseUrl, rdfType):
+    """
+    Creates a new entity with the given base URL and rdf:type, adds the new entity to derivation outputs, then returns the initialised IRI.
+
+    Args:
+        baseUrl (str): Base URL for the new entity
+        rdfType (str): IRI of the rdf:type of the new entity
+
+    Returns:
+        str: IRI of the newly created entity.
+    """
+    return self.derivation_outputs.createNewEntityWithBaseUrl(baseUrl, rdfType)
+
+
+
+ +
+ +
+ + +

+ addTriple + + +

+
addTriple(s, p, o)
+
+ +
+ +

Adds a triple to the derivation outputs. +Note that only one addTriple function is provided here, the two functions taking TriplePattern is NOT provided for simplicity of java-python data structure conversion.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ s + + str + +
+

Subject of the triple

+
+ 		+ required +
+ p + + str + +
+

Predicate of the triple

+
+ 		+ required +
+ o + + str + +
+

Object of the triple

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
def addTriple(self, s, p, o):
+    """
+    Adds a triple to the derivation outputs.
+    Note that only one addTriple function is provided here, the two functions taking TriplePattern is NOT provided for simplicity of java-python data structure conversion.
+
+    Args:
+        s (str): Subject of the triple
+        p (str): Predicate of the triple
+        o (str): Object of the triple
+    """
+    self.derivation_outputs.addTriple(s, p, o)
+
+
+
+ +
+ +
+ + +

+ addLiteral + + +

+
addLiteral(s, p, o)
+
+ +
+ +

Adds a literal to the derivation outputs. +Note that only one addLiteral is provided here as the correct method to use will be decided by java automatically.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ s + + str + +
+

Subject of the triple

+
+ 		+ required +
+ p + + str + +
+

Predicate of the triple

+
+ 		+ required +
+ o + + Union[str, Literal] + +
+

Literal object of the triple

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
249
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
def addLiteral(self, s, p, o):
+    """
+    Adds a literal to the derivation outputs.
+    Note that only one addLiteral is provided here as the correct method to use will be decided by java automatically.
+
+    Args:
+        s (str): Subject of the triple
+        p (str): Predicate of the triple
+        o (Union[str, Literal]): Literal object of the triple
+    """
+    self.derivation_outputs.addLiteral(s, p, o)
+
+
+
+ +
+ +
+ + +

+ addLiteralWithDataType + + +

+
addLiteralWithDataType(s, p, o, dataType)
+
+ +
+ +

Adds a literal with a specified data type to the derivation outputs. +Note that this method corresponds to addLiteral(String, String, String, String) in DerivationOutputs.java, +but renamed in python due to limitations of overloading in python.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ s + + str + +
+

Subject of the triple

+
+ 		+ required +
+ p + + str + +
+

Predicate of the triple

+
+ 		+ required +
+ o + + str + +
+

Literal object of the triple

+
+ 		+ required +
+ dataType + + str + +
+

Data type of the literal

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
def addLiteralWithDataType(self, s, p, o, dataType):
+    """
+    Adds a literal with a specified data type to the derivation outputs.
+    Note that this method corresponds to addLiteral(String, String, String, String) in `DerivationOutputs.java`,
+    but renamed in python due to limitations of overloading in python.
+
+    Args:
+        s (str): Subject of the triple
+        p (str): Predicate of the triple
+        o (str): Literal object of the triple
+        dataType (str): Data type of the literal
+    """
+    self.derivation_outputs.addLiteral(s, p, o, dataType)
+
+
+
+ +
+ +
+ + +

+ addGraph + + +

+
addGraph(g: Graph)
+
+ +
+ +

Adds a whole rdflib.Graph to the derivation outputs.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ g + + Graph + +
+

The graph to add to the derivation outputs

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
def addGraph(self, g: Graph):
+    """
+    Adds a whole rdflib.Graph to the derivation outputs.
+
+    Args:
+        g (Graph): The graph to add to the derivation outputs
+    """
+    for s, p, o in g:
+        try:
+            if p.toPython() == RDF.type.toPython():
+                self.createNewEntity(s.toPython(), o.toPython())
+            else:
+                # add data properties
+                if isinstance(o, Literal):
+                    if isinstance(o.toPython(), Literal):
+                        # if o.toPython() is a Literal instance, then it's returning itself
+                        # this means the datatype provided to initialise o is NOT presented in rdflib.term.XSDToPython
+                        # therefore, it cannot be cast to native python type
+                        # but str(o) will return the lexical_or_value used
+                        self.addLiteralWithDataType(s.toPython(), p.toPython(), str(o), o._datatype.toPython())
+                    else:
+                        # .toPython() works out what's the most suitable python class and cast to it
+                        self.addLiteral(s.toPython(), p.toPython(), o.toPython())
+                # add object properties
+                else:
+                    self.addTriple(s.toPython(), p.toPython(), o.toPython())
+        except Exception as exc:
+            raise Exception(f"Failed to add: {s.n3()} {p.n3()} {o.n3()}") from exc
+
+
+
+ +
+ +
+ + +

+ add_outputs_ogm + + +

+
add_outputs_ogm(objects: Union[BaseClass, List[BaseClass]])
+
+ +
+ +

Adds objects of a specified class to the derivation outputs.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ objects + + Union[BaseClass, List[BaseClass]] + +
+

The objects to add to the derivation outputs

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/derivation.py + 
304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
def add_outputs_ogm(self, objects: Union[BaseClass, List[BaseClass]]):
+    """
+    Adds objects of a specified class to the derivation outputs.
+
+    Args:
+        objects (Union[BaseClass, List[BaseClass]]): The objects to add to the derivation outputs
+    """
+    if isinstance(objects, BaseClass):
+        objects = [objects]
+    iris = [o.instance_iri for o in objects]
+    self.addGraph(KnowledgeGraph.all_triples_of_nodes(iris))
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/derivation_agent/index.html b/api/derivation_agent/index.html new file mode 100644 index 00000000000..fe40563ce14 --- /dev/null +++ b/api/derivation_agent/index.html @@ -0,0 +1,4205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Derivation Agent - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Derivation Agent

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ FlaskConfig + + +

+ + +
+

+ Bases: object

+ + +

This class provides the configuration for flask app object. +Each config should be provided as constant. +For more information, visit https://flask.palletsprojects.com/en/3.0.x/config/.

+ + +

Attributes:

+ + + + + + + + + + + + + + + +
NameTypeDescription
SCHEDULER_API_ENABLED + bool + +
+

Enables the Flask Scheduler API (default is True)

+
+
+ + + + + + + + + +
+ + + + + + + + + + + +
+ +
+ +
+ +
+ + + +

+ DerivationAgent + + +

+
DerivationAgent(time_interval: int, kg_url: str, kg_update_url: str = None, kg_user: str = None, kg_password: str = None, fs_url: str = None, fs_user: str = None, fs_password: str = None, derivation_instance_base_url: str = TWA_BASE_URL, flask_config: FlaskConfig = FlaskConfig(), agent_endpoint_base_url: str = 'http://localhost:5000/', register_agent: bool = True, max_thread_monitor_async_derivations: int = 1, email_recipient: str = '', email_subject_prefix: str = '', email_username: str = '', email_auth_json_path: str = '', email_start_end_async_derivations: bool = False, logger_for_dev: bool = True)
+
+ +
+

+ Bases: ABC

+ + +

Abstract base class for a derivation agent.

+

This class provides the foundational methods and configurations required for a +derivation agent. It uses a Flask application and APScheduler to manage asynchronous +derivations and periodic jobs.

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
app + Flask + +
+

The Flask application instance.

+
+
scheduler + APScheduler + +
+

The APScheduler instance for managing periodic jobs.

+
+
time_interval + int + +
+

The time interval between two runs of the derivation monitoring job (in seconds).

+
+
max_thread_monitor_async_derivations + int + +
+

Maximum number of threads to be used for monitoring async derivations.

+
+
syncDerivationEndpoint + str + +
+

HTTP endpoint for handling synchronous derivations.

+
+
kgUrl + str + +
+

SPARQL query endpoint.

+
+
kgUpdateUrl + str + +
+

SPARQL update endpoint.

+
+
kgUser + str + +
+

Username for the SPARQL endpoints.

+
+
kgPassword + str + +
+

Password for the SPARQL endpoints.

+
+
fs_url + str + +
+

File server endpoint.

+
+
fs_user + str + +
+

Username for the file server.

+
+
fs_password + str + +
+

Password for the file server.

+
+
derivation_client + PyDerivationClient + +
+

Client for managing derivations.

+
+
sparql_client + PySparqlClient + +
+

SPARQL client instance.

+
+
logger + Logger + +
+

Logger for the agent.

+
+
yag + SMTP + +
+

Email client for sending notifications.

+
+
email_recipient + List[str] + +
+

List of email recipients.

+
+
email_subject_prefix + str + +
+

Prefix for email subjects.

+
+
email_start_end_async_derivations + bool + +
+

Flag to send email notifications at the start and end of async derivations.

+
+
register_agent + bool + +
+

Flag to register the agent to the knowledge graph.

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ time_interval + + int + +
+

time interval between two runs of derivation monitoring job (in SECONDS)

+
+ 		+ required +
+ kg_url + + str + +
+

SPARQL query endpoint, an example: "http://localhost:8080/blazegraph/namespace/triplestore/sparql"

+
+ 		+ required +
+ kg_update_url + + str + +
+

SPARQL update endpoint, will be set to the same value as kg_url if not provided, an example: "http://localhost:8080/blazegraph/namespace/triplestore/sparql"

+
+ 		+ None +
+ kg_user + + str + +
+

username used to access the SPARQL query/update endpoint specified by kg_url/kg_update_url

+
+ 		+ None +
+ kg_password + + str + +
+

password that set for the kg_user used to access the SPARQL query/update endpoint specified by kg_url/kg_update_url

+
+ 		+ None +
+ fs_url + + str + +
+

file server endpoint, an example: "http://localhost:8080/FileServer/"

+
+ 		+ None +
+ fs_user + + str + +
+

username used to access the file server endpoint specified by fs_url

+
+ 		+ None +
+ fs_password + + str + +
+

password that set for the fs_user used to access the file server endpoint specified by fs_url

+
+ 		+ None +
+ derivation_instance_base_url + + str + +
+

namespace to be used when creating derivation instance, an example: "http://example.com/kg/"

+
+ 		+ TWA_BASE_URL +
+ flask_config + + FlaskConfig + +
+

configuration object for flask app, should be an instance of the class FlaskConfig provided as part of this package

+
+ 		+ FlaskConfig() +
+ agent_endpoint_base_url + + str + +
+

data property OntoAgent:hasHttpUrl of OntoAgent:Operation of the derivation agent, an example: "http://localhost:5000/endpoint"

+
+ 		+ 'http://localhost:5000/' +
+ register_agent + + bool + +
+

boolean value, whether to register the agent to the knowledge graph

+
+ 		+ True +
+ max_thread_monitor_async_derivations + + int + +
+

maximum number of threads that to be used for monitoring async derivations

+
+ 		+ 1 +
+ email_recipient + + str + +
+

recipients of email notification seperated by semicolon, e.g. "abc@email.com;def@email.com"

+
+ 		+ '' +
+ email_subject_prefix + + str + +
+

subject prefix of the email title to put in a square bracket, e.g. the email subject will start with "[My Prefix]" when provided "My Prefix"

+
+ 		+ '' +
+ email_username + + str + +
+

the username to be used as the sender of the email

+
+ 		+ '' +
+ email_auth_json_path + + str + +
+

file path to the auth json for the email_username

+
+ 		+ '' +
+ email_start_end_async_derivations + + bool + +
+

a boolean flag indicating whether to send email notification at the start and end of processing async derivations

+
+ 		+ False +
+ logger_for_dev + + bool + +
+

logger for agents in development or production

+
+ 		+ True +
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
 70
+ 71
+ 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
def __init__(
+    self,
+    time_interval: int,
+    kg_url: str,
+    kg_update_url: str = None,
+    kg_user: str = None,
+    kg_password: str = None,
+    fs_url: str = None,
+    fs_user: str = None,
+    fs_password: str = None,
+    derivation_instance_base_url: str = TWA_BASE_URL,
+    flask_config: FlaskConfig = FlaskConfig(),
+    agent_endpoint_base_url: str = "http://localhost:5000/",
+    register_agent: bool = True,
+    max_thread_monitor_async_derivations: int = 1,
+    email_recipient: str = '',
+    email_subject_prefix: str = '',
+    email_username: str = '',
+    email_auth_json_path: str = '',
+    email_start_end_async_derivations: bool = False,
+    logger_for_dev: bool = True,
+):
+    """
+    Initialises the instance of DerivationAgent.
+
+    Args:
+        time_interval (int): time interval between two runs of derivation monitoring job (in SECONDS)
+        kg_url (str): SPARQL query endpoint, an example: "http://localhost:8080/blazegraph/namespace/triplestore/sparql"
+        kg_update_url (str): SPARQL update endpoint, will be set to the same value as kg_url if not provided, an example: "http://localhost:8080/blazegraph/namespace/triplestore/sparql"
+        kg_user (str): username used to access the SPARQL query/update endpoint specified by kg_url/kg_update_url
+        kg_password (str): password that set for the kg_user used to access the SPARQL query/update endpoint specified by kg_url/kg_update_url
+        fs_url (str): file server endpoint, an example: "http://localhost:8080/FileServer/"
+        fs_user (str): username used to access the file server endpoint specified by fs_url
+        fs_password (str): password that set for the fs_user used to access the file server endpoint specified by fs_url
+        derivation_instance_base_url (str): namespace to be used when creating derivation instance, an example: "http://example.com/kg/"
+        flask_config (FlaskConfig): configuration object for flask app, should be an instance of the class FlaskConfig provided as part of this package
+        agent_endpoint_base_url (str): data property OntoAgent:hasHttpUrl of OntoAgent:Operation of the derivation agent, an example: "http://localhost:5000/endpoint"
+        register_agent (bool): boolean value, whether to register the agent to the knowledge graph
+        max_thread_monitor_async_derivations (int): maximum number of threads that to be used for monitoring async derivations
+        email_recipient (str): recipients of email notification seperated by semicolon, e.g. "abc@email.com;def@email.com"
+        email_subject_prefix (str): subject prefix of the email title to put in a square bracket, e.g. the email subject will start with "[My Prefix]" when provided "My Prefix"
+        email_username (str): the username to be used as the sender of the email
+        email_auth_json_path (str): file path to the auth json for the `email_username`
+        email_start_end_async_derivations (bool): a boolean flag indicating whether to send email notification at the start and end of processing async derivations
+        logger_for_dev (bool): logger for agents in development or production
+    """
+
+    # create a JVM module view and use it to import the required java classes
+    self.jpsBaseLib_view = jpsBaseLibGW.createModuleView()
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view, "uk.ac.cam.cares.jps.base.agent.*")
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view, "uk.ac.cam.cares.jps.base.query.*")
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view, "uk.ac.cam.cares.jps.base.derivation.*")
+
+    # initialise flask app with its configuration
+    self.app = Flask(self.__class__.__name__)
+    self.app.config.from_object(flask_config)
+
+    # initialise flask scheduler and assign time interval for monitor_async_derivations job
+    self.scheduler = APScheduler(app=self.app)
+    self.time_interval = time_interval
+    self.max_thread_monitor_async_derivations = max_thread_monitor_async_derivations
+
+    # assign IRI and HTTP URL of the agent
+    # self.agentIRI
+    self.syncDerivationEndpoint = agent_endpoint_base_url + 'derivation' if agent_endpoint_base_url.endswith('/') else agent_endpoint_base_url + '/derivation'
+
+    # assign KG related information
+    self.kgUrl = kg_url
+    self.kgUpdateUrl = kg_update_url if kg_update_url is not None else kg_url
+    # NOTE that we check first if below are empty string first
+    # as the config_derivation_agent will read as '' if the value is not provided in env file
+    self.kgUser = kg_user if kg_user != '' else None
+    self.kgPassword = kg_password if kg_password != '' else None
+
+    # assign file server related information
+    # NOTE that we check first if below are empty string first
+    # as the config_derivation_agent will read as '' if the value is not provided in env file
+    self.fs_url = fs_url if fs_url != '' else None
+    self.fs_user = fs_user if fs_user != '' else None
+    self.fs_password = fs_password if fs_password != '' else None
+
+    # initialise the derivation_client with SPARQL Query and Update endpoint
+    self.derivation_client = PyDerivationClient(
+        derivation_instance_base_url,
+        self.kgUrl,
+        self.kgUpdateUrl,
+        self.kgUser,
+        self.kgPassword,
+    )
+
+    # initialise the SPARQL client as None, this will be replaced when get_sparql_client() is first called
+    self.sparql_client = None
+
+    # initialise the logger
+    self.logger = agentlogging.get_logger('dev' if logger_for_dev else 'prod')
+
+    # initialise the email object and email_start_end_async_derivations flag
+    if all([bool(param) for param in [email_recipient, email_username, email_auth_json_path]]):
+        self.yag = yagmail.SMTP(email_username, oauth2_file=email_auth_json_path)
+        self.email_recipient = email_recipient.split(';')
+        self.email_subject_prefix = email_subject_prefix if bool(email_subject_prefix) else str(self.__class__.__name__)
+    else:
+        self.yag = None
+    self.email_start_end_async_derivations = email_start_end_async_derivations
+
+    # register the agent to the KG if required
+    self.register_agent = register_agent
+    try:
+        self.register_agent_in_kg()
+    except Exception as e:
+        self.logger.error(
+            "Failed to register the agent <{}> to the KG <{}>. Error: {}".format(self.__class__.agentIRI, self.kgUrl, e),
+            stack_info=True, exc_info=True)
+        raise e
+
+    self.logger.info(
+        "DerivationAgent <%s> is initialised to monitor derivations in triple store <%s> with a time interval of %d seconds." % (
+            self.__class__.agentIRI, self.kgUrl, self.time_interval)
+    )
+
+
+ + + +
+ + + + + + + +
+ + + +

+ agent_input_concepts + + + + abstractmethod + classmethod + property + + +

+
agent_input_concepts: List[Union[str, BaseClass]]
+
+ +
+ +

This method returns a list of input concepts of the agent. This should be overridden by the derived class.

+
+ +
+ +
+ + + +

+ agent_output_concepts + + + + abstractmethod + classmethod + property + + +

+
agent_output_concepts: List[Union[str, BaseClass]]
+
+ +
+ +

This method returns a list of output concepts of the agent. This should be overridden by the derived class.

+
+ +
+ + + +
+ + +

+ periodical_job + + +

+
periodical_job(func)
+
+ +
+ +

This method is used to start a periodic job. This should be used as a decorator (@Derivation.periodical_job) for the method that needs to be executed periodically.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
195
+196
+197
+198
+199
+200
+201
+202
+203
def periodical_job(func):
+    """This method is used to start a periodic job. This should be used as a decorator (@Derivation.periodical_job) for the method that needs to be executed periodically."""
+    def inner(self, *args, **kwargs):
+        func(self, *args, **kwargs)
+        if not self.scheduler.running:
+            self.scheduler.start()
+            self.logger.info("Scheduler is started.")
+    inner.__is_periodical_job__ = True
+    return inner
+
+
+
+ +
+ +
+ + +

+ send_email_when_exception + + +

+
send_email_when_exception(func_return_value=False)
+
+ +
+ +

Decorator to send an email when an exception occurs in the decorated method.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
def send_email_when_exception(func_return_value=False):
+    """Decorator to send an email when an exception occurs in the decorated method."""
+    def decorator(func):
+        def inner(self, *args, **kwargs):
+            try:
+                if not func_return_value:
+                    func(self, *args, **kwargs)
+                else:
+                    return func(self, *args, **kwargs)
+            except Exception as e:
+                if self.yag is not None:
+                    self.send_email(
+                        f"[{self.email_subject_prefix}] exception: {str(func.__name__)}",
+                        [
+                            format_current_time(),
+                            # the "<" and ">" may exist in exception message if any IRI is presented, e.g. <http://iri>
+                            # here we replace them to HTML entities, so that the IRIs can be displayed correctly
+                            # for more information about HTML entities, visit https://www.w3schools.com/html/html_entities.asp
+                            str(e).replace("<", "&lt;").replace(">", "&gt;"),
+                            traceback.format_exc()
+                        ]
+                    )
+                # Log error regardless
+                self.logger.exception(e)
+        return inner
+    return decorator
+
+
+
+ +
+ +
+ + +

+ send_email + + +

+
send_email(subject: str, contents: list)
+
+ +
+ +

Sends an email notification with the given subject and contents.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ subject + + str + +
+

The subject of the email

+
+ 		+ required +
+ contents + + list + +
+

The contents of the email

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
def send_email(self, subject: str, contents: list):
+    """
+    Sends an email notification with the given subject and contents.
+
+    Args:
+        subject (str): The subject of the email
+        contents (list): The contents of the email
+    """
+    timeout = 2
+    process_email = Process(target=self.yag.send, args=(self.email_recipient, subject, contents))
+    process_email.start()
+    process_email.join(timeout=timeout)
+    if process_email.is_alive():
+        process_email.kill()
+        process_email.join()
+    if process_email.exitcode != 0:
+        self.logger.error(f"Timed out sending email notification after {timeout} seconds.\n Recipient: {self.email_recipient}\n Subject: {subject}\n Contents: {contents}")
+
+
+
+ +
+ +
+ + +

+ send_email_when_async_derivation_up_to_date + + +

+
send_email_when_async_derivation_up_to_date(derivation_iri: str)
+
+ +
+ +

Sends an email notification when an asynchronous derivation is up-to-date.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivation_iri + + str + +
+

The IRI of the derivation that was processed

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
def send_email_when_async_derivation_up_to_date(self, derivation_iri: str):
+    """
+    Sends an email notification when an asynchronous derivation is up-to-date.
+
+    Args:
+        derivation_iri (str): The IRI of the derivation that was processed
+    """
+    if self.yag is not None and self.email_start_end_async_derivations:
+        self.send_email(
+            f"[{self.email_subject_prefix}] async derivation up-to-date",
+            [format_current_time(), f"{derivation_iri}"]
+        )
+
+
+
+ +
+ +
+ + +

+ send_email_when_async_derivation_started + + +

+
send_email_when_async_derivation_started(derivation_iri)
+
+ +
+ +

Sends an email notification when an asynchronous derivation starts.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivation_iri + + str + +
+

The IRI of the derivation that was processed

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
def send_email_when_async_derivation_started(self, derivation_iri):
+    """
+    Sends an email notification when an asynchronous derivation starts.
+
+    Args:
+        derivation_iri (str): The IRI of the derivation that was processed
+    """
+    if self.yag is not None and self.email_start_end_async_derivations:
+        self.send_email(
+            f"[{self.email_subject_prefix}] async derivation now-in-progress",
+            [format_current_time(), f"{derivation_iri}"]
+        )
+
+
+
+ +
+ +
+ + +

+ get_sparql_client + + +

+
get_sparql_client(sparql_client_cls: Type[PY_SPARQL_CLIENT]) -> PY_SPARQL_CLIENT
+
+ +
+ +

Returns a SPARQL client object that instantiated from sparql_client_cls, which should extend PySparqlClient class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ sparql_client_cls + + Type[PY_SPARQL_CLIENT] + +
+

The SPARQL client class

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
PY_SPARQL_CLIENT + PY_SPARQL_CLIENT + +
+

An instance of the SPARQL client

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
def get_sparql_client(self, sparql_client_cls: Type[PY_SPARQL_CLIENT]) -> PY_SPARQL_CLIENT:
+    """
+    Returns a SPARQL client object that instantiated from sparql_client_cls, which should extend PySparqlClient class.
+
+    Args:
+        sparql_client_cls (Type[PY_SPARQL_CLIENT]): The SPARQL client class
+
+    Returns:
+        PY_SPARQL_CLIENT: An instance of the SPARQL client
+    """
+    if self.sparql_client is None or not isinstance(self.sparql_client, sparql_client_cls):
+        self.sparql_client = sparql_client_cls(
+            query_endpoint=self.kgUrl, update_endpoint=self.kgUpdateUrl,
+            kg_user=self.kgUser, kg_password=self.kgPassword,
+            fs_url=self.fs_url, fs_user=self.fs_user, fs_pwd=self.fs_password
+        )
+    return self.sparql_client
+
+
+
+ +
+ +
+ + +

+ register_agent_in_kg + + +

+
register_agent_in_kg()
+
+ +
+ +

This method registers the agent to the knowledge graph by uploading its OntoAgent triples generated on-the-fly.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
def register_agent_in_kg(self):
+    """This method registers the agent to the knowledge graph by uploading its OntoAgent triples generated on-the-fly."""
+    if self.register_agent:
+        input_concepts = self.agent_input_concepts
+        output_concepts = self.agent_output_concepts
+        if not isinstance(input_concepts, list) or not isinstance(output_concepts, list):
+            raise Exception("Failed to proceed with registering the agent <{}> to the KG <{}>. Error: Input and output concepts must be lists. Received: {} (type: {}) and {} (type: {})".format(
+                self.__class__.agentIRI, self.kgUrl, input_concepts, type(input_concepts), output_concepts, type(output_concepts)))
+        if len(input_concepts) == 0 or len(output_concepts) == 0:
+            raise Exception("Failed to proceed with registering the agent <{}> to the KG <{}>. Error: No input or output concepts specified.".format(self.__class__.agentIRI, self.kgUrl))
+        input_concepts_iris = [o if isinstance(o, str) else o.rdf_type for o in input_concepts]
+        output_concepts_iris = [o if isinstance(o, str) else o.rdf_type for o in output_concepts]
+        self.derivation_client.createOntoAgentInstance(self.__class__.agentIRI, self.syncDerivationEndpoint, input_concepts_iris, output_concepts_iris)
+        self.logger.info("Agent <%s> is registered to the KG <%s> with input signature %s and output signature %s." % (
+            self.__class__.agentIRI, self.kgUrl, input_concepts, output_concepts))
+    else:
+        self.logger.info("Flag register_agent is False. Agent <%s> is NOT registered to the KG <%s>." % (self.__class__.agentIRI, self.kgUrl))
+
+
+
+ +
+ +
+ + +

+ add_url_pattern + + +

+
add_url_pattern(url_pattern: str = None, url_pattern_name: str = None, function: RouteCallable = None, methods: str = ['GET'], *args, **kwargs)
+
+ +
+ +

This method is a wrapper of add_url_rule method of Flask object that adds customised URL Pattern to derivation agent. +For more information, visit https://flask.palletsprojects.com/en/3.0.x/api/#flask.Flask.add_url_rule +WARNING: Use of this by developer is STRONGLY discouraged. +The design intention of an derivation agent is to communicate via the KNOWLEDGE GRAPH, and NOT via HTTP requests.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ url_pattern + + str + +
+

the endpoint url to associate with the rule and view function

+
+ 		+ None +
+ url_pattern_name + + str + +
+

the name of the endpoint

+
+ 		+ None +
+ function + + RouteCallable + +
+

the view function to associate with the endpoint

+
+ 		+ None +
+ methods + + str + +
+

HTTP request methods, default to ['GET']

+
+ 		+ ['GET'] +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
def add_url_pattern(
+    self,
+    url_pattern: str = None,
+    url_pattern_name: str = None,
+    function: RouteCallable = None,
+    methods: str = ['GET'],
+    *args,
+    **kwargs
+):
+    """
+    This method is a wrapper of add_url_rule method of Flask object that adds customised URL Pattern to derivation agent.
+    For more information, visit https://flask.palletsprojects.com/en/3.0.x/api/#flask.Flask.add_url_rule
+    WARNING: Use of this by developer is STRONGLY discouraged.
+    The design intention of an derivation agent is to communicate via the KNOWLEDGE GRAPH, and NOT via HTTP requests.
+
+    Args:
+        url_pattern (str): the endpoint url to associate with the rule and view function
+        url_pattern_name (str): the name of the endpoint
+        function (flask.typing.RouteCallable): the view function to associate with the endpoint
+        methods (str): HTTP request methods, default to ['GET']
+    """
+    self.app.add_url_rule(url_pattern, url_pattern_name,
+                          function, methods=methods, *args, **kwargs)
+    self.logger.info(f"A URL Pattern <{url_pattern}> is added.")
+
+
+
+ +
+ +
+ + +

+ monitor_async_derivations + + +

+
monitor_async_derivations()
+
+ +
+ +

This method monitors the status of the asynchronous derivation that "isDerivedUsing" DerivationAgent.

+

When it detects the status is "Requested", the agent will mark the status as "InProgress" and start the job. +Once the job is finished, the agent marks the status as "Finished" and attaches the new derived IRI to it via "hasNewDerivedIRI". +All new generated triples are also written to the knowledge graph at this point.

+

When it detects the status is "InProgress", the currently implementation just passes.

+

When it detects the status is "Finished", the agent deletes the old entities, +reconnects the new instances (previously attached to the status via "hasNewDerivedIRI") with the original derivation, +cleans up all the status, and finally updates the timestamp of the derivation. +All these processing steps at the Finished status are taken care of by method +uk.ac.cam.cares.jps.base.derivation.DerivationClient.cleanUpFinishedDerivationUpdate(String).

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386
+387
+388
+389
+390
+391
+392
+393
+394
+395
+396
+397
+398
+399
+400
+401
+402
+403
+404
+405
+406
+407
+408
+409
+410
+411
+412
+413
+414
+415
+416
+417
+418
+419
+420
+421
+422
+423
+424
+425
+426
+427
+428
+429
+430
+431
+432
+433
+434
+435
+436
+437
+438
+439
+440
+441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
+452
+453
+454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
+465
+466
+467
+468
+469
+470
+471
+472
+473
+474
+475
+476
+477
+478
+479
+480
+481
+482
+483
+484
+485
+486
+487
+488
+489
+490
+491
+492
+493
+494
+495
+496
+497
+498
+499
+500
+501
+502
+503
+504
+505
+506
@send_email_when_exception(func_return_value=False)
+def monitor_async_derivations(self):
+    """
+    This method monitors the status of the asynchronous derivation that "isDerivedUsing" DerivationAgent.
+
+    When it detects the status is "Requested", the agent will mark the status as "InProgress" and start the job.
+    Once the job is finished, the agent marks the status as "Finished" and attaches the new derived IRI to it via "hasNewDerivedIRI".
+    All new generated triples are also written to the knowledge graph at this point.
+
+    When it detects the status is "InProgress", the currently implementation just passes.
+
+    When it detects the status is "Finished", the agent deletes the old entities,
+    reconnects the new instances (previously attached to the status via "hasNewDerivedIRI") with the original derivation,
+    cleans up all the status, and finally updates the timestamp of the derivation.
+    All these processing steps at the `Finished` status are taken care of by method
+    `uk.ac.cam.cares.jps.base.derivation.DerivationClient.cleanUpFinishedDerivationUpdate(String)`.
+    """
+
+    # Below codes follow the logic as defined in DerivationAgent.java in JPS_BASE_LIB
+    # for more information, please visit https://github.com/cambridge-cares/TheWorldAvatar/blob/main/JPS_BASE_LIB/src/main/java/uk/ac/cam/cares/jps/base/agent/DerivationAgent.java
+
+    # Initialise two conditions for the while loop
+    # 1. break_out_time is the timestamp when the next round of monitoring should be started
+    break_out_time = time.time() + self.time_interval
+    # 2. query_again is the flag to indicate whether the derivation status should be updated in memory
+    query_again = False
+
+    # There is no do-while loop in Python, so we use a while loop with a break statement
+    # "while True" makes sure the loop is executed at least once
+    while True:
+        # Retrieves a list of derivations and their status type that "isDerivedUsing" DerivationAgent
+        derivationAndStatusType = self.derivation_client.derivation_client.getDerivationsAndStatusType(
+            self.agentIRI)
+        if bool(derivationAndStatusType):
+            self.logger.info("A list of asynchronous derivations that <isDerivedUsing> <%s> are retrieved: %s." % (
+                self.agentIRI, {d: str(derivationAndStatusType[d]) for d in derivationAndStatusType}))
+
+            # Iterate over the list of derivation, and do different things depend on the derivation status
+            for derivation in derivationAndStatusType:
+                statusType = str(derivationAndStatusType[derivation])
+
+                try:
+                    # If "Requested", check the immediate upstream derivations if they are up-to-date
+                    # if any of the asynchronous derivations are still outdated, skip, otherwise, request update of all synchronous derivations
+                    # then retrieve inputs, marks as "InProgress", start job, update status at job completion
+                    if statusType == 'REQUESTED':
+                        immediateUpstreamDerivationToUpdate = self.derivation_client.derivation_client.checkImmediateUpstreamDerivation(derivation)
+                        if self.jpsBaseLib_view.DerivationSparql.ONTODERIVATION_DERIVATIONASYN in immediateUpstreamDerivationToUpdate:
+                            self.logger.info("Asynchronous derivation <" + derivation
+                                            + "> has a list of immediate upstream asynchronous derivations to be updated: "
+                                            + str(immediateUpstreamDerivationToUpdate))
+                            # set flag to false to skips this "Requested" derivation until next time
+                            # this is to avoid the agent flooding the KG with queries of the status over a short period of time
+                            query_again = False
+                        else:
+                            syncDerivationsToUpdate = self.derivation_client.derivation_client.groupSyncDerivationsToUpdate(immediateUpstreamDerivationToUpdate)
+                            if bool(syncDerivationsToUpdate):
+                                self.logger.info("Asynchronous derivation <" + derivation
+                                                + "> has a list of immediate upstream synchronous derivations to be updated: "
+                                                + str(syncDerivationsToUpdate))
+                                self.derivation_client.derivation_client.updatePureSyncDerivations(syncDerivationsToUpdate)
+                                self.logger.info("Update of synchronous derivation is done for: " + str(syncDerivationsToUpdate))
+                            if not bool(self.derivation_client.derivation_client.checkImmediateUpstreamDerivation(derivation)):
+                                agentInputs = str(self.derivation_client.derivation_client.retrieveAgentInputIRIs(derivation, self.agentIRI))
+                                # Mark the status as "InProgress"
+                                # if another agent thread is updating the same derivation concurrently
+                                # and successed before this thread, then this method will return false
+                                progressToJob = self.derivation_client.derivation_client.updateStatusBeforeSetupJob(derivation)
+                                # only progress to job if the status is updated successfully
+                                # otherwise, the other thread will handle the job
+                                if not progressToJob:
+                                    self.logger.info(f"Asynchronous derivation <{derivation}> is already in progress by another agent thread.")
+                                else:
+                                    self.logger.info("Agent <%s> retrieved inputs of asynchronous derivation <%s>: %s." % (
+                                        self.agentIRI, derivation, agentInputs))
+                                    self.logger.info("Asynchronous derivation <%s> is in progress." % (derivation))
+                                    # send email to indicate the derivation is handled in this thread and started, i.e. now-in-progress
+                                    self.send_email_when_async_derivation_started(derivation)
+
+                                    # Preprocessing inputs to be sent to agent for setting up job, this is now in dict datatype
+                                    agent_input_json = json.loads(agentInputs) if not isinstance(agentInputs, dict) else agentInputs
+                                    agent_input_key = str(self.jpsBaseLib_view.DerivationClient.AGENT_INPUT_KEY)
+                                    if agent_input_key in agent_input_json:
+                                        inputs_to_send = agent_input_json[agent_input_key]
+                                    else:
+                                        self.logger.error("Agent input key (%s) might be missing. Received input: %s." % (
+                                            agent_input_key, agent_input_json.__dict__))
+                                    # The inputs_to_send should be a key-values pair format,
+                                    # for example: {'OntoXX:Concept_A': ['Instance_A'], 'OntoXX:Concept_B': ['Instance_B']}
+                                    derivationInputs = self.jpsBaseLib_view.DerivationInputs(inputs_to_send, derivation)
+                                    derivation_inputs = DerivationInputs(derivationInputs)
+                                    derivationOutputs = self.jpsBaseLib_view.DerivationOutputs()
+                                    derivation_outputs = DerivationOutputs(derivationOutputs)
+                                    self.process_request_parameters(derivation_inputs, derivation_outputs)
+
+                                    newDerivedIRI = derivationOutputs.getNewDerivedIRI()
+                                    newTriples = derivationOutputs.getOutputTriples()
+                                    self.derivation_client.derivation_client.updateStatusAtJobCompletion(derivation, newDerivedIRI, newTriples)
+                                    self.logger.info("Asynchronous derivation <%s> generated new derived IRI: <%s>." % (
+                                        derivation, ">, <".join(newDerivedIRI)))
+                                    self.logger.info("Asynchronous derivation <" + derivation +
+                                                    "> has all new generated triples: " + str([t.getQueryString() for t in newTriples]))
+                                    self.logger.info("Asynchronous derivation <" + derivation + "> is now finished, to be cleaned up.")
+
+                            # set flag to true as either (1) the agent has been process this derivation for some time
+                            # and status of other derivations in KG might have changed by other processes during this time
+                            # or (2) the derivation is processed by another agent therefore needs a record update
+                            query_again = True
+
+                    # If "InProgress", pass
+                    elif statusType == 'INPROGRESS':
+                        # the query_again flag is set as false to let agent carry on to next derivation in the list
+                        query_again = False
+
+                    # If "Finished", do all the clean-up steps
+                    elif statusType == 'FINISHED':
+                        self.derivation_client.derivation_client.cleanUpFinishedDerivationUpdate(derivation)
+                        # set flag to true as the cleaning up process can take some time when there are a lot of triples
+                        query_again = True
+                        # send email to indicate the derivation is now finished and cleaned up, i.e. up-to-date
+                        self.send_email_when_async_derivation_up_to_date(derivation)
+
+                    elif statusType == 'ERROR':
+                        # for now just passes
+                        query_again = False
+
+                    elif statusType == 'NOSTATUS':
+                        # no need to query_again as the derivation is considered as up-to-date
+                        query_again = False
+
+                    # If anything else, pass
+                    else:
+                        self.logger.info("Asynchronous derivation <%s> has unhandled status type: %s." % (
+                            derivation, statusType))
+                        query_again = False
+
+                except Exception as exc:
+                    trace_back = traceback.format_exc()
+                    jps_exc = PythonException(trace_back)
+                    self.derivation_client.derivation_client.markAsError(derivation, jps_exc.exception)
+                    query_again = True
+                    self.logger.error(f"Error when handling derivation <{derivation}>", stack_info=True, exc_info=True)
+                    # Raise exception so that this will be sent via email notification
+                    raise exc
+
+                # Break out the for loop and query again the list of derivations and their status
+                if query_again:
+                    break
+
+        else:
+            self.logger.info("Currently, no asynchronous derivation <isDerivedUsing> <%s>." % (self.agentIRI))
+
+        # Check if the two flags are still met, if not, break out the while loop
+        # i.e. process until the time is up and if have not gone through all derivations
+        if time.time() > break_out_time or not query_again:
+            break
+
+
+
+ +
+ +
+ + +

+ process_request_parameters + + + + abstractmethod + + +

+
process_request_parameters(derivation_inputs: DerivationInputs, derivation_outputs: DerivationOutputs)
+
+ +
+ +

This method perform the agent logic of converting derivation inputs to derivation outputs. +Developer shall override this when writing new derivation agent based on DerivationAgent class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivation_inputs + + DerivationInputs + +
+

instance of derivation inputs, essentially in the format of: +{ + "https://example.com/kg/Concept_1": ["https://example.com/kg/Concept_1/Instance_1"], + "https://example.com/kg/Concept_2": ["https://example.com/kg/Concept_2/Instance_2"], + "https://example.com/kg/Concept_3": + ["https://example.com/kg/Concept_3/Instance_3_1", + "https://example.com/kg/Concept_3/Instance_3_2"], + "https://example.com/kg/Concept_4": ["https://example.com/kg/Concept_4/Instance_4"] +}

+
+ 		+ required +
+ derivation_outputs + + DerivationOutputs + +
+

instance of derivation outputs, developer should add new created entiteis and triples to this variable

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
508
+509
+510
+511
+512
+513
+514
+515
+516
+517
+518
+519
+520
+521
+522
+523
+524
+525
+526
@abstractmethod
+def process_request_parameters(self, derivation_inputs: DerivationInputs, derivation_outputs: DerivationOutputs):
+    """
+    This method perform the agent logic of converting derivation inputs to derivation outputs.
+    Developer shall override this when writing new derivation agent based on DerivationAgent class.
+
+    Args:
+        derivation_inputs (DerivationInputs): instance of derivation inputs, essentially in the format of:
+            {
+                "https://example.com/kg/Concept_1": ["https://example.com/kg/Concept_1/Instance_1"],
+                "https://example.com/kg/Concept_2": ["https://example.com/kg/Concept_2/Instance_2"],
+                "https://example.com/kg/Concept_3":
+                ["https://example.com/kg/Concept_3/Instance_3_1",
+                    "https://example.com/kg/Concept_3/Instance_3_2"],
+                "https://example.com/kg/Concept_4": ["https://example.com/kg/Concept_4/Instance_4"]
+            }
+        derivation_outputs (DerivationOutputs): instance of derivation outputs, developer should add new created entiteis and triples to this variable
+    """
+    pass
+
+
+
+ +
+ +
+ + +

+ start_all_periodical_job + + +

+
start_all_periodical_job()
+
+ +
+ +

This method starts all scheduled periodical jobs.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
541
+542
+543
+544
+545
def start_all_periodical_job(self):
+    """This method starts all scheduled periodical jobs."""
+    all_periodical_jobs = [getattr(self, name) for name in dir(self) if callable(getattr(self, name)) and not name.startswith('__') and hasattr(getattr(self, name), '__is_periodical_job__')]
+    for func in all_periodical_jobs:
+        func()
+
+
+
+ +
+ +
+ + +

+ handle_sync_derivations + + +

+
handle_sync_derivations()
+
+ +
+ +

This method handles synchronous derivation by using the Flask app object of the DerivationAgent to process the HTTP request, +and then pass it to process_request_parameters function provided by the developers.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
547
+548
+549
+550
+551
+552
+553
+554
+555
+556
+557
+558
+559
+560
+561
+562
+563
+564
+565
+566
+567
+568
+569
+570
+571
+572
+573
+574
+575
+576
+577
+578
+579
+580
+581
+582
+583
+584
+585
+586
+587
+588
+589
+590
+591
+592
+593
+594
+595
+596
+597
+598
+599
+600
+601
+602
+603
+604
+605
+606
+607
+608
+609
+610
+611
+612
+613
+614
+615
+616
+617
+618
+619
+620
+621
+622
+623
+624
+625
+626
+627
+628
+629
+630
+631
+632
+633
+634
@send_email_when_exception(func_return_value=True)
+def handle_sync_derivations(self):
+    """
+    This method handles synchronous derivation by using the Flask app object of the DerivationAgent to process the HTTP request,
+    and then pass it to `process_request_parameters` function provided by the developers.
+    """
+    self.logger.info("Received synchronous derivation request: %s." % (request.url))
+    requestParams = request.json
+    res = {}
+    if self.validate_inputs(requestParams):
+        # retrieve necessary information
+        derivationIRI = requestParams[self.jpsBaseLib_view.DerivationClient.DERIVATION_KEY]
+        derivationType = requestParams[self.jpsBaseLib_view.DerivationClient.DERIVATION_TYPE_KEY]
+        syncNewInfoFlag = requestParams[self.jpsBaseLib_view.DerivationClient.SYNC_NEW_INFO_FLAG]
+
+        # serialises DerivationInputs objects from JSONObject
+        inputs = self.jpsBaseLib_view.DerivationInputs(requestParams[self.jpsBaseLib_view.DerivationClient.AGENT_INPUT_KEY], derivationIRI)
+        self.logger.info("Received derivation request parameters: " + str(requestParams))
+
+        # initialise DerivationOutputs, also set up information
+        outputs = self.jpsBaseLib_view.DerivationOutputs()
+        outputs.setThisDerivation(derivationIRI)
+        outputs.setRetrievedInputsAt(int(time.time()))
+        if not syncNewInfoFlag:
+            outputs.setOldEntitiesMap(requestParams[self.jpsBaseLib_view.DerivationClient.BELONGSTO_KEY])
+            outputs.setOldEntitiesDownstreamDerivationMap(requestParams[self.jpsBaseLib_view.DerivationClient.DOWNSTREAMDERIVATION_KEY])
+
+        # apply agent logic to convert inputs to outputs
+        derivation_inputs = DerivationInputs(inputs)
+        derivation_outputs = DerivationOutputs(outputs)
+        self.process_request_parameters(derivation_inputs, derivation_outputs)
+
+        # return response if this sync derivation is generated for new info
+        if syncNewInfoFlag:
+            agentServiceIRI = requestParams[self.jpsBaseLib_view.DerivationClient.AGENT_IRI_KEY]
+            self.derivation_client.derivation_client.writeSyncDerivationNewInfo(
+                outputs.getOutputTriples(), outputs.getNewDerivedIRI(),
+                agentServiceIRI, inputs.getAllIris(),
+                derivationIRI, derivationType, outputs.getRetrievedInputsAt()
+            )
+            res[self.jpsBaseLib_view.DerivationOutputs.RETRIEVED_INPUTS_TIMESTAMP_KEY] = outputs.getRetrievedInputsAt()
+            res[self.jpsBaseLib_view.DerivationClient.AGENT_OUTPUT_KEY] = json.loads(str(outputs.getNewEntitiesJsonMap()))
+            self.logger.info("Synchronous derivation for new information generated successfully, returned response: " + str(res))
+            return json.dumps(res)
+
+        # only enters below if the computation was not for new information (new instances)
+        derivation = self.jpsBaseLib_view.Derivation(derivationIRI, derivationType)
+        if not derivation.isDerivationAsyn() and not derivation.isDerivationWithTimeSeries():
+            # Perform the mapping between the new outputs and the downstream derivations
+            connectionMap = self.derivation_client.derivation_client.mapSyncNewOutputsToDownstream(
+                outputs.getThisDerivation(), outputs.getNewOutputsAndRdfTypeMap())
+            # construct and fire SPARQL update given DerivationOutputs objects, if normal
+            # derivation NOTE this makes sure that the new generated instances/triples will
+            # ONLY be written to knowledge graph if the target derivation is till outdated
+            # at the point of executing SPARQL update, i.e. this solves concurrent request
+            # issue as detailed in
+            # https://github.com/cambridge-cares/TheWorldAvatar/issues/184
+            triplesChangedForSure = self.derivation_client.derivation_client.reconnectSyncDerivation(
+                outputs.getThisDerivation(), connectionMap,
+                outputs.getOutputTriples(), outputs.getRetrievedInputsAt()
+            )
+
+            # for normal Derivation, we need to return both timestamp and the new derived
+            if triplesChangedForSure:
+                # if we know the triples are changed for sure, we return the triples
+                # computed by this agent
+                res[self.jpsBaseLib_view.DerivationOutputs.RETRIEVED_INPUTS_TIMESTAMP_KEY] = outputs.getRetrievedInputsAt()
+                res[self.jpsBaseLib_view.DerivationClient.AGENT_OUTPUT_KEY] = json.loads(str(outputs.getNewEntitiesJsonMap()))
+                res[self.jpsBaseLib_view.DerivationClient.AGENT_OUTPUT_CONNECTION_KEY] = json.loads(str(self.jpsBaseLib_view.org.json.JSONObject(connectionMap)))
+                self.logger.info("Derivation update is done in the knowledge graph, returned response: " + str(res))
+            else:
+                # if we are not certain, query the knowledge graph to get the accurate
+                # information
+                updated = self.derivation_client.derivation_client.getDerivation(derivationIRI)
+                res[self.jpsBaseLib_view.DerivationOutputs.RETRIEVED_INPUTS_TIMESTAMP_KEY] = updated.getTimestamp()
+                res[self.jpsBaseLib_view.DerivationClient.AGENT_OUTPUT_KEY] = json.loads(str(updated.getBelongsToMap()))
+                res[self.jpsBaseLib_view.DerivationClient.AGENT_OUTPUT_CONNECTION_KEY] = json.loads(str(updated.getDownstreamDerivationConnectionMap()))
+                self.logger.info("Unable to determine if the SPARQL update mutated triples, returned latest information in knowledge graph: "
+                                 + str(res))
+        else:
+            # for DerivationWithTimeSeries, we just need to return retrievedInputsAt
+            res[self.jpsBaseLib_view.DerivationOutputs.RETRIEVED_INPUTS_TIMESTAMP_KEY] = outputs.getRetrievedInputsAt()
+            self.logger.info(
+                "DerivationWithTimeSeries update is done, returned response: " + str(res))
+    else:
+        res[self.jpsBaseLib_view.DerivationClient.AGENT_OUTPUT_KEY] = self.jpsBaseLib_view.DerivationAgent.EMPTY_REQUEST_MSG
+
+    return json.dumps(res)
+
+
+
+ +
+ +
+ + +

+ validate_inputs + + + + abstractmethod + + +

+
validate_inputs(http_request) -> bool
+
+ +
+ +

Validates the HTTP request sent to the agent for processing synchronous derivations. +Developer can overwrite this function for customised validation.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ http_request + + +
+

The HTTP request received

+
+ 		+ required +
+ + +

Raises:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
+ Exception + +
+

HTTP request is empty

+
+
+ Exception + +
+

IRI for derivation is not provided in the HTTP request

+
+
+ Exception + +
+

IRI for agent is not provided in the HTTP request

+
+
+ Exception + +
+

IRI for old derivation outputs are not provided in the HTTP request

+
+
+ Exception + +
+

IRI for downstream derivations are not provided in the HTTP request

+
+
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
bool + bool + +
+

Whether the HTTP request is valid

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
636
+637
+638
+639
+640
+641
+642
+643
+644
+645
+646
+647
+648
+649
+650
+651
+652
+653
+654
+655
+656
+657
+658
+659
+660
+661
+662
+663
+664
+665
+666
+667
+668
+669
+670
+671
+672
+673
+674
+675
+676
+677
+678
+679
+680
+681
+682
+683
@abstractmethod
+def validate_inputs(self, http_request) -> bool:
+    """
+    Validates the HTTP request sent to the agent for processing synchronous derivations.
+    Developer can overwrite this function for customised validation.
+
+    Args:
+        http_request: The HTTP request received
+
+    Raises:
+        Exception: HTTP request is empty
+        Exception: IRI for derivation is not provided in the HTTP request
+        Exception: IRI for agent is not provided in the HTTP request
+        Exception: IRI for old derivation outputs are not provided in the HTTP request
+        Exception: IRI for downstream derivations are not provided in the HTTP request
+
+    Returns:
+        bool: Whether the HTTP request is valid
+    """
+    self.logger.info("Validating inputs: " + str(http_request))
+    if not bool(http_request):
+        self.logger.warn("RequestParams are empty, throwing BadRequestException...")
+        raise Exception("RequestParams are empty")
+
+    if self.jpsBaseLib_view.DerivationClient.AGENT_INPUT_KEY not in http_request:
+        self.logger.info(f"Agent <{self.agentIRI}> received an empty request...")
+        return False
+    else:
+        if self.jpsBaseLib_view.DerivationClient.DERIVATION_KEY not in http_request:
+            msg = f"Agent <{self.agentIRI}> received a request that doesn't have derivationIRI..."
+            self.logger.error(msg)
+            raise Exception(msg)
+        if http_request[self.jpsBaseLib_view.DerivationClient.SYNC_NEW_INFO_FLAG]:
+            if self.jpsBaseLib_view.DerivationClient.AGENT_IRI_KEY not in http_request:
+                msg = f"Agent <{self.agentIRI}> received a request for sync new information that doesn't have information about agent IRI..."
+                self.logger.error(msg)
+                raise Exception(msg)
+        else:
+            if self.jpsBaseLib_view.DerivationClient.BELONGSTO_KEY not in http_request:
+                msg = f"Agent <{self.agentIRI}> received a request that doesn't have information about old outputs..."
+                self.logger.error(msg)
+                raise Exception(msg)
+            if self.jpsBaseLib_view.DerivationClient.DOWNSTREAMDERIVATION_KEY not in http_request:
+                msg = f"Agent <{self.agentIRI}> received a request that doesn't have information about downstream derivation..."
+                self.logger.error(msg)
+                raise Exception(msg)
+
+    return True
+
+
+
+ +
+ +
+ + +

+ run_flask_app + + +

+
run_flask_app(**kwargs)
+
+ +
+ +

This method runs the flask app as an HTTP servlet.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
685
+686
+687
def run_flask_app(self, **kwargs):
+    """This method runs the flask app as an HTTP servlet."""
+    self.app.run(**kwargs)
+
+
+
+ +
+ + + +
+ +
+ +
+ + +
+ + +

+ format_current_time + + +

+
format_current_time() -> str
+
+ +
+ +

Formats the current local time as a string.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

The current local time in the format "YYYY-MM-DD HH:MM:SS TIMEZONE".

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agent/derivation_agent.py + 
689
+690
+691
+692
+693
+694
+695
+696
def format_current_time() -> str:
+    """
+    Formats the current local time as a string.
+
+    Returns:
+        str: The current local time in the format "YYYY-MM-DD HH:MM:SS TIMEZONE".
+    """
+    return str(time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())) + f" {str(time.localtime().tm_zone)}"
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/derivation_client/index.html b/api/derivation_client/index.html new file mode 100644 index 00000000000..4602dbb0c43 --- /dev/null +++ b/api/derivation_client/index.html @@ -0,0 +1,4853 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Derivation Client - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Derivation Client

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ PyDerivationClient + + +

+
PyDerivationClient(derivation_instance_base_url: str, query_endpoint: str, update_endpoint: str, kg_user: str = None, kg_password: str = None)
+
+ +
+ + +

This is a wrapper class for the java class uk.ac.cam.cares.jps.base.derivation.DerivationClient. +Only the methods that commonly used are wrapped here. For other methods, one may access them via +self.derivation_client.nameOfJavaMethod(args).

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
derivation_client + +
+

The Java DerivationClient object

+
+
jpsBaseLib_view + +
+

The JVM module view for accessing Java classes

+
+
+ + +

Methods:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
createDerivation +
+

Create a normal derivation markup.

+
+
createSyncDerivationForNewInfo +
+

Create a synchronous derivation for new info to be computed by the agent.

+
+
createSyncDerivationForNewInfoWithHttpUrl +
+

Create a synchronous derivation for new info to be computed by the agent with the agent URL provided.

+
+
bulkCreateDerivations +
+

Create multiple normal derivations in one go.

+
+
createDerivationWithTimeSeries +
+

Create a time series derivation markup.

+
+
bulkCreateDerivationsWithTimeSeries +
+

Create multiple time series derivations in one go.

+
+
createAsyncDerivation +
+

Create an asynchronous derivation markup.

+
+
createAsyncDerivationFromDerivation +
+

Create an asynchronous derivation markup from an existing derivation.

+
+
bulkCreateAsyncDerivations +
+

Create multiple asynchronous derivations in one go.

+
+
createAsyncDerivationForNewInfo +
+

Create an asynchronous derivation markup for new information.

+
+
bulkCreateAsyncDerivationsForNewInfo +
+

Create multiple asynchronous derivations for new information in one go.

+
+
validateDerivations +
+

Validate all derivations and their inputs are attached with timestamps, also no circular dependencies.

+
+
createOntoAgentInstance +
+

Register an OntoAgent instance in the triple store.

+
+
addTimeInstance +
+

Add a time instance to each entity in the list of entities.

+
+
addTimeInstanceCurrentTimestamp +
+

Add time instance with current timestamp to the given entities.

+
+
updateTimestamp +
+

Update the timestamp of the entity to the current time.

+
+
updateTimestamps +
+

Update the timestamp of all entities in the list.

+
+
dropTimestampsOf +
+

Drop the timestamp of the given entities.

+
+
getDerivations +
+

Get the derivations of the given agent.

+
+
getDerivationsOf +
+

Get the derivations of the given entities.

+
+
unifiedUpdateDerivation +
+

Unified update derivation method.

+
+
updatePureSyncDerivation +
+

Update a single synchronous derivation.

+
+
updatePureSyncDerivations +
+

Update a list of synchronous derivations.

+
+
updatePureSyncDerivationsInParallel +
+

Update a list of synchronous derivations in parallel.

+
+
updateAllSyncDerivations +
+

Update all synchronous derivations within the knowledge graph.

+
+
updateMixedAsyncDerivation +
+

Update a directed acyclic graph of a-/sync derivations.

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivation_instance_base_url + + str + +
+

base url of the derivation instance to be created by the client

+
+ 		+ required +
+ query_endpoint + + str + +
+

query endpoint of the knowledge graph

+
+ 		+ required +
+ update_endpoint + + str + +
+

update endpoint of the knowledge graph

+
+ 		+ required +
+ kg_user + + str + +
+

username for the knowledge graph endpoint. Defaults to None.

+
+ 		+ None +
+ kg_password + + str + +
+

password for the knowledge graph endpoint. Defaults to None.

+
+ 		+ None +
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
def __init__(
+    self,
+    derivation_instance_base_url: str,
+    query_endpoint: str,
+    update_endpoint: str,
+    kg_user:str=None,
+    kg_password:str=None
+) -> None:
+    """
+    Initialise the derivation client
+
+    Args:
+        derivation_instance_base_url (str): base url of the derivation instance to be created by the client
+        query_endpoint (str): query endpoint of the knowledge graph
+        update_endpoint (str): update endpoint of the knowledge graph
+        kg_user (str, optional): username for the knowledge graph endpoint. Defaults to None.
+        kg_password (str, optional): password for the knowledge graph endpoint. Defaults to None.
+    """
+
+    # create a JVM module view and use it to import the required java classes
+    self.jpsBaseLib_view = jpsBaseLibGW.createModuleView()
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view,"uk.ac.cam.cares.jps.base.query.*")
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view,"uk.ac.cam.cares.jps.base.derivation.*")
+
+    # create store_client
+    if kg_user is None:
+        store_client = self.jpsBaseLib_view.RemoteStoreClient(query_endpoint, update_endpoint)
+    else:
+        store_client = self.jpsBaseLib_view.RemoteStoreClient(
+            query_endpoint, update_endpoint, kg_user, kg_password)
+
+    # create derivation_client
+    self.derivation_client = self.jpsBaseLib_view.DerivationClient(store_client, derivation_instance_base_url)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ createDerivation + + +

+
createDerivation(entities: List[str], agentIRI: str, inputs: List[str]) -> str
+
+ +
+ +

Create a normal derivation markup.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of entities that belongsTo the derivation

+
+ 		+ required +
+ agentIRI + + str + +
+

List of agents that the derivation isDerivedUsing

+
+ 		+ required +
+ inputs + + List[str] + +
+

List of inputs that the derivation isDerivedFrom

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the created derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
def createDerivation(
+    self,
+    entities: List[str],
+    agentIRI: str,
+    inputs: List[str]
+) -> str:
+    """
+    Create a normal derivation markup.
+
+    Args:
+        entities (List[str]): List of entities that belongsTo the derivation
+        agentIRI (str): List of agents that the derivation isDerivedUsing
+        inputs (List[str]): List of inputs that the derivation isDerivedFrom
+
+    Returns:
+        str: IRI of the created derivation
+    """
+    return self.derivation_client.createDerivation(entities, agentIRI, inputs)
+
+
+
+ +
+ +
+ + +

+ createSyncDerivationForNewInfo + + +

+
createSyncDerivationForNewInfo(agentIRI: str, inputsIRI: List[str], derivationType: str) -> Derivation
+
+ +
+ +

Create a sync derivation for new info to be computed by the agent.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ agentIRI + + str + +
+

IRI of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ inputsIRI + + List[str] + +
+

List of inputs that the derivation isDerivedFrom

+
+ 		+ required +
+ derivationType + + str + +
+

IRI of the synchronous derivation type to be created

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Derivation + Derivation + +
+

Object of the created derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
+147
+148
def createSyncDerivationForNewInfo(
+    self,
+    agentIRI: str,
+    inputsIRI: List[str],
+    derivationType: str
+) -> Derivation:
+    """
+    Create a sync derivation for new info to be computed by the agent.
+
+    Args:
+        agentIRI (str): IRI of the agent that the derivation isDerivedUsing
+        inputsIRI (List[str]): List of inputs that the derivation isDerivedFrom
+        derivationType (str): IRI of the synchronous derivation type to be created
+
+    Returns:
+        Derivation: Object of the created derivation
+    """
+    derivation_java = self.derivation_client.createSyncDerivationForNewInfo(agentIRI, inputsIRI, derivationType)
+    return Derivation(derivation_java=derivation_java)
+
+
+
+ +
+ +
+ + +

+ createSyncDerivationForNewInfoWithHttpUrl + + +

+
createSyncDerivationForNewInfoWithHttpUrl(agentIRI: str, agentURL: str, inputsIRI: List[str], derivationType: str) -> Derivation
+
+ +
+ +

Create a sync derivation for new info to be computed by the agent with the agent url provided.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ agentIRI + + str + +
+

IRI of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ agentURL + + str + +
+

HTTP URL of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ inputsIRI + + List[str] + +
+

List of inputs that the derivation isDerivedFrom

+
+ 		+ required +
+ derivationType + + str + +
+

IRI of the synchronous derivation type to be created

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
Derivation + Derivation + +
+

Object of the created derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
def createSyncDerivationForNewInfoWithHttpUrl(
+    self,
+    agentIRI: str,
+    agentURL: str,
+    inputsIRI: List[str],
+    derivationType: str
+) -> Derivation:
+    """
+    Create a sync derivation for new info to be computed by the agent with the agent url provided.
+
+    Args:
+        agentIRI (str): IRI of the agent that the derivation isDerivedUsing
+        agentURL (str): HTTP URL of the agent that the derivation isDerivedUsing
+        inputsIRI (List[str]): List of inputs that the derivation isDerivedFrom
+        derivationType (str): IRI of the synchronous derivation type to be created
+
+    Returns:
+        Derivation: Object of the created derivation
+    """
+    derivation_java = self.derivation_client.createSyncDerivationForNewInfo(agentIRI, agentURL, inputsIRI, derivationType)
+    return Derivation(derivation_java=derivation_java)
+
+
+
+ +
+ +
+ + +

+ bulkCreateDerivations + + +

+
bulkCreateDerivations(entitiesList: List[List[str]], agentIRIList: List[str], inputsList: List[List[str]]) -> List[str]
+
+ +
+ +

Create multiple normal derivations in one go.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entitiesList + + List[List[str]] + +
+

List of list of entities that belongsTo the derivations

+
+ 		+ required +
+ agentIRIList + + List[str] + +
+

List of agents that the derivations isDerivedUsing

+
+ 		+ required +
+ inputsList + + List[List[str]] + +
+

List of list of inputs that the derivations isDerivedFrom

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[str] + +
+

List[str]: List of IRIs of the created derivations

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
def bulkCreateDerivations(
+    self,
+    entitiesList: List[List[str]],
+    agentIRIList: List[str],
+    inputsList: List[List[str]]
+) -> List[str]:
+    """
+    Create multiple normal derivations in one go.
+
+    Args:
+        entitiesList (List[List[str]]): List of list of entities that belongsTo the derivations
+        agentIRIList (List[str]): List of agents that the derivations isDerivedUsing
+        inputsList (List[List[str]]): List of list of inputs that the derivations isDerivedFrom
+
+    Returns:
+        List[str]: List of IRIs of the created derivations
+    """
+    return self.derivation_client.bulkCreateDerivations(entitiesList, agentIRIList, inputsList)
+
+
+
+ +
+ +
+ + +

+ createDerivationWithTimeSeries + + +

+
createDerivationWithTimeSeries(entities: List[str], agentIRI: str, inputs: List[str]) -> str
+
+ +
+ +

Create a time series derivation markup.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of entities that belongsTo the derivation

+
+ 		+ required +
+ agentIRI + + str + +
+

IRI of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ inputs + + List[str] + +
+

List of inputs that the derivation isDerivedFrom

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the created time series derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
def createDerivationWithTimeSeries(
+    self,
+    entities: List[str],
+    agentIRI: str,
+    inputs: List[str]
+) -> str:
+    """
+    Create a time series derivation markup.
+
+    Args:
+        entities (List[str]): List of entities that belongsTo the derivation
+        agentIRI (str): IRI of the agent that the derivation isDerivedUsing
+        inputs (List[str]): List of inputs that the derivation isDerivedFrom
+
+    Returns:
+        str: IRI of the created time series derivation
+    """
+    return self.derivation_client.createDerivationWithTimeSeries(entities, agentIRI, inputs)
+
+
+
+ +
+ +
+ + +

+ bulkCreateDerivationsWithTimeSeries + + +

+
bulkCreateDerivationsWithTimeSeries(entitiesList: List[List[str]], agentIRIList: List[str], inputsList: List[List[str]]) -> List[str]
+
+ +
+ +

Create multiple time series derivations in one go.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entitiesList + + List[List[str]] + +
+

List of list of entities that belongsTo the derivations

+
+ 		+ required +
+ agentIRIList + + List[str] + +
+

List of agents that the derivations isDerivedUsing

+
+ 		+ required +
+ inputsList + + List[List[str]] + +
+

List of list of inputs that the derivations isDerivedFrom

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[str] + +
+

List[str]: List of IRIs of the created time series derivations

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
def bulkCreateDerivationsWithTimeSeries(
+    self,
+    entitiesList: List[List[str]],
+    agentIRIList: List[str],
+    inputsList: List[List[str]]
+) -> List[str]:
+    """
+    Create multiple time series derivations in one go.
+
+    Args:
+        entitiesList (List[List[str]]): List of list of entities that belongsTo the derivations
+        agentIRIList (List[str]): List of agents that the derivations isDerivedUsing
+        inputsList (List[List[str]]): List of list of inputs that the derivations isDerivedFrom
+
+    Returns:
+        List[str]: List of IRIs of the created time series derivations
+    """
+    return self.derivation_client.bulkCreateDerivationsWithTimeSeries(entitiesList, agentIRIList, inputsList)
+
+
+
+ +
+ +
+ + +

+ createAsyncDerivation + + +

+
createAsyncDerivation(entities: List[str], agentIRI: str, inputs: List[str], forUpdate: bool) -> str
+
+ +
+ +

Create an asynchronous derivation markup. If forUpdate is True, the derivation will be marked as "Requested" +with a timestamp of 0. Otherwise, the derivation will be marked without status but with a current timestamp.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of entities that belongsTo the derivation

+
+ 		+ required +
+ agentIRI + + str + +
+

IRI of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ inputs + + List[str] + +
+

List of inputs that the derivation isDerivedFrom

+
+ 		+ required +
+ forUpdate + + bool + +
+

Boolean flag to indicate if the derivation markup is for update

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the created asynchronous derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
def createAsyncDerivation(
+    self,
+    entities: List[str],
+    agentIRI: str,
+    inputs: List[str],
+    forUpdate: bool
+) -> str:
+    """
+    Create an asynchronous derivation markup. If `forUpdate` is True, the derivation will be marked as "Requested"
+    with a timestamp of 0. Otherwise, the derivation will be marked without status but with a current timestamp.
+
+    Args:
+        entities (List[str]): List of entities that belongsTo the derivation
+        agentIRI (str): IRI of the agent that the derivation isDerivedUsing
+        inputs (List[str]): List of inputs that the derivation isDerivedFrom
+        forUpdate (bool): Boolean flag to indicate if the derivation markup is for update
+
+    Returns:
+        str: IRI of the created asynchronous derivation
+    """
+    return self.derivation_client.createAsyncDerivation(entities, agentIRI, inputs, forUpdate)
+
+
+
+ +
+ +
+ + +

+ createAsyncDerivationFromDerivation + + +

+
createAsyncDerivationFromDerivation(entities: List[str], agentIRI: str, derivation: str, forUpdate: bool) -> str
+
+ +
+ +

Create an asynchronous derivation markup from an existing derivation. If forUpdate is True, the derivation +will be marked as "Requested" with a timestamp of 0. Otherwise, the derivation will be marked without status but +with a current timestamp.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of entities that belongsTo the derivation

+
+ 		+ required +
+ agentIRI + + str + +
+

IRI of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ derivation + + str + +
+

IRI of an existing derivation whose outputs the new derivation isDerivedFrom

+
+ 		+ required +
+ forUpdate + + bool + +
+

Boolean flag to indicate if the derivation markup is for update

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the created asynchronous derivation

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
def createAsyncDerivationFromDerivation(
+    self,
+    entities: List[str],
+    agentIRI: str,
+    derivation: str,
+    forUpdate: bool
+) -> str:
+    """
+    Create an asynchronous derivation markup from an existing derivation. If `forUpdate` is True, the derivation
+    will be marked as "Requested" with a timestamp of 0. Otherwise, the derivation will be marked without status but
+    with a current timestamp.
+
+    Args:
+        entities (List[str]): List of entities that belongsTo the derivation
+        agentIRI (str): IRI of the agent that the derivation isDerivedUsing
+        derivation (str): IRI of an existing derivation whose outputs the new derivation isDerivedFrom
+        forUpdate (bool): Boolean flag to indicate if the derivation markup is for update
+
+    Returns:
+        str: IRI of the created asynchronous derivation
+    """
+    return self.derivation_client.createAsyncDerivation(entities, agentIRI, derivation, forUpdate)
+
+
+
+ +
+ +
+ + +

+ bulkCreateAsyncDerivations + + +

+
bulkCreateAsyncDerivations(entitiesList: List[List[str]], agentIRIList: List[str], inputsList: List[List[str]], forUpdateFlagList: List[bool]) -> List[str]
+
+ +
+ +

Create multiple asynchronous derivations in one go. If the flag in forUpdateFlagList is True, the corresponding +derivation will be marked as "Requested" with a timestamp of 0. Otherwise, the derivation will be marked without +status but with a current timestamp.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entitiesList + + List[List[str]] + +
+

List of list of entities that belongsTo the derivations

+
+ 		+ required +
+ agentIRIList + + List[str] + +
+

List of agents that the derivations isDerivedUsing

+
+ 		+ required +
+ inputsList + + List[List[str]] + +
+

List of list of inputs that the derivations isDerivedFrom

+
+ 		+ required +
+ forUpdateFlagList + + List[bool] + +
+

List of boolean flags to indicate if the derivation markup is for update

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[str] + +
+

List[str]: List of IRIs of the created asynchronous derivations

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
def bulkCreateAsyncDerivations(
+    self,
+    entitiesList: List[List[str]],
+    agentIRIList: List[str],
+    inputsList: List[List[str]],
+    forUpdateFlagList: List[bool]
+) -> List[str]:
+    """
+    Create multiple asynchronous derivations in one go. If the flag in `forUpdateFlagList` is True, the corresponding
+    derivation will be marked as "Requested" with a timestamp of 0. Otherwise, the derivation will be marked without
+    status but with a current timestamp.
+
+    Args:
+        entitiesList (List[List[str]]): List of list of entities that belongsTo the derivations
+        agentIRIList (List[str]): List of agents that the derivations isDerivedUsing
+        inputsList (List[List[str]]): List of list of inputs that the derivations isDerivedFrom
+        forUpdateFlagList (List[bool]): List of boolean flags to indicate if the derivation markup is for update
+
+    Returns:
+        List[str]: List of IRIs of the created asynchronous derivations
+    """
+    return self.derivation_client.bulkCreateAsyncDerivations(entitiesList, agentIRIList, inputsList, forUpdateFlagList)
+
+
+
+ +
+ +
+ + +

+ createAsyncDerivationForNewInfo + + +

+
createAsyncDerivationForNewInfo(agentIRI: str, inputsAndDerivations: List[str]) -> str
+
+ +
+ +

Create an asynchronous derivation markup for new information. The derivation will be marked as "Requested" with +a timestamp of 0. The outputs of the derivation will be computed by the agent in due course. Note that all IRIs in +the inputsAndDerivations list will be directly connected to the derivation as its inputs. Therefore, existing IRIs +of the derivation outputs should be provided if applicable, instead of the IRI of that derivation.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ agentIRI + + str + +
+

IRI of the agent that the derivation isDerivedUsing

+
+ 		+ required +
+ inputsAndDerivations + + List[str] + +
+

List of inputs and derivations that the derivation isDerivedFrom

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

IRI of the created asynchronous derivation for new information

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
def createAsyncDerivationForNewInfo(
+    self,
+    agentIRI: str,
+    inputsAndDerivations: List[str]
+) -> str:
+    """
+    Create an asynchronous derivation markup for new information. The derivation will be marked as "Requested" with
+    a timestamp of 0. The outputs of the derivation will be computed by the agent in due course. Note that all IRIs in
+    the `inputsAndDerivations` list will be directly connected to the derivation as its inputs. Therefore, existing IRIs
+    of the derivation outputs should be provided if applicable, instead of the IRI of that derivation.
+
+    Args:
+        agentIRI (str): IRI of the agent that the derivation isDerivedUsing
+        inputsAndDerivations (List[str]): List of inputs and derivations that the derivation isDerivedFrom
+
+    Returns:
+        str: IRI of the created asynchronous derivation for new information
+    """
+    return self.derivation_client.createAsyncDerivationForNewInfo(agentIRI, inputsAndDerivations)
+
+
+
+ +
+ +
+ + +

+ bulkCreateAsyncDerivationsForNewInfo + + +

+
bulkCreateAsyncDerivationsForNewInfo(agentIRIList: List[str], inputsAndDerivationsList: List[List[str]]) -> List[str]
+
+ +
+ +

Create multiple asynchronous derivations for new information in one go. The derivations will be marked as +"Requested" with a timestamp of 0. The outputs of the derivations will be computed by the agents in due course. +Note that all IRIs in the inputsAndDerivationsList list will be directly connected to the derivations as their +inputs. Therefore, existing IRIs of the derivation outputs should be provided if applicable, instead of the IRI +of that derivation.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ agentIRIList + + List[str] + +
+

List of agents that the derivations isDerivedUsing

+
+ 		+ required +
+ inputsAndDerivationsList + + List[List[str]] + +
+

List of list of inputs and derivations that the derivations isDerivedFrom

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[str] + +
+

List[str]: List of IRIs of the created asynchronous derivations for new information

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
def bulkCreateAsyncDerivationsForNewInfo(
+    self,
+    agentIRIList: List[str],
+    inputsAndDerivationsList: List[List[str]]
+) -> List[str]:
+    """
+    Create multiple asynchronous derivations for new information in one go. The derivations will be marked as
+    "Requested" with a timestamp of 0. The outputs of the derivations will be computed by the agents in due course.
+    Note that all IRIs in the `inputsAndDerivationsList` list will be directly connected to the derivations as their
+    inputs. Therefore, existing IRIs of the derivation outputs should be provided if applicable, instead of the IRI
+    of that derivation.
+
+    Args:
+        agentIRIList (List[str]): List of agents that the derivations isDerivedUsing
+        inputsAndDerivationsList (List[List[str]]): List of list of inputs and derivations that the derivations isDerivedFrom
+
+    Returns:
+        List[str]: List of IRIs of the created asynchronous derivations for new information
+    """
+    return self.derivation_client.bulkCreateAsyncDerivationsForNewInfo(agentIRIList, inputsAndDerivationsList)
+
+
+
+ +
+ +
+ + +

+ validateDerivations + + +

+
validateDerivations() -> bool
+
+ +
+ +

This checks for any circular dependency and ensures that all the linked inputs have a suitable timestamp attached. +NOTE however, this method does not check for everything, e.g. instances having appropriate rdf:types, and the agent design.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
bool + bool + +
+

Whether the created derivations are valid, i.e. no circular dependency, timestamps correctly attached

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
351
+352
+353
+354
+355
+356
+357
+358
+359
def validateDerivations(self) -> bool:
+    """
+    This checks for any circular dependency and ensures that all the linked inputs have a suitable timestamp attached.
+    NOTE however, this method does not check for everything, e.g. instances having appropriate rdf:types, and the agent design.
+
+    Returns:
+        bool: Whether the created derivations are valid, i.e. no circular dependency, timestamps correctly attached
+    """
+    return self.derivation_client.validateDerivations()
+
+
+
+ +
+ +
+ + +

+ createOntoAgentInstance + + +

+
createOntoAgentInstance(ontoAgentServiceIRI: str, ontoAgentOperationHttpUrl: str, inputTypes: List[str], outputTypes: List[str])
+
+ +
+ +

Register an OntoAgent instance in the triple store.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ ontoAgentServiceIRI + + str + +
+

IRI of the agent's OntoAgent:Service

+
+ 		+ required +
+ ontoAgentOperationHttpUrl + + str + +
+

IRI of the agent's operation HTTP URL

+
+ 		+ required +
+ inputTypes + + List[str] + +
+

List of IRI of the agent's input types

+
+ 		+ required +
+ outputTypes + + List[str] + +
+

List of IRI of the agent's output types

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
365
+366
+367
+368
+369
+370
+371
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
def createOntoAgentInstance(
+    self,
+    ontoAgentServiceIRI: str,
+    ontoAgentOperationHttpUrl: str,
+    inputTypes: List[str],
+    outputTypes: List[str]
+):
+    """
+    Register an OntoAgent instance in the triple store.
+
+    Args:
+        ontoAgentServiceIRI (str): IRI of the agent's OntoAgent:Service
+        ontoAgentOperationHttpUrl (str): IRI of the agent's operation HTTP URL
+        inputTypes (List[str]): List of IRI of the agent's input types
+        outputTypes (List[str]): List of IRI of the agent's output types
+    """
+    self.derivation_client.createOntoAgentInstance(
+        ontoAgentServiceIRI, ontoAgentOperationHttpUrl, inputTypes, outputTypes)
+
+
+
+ +
+ +
+ + +

+ addTimeInstance + + +

+
addTimeInstance(entities: List[str])
+
+ +
+ +

Add a time instance to each entity in the list of entities.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of IRIs of entities to add time instance to

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
388
+389
+390
+391
+392
+393
+394
+395
def addTimeInstance(self, entities: List[str]):
+    """
+    Add a time instance to each entity in the list of entities.
+
+    Args:
+        entities (List[str]): List of IRIs of entities to add time instance to
+    """
+    self.derivation_client.addTimeInstance(entities)
+
+
+
+ +
+ +
+ + +

+ addTimeInstanceCurrentTimestamp + + +

+
addTimeInstanceCurrentTimestamp(entities: List[str])
+
+ +
+ +

Add time instance with current timestamp to the given entities

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of IRIs of entities to add time instance to

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
398
+399
+400
+401
+402
+403
+404
+405
def addTimeInstanceCurrentTimestamp(self, entities: List[str]):
+    """
+    Add time instance with current timestamp to the given entities
+
+    Args:
+        entities (List[str]): List of IRIs of entities to add time instance to
+    """
+    self.derivation_client.addTimeInstanceCurrentTimestamp(entities)
+
+
+
+ +
+ +
+ + +

+ updateTimestamp + + +

+
updateTimestamp(entity: str)
+
+ +
+ +

Update the timestamp of the entity to the current time.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entity + + str + +
+

IRI of the entity to update the timestamp of

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
408
+409
+410
+411
+412
+413
+414
+415
def updateTimestamp(self, entity: str):
+    """
+    Update the timestamp of the entity to the current time.
+
+    Args:
+        entity (str): IRI of the entity to update the timestamp of
+    """
+    self.derivation_client.updateTimestamp(entity)
+
+
+
+ +
+ +
+ + +

+ updateTimestamps + + +

+
updateTimestamps(entities: List[str])
+
+ +
+ +

Update the timestamp of all entities in the list.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of IRIs of entities to update the timestamp for

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
418
+419
+420
+421
+422
+423
+424
+425
def updateTimestamps(self, entities: List[str]):
+    """
+    Update the timestamp of all entities in the list.
+
+    Args:
+        entities (List[str]): List of IRIs of entities to update the timestamp for
+    """
+    self.derivation_client.updateTimestamps(entities)
+
+
+
+ +
+ +
+ + +

+ dropTimestampsOf + + +

+
dropTimestampsOf(entities: List[str])
+
+ +
+ +

Drop the timestamp of the given entities.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of IRIs of entities to drop the timestamp of

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
428
+429
+430
+431
+432
+433
+434
+435
def dropTimestampsOf(self, entities: List[str]):
+    """
+    Drop the timestamp of the given entities.
+
+    Args:
+        entities (List[str]): List of IRIs of entities to drop the timestamp of
+    """
+    self.derivation_client.dropTimestampsOf(entities)
+
+
+
+ +
+ +
+ + +

+ getDerivations + + +

+
getDerivations(agentIRI: str) -> List[str]
+
+ +
+ +

Get the derivations of the given agent.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ agentIRI + + str + +
+

IRI of the agent

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
list + List[str] + +
+

List of IRIs of the derivations that isDerivedUsing the given agent

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
441
+442
+443
+444
+445
+446
+447
+448
+449
+450
+451
def getDerivations(self, agentIRI: str) -> List[str]:
+    """
+    Get the derivations of the given agent.
+
+    Args:
+        agentIRI (str): IRI of the agent
+
+    Returns:
+        list: List of IRIs of the derivations that isDerivedUsing the given agent
+    """
+    return list(self.derivation_client.getDerivations(agentIRI))
+
+
+
+ +
+ +
+ + +

+ getDerivationsOf + + +

+
getDerivationsOf(entities: List[str]) -> Dict[str, str]
+
+ +
+ +

Get the derivations of the given entities.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ entities + + List[str] + +
+

List of entities

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, str] + +
+

Dict[str, str]: The dictionary with the entity IRIs as keys and the derivation IRIs as values

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
454
+455
+456
+457
+458
+459
+460
+461
+462
+463
+464
def getDerivationsOf(self, entities: List[str]) -> Dict[str, str]:
+    """
+    Get the derivations of the given entities.
+
+    Args:
+        entities (List[str]): List of entities
+
+    Returns:
+        Dict[str, str]: The dictionary with the entity IRIs as keys and the derivation IRIs as values
+    """
+    return self.derivation_client.getDerivationsOf(entities)
+
+
+
+ +
+ +
+ + +

+ unifiedUpdateDerivation + + +

+
unifiedUpdateDerivation(derivationIRI: str)
+
+ +
+ +

Unified update derivation method. +This methods updates the specified derivation and all its upstream derivations.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationIRI + + str + +
+

IRI of the derivation to be updated

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
467
+468
+469
+470
+471
+472
+473
+474
+475
def unifiedUpdateDerivation(self, derivationIRI: str):
+    """
+    Unified update derivation method.
+    This methods updates the specified derivation and all its upstream derivations.
+
+    Args:
+        derivationIRI (str): IRI of the derivation to be updated
+    """
+    self.derivation_client.unifiedUpdateDerivation(derivationIRI)
+
+
+
+ +
+ +
+ + +

+ updatePureSyncDerivation + + +

+
updatePureSyncDerivation(derivationIRI: str)
+
+ +
+ +

Update the specified synchronous derivation and all its upstream derivations.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationIRI + + str + +
+

IRI of the derivation to be updated

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
477
+478
+479
+480
+481
+482
+483
+484
def updatePureSyncDerivation(self, derivationIRI: str):
+    """
+    Update the specified *synchronous* derivation and all its upstream derivations.
+
+    Args:
+        derivationIRI (str): IRI of the derivation to be updated
+    """
+    self.derivation_client.updatePureSyncDerivation(derivationIRI)
+
+
+
+ +
+ +
+ + +

+ updatePureSyncDerivations + + +

+
updatePureSyncDerivations(derivationIRIs: List[str])
+
+ +
+ +

Update the specified list of synchronous derivations and all their upstream derivations.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationIRIs + + List[str] + +
+

List of IRIs of the derivations to be updated

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
486
+487
+488
+489
+490
+491
+492
+493
def updatePureSyncDerivations(self, derivationIRIs: List[str]):
+    """
+    Update the specified list of *synchronous* derivations and all their upstream derivations.
+
+    Args:
+        derivationIRIs (List[str]): List of IRIs of the derivations to be updated
+    """
+    self.derivation_client.updatePureSyncDerivations(derivationIRIs)
+
+
+
+ +
+ +
+ + +

+ updatePureSyncDerivationsInParallel + + +

+
updatePureSyncDerivationsInParallel(derivationIRIs: List[str])
+
+ +
+ +

Update the specified list of synchronous derivations and all their upstream derivations in parallel.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationIRIs + + List[str] + +
+

List of IRIs of the derivations to be updated

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
495
+496
+497
+498
+499
+500
+501
+502
def updatePureSyncDerivationsInParallel(self, derivationIRIs: List[str]):
+    """
+    Update the specified list of *synchronous* derivations and all their upstream derivations in parallel.
+
+    Args:
+        derivationIRIs (List[str]): List of IRIs of the derivations to be updated
+    """
+    self.derivation_client.updatePureSyncDerivationsInParallel(derivationIRIs)
+
+
+
+ +
+ +
+ + +

+ updateAllSyncDerivations + + +

+
updateAllSyncDerivations()
+
+ +
+ +

Update all synchronous derivations in the knowledge graph.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
504
+505
+506
+507
+508
def updateAllSyncDerivations(self):
+    """
+    Update all *synchronous* derivations in the knowledge graph.
+    """
+    self.derivation_client.updateAllSyncDerivations()
+
+
+
+ +
+ +
+ + +

+ updateMixedAsyncDerivation + + +

+
updateMixedAsyncDerivation(derivationIRI: str)
+
+ +
+ +

Update a directed acyclic graph (DAG) of pure asynchronous derivations or asynchronous derivations depending on synchronous derivations.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ derivationIRI + + str + +
+

IRI of the derivation to be updated

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/derivation_client.py + 
510
+511
+512
+513
+514
+515
+516
+517
def updateMixedAsyncDerivation(self, derivationIRI: str):
+    """
+    Update a directed acyclic graph (DAG) of pure asynchronous derivations or asynchronous derivations depending on synchronous derivations.
+
+    Args:
+        derivationIRI (str): IRI of the derivation to be updated
+    """
+    self.derivation_client.updateMixedAsyncDerivation(derivationIRI)
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/gateway/index.html b/api/gateway/index.html new file mode 100644 index 00000000000..3263cdc3657 --- /dev/null +++ b/api/gateway/index.html @@ -0,0 +1,1353 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Gateway - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Gateway

+ +

The purpose of this module is to create and start Java resource gateway objects to be used in other modules and scripts.

+

Instantiation of gateway object

+

To begin with, the resource gateway object for JpsBaseLib, which allows access to JPS_BASE_LIB, needs to be instantiated:

+
# To avoid unnecessary logging information from py4j package, set logger level before
+# first creation of JPS_BASE_LIB module view (i.e. jpsBaseLibView = jpsBaseLibGW.createModuleView())
+import logging
+logging.getLogger("py4j").setLevel(logging.INFO)
+
+from twa.resources import JpsBaseLib
+jpsBaseLibGW = JpsBaseLib()
+
+

Start the gateway object

+

Below method starts the communication with the Java side:

+
jpsBaseLibGW.launchGateway()
+
+# Alternatively, one can supply args to the launchGateway() method:
+# jpsBaseLibGW.launchGateway(**LGkwargs)
+
+

where the **LGkwargs argument represents a dictionary of any optional argument: value pairs one wishes to pass to the py4j launch_gateway method. Please refer to the method documentation for the description of all the possible arguments. The most important and useful settings are set by default in the twa.JPSGateway.launchGateway method so a user hardly ever need to pass any arguments in that call. If required, however, the twa.JPSGateway.launchGateway method defaults can be overwritten by simply passing their new values.

+
+

NOTE that compared to the twa.JPSGateway class, the JpsBaseLib constructor call neither accepts the resource name nor the resource jar path as arguments. This ensures that the resource is properly encapsulated.

+
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/jps_gateway/index.html b/api/jps_gateway/index.html new file mode 100644 index 00000000000..1d3ec2feaec --- /dev/null +++ b/api/jps_gateway/index.html @@ -0,0 +1,2280 @@ + + + + + + + + + + + + + + + + + + + + + + + + + JPS Gateway - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

JPS Gateway

+ +
+

JPSGateway is the parent class which should be instantiated by every resource gateway class.

+

The resource gateway class is automatically created upon the resource installation, whose class name is the same as the name of the resource given during the installation.

+

Therefore, one should ideally only work with the resource classes, e.g. JpsBaseLib, rather than with the parent JPSGateway class.

+

The documentation here is provided for developers' information.

+
+ + +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ JPSGatewaySingletonMeta + + +

+ + +
+

+ Bases: type

+ + +

A Singleton metaclass that ensures only one instance of the class is created.

+ + + + + + + + + +
+ + + + + + + + + + + +
+ +
+ +
+ +
+ + + +

+ JPSGateway + + +

+
JPSGateway(resName: str = None, jarPath: str = None, **JGkwargs)
+
+ +
+ + +

Wrapper class of the py4j JavaGateway class for managing +Python-Java communication.

+

The class can be used in the following way:

+
from twa import JPSGateway
+
+yourGateway = JPSGateway(resName=yourResName, jarPath=yourResJarPath, **JGkwargs)
+
+
+

Note that if you wish to access an already installed resource through +the JPSGateway (not recommended), then the jarPath argument can be omitted +as it can be looked up by the resource name in the resource registry. Also, +note that some of the py4j.java_gateway.JavaGateway constructor arguments +are not allowed or should be passed to the py4j.java_gateway.launch_gateway +method instead. If that is the case, the code will print a warning message +which shows how to set the desired argument correctly. Please also note that +according to the py4j documentation, the gateway_parameters argument to the +py4j.java_gateway.JavaGateway constructor must have the type of the +py4j GatewayParameters +object. However, to make it easy for the twa users, this argument can be passed +as a dictionary which then is automatically converted into the py4j GatewayParameters object.

+
+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
resName + str + +
+

name of the Java resource

+
+
jarPath + str + +
+

absolute path to the main jar file of the java resource

+
+
gateway + JavaGateway + +
+

the gateway object handling Python-Java communication

+
+
_isStarted + bool + +
+

flag indicating if the gateway was launched

+
+
_gatewayUserParams + dict + +
+

dictionary storing user provided JavaGateway parameters

+
+
_launchGatewayUserParams + dict + +
+

dictionary storing user provided launch_gateway parameters

+
+
_initialised + bool + +
+

flag inticating if the instance is already initialised

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ resName + + str + +
+

name of the Java resource

+
+ 		+ None +
+ jarPath + + str + +
+

absolute path to the main jar file of the java resource

+
+ 		+ None +
+ JGkwargs + + dict + +
+

dictionary storing user provided JavaGateway parameters +argument: value pairs one wishes to pass to the +py4j JavaGateway constructor

+
+ 		+ {} +
+
+

Note that the JGkwargs related to the 'gateway_parameters' +argument should be passed as a dictionary which is then +automatically converted into the 'GatewayParameters' object. +Please refer to the +py4j documentation +for the description of all the possible arguments.

+

As an example, the following arguments:

+
JGkwargs = {'gateway_parameters':{'auto_convert':True}}
+
+

will be automatically converted to:

+
JGkwargs = {'gateway_parameters': GatewayParameters(auto_convert=True)}}
+
+

Note that the 'java_process' and 'auth_token' arguments +will be skipped if present and they are automatically +set by the py4j.java_gateway.launch_gateway method

+

Note that the 'port' argument will skipped if present +as it can only be passed to the py4j.java_gateway.launch_gateway call

+

Note that setting the JavaGateway 'eager_load' and the +py4j.java_gateway.launch_gateway 'enable_auth' arguments to +True at the same time does NOT work. The arguments are mutually +exclusive

+

Note that the most important and useful settings are set by default +in this constructor so a user hardly ever need to pass any arguments +in that call. If required, however, the defaults of this constructor +can be overwritten by simply passing their new values. Please also +note that this constructor only instantiates the JPSGateway object, +and it DOES NOT instantiate the py4j.java_gateway.JavaGateway, whose +instantiation only happens in the twa.JPSGateway.launchGateway method +explained in more details below.

+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/JPSGateway.py + 
190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
def __init__(self, resName:str=None, jarPath:str=None, **JGkwargs):
+    """
+    JPSGateway constructor class
+
+    Args:
+        resName (str): name of the Java resource
+        jarPath (str): absolute path to the main jar file of the java resource
+        JGkwargs (dict): dictionary storing user provided JavaGateway parameters
+            `argument: value` pairs one wishes to pass to the
+            [py4j JavaGateway](https://www.py4j.org/py4j_java_gateway.html#py4j.java_gateway.JavaGateway) constructor
+
+    > Note that the JGkwargs related to the 'gateway_parameters'
+    argument should be passed as a dictionary which is then
+    automatically converted into the 'GatewayParameters' object.
+    Please refer to the
+    [py4j documentation](https://www.py4j.org/py4j_java_gateway.html)
+    for the description of all the possible arguments.
+
+    > As an example, the following arguments:
+
+    > ```python
+    > JGkwargs = {'gateway_parameters':{'auto_convert':True}}
+    > ```
+
+    > will be automatically converted to:
+
+    > ```python
+    > JGkwargs = {'gateway_parameters': GatewayParameters(auto_convert=True)}}
+    > ```
+
+    > Note that the 'java_process' and 'auth_token' arguments
+    will be skipped if present and they are automatically
+    set by the py4j.java_gateway.launch_gateway method
+
+    > Note that the 'port' argument will skipped if present
+    as it can only be passed to the py4j.java_gateway.launch_gateway call
+
+    > Note that setting the JavaGateway 'eager_load' and the
+    py4j.java_gateway.launch_gateway 'enable_auth' arguments to
+    True at the same time does NOT work. The arguments are mutually
+    exclusive
+
+    > Note that the most important and useful settings are set by default
+    in this constructor so a user hardly ever need to pass any arguments
+    in that call. If required, however, the defaults of this constructor
+    can be overwritten by simply passing their new values. Please also
+    note that this constructor only instantiates the `JPSGateway` object,
+    and it DOES NOT instantiate the `py4j.java_gateway.JavaGateway`, whose
+    instantiation only happens in the `twa.JPSGateway.launchGateway` method
+    explained in more details below.
+    """
+    if not hasattr(self, '_initialised'):
+        # ensures __init__ runs only once
+        self._initialised = True
+        self.resName = resName
+        self.jarPath = jarPath
+        if self.jarPath is None:
+            self.jarPath = resReg.getResMainFilePath(resName)
+
+        try:
+            if not path.isfile(self.jarPath):
+                print('Error: Resource jarpath is invalid.')
+                raise FileNotFoundError
+        except TypeError:
+            print('Error: Resource jarpath is invalid.')
+            raise FileNotFoundError
+        self.gateway = None
+        self._gatewayUserParams = _processJGkwargs(**JGkwargs)
+        self._launchGatewayUserParams = None
+        self._isStarted = False
+        print(f'Info: Initializing JPSGateway with resName={resName}, jarPath={jarPath}')
+    else:
+        print(f'Info: Gateway already initialised. Any JavaGateway created ({self.gateway}) will be reused.')
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ launchGateway + + +

+
launchGateway(**LGkwargs)
+
+ +
+ +

Wrapper method for the py4j.java_gateway.launch_gateway +method which launches the Gateway in a new Java process +and creates a default JavaGateway to connect to it.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ LGkwargs + + dict + +
+

a dictionary containing the py4j.java_gateway.launch_gateway method arguments

+
+ 		+ {} +
+
+

Note that the 'jarpath' and 'return_proc' arguments cannot +be changed and will be skipped if provided

+

Note that this calls an internal py4j.java_gateway.launch_gateway function which is +different from the launch_gateway function described in py4j web documentation. +The py4j function described in py4j web documentation is a JavaGateway classmethod +which in turn calls the function below. It is a bit confusing as the two functions have +the same name. The difference between the two is that the launch_gateway classmethod +launches the java process and then creates a JavaGateway object connected to it, the +problem is that this function call does not accept any user JavaGateway constructor +arguments. The non classmethod call on the other hand only launches the java process +without creating the JavaGateway instance. The JavaGateway instance can be then created +at a later stage with user defined parameters plus the parameters returned from the +launch_gateway method call that connect the running java process and the JavaGateway. +Therefore, the non classmethod py4j.java_gateway.launch_gateway is called herein and its +outputs are passed to the JavaGateway constructor.

+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/JPSGateway.py + 
264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
def launchGateway(self, **LGkwargs):
+    """
+    Wrapper method for the py4j.java_gateway.launch_gateway
+    method which launches the Gateway in a new Java process
+    and creates a default JavaGateway to connect to it.
+
+    Args:
+        LGkwargs (dict): a dictionary containing the py4j.java_gateway.launch_gateway method arguments
+
+    > Note that the 'jarpath' and 'return_proc' arguments cannot
+    be changed and will be skipped if provided
+
+    > Note that **this calls an internal py4j.java_gateway.launch_gateway function which is
+    different from the launch_gateway function described in py4j web documentation.**
+    The py4j function described in py4j web documentation is a JavaGateway classmethod
+    which in turn calls the function below. It is a bit confusing as the two functions have
+    the same name. The difference between the two is that the launch_gateway classmethod
+    launches the java process and then creates a JavaGateway object connected to it, the
+    problem is that this function call does not accept any user JavaGateway constructor
+    arguments. The non classmethod call on the other hand only launches the java process
+    without creating the JavaGateway instance. The JavaGateway instance can be then created
+    at a later stage with user defined parameters plus the parameters returned from the
+    launch_gateway method call that connect the running java process and the JavaGateway.
+    Therefore, the non classmethod py4j.java_gateway.launch_gateway is called herein and its
+    outputs are passed to the JavaGateway constructor.
+
+    """
+
+    with self._launch_lock:
+        if not self._isStarted:
+            LGkwargs = _processLGkwargs(self.__class__.__name__, **LGkwargs)
+            self._launchGatewayUserParams = LGkwargs
+
+            # this launches the java process
+            try:
+                _ret = launch_gateway(jarpath=self.jarPath, **LGkwargs)
+            except TypeError as e:
+                print(textwrap.dedent("""
+                    Error: The launch_gateway method called with invalid argument(s).
+                        Please see the py4j documentation at:
+                            https://www.py4j.org/py4j_java_gateway.html#py4j.java_gateway.launch_gateway
+                        to see the list of supported arguments."""))
+                raise e
+            except FileNotFoundError as e:
+                print(textwrap.dedent("""
+                    Error: Could not launch the resource gateway. Make sure that:
+                            1 - the resource jarPath is correct
+                            2 - java runtime environment 7+ is installed
+                            3 - java runtime environment 7+ is correctly added to the system path"""))
+                raise e
+
+            if LGkwargs['enable_auth']:
+                _port, _auth_token, proc = _ret
+            else:
+                _port, proc, _auth_token = _ret + (None, )
+
+            self._gatewayUserParams = _addConJGParams(_port, proc, _auth_token, self._gatewayUserParams)
+            # this creates the JavaGateway object connected to the launched java process above
+            try:
+                self.gateway = JavaGateway(**self._gatewayUserParams)
+            except TypeError as e:
+                print(textwrap.dedent("""
+                    Error: The JavaGateway constructor method called with invalid argument(s).
+                        Please see the py4j documentation at:
+                            https://www.py4j.org/py4j_java_gateway.html#py4j.java_gateway.JavaGateway
+                        to see the list of supported arguments."""))
+
+            self._isStarted = True
+        else:
+            print("Info: JavaGateway already started.")
+
+
+
+ +
+ +
+ + +

+ shutdown + + +

+
shutdown()
+
+ +
+ +

Wrapper method for the py4j shutdown method +to stop the JavaGateway client.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/JPSGateway.py + 
335
+336
+337
+338
+339
+340
+341
def shutdown(self):
+    """
+    Wrapper method for the py4j shutdown method
+    to stop the JavaGateway client.
+    """
+    if self._isStarted:
+        self.gateway.shutdown()
+
+
+
+ +
+ +
+ + +

+ createModuleView + + +

+
createModuleView()
+
+ +
+ +

Wrapper method for the py4j new_jvm_view method. +Creates a new JVM view with its own imports.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
new_jvm_view + JVM + +
+

A new JVM view object

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/JPSGateway.py + 
343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
def createModuleView(self):
+    """
+    Wrapper method for the py4j new_jvm_view method.
+    Creates a new JVM view with its own imports.
+
+    Returns:
+        new_jvm_view (JavaGateway.JVM): A new JVM view object
+    """
+    if self._isStarted:
+        return self.gateway.new_jvm_view()
+    else:
+        print("Error: Cannot create the module view. The JavaGateway is not started. Call the gateway start() method first.")
+
+
+
+ +
+ +
+ + +

+ importPackages + + +

+
importPackages(moduleView, importStatement)
+
+ +
+ +

Wrapper method for the py4j java_import method. +Imports a class / package into the specified JVM view

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ moduleView + + JVM + +
+

A new JVM view object

+
+ 		+ required +
+ importStatement + + str + +
+

The class / package name to import

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/JPSGateway.py + 
356
+357
+358
+359
+360
+361
+362
+363
+364
+365
+366
+367
+368
def importPackages(self, moduleView, importStatement):
+    """
+    Wrapper method for the py4j java_import method.
+    Imports a class / package into the specified JVM view
+
+    Args:
+        moduleView (JavaGateway.JVM): A new JVM view object
+        importStatement (str): The class / package name to import
+    """
+    if self._isStarted:
+        java_import(moduleView, importStatement)
+    else:
+        print("Error: Cannot import packages. The JavaGateway is not started. Call the gateway start() method first.")
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/logging/index.html b/api/logging/index.html new file mode 100644 index 00000000000..e06e8d41aaf --- /dev/null +++ b/api/logging/index.html @@ -0,0 +1,1644 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Logging - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Logging

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ StreamToLogger + + +

+
StreamToLogger(logger, log_level=DEBUG)
+
+ +
+

+ Bases: TextIOBase

+ + +

Fake file-like stream object that redirects writes to a logger instance.

+
+

StreamToLogger is made to extend TextIOBase to prevent error like below when running pytest with docker-compose +as part of dockerised test in developing pyderivationagent package: + AttributeError: 'StreamToLogger' object has no attribute 'isatty'

+

To reproduce the error, one may checkout to +this commit +and run pytest -s --docker-compose=./docker-compose.test.yml in the folder

+

This error was due to this line +in pytest checking if sys.stdout.isatty() is True/False

+

Another fix is to provide "def isatty(self) -> bool:"" but extending TextIOBase seems to be a "safer"/"cleaner" fix, +according to this comment

+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agentlogging/logging.py + 
45
+46
+47
+48
def __init__(self, logger, log_level=logging.DEBUG):
+    self.logger = logger
+    self.log_level = log_level
+    self.linebuf = ''
+
+
+ + + +
+ + + + + + + + + + + +
+ +
+ +
+ + +
+ + +

+ get_logger + + +

+
get_logger(logger_name: str)
+
+ +
+ +

Get the dev or prod logger (avoids having to import 'logging' in calling code).

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ logger_name + + str + +
+

name of the logger to be used, available options include 'dev' and 'prod'

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ +
+

Logger to use for logging statements.

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agentlogging/logging.py + 
84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
def get_logger(logger_name: str):
+    """
+    Get the dev or prod logger (avoids having to import 'logging' in calling code).
+
+    Args:
+        logger_name: name of the logger to be used, available options include 'dev' and 'prod'
+
+    Returns:
+        Logger to use for logging statements.
+    """
+    valid_logger_names = ['dev','prod']
+
+    if logger_name in valid_logger_names:
+        return logging.getLogger(logger_name)
+    else:
+        raise ValueError("Invalid logger name: allowed values are "+",".join(valid_logger_names))
+
+
+
+ +
+ +
+ + +

+ shutdown + + +

+
shutdown()
+
+ +
+ +

Shutdown the logging system, should be called +before application exit after all logging calls.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agentlogging/logging.py + 
102
+103
+104
+105
+106
+107
def shutdown():
+    """
+    Shutdown the logging system, should be called
+    before application exit after all logging calls.
+    """
+    logging.shutdown()
+
+
+
+ +
+ +
+ + +

+ clear_loggers + + +

+
clear_loggers()
+
+ +
+ +

Remove handlers from all loggers. Method adopted from +this comment.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/agentlogging/logging.py + 
110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
def clear_loggers():
+    """
+    Remove handlers from all loggers. Method adopted from
+    [this comment](https://github.com/pytest-dev/pytest/issues/5502#issuecomment-647157873).
+    """
+    import logging
+    loggers = [logging.getLogger()] + list(logging.Logger.manager.loggerDict.values())
+    for logger in loggers:
+        handlers = getattr(logger, 'handlers', [])
+        for handler in handlers:
+            logger.removeHandler(handler)
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/res_manager/index.html b/api/res_manager/index.html new file mode 100644 index 00000000000..d0bf160e694 --- /dev/null +++ b/api/res_manager/index.html @@ -0,0 +1,1472 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Resource Manager - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Resource Manager

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + + +
+ + +

+ start + + +

+
start()
+
+ +
+ +

The entry point of the helper function, which allows jpsrm to be called from the command line.

+ + +
+ Usage +

jpsrm install [--jar JARFILE]

+

jpsrm uninstall

+

jpsrm list

+

jpsrm clean

+
+ +
+ Options +

-j, --jar: Name of the main jar file. If not provided, the first + found jar file in the resource directory will be used.

+
+
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resManager.py + 
22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
def start():
+    """ The entry point of the helper function, which allows `jpsrm` to be called from the command line.
+
+    Usage:
+        jpsrm install <resource> <from> [--jar JARFILE]
+
+        jpsrm uninstall <resource>
+
+        jpsrm list
+
+        jpsrm clean
+
+    Options:
+        -j, --jar: Name of the main jar file. If not provided, the first
+            found jar file in the resource directory will be used.
+    """
+    devinstall = False
+    try:
+        args = docopt(doc)
+    except DocoptExit:
+        if len(sys.argv)==2:
+            if sys.argv[1]=='devinstall':
+                devinstall = True
+        if not devinstall:
+            raise DocoptExit('Error: jpsrm called with wrong arguments.')
+
+    if devinstall:
+        _doDevinstall()
+    else:
+        if args['install']:
+            resReg.addResToReg(resName=args['<resource>'], resLoc=args['<from>'], resMainJarFile=args['JARFILE'])
+        elif args['uninstall']:
+            resReg.removeResFromReg(resName=args['<resource>'])
+        elif args['list']:
+            resReg.listRes()
+        elif args['clean']:
+            resReg.cleanReg()
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/res_registry/index.html b/api/res_registry/index.html new file mode 100644 index 00000000000..9309c73fa84 --- /dev/null +++ b/api/res_registry/index.html @@ -0,0 +1,1928 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Resource Registry - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Resource Registry

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ resRegistry + + +

+
resRegistry()
+
+ +
+ + +

Registry class for managing jps resources.

+ + +

Attributes:

+ + + + + + + + + + + + + + + +
NameTypeDescription
resReg + dict + +
+

resource registry dictionary

+
+
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resRegistry.py + 
22
+23
+24
+25
+26
+27
+28
+29
+30
def __init__(self):
+    """
+    Constructs the registry object. If regsitry file does not exists, it creates one on the fly.
+    """
+    try:
+        self.resReg = json.load(pkg_resources.resource_stream(__name__, os.path.join('..','resources',_RES_REG_FILE)))
+    except FileNotFoundError:
+        self.resReg = {'resources':{}}
+        self._updateRegFile()
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ addResToReg + + +

+
addResToReg(resName, resLoc, resMainJarFile=None)
+
+ +
+ +

Adds a resource to the registry.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ resName + + str + +
+

resource name

+
+ 		+ required +
+ resLoc + + str + +
+

path to the resource directory

+
+ 		+ required +
+ resMainJarFile + + str + +
+

name of the main jar file, if not provided the first jar found +in the resource dir will be selected, if no jars are present it is set to None

+
+ 		+ None +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resRegistry.py + 
46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
def addResToReg(self, resName, resLoc, resMainJarFile=None):
+    """
+    Adds a resource to the registry.
+
+    Args:
+        resName (str): resource name
+        resLoc (str): path to the resource directory
+        resMainJarFile (str): name of the main jar file, if not provided the first jar found
+            in the resource dir will be selected, if no jars are present it is set to None
+    """
+    if not self._isResInReg(resName):
+        print("Info: Adding the {0} resource...".format(resName))
+        self._checkResName(resName)
+
+        # TODO default resources
+        #======================
+        #if self._isResInDefReg(resName):
+        #    print("Info: {0} is a default resource. Retrieving the resource metadata...".format(resName))
+        #    resMeta = self._getResDefMeta(resName)
+        #    resLoc = resMeta['getFrom']
+        #    resMainJarFile = resMeta['mainFile']
+        ##======================
+        self._addResRegEntry(resName)
+        if resMainJarFile is None:
+            resMainJarFile = self._checkForMainJar(resLoc)
+        self._updateResRegEntry(resName, {'mainJarFile':resMainJarFile})
+        self._addResFiles(resName, resLoc)
+        self._addResMetaFile(resName)
+        self._updateRegFile()
+    else:
+        print('Info: Resource already exist.')
+
+
+
+ +
+ +
+ + +

+ removeResFromReg + + +

+
removeResFromReg(resName)
+
+ +
+ +

Removes a resource from the registry.

+
+

Note, it removes all the resource files as well.

+
+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ resName + + str + +
+

resource name

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resRegistry.py + 
78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
def removeResFromReg(self, resName):
+    """
+    Removes a resource from the registry.
+    > Note, it removes all the resource files as well.
+
+    Args:
+        resName (str): resource name
+    """
+    if self._isResInReg(resName):
+        print("Info: Removing {0} resource...".format(resName))
+        self._removeResRegEntry(resName)
+        self._removeResFiles(resName)
+        self._updateRegFile()
+    else:
+        print("Info: {0} resource is not on the registry!".format(resName))
+
+
+
+ +
+ +
+ + +

+ listRes + + +

+
listRes()
+
+ +
+ +

Lists all currently installed resources.

+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resRegistry.py + 
94
+95
+96
+97
+98
def listRes(self):
+    """
+    Lists all currently installed resources.
+    """
+    print('\n'.join(list(self.resReg['resources'].keys())))
+
+
+
+ +
+ +
+ + +

+ cleanReg + + +

+
cleanReg()
+
+ +
+ +

Cleans the registry.

+
+

Use with caution. The command removes:

+
    +
  • +

    all registry entries with no corresponding resource files

    +
    • +
  • +

    all resource files with no corresponding registry entries

    +
    • +
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resRegistry.py + 
100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
def cleanReg(self):
+    """
+    Cleans the registry.
+
+    > Use with caution. The command removes:
+
+    > - all registry entries with no corresponding resource files
+
+    > - all resource files with no corresponding registry entries
+    """
+
+    print("Info: Removing resources that do not exist on the registry...")
+    for f in os.scandir(_RES_DIR):
+        if f.is_dir():
+            if not self._isResInReg(f.name):
+                print("Info: Found {} directory that is not on the registry. Removing...".format(f.name))
+                shutil.rmtree(f.path)
+    print("Info: Removing resources complete.")
+    print("Info: Removing registry entries that have no corresponding resource files...")
+    if not self._isEmpty():
+        for resName in self.resReg['resources']:
+            if not os.path.exists(self._getResPath(resName)):
+                print("Info: Found {} registry entry with no resource files.".format(resName))
+                self._removeResRegEntry(resName)
+    print("Info: Removing registry entries complete.")
+
+
+
+ +
+ +
+ + +

+ getResMainFilePath + + +

+
getResMainFilePath(resName)
+
+ +
+ +

Returns an absolute path to the resource main jar file.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ resName + + str + +
+

resource name

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/resRegistry/resRegistry.py + 
126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
def getResMainFilePath(self, resName):
+    """
+    Returns an absolute path to the resource main jar file.
+
+    Args:
+        resName (str): resource name
+    """
+    if resName in self.resReg['resources']:
+        mainFile = self.resReg['resources'][resName]['mainJarFile']
+        return os.path.join(self._getResPath(resName), mainFile)
+    else:
+        return None
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/sparql_client/index.html b/api/sparql_client/index.html new file mode 100644 index 00000000000..1e0263edf95 --- /dev/null +++ b/api/sparql_client/index.html @@ -0,0 +1,3156 @@ + + + + + + + + + + + + + + + + + + + + + + + + + SparqlClient - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

SparqlClient

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + +

+ PySparqlClient + + +

+
PySparqlClient(query_endpoint: str, update_endpoint: str, kg_user: str = None, kg_password: str = None, fs_url: str = None, fs_user: str = None, fs_pwd: str = None)
+
+ +
+ + +

The purpose of this class is to provide a Python interface to the Java-based RemoteStoreClient for querying and updating the knowledge graph (triplestore).

+ + +

Attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
jpsBaseLib_view + JVM + +
+

The module view for the JpsBaseLib

+
+
kg_client + RemoteStoreClient + +
+

The Java-based uk.ac.cam.cares.jps.base.query.RemoteStoreClient object

+
+
query_endpoint + str + +
+

The SPARQL query endpoint of the knowledge graph

+
+
update_endpoint + str + +
+

The SPARQL update endpoint of the knowledge graph

+
+
fs_url + str + +
+

The URL of the fileserver

+
+
fs_auth + str + +
+

The authentication information for the fileserver

+
+
+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ query_endpoint + + str + +
+

The SPARQL query endpoint of the knowledge graph

+
+ 		+ required +
+ update_endpoint + + str + +
+

The SPARQL update endpoint of the knowledge graph

+
+ 		+ required +
+ kg_user + + str + +
+

The username for the knowledge graph

+
+ 		+ None +
+ kg_password + + str + +
+

The password for the knowledge graph

+
+ 		+ None +
+ fs_url + + str + +
+

The URL of the fileserver

+
+ 		+ None +
+ fs_user + + str + +
+

The username for the fileserver

+
+ 		+ None +
+ fs_pwd + + str + +
+

The password for the fileserver

+
+ 		+ None +
+ + + + + + +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
def __init__(
+    self,
+    query_endpoint: str,
+    update_endpoint: str,
+    kg_user: str = None,
+    kg_password: str = None,
+    fs_url: str = None,
+    fs_user: str = None,
+    fs_pwd: str = None
+):
+    """
+    The constructor for the PySparqlClient class.
+
+    Args:
+        query_endpoint (str): The SPARQL query endpoint of the knowledge graph
+        update_endpoint (str): The SPARQL update endpoint of the knowledge graph
+        kg_user (str): The username for the knowledge graph
+        kg_password (str): The password for the knowledge graph
+        fs_url (str): The URL of the fileserver
+        fs_user (str): The username for the fileserver
+        fs_pwd (str): The password for the fileserver
+    """
+    # create a JVM module view and use it to import the required java classes
+    self.jpsBaseLib_view = jpsBaseLibGW.createModuleView()
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view,"uk.ac.cam.cares.jps.base.query.*")
+    jpsBaseLibGW.importPackages(self.jpsBaseLib_view,"uk.ac.cam.cares.jps.base.derivation.*")
+
+    if kg_user is not None:
+        self.kg_client = self.jpsBaseLib_view.RemoteStoreClient(query_endpoint, update_endpoint, kg_user, kg_password)
+    else:
+        self.kg_client = self.jpsBaseLib_view.RemoteStoreClient(query_endpoint, update_endpoint)
+
+    # Expose query and update endpoint
+    self.query_endpoint = query_endpoint
+    self.update_endpoint = update_endpoint
+
+    # Also initialise the fileserver URL and auth info
+    # TODO in the future development, make use of pyuploader
+    self.fs_url = fs_url
+    self.fs_auth = (fs_user, fs_pwd)
+
+
+ + + +
+ + + + + + + + + +
+ + +

+ check_instance_class + + +

+
check_instance_class(instance: str, instance_class: str) -> bool
+
+ +
+ +

This method checks if the given instance is instantiated from the given instance class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ instance + + str + +
+

IRI of an instance

+
+ 		+ required +
+ instance_class + + str + +
+

IRI of the instance class to be checked against

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
bool + bool + +
+

True if the instance is instantiated from the given instance class, False otherwise

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
def check_instance_class(self, instance: str, instance_class: str) -> bool:
+    """
+    This method checks if the given instance is instantiated from the given instance class.
+
+    Args:
+        instance (str): IRI of an instance
+        instance_class (str): IRI of the instance class to be checked against
+
+    Returns:
+        bool: True if the instance is instantiated from the given instance class, False otherwise
+    """
+    # Delete "<" and ">" around the IRI
+    instance = utils.trim_iri(instance)
+    instance_class = utils.trim_iri(instance_class)
+
+    # Prepare query string, ignore owl:Thing and owl:NamedIndividual
+    query = f"""{PREFIX_RDFS} {PREFIX_RDF} {PREFIX_XSD} {PREFIX_OWL}
+            SELECT ?result
+            WHERE {{ <{instance}> rdf:type ?type .
+                FILTER(?type != owl:Thing && ?type != owl:NamedIndividual) .
+                BIND(xsd:boolean(if(?type = <{instance_class}>, "true", "false")) as ?result)
+            }}"""
+
+    # Perform query
+    response = self.perform_query(query)
+
+    res = [list(r.values())[0] for r in response]
+    if res[0] == 'true':
+        return True
+    else:
+        return False
+
+
+
+ +
+ +
+ + +

+ get_amount_of_triples + + +

+
get_amount_of_triples() -> int
+
+ +
+ +

This method returns the total number of triples in the knowledge graph.

+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
int + int + +
+

The total number of triples in the knowledge graph

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
 98
+ 99
+100
+101
+102
+103
+104
+105
+106
def get_amount_of_triples(self) -> int:
+    """
+    This method returns the total number of triples in the knowledge graph.
+
+    Returns:
+        int: The total number of triples in the knowledge graph
+    """
+    # return an integer of total number of triples
+    return self.kg_client.getTotalNumberOfTriples()
+
+
+
+ +
+ +
+ + +

+ perform_query + + +

+
perform_query(query: str) -> Dict[str, Any]
+
+ +
+ +

This function performs query to knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ query + + str + +
+

SPARQL Query string

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, Any] + +
+

Dict[str, Any]: The response of the query

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
def perform_query(self, query: str) -> Dict[str, Any]:
+    """
+    This function performs query to knowledge graph.
+
+    Args:
+        query (str): SPARQL Query string
+
+    Returns:
+        Dict[str, Any]: The response of the query
+    """
+    response = str(self.kg_client.executeQuery(query))
+    return json.loads(response)
+
+
+
+ +
+ +
+ + +

+ perform_update + + +

+
perform_update(update: str) -> None
+
+ +
+ +

This function performs SPARQL Update to knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ update + + str + +
+

SPARQL Update string

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
121
+122
+123
+124
+125
+126
+127
+128
def perform_update(self, update: str) -> None:
+    """
+    This function performs SPARQL Update to knowledge graph.
+
+    Args:
+        update (str): SPARQL Update string
+    """
+    self.kg_client.executeUpdate(update)
+
+
+
+ +
+ +
+ + +

+ get_all_instances_of_class + + +

+
get_all_instances_of_class(class_iri: str) -> List[str]
+
+ +
+ +

This function returns all instances of the given class.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ class_iri + + str + +
+

IRI of the class

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ List[str] + +
+

List[str]: List of IRIs of all instances of the given class

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145
+146
def get_all_instances_of_class(self, class_iri: str) -> List[str]:
+    """
+    This function returns all instances of the given class.
+
+    Args:
+        class_iri (str): IRI of the class
+
+    Returns:
+        List[str]: List of IRIs of all instances of the given class
+    """
+    # Prepare query string
+    query = f"""SELECT ?iri WHERE {{ ?iri a <{class_iri}> }}"""
+
+    # Perform query
+    response = self.perform_query(query)
+
+    return [list(r.values())[0] for r in response]
+
+
+
+ +
+ +
+ + +

+ upload_ontology + + +

+
upload_ontology(file_path: str) -> None
+
+ +
+ +

This function uploads ontology to knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ file_path + + str + +
+

The file path of ontology to be uploaded

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
148
+149
+150
+151
+152
+153
+154
+155
+156
def upload_ontology(self, file_path: str) -> None:
+    """
+    This function uploads ontology to knowledge graph.
+
+    Args:
+        file_path (str): The file path of ontology to be uploaded
+    """
+    javaFile = self.jpsBaseLib_view.java.io.File(file_path)
+    self.kg_client.uploadFile(javaFile)
+
+
+
+ +
+ +
+ + +

+ upload_file + + +

+
upload_file(local_file_path: str, filename_with_subdir: str = None) -> Tuple[str, float]
+
+ +
+ +

This function uploads the file at the given local file path to file server.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ local_file_path + + str + +
+

The local file path of the file to be uploaded

+
+ 		+ required +
+ filename_with_subdir + + str + +
+

The filename with subdirectory in the file server

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Tuple[str, float] + +
+

Tuple[str, float]: The remote file path and the timestamp when the file was uploaded

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
def upload_file(self, local_file_path: str, filename_with_subdir: str = None) -> Tuple[str, float]:
+    """
+    This function uploads the file at the given local file path to file server.
+
+    Args:
+        local_file_path (str): The local file path of the file to be uploaded
+        filename_with_subdir (str): The filename with subdirectory in the file server
+
+    Returns:
+        Tuple[str, float]: The remote file path and the timestamp when the file was uploaded
+    """
+    if self.fs_url is None or self.fs_auth is None:
+        raise Exception("ERROR: Fileserver URL and auth are not provided correctly.")
+    with open(local_file_path, 'rb') as file_obj:
+        files = {'file': file_obj}
+        timestamp_upload, response = datetime.now().timestamp(), requests.post(
+            self.fs_url+filename_with_subdir if filename_with_subdir is not None else self.fs_url,
+            auth=self.fs_auth, files=files
+        )
+
+        # If the upload succeeded, return the remote file path and the timestamp when the file was uploaded
+        if (response.status_code == requests.status_codes.codes.OK):
+            remote_file_path = response.headers['file']
+
+            return remote_file_path, timestamp_upload
+        else:
+            raise Exception(f"ERROR: Local file ({local_file_path}) upload to file server <{self.fs_url}> failed with code {response.status_code} and response body: {str(response.content)}")
+
+
+
+ +
+ +
+ + +

+ download_file + + +

+
download_file(remote_file_path: str, downloaded_file_path: str) -> None
+
+ +
+ +

This function downloads a file given the remote file path and the local file path to store the downloaded file.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ remote_file_path + + str + +
+

The remote file path of the file to be downloaded

+
+ 		+ required +
+ downloaded_file_path + + str + +
+

The local file path to store the downloaded file

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
186
+187
+188
+189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
def download_file(self, remote_file_path: str, downloaded_file_path: str) -> None:
+    """
+    This function downloads a file given the remote file path and the local file path to store the downloaded file.
+
+    Args:
+        remote_file_path (str): The remote file path of the file to be downloaded
+        downloaded_file_path (str): The local file path to store the downloaded file
+    """
+    response = requests.get(remote_file_path, auth=self.fs_auth)
+    if (response.status_code == requests.status_codes.codes.OK):
+        with open(downloaded_file_path, 'wb') as file_obj:
+            for chunk in response.iter_content(chunk_size=128):
+                file_obj.write(chunk)
+    else:
+        raise Exception(f"ERROR: File <{remote_file_path}> download failed with code {response.status_code} and response body: {str(response.content)}")
+
+
+
+ +
+ +
+ + +

+ upload_graph + + +

+
upload_graph(g: Graph) -> None
+
+ +
+ +

This function uploads the given graph to the knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ g + + Graph + +
+

The rdflib.Graph object to be uploaded

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
202
+203
+204
+205
+206
+207
+208
+209
+210
def upload_graph(self, g: Graph) -> None:
+    """
+    This function uploads the given graph to the knowledge graph.
+
+    Args:
+        g (Graph): The rdflib.Graph object to be uploaded
+    """
+    update = f"""INSERT DATA {{ {g.serialize(format='nt')} }}"""
+    self.perform_update(update)
+
+
+
+ +
+ +
+ + +

+ delete_graph + + +

+
delete_graph(g: Graph) -> None
+
+ +
+ +

This function deletes the triples in the graph provided.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ g + + Graph + +
+

The rdflib.Graph object to be deleted

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
212
+213
+214
+215
+216
+217
+218
+219
+220
def delete_graph(self, g: Graph) -> None:
+    """
+    This function deletes the triples in the graph provided.
+
+    Args:
+        g (Graph): The rdflib.Graph object to be deleted
+    """
+    update = f"""DELETE DATA {{ {g.serialize(format='nt')} }}"""
+    self.perform_update(update)
+
+
+
+ +
+ +
+ + +

+ delete_and_insert_graphs + + +

+
delete_and_insert_graphs(g_to_delete: Graph, g_to_insert: Graph) -> None
+
+ +
+ +

This function deletes the triples in the first graph and inserts the triples in the second graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ g_to_delete + + Graph + +
+

The rdflib.Graph object to be deleted

+
+ 		+ required +
+ g_to_insert + + Graph + +
+

The rdflib.Graph object to be inserted

+
+ 		+ required +
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
def delete_and_insert_graphs(self, g_to_delete: Graph, g_to_insert: Graph) -> None:
+    """
+    This function deletes the triples in the first graph and inserts the triples in the second graph.
+
+    Args:
+        g_to_delete (Graph): The rdflib.Graph object to be deleted
+        g_to_insert (Graph): The rdflib.Graph object to be inserted
+    """
+    update = f"""DELETE {{ {g_to_delete.serialize(format='nt')} }}
+                 INSERT {{ {g_to_insert.serialize(format='nt')} }}
+                 WHERE {{}}"""
+    self.perform_update(update)
+
+
+
+ +
+ +
+ + +

+ check_if_triple_exist + + +

+
check_if_triple_exist(s: str, p: str, o: Any, data_type: str = None) -> bool
+
+ +
+ +

This function checks if the given triple exists in the knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ s + + str + +
+

Subject IRI

+
+ 		+ required +
+ p + + str + +
+

Predicate IRI

+
+ 		+ required +
+ o + + Any + +
+

Object IRI or literal value

+
+ 		+ required +
+ data_type + + str + +
+

Data type of the object literal

+
+ 		+ None +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
bool + bool + +
+

True if the triple exists, False otherwise

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252
+253
def check_if_triple_exist(self, s: str, p: str, o: Any, data_type: str = None) -> bool:
+    """
+    This function checks if the given triple exists in the knowledge graph.
+
+    Args:
+        s (str): Subject IRI
+        p (str): Predicate IRI
+        o (Any): Object IRI or literal value
+        data_type (str): Data type of the object literal
+
+    Returns:
+        bool: True if the triple exists, False otherwise
+    """
+    s = "?s" if s is None else f"<{utils.trim_iri(s)}>"
+    p = "?p" if p is None else f"<{utils.trim_iri(p)}>"
+    o = "?o" if o is None else f"<{utils.trim_iri(o)}>" if data_type is None else Literal(o, datatype=utils.trim_iri(data_type))._literal_n3()
+    query = f"""ASK {{{s} {p} {o}.}}"""
+    response = self.perform_query(query)
+    return response[0]['ASK']
+
+
+
+ +
+ +
+ + +

+ get_outgoing_and_attributes + + +

+
get_outgoing_and_attributes(node_iris: Set[str]) -> Dict[str, Dict[str, Set[Any]]]
+
+ +
+ +

This function returns the outgoing edges and attributes of the given nodes in the knowledge graph.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ node_iris + + Set[str] + +
+

The set of IRIs of the nodes

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
TypeDescription
+ Dict[str, Dict[str, Set[Any]]] + +
+

Dict[str, Dict[str, Set[Any]]]: The dictionary of the outgoing edges and attributes of the given nodes, where the key is the node IRI

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/kg_operations/sparql_client.py + 
255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
def get_outgoing_and_attributes(self, node_iris: Set[str]) -> Dict[str, Dict[str, Set[Any]]]:
+    """
+    This function returns the outgoing edges and attributes of the given nodes in the knowledge graph.
+
+    Args:
+        node_iris (Set[str]): The set of IRIs of the nodes
+
+    Returns:
+        Dict[str, Dict[str, Set[Any]]]: The dictionary of the outgoing edges and attributes of the given nodes, where the key is the node IRI
+    """
+    result = {}
+    if isinstance(node_iris, str):
+        node_iris = [node_iris]
+    if isinstance(node_iris, list):
+        node_iris = set(node_iris)
+    if not node_iris:
+        return result
+    query = f"""SELECT ?s ?p ?o WHERE {{VALUES ?s {{ {' '.join([f'<{utils.trim_iri(iri)}>' for iri in node_iris])} }} ?s ?p ?o.}}"""
+    response = self.perform_query(query)
+    for r in response:
+        if r['s'] not in result:
+            result[r['s']] = {}
+        if r['p'] not in result[r['s']]:
+            result[r['s']][r['p']] = set()
+        result[r['s']][r['p']].add(r['o'])
+    return result
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/utilities/index.html b/api/utilities/index.html new file mode 100644 index 00000000000..111cf6b3915 --- /dev/null +++ b/api/utilities/index.html @@ -0,0 +1,2070 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Utilities - The World Avatar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + + + + + + +
+
+
+ + + + +
+
+ + + + + + + +

Utilities

+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + +
+ + + +

+ TWA_BASE_URL + + + + module-attribute + + +

+
TWA_BASE_URL = 'https://www.theworldavatar.com/kg/'
+
+ +
+ +

To be used by attaching specific namespace and class name to it +e.g. https://www.theworldavatar.com/kg/ontolab/LabEquipment

+
+ +
+ + + + + +
+ +
+ +
+ +
+ + + + +
+ + + + + + + + +
+ + + + + + + + + +
+ + +

+ check_valid_url + + +

+
check_valid_url(url: str) -> str
+
+ +
+ +

This function checks if the provided URL for namespace starts with "http://" or "https://". +If so, it returns the URL and add "/" if it's not already ending with a "/" or "#".

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ url + + str + +
+

The URL to be checked

+
+ 		+ required +
+ + +

Raises:

+ + + + + + + + + + + + + +
TypeDescription
+ Exception + +
+

The URL is not provided with either "http://" or "https://" as its start

+
+
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

The original URL or the processed URL with a "/" added at its end

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/utils.py + 
 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
def check_valid_url(url: str) -> str:
+    """
+    This function checks if the provided URL for namespace starts with "http://" or "https://".
+    If so, it returns the URL and add "/" if it's not already ending with a "/" or "#".
+
+    Args:
+        url (str): The URL to be checked
+
+    Raises:
+        Exception: The URL is not provided with either "http://" or "https://" as its start
+
+    Returns:
+        str: The original URL or the processed URL with a "/" added at its end
+    """
+    if url.startswith('http://') or url.startswith('https://'):
+        return url if url[-1] in ['/', '#'] else url + '/'
+    else:
+        raise Exception("The provide url for namespace should start with either 'http://' or 'https://'.")
+
+
+
+ +
+ +
+ + +

+ construct_namespace_iri + + +

+
construct_namespace_iri(base_url: str, namespace: str) -> str
+
+ +
+ +

This function constructs the namespace IRI from the base URL and namespace. +For example, if the base URL is "https://www.theworldavatar.com/kg" and the namespace is "ontolab", +The function will return "https://www.theworldavatar.com/kg/ontolab".

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ base_url + + str + +
+

The base URL of the namespace IRI, e.g. "https://www.theworldavatar.com/kg"

+
+ 		+ required +
+ namespace + + str + +
+

The namespace, e.g. "ontolab", will be ignored if None

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

The namespace IRI, e.g. "https://www.theworldavatar.com/kg/ontolab"

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/utils.py + 
25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
def construct_namespace_iri(base_url: str, namespace: str) -> str:
+    """
+    This function constructs the namespace IRI from the base URL and namespace.
+    For example, if the base URL is "https://www.theworldavatar.com/kg" and the namespace is "ontolab",
+    The function will return "https://www.theworldavatar.com/kg/ontolab".
+
+    Args:
+        base_url (str): The base URL of the namespace IRI, e.g. "https://www.theworldavatar.com/kg"
+        namespace (str): The namespace, e.g. "ontolab", will be ignored if None
+
+    Returns:
+        str: The namespace IRI, e.g. "https://www.theworldavatar.com/kg/ontolab"
+    """
+    return f'{check_valid_url(base_url)}{namespace}' if namespace is not None else base_url
+
+
+
+ +
+ +
+ + +

+ construct_rdf_type + + +

+
construct_rdf_type(namespace_iri: str, class_name: str) -> str
+
+ +
+ +

This function constructs the RDF type IRI from the namespace IRI and class name.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ namespace_iri + + str + +
+

The namespace IRI, e.g. "https://www.theworldavatar.com/kg/ontolab"

+
+ 		+ required +
+ class_name + + str + +
+

The class name, e.g. "LabEquipment"

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

The RDF type IRI, e.g. "https://www.theworldavatar.com/kg/ontolab/LabEquipment"

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/utils.py + 
41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
def construct_rdf_type(namespace_iri: str, class_name: str) -> str:
+    """
+    This function constructs the RDF type IRI from the namespace IRI and class name.
+
+    Args:
+        namespace_iri (str): The namespace IRI, e.g. "https://www.theworldavatar.com/kg/ontolab"
+        class_name (str): The class name, e.g. "LabEquipment"
+
+    Returns:
+        str: The RDF type IRI, e.g. "https://www.theworldavatar.com/kg/ontolab/LabEquipment"
+    """
+    return f'{check_valid_url(namespace_iri)}{class_name}'
+
+
+
+ +
+ +
+ + +

+ init_instance_iri + + +

+
init_instance_iri(namespace_iri: str, class_name: str) -> str
+
+ +
+ +

The function constructs a unique IRI for an instance of a class in a namespace.

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ namespace_iri + + str + +
+

The namespace IRI, e.g. "https://www.theworldavatar.com/kg/ontolab"

+
+ 		+ required +
+ class_name + + str + +
+

The class name, e.g. "LabEquipment"

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + str + +
+

The unique IRI for the instance, e.g. "https://www.theworldavatar.com/kg/ontolab/LabEquipment_12345678"

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/utils.py + 
55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
def init_instance_iri(namespace_iri: str, class_name: str) -> str:
+    """
+    The function constructs a unique IRI for an instance of a class in a namespace.
+
+    Args:
+        namespace_iri (str): The namespace IRI, e.g. "https://www.theworldavatar.com/kg/ontolab"
+        class_name (str): The class name, e.g. "LabEquipment"
+
+    Returns:
+        str: The unique IRI for the instance, e.g. "https://www.theworldavatar.com/kg/ontolab/LabEquipment_12345678"
+    """
+    return f'{construct_rdf_type(namespace_iri, class_name)}_{str(uuid4())}'
+
+
+
+ +
+ +
+ + +

+ trim_iri + + +

+
trim_iri(iri: Union[str, List[str]]) -> Union[str, List[str]]
+
+ +
+ +

This function trims the "<" and ">" characters from the left and right side of the given IRI (or lists of IRIs).

+ + +

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
+ iri + + str or list + +
+

The IRI(s) to be trimmed

+
+ 		+ required +
+ + +

Returns:

+ + + + + + + + + + + + + +
Name TypeDescription
str + Union[str, List[str]] + +
+

The trimmed IRI

+
+
+ +
+ Source code in JPS_BASE_LIB/python_wrapper/twa/data_model/utils.py + 
69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
def trim_iri(iri: Union[str, List[str]]) -> Union[str, List[str]]:
+    """
+    This function trims the "<" and ">" characters from the left and right side of the given IRI (or lists of IRIs).
+
+    Args:
+        iri (str or list): The IRI(s) to be trimmed
+
+    Returns:
+        str: The trimmed IRI
+    """
+    if isinstance(iri, list):
+        for i in range(len(iri)):
+            iri[i] = trim_iri(iri[i])
+    else:
+        iri = iri.strip().lstrip("<").rstrip(">")
+    return iri
+
+
+
+ +
+ + + +
+ +
+ +
+ + + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css new file mode 100644 index 00000000000..b500381b5c5 --- /dev/null +++ b/assets/_mkdocstrings.css @@ -0,0 +1,143 @@ + +/* Avoid breaking parameter names, etc. in table cells. */ +.doc-contents td code { + word-break: normal !important; +} + +/* No line break before first paragraph of descriptions. */ +.doc-md-description, +.doc-md-description>p:first-child { + display: inline; +} + +/* Max width for docstring sections tables. */ +.doc .md-typeset__table, +.doc .md-typeset__table table { + display: table !important; + width: 100%; +} + +.doc .md-typeset__table tr { + display: table-row; +} + +/* Defaults in Spacy table style. */ +.doc-param-default { + float: right; +} + +/* Parameter headings must be inline, not blocks. */ +.doc-heading-parameter { + display: inline; +} + +/* Prefer space on the right, not the left of parameter permalinks. */ +.doc-heading-parameter .headerlink { + margin-left: 0 !important; + margin-right: 0.2rem; +} + +/* Backward-compatibility: docstring section titles in bold. */ +.doc-section-title { + font-weight: bold; +} + +/* Symbols in Navigation and ToC. */ +:root, :host, +[data-md-color-scheme="default"] { + --doc-symbol-parameter-fg-color: #df50af; + --doc-symbol-attribute-fg-color: #953800; + --doc-symbol-function-fg-color: #8250df; + --doc-symbol-method-fg-color: #8250df; + --doc-symbol-class-fg-color: #0550ae; + --doc-symbol-module-fg-color: #5cad0f; + + --doc-symbol-parameter-bg-color: #df50af1a; + --doc-symbol-attribute-bg-color: #9538001a; + --doc-symbol-function-bg-color: #8250df1a; + --doc-symbol-method-bg-color: #8250df1a; + --doc-symbol-class-bg-color: #0550ae1a; + --doc-symbol-module-bg-color: #5cad0f1a; +} + +[data-md-color-scheme="slate"] { + --doc-symbol-parameter-fg-color: #ffa8cc; + --doc-symbol-attribute-fg-color: #ffa657; + --doc-symbol-function-fg-color: #d2a8ff; + --doc-symbol-method-fg-color: #d2a8ff; + --doc-symbol-class-fg-color: #79c0ff; + --doc-symbol-module-fg-color: #baff79; + + --doc-symbol-parameter-bg-color: #ffa8cc1a; + --doc-symbol-attribute-bg-color: #ffa6571a; + --doc-symbol-function-bg-color: #d2a8ff1a; + --doc-symbol-method-bg-color: #d2a8ff1a; + --doc-symbol-class-bg-color: #79c0ff1a; + --doc-symbol-module-bg-color: #baff791a; +} + +code.doc-symbol { + border-radius: .1rem; + font-size: .85em; + padding: 0 .3em; + font-weight: bold; +} + +code.doc-symbol-parameter { + color: var(--doc-symbol-parameter-fg-color); + background-color: var(--doc-symbol-parameter-bg-color); +} + +code.doc-symbol-parameter::after { + content: "param"; +} + +code.doc-symbol-attribute { + color: var(--doc-symbol-attribute-fg-color); + background-color: var(--doc-symbol-attribute-bg-color); +} + +code.doc-symbol-attribute::after { + content: "attr"; +} + +code.doc-symbol-function { + color: var(--doc-symbol-function-fg-color); + background-color: var(--doc-symbol-function-bg-color); +} + +code.doc-symbol-function::after { + content: "func"; +} + +code.doc-symbol-method { + color: var(--doc-symbol-method-fg-color); + background-color: var(--doc-symbol-method-bg-color); +} + +code.doc-symbol-method::after { + content: "meth"; +} + +code.doc-symbol-class { + color: var(--doc-symbol-class-fg-color); + background-color: var(--doc-symbol-class-bg-color); +} + +code.doc-symbol-class::after { + content: "class"; +} + +code.doc-symbol-module { + color: var(--doc-symbol-module-fg-color); + background-color: var(--doc-symbol-module-bg-color); +} + +code.doc-symbol-module::after { + content: "mod"; +} + +.doc-signature .autorefs { + color: inherit; + border-bottom: 1px dotted currentcolor; +} diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000000..1cf13b9f9d9 Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.1e8ae164.min.js b/assets/javascripts/bundle.1e8ae164.min.js new file mode 100644 index 00000000000..212979889b9 --- /dev/null +++ b/assets/javascripts/bundle.1e8ae164.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var _i=Object.create;var br=Object.defineProperty;var Ai=Object.getOwnPropertyDescriptor;var Ci=Object.getOwnPropertyNames,Ft=Object.getOwnPropertySymbols,ki=Object.getPrototypeOf,vr=Object.prototype.hasOwnProperty,eo=Object.prototype.propertyIsEnumerable;var Zr=(e,t,r)=>t in e?br(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,F=(e,t)=>{for(var r in t||(t={}))vr.call(t,r)&&Zr(e,r,t[r]);if(Ft)for(var r of Ft(t))eo.call(t,r)&&Zr(e,r,t[r]);return e};var to=(e,t)=>{var r={};for(var o in e)vr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Ft)for(var o of Ft(e))t.indexOf(o)<0&&eo.call(e,o)&&(r[o]=e[o]);return r};var gr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Hi=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Ci(t))!vr.call(e,n)&&n!==r&&br(e,n,{get:()=>t[n],enumerable:!(o=Ai(t,n))||o.enumerable});return e};var jt=(e,t,r)=>(r=e!=null?_i(ki(e)):{},Hi(t||!e||!e.__esModule?br(r,"default",{value:e,enumerable:!0}):r,e));var ro=(e,t,r)=>new Promise((o,n)=>{var i=c=>{try{s(r.next(c))}catch(p){n(p)}},a=c=>{try{s(r.throw(c))}catch(p){n(p)}},s=c=>c.done?o(c.value):Promise.resolve(c.value).then(i,a);s((r=r.apply(e,t)).next())});var no=gr((xr,oo)=>{(function(e,t){typeof xr=="object"&&typeof oo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(xr,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(C){return!!(C&&C!==document&&C.nodeName!=="HTML"&&C.nodeName!=="BODY"&&"classList"in C&&"contains"in C.classList)}function c(C){var ct=C.type,Ne=C.tagName;return!!(Ne==="INPUT"&&a[ct]&&!C.readOnly||Ne==="TEXTAREA"&&!C.readOnly||C.isContentEditable)}function p(C){C.classList.contains("focus-visible")||(C.classList.add("focus-visible"),C.setAttribute("data-focus-visible-added",""))}function l(C){C.hasAttribute("data-focus-visible-added")&&(C.classList.remove("focus-visible"),C.removeAttribute("data-focus-visible-added"))}function f(C){C.metaKey||C.altKey||C.ctrlKey||(s(r.activeElement)&&p(r.activeElement),o=!0)}function u(C){o=!1}function h(C){s(C.target)&&(o||c(C.target))&&p(C.target)}function w(C){s(C.target)&&(C.target.classList.contains("focus-visible")||C.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(C.target))}function A(C){document.visibilityState==="hidden"&&(n&&(o=!0),Z())}function Z(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function te(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(C){C.target.nodeName&&C.target.nodeName.toLowerCase()==="html"||(o=!1,te())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",A,!0),Z(),r.addEventListener("focus",h,!0),r.addEventListener("blur",w,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var zr=gr((kt,Vr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof kt=="object"&&typeof Vr=="object"?Vr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof kt=="object"?kt.ClipboardJS=r():t.ClipboardJS=r()})(kt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Li}});var a=i(279),s=i.n(a),c=i(370),p=i.n(c),l=i(817),f=i.n(l);function u(D){try{return document.execCommand(D)}catch(M){return!1}}var h=function(M){var O=f()(M);return u("cut"),O},w=h;function A(D){var M=document.documentElement.getAttribute("dir")==="rtl",O=document.createElement("textarea");O.style.fontSize="12pt",O.style.border="0",O.style.padding="0",O.style.margin="0",O.style.position="absolute",O.style[M?"right":"left"]="-9999px";var I=window.pageYOffset||document.documentElement.scrollTop;return O.style.top="".concat(I,"px"),O.setAttribute("readonly",""),O.value=D,O}var Z=function(M,O){var I=A(M);O.container.appendChild(I);var W=f()(I);return u("copy"),I.remove(),W},te=function(M){var O=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},I="";return typeof M=="string"?I=Z(M,O):M instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(M==null?void 0:M.type)?I=Z(M.value,O):(I=f()(M),u("copy")),I},J=te;function C(D){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?C=function(O){return typeof O}:C=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},C(D)}var ct=function(){var M=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},O=M.action,I=O===void 0?"copy":O,W=M.container,K=M.target,Ce=M.text;if(I!=="copy"&&I!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(K!==void 0)if(K&&C(K)==="object"&&K.nodeType===1){if(I==="copy"&&K.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(I==="cut"&&(K.hasAttribute("readonly")||K.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Ce)return J(Ce,{container:W});if(K)return I==="cut"?w(K):J(K,{container:W})},Ne=ct;function Pe(D){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Pe=function(O){return typeof O}:Pe=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},Pe(D)}function xi(D,M){if(!(D instanceof M))throw new TypeError("Cannot call a class as a function")}function Xr(D,M){for(var O=0;O0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof W.action=="function"?W.action:this.defaultAction,this.target=typeof W.target=="function"?W.target:this.defaultTarget,this.text=typeof W.text=="function"?W.text:this.defaultText,this.container=Pe(W.container)==="object"?W.container:document.body}},{key:"listenClick",value:function(W){var K=this;this.listener=p()(W,"click",function(Ce){return K.onClick(Ce)})}},{key:"onClick",value:function(W){var K=W.delegateTarget||W.currentTarget,Ce=this.action(K)||"copy",It=Ne({action:Ce,container:this.container,target:this.target(K),text:this.text(K)});this.emit(It?"success":"error",{action:Ce,text:It,trigger:K,clearSelection:function(){K&&K.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(W){return hr("action",W)}},{key:"defaultTarget",value:function(W){var K=hr("target",W);if(K)return document.querySelector(K)}},{key:"defaultText",value:function(W){return hr("text",W)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(W){var K=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(W,K)}},{key:"cut",value:function(W){return w(W)}},{key:"isSupported",value:function(){var W=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],K=typeof W=="string"?[W]:W,Ce=!!document.queryCommandSupported;return K.forEach(function(It){Ce=Ce&&!!document.queryCommandSupported(It)}),Ce}}]),O}(s()),Li=Mi},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,c){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(c))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,h,w){var A=p.apply(this,arguments);return l.addEventListener(u,A,w),{destroy:function(){l.removeEventListener(u,A,w)}}}function c(l,f,u,h,w){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(A){return s(A,f,u,h,w)}))}function p(l,f,u,h){return function(w){w.delegateTarget=a(w.target,f),w.delegateTarget&&h.call(l,w)}}o.exports=c},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function c(u,h,w){if(!u&&!h&&!w)throw new Error("Missing required arguments");if(!a.string(h))throw new TypeError("Second argument must be a String");if(!a.fn(w))throw new TypeError("Third argument must be a Function");if(a.node(u))return p(u,h,w);if(a.nodeList(u))return l(u,h,w);if(a.string(u))return f(u,h,w);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function p(u,h,w){return u.addEventListener(h,w),{destroy:function(){u.removeEventListener(h,w)}}}function l(u,h,w){return Array.prototype.forEach.call(u,function(A){A.addEventListener(h,w)}),{destroy:function(){Array.prototype.forEach.call(u,function(A){A.removeEventListener(h,w)})}}}function f(u,h,w){return s(document.body,u,h,w)}o.exports=c},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),p=document.createRange();p.selectNodeContents(i),c.removeAllRanges(),c.addRange(p),a=c.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var c=this;function p(){c.off(i,p),a.apply(s,arguments)}return p._=a,this.on(i,p,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),c=0,p=s.length;for(c;c{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var Va=/["'&<>]/;qn.exports=za;function za(e){var t=""+e,r=Va.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(p[0]===6||p[0]===2)){r=0;continue}if(p[0]===3&&(!i||p[1]>i[0]&&p[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function V(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function z(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||s(u,h)})})}function s(u,h){try{c(o[u](h))}catch(w){f(i[0][3],w)}}function c(u){u.value instanceof ot?Promise.resolve(u.value.v).then(p,l):f(i[0][2],u)}function p(u){s("next",u)}function l(u){s("throw",u)}function f(u,h){u(h),i.shift(),i.length&&s(i[0][0],i[0][1])}}function so(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof ue=="function"?ue(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,c){a=e[i](a),n(s,c,a.done,a.value)})}}function n(i,a,s,c){Promise.resolve(c).then(function(p){i({value:p,done:s})},a)}}function k(e){return typeof e=="function"}function pt(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Wt=pt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Ve(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ie=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=ue(a),c=s.next();!c.done;c=s.next()){var p=c.value;p.remove(this)}}catch(A){t={error:A}}finally{try{c&&!c.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof Wt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=ue(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{co(w)}catch(A){i=i!=null?i:[],A instanceof Wt?i=z(z([],V(i)),V(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new Wt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)co(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ve(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ve(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Er=Ie.EMPTY;function Dt(e){return e instanceof Ie||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function co(e){k(e)?e():e.unsubscribe()}var ke={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var lt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Er:(this.currentObservers=null,s.push(r),new Ie(function(){o.currentObservers=null,Ve(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new vo(r,o)},t}(j);var vo=function(e){se(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Er},t}(g);var St={now:function(){return(St.delegate||Date).now()},delegate:void 0};var Ot=function(e){se(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=St);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,c=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),c=0;c0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(ut.cancelAnimationFrame(o),r._scheduled=void 0)},t}(zt);var yo=function(e){se(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(qt);var de=new yo(xo);var L=new j(function(e){return e.complete()});function Kt(e){return e&&k(e.schedule)}function _r(e){return e[e.length-1]}function Je(e){return k(_r(e))?e.pop():void 0}function Ae(e){return Kt(_r(e))?e.pop():void 0}function Qt(e,t){return typeof _r(e)=="number"?e.pop():t}var dt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Yt(e){return k(e==null?void 0:e.then)}function Bt(e){return k(e[ft])}function Gt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Jt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Di(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Xt=Di();function Zt(e){return k(e==null?void 0:e[Xt])}function er(e){return ao(this,arguments,function(){var r,o,n,i;return Ut(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,ot(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,ot(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,ot(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function tr(e){return k(e==null?void 0:e.getReader)}function N(e){if(e instanceof j)return e;if(e!=null){if(Bt(e))return Ni(e);if(dt(e))return Vi(e);if(Yt(e))return zi(e);if(Gt(e))return Eo(e);if(Zt(e))return qi(e);if(tr(e))return Ki(e)}throw Jt(e)}function Ni(e){return new j(function(t){var r=e[ft]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Vi(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):ce,ye(1),r?Qe(t):jo(function(){return new or}))}}function $r(e){return e<=0?function(){return L}:x(function(t,r){var o=[];t.subscribe(S(r,function(n){o.push(n),e=2,!0))}function le(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,c=s===void 0?!0:s;return function(p){var l,f,u,h=0,w=!1,A=!1,Z=function(){f==null||f.unsubscribe(),f=void 0},te=function(){Z(),l=u=void 0,w=A=!1},J=function(){var C=l;te(),C==null||C.unsubscribe()};return x(function(C,ct){h++,!A&&!w&&Z();var Ne=u=u!=null?u:r();ct.add(function(){h--,h===0&&!A&&!w&&(f=Pr(J,c))}),Ne.subscribe(ct),!l&&h>0&&(l=new it({next:function(Pe){return Ne.next(Pe)},error:function(Pe){A=!0,Z(),f=Pr(te,n,Pe),Ne.error(Pe)},complete:function(){w=!0,Z(),f=Pr(te,a),Ne.complete()}}),N(C).subscribe(l))})(p)}}function Pr(e,t){for(var r=[],o=2;oe.next(document)),e}function R(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=me(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function me(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var la=T(d(document.body,"focusin"),d(document.body,"focusout")).pipe(be(1),q(void 0),m(()=>Re()||document.body),B(1));function vt(e){return la.pipe(m(t=>e.contains(t)),Y())}function Vo(e,t){return T(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?be(t):ce,q(!1))}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function zo(e){return T(d(window,"load"),d(window,"resize")).pipe(Me(0,de),m(()=>Ue(e)),q(Ue(e)))}function ir(e){return{x:e.scrollLeft,y:e.scrollTop}}function et(e){return T(d(e,"scroll"),d(window,"resize")).pipe(Me(0,de),m(()=>ir(e)),q(ir(e)))}function qo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)qo(e,r)}function E(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)qo(o,n);return o}function ar(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function gt(e){let t=E("script",{src:e});return H(()=>(document.head.appendChild(t),T(d(t,"load"),d(t,"error").pipe(v(()=>Ar(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),ye(1))))}var Ko=new g,ma=H(()=>typeof ResizeObserver=="undefined"?gt("https://unpkg.com/resize-observer-polyfill"):$(void 0)).pipe(m(()=>new ResizeObserver(e=>{for(let t of e)Ko.next(t)})),v(e=>T(qe,$(e)).pipe(_(()=>e.disconnect()))),B(1));function pe(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Ee(e){return ma.pipe(y(t=>t.observe(e)),v(t=>Ko.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(()=>pe(e)))),q(pe(e)))}function xt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function sr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var Qo=new g,fa=H(()=>$(new IntersectionObserver(e=>{for(let t of e)Qo.next(t)},{threshold:0}))).pipe(v(e=>T(qe,$(e)).pipe(_(()=>e.disconnect()))),B(1));function yt(e){return fa.pipe(y(t=>t.observe(e)),v(t=>Qo.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function Yo(e,t=16){return et(e).pipe(m(({y:r})=>{let o=pe(e),n=xt(e);return r>=n.height-o.height-t}),Y())}var cr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function Bo(e){return cr[e].checked}function Be(e,t){cr[e].checked!==t&&cr[e].click()}function We(e){let t=cr[e];return d(t,"change").pipe(m(()=>t.checked),q(t.checked))}function ua(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function da(){return T(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(q(!1))}function Go(){let e=d(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:Bo("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!ua(o,r)}return!0}),le());return da().pipe(v(t=>t?L:e))}function ve(){return new URL(location.href)}function st(e,t=!1){if(G("navigation.instant")&&!t){let r=E("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function Jo(){return new g}function Xo(){return location.hash.slice(1)}function Zo(e){let t=E("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function ha(e){return T(d(window,"hashchange"),e).pipe(m(Xo),q(Xo()),b(t=>t.length>0),B(1))}function en(e){return ha(e).pipe(m(t=>me(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function At(e){let t=matchMedia(e);return nr(r=>t.addListener(()=>r(t.matches))).pipe(q(t.matches))}function tn(){let e=matchMedia("print");return T(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(q(e.matches))}function Ur(e,t){return e.pipe(v(r=>r?t():L))}function Wr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function De(e,t){return Wr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),B(1))}function rn(e,t){let r=new DOMParser;return Wr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),B(1))}function on(e,t){let r=new DOMParser;return Wr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),B(1))}function nn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function an(){return T(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(nn),q(nn()))}function sn(){return{width:innerWidth,height:innerHeight}}function cn(){return d(window,"resize",{passive:!0}).pipe(m(sn),q(sn()))}function pn(){return Q([an(),cn()]).pipe(m(([e,t])=>({offset:e,size:t})),B(1))}function pr(e,{viewport$:t,header$:r}){let o=t.pipe(X("size")),n=Q([o,r]).pipe(m(()=>Ue(e)));return Q([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:c,y:p}])=>({offset:{x:a.x-c,y:a.y-p+i},size:s})))}function ba(e){return d(e,"message",t=>t.data)}function va(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function ln(e,t=new Worker(e)){let r=ba(t),o=va(t),n=new g;n.subscribe(o);let i=o.pipe(ee(),oe(!0));return n.pipe(ee(),$e(r.pipe(U(i))),le())}var ga=P("#__config"),Et=JSON.parse(ga.textContent);Et.base=`${new URL(Et.base,ve())}`;function we(){return Et}function G(e){return Et.features.includes(e)}function ge(e,t){return typeof t!="undefined"?Et.translations[e].replace("#",t.toString()):Et.translations[e]}function Te(e,t=document){return P(`[data-md-component=${e}]`,t)}function ie(e,t=document){return R(`[data-md-component=${e}]`,t)}function xa(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function mn(e){if(!G("announce.dismiss")||!e.childElementCount)return L;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return H(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),xa(e).pipe(y(r=>t.next(r)),_(()=>t.complete()),m(r=>F({ref:e},r)))})}function ya(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function fn(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),ya(e,t).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))}function Ct(e,t){return t==="inline"?E("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},E("div",{class:"md-tooltip__inner md-typeset"})):E("div",{class:"md-tooltip",id:e,role:"tooltip"},E("div",{class:"md-tooltip__inner md-typeset"}))}function un(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return E("aside",{class:"md-annotation",tabIndex:0},Ct(t),E("a",{href:r,class:"md-annotation__index",tabIndex:-1},E("span",{"data-md-annotation-id":e})))}else return E("aside",{class:"md-annotation",tabIndex:0},Ct(t),E("span",{class:"md-annotation__index",tabIndex:-1},E("span",{"data-md-annotation-id":e})))}function dn(e){return E("button",{class:"md-clipboard md-icon",title:ge("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function Dr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(c=>!e.terms[c]).reduce((c,p)=>[...c,E("del",null,p)," "],[]).slice(0,-1),i=we(),a=new URL(e.location,i.base);G("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,c])=>c).reduce((c,[p])=>`${c} ${p}`.trim(),""));let{tags:s}=we();return E("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},E("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&E("div",{class:"md-search-result__icon md-icon"}),r>0&&E("h1",null,e.title),r<=0&&E("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(c=>{let p=s?c in s?`md-tag-icon md-tag--${s[c]}`:"md-tag-icon":"";return E("span",{class:`md-tag ${p}`},c)}),o>0&&n.length>0&&E("p",{class:"md-search-result__terms"},ge("search.result.term.missing"),": ",...n)))}function hn(e){let t=e[0].score,r=[...e],o=we(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreDr(l,1)),...c.length?[E("details",{class:"md-search-result__more"},E("summary",{tabIndex:-1},E("div",null,c.length>0&&c.length===1?ge("search.result.more.one"):ge("search.result.more.other",c.length))),...c.map(l=>Dr(l,1)))]:[]];return E("li",{class:"md-search-result__item"},p)}function bn(e){return E("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>E("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?ar(r):r)))}function Nr(e){let t=`tabbed-control tabbed-control--${e}`;return E("div",{class:t,hidden:!0},E("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function vn(e){return E("div",{class:"md-typeset__scrollwrap"},E("div",{class:"md-typeset__table"},e))}function Ea(e){let t=we(),r=new URL(`../${e.version}/`,t.base);return E("li",{class:"md-version__item"},E("a",{href:`${r}`,class:"md-version__link"},e.title))}function gn(e,t){return e=e.filter(r=>{var o;return!((o=r.properties)!=null&&o.hidden)}),E("div",{class:"md-version"},E("button",{class:"md-version__current","aria-label":ge("select.version")},t.title),E("ul",{class:"md-version__list"},e.map(Ea)))}var wa=0;function Ta(e,t){document.body.append(e);let{width:r}=pe(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=sr(t),n=typeof o!="undefined"?et(o):$({x:0,y:0}),i=T(vt(t),Vo(t)).pipe(Y());return Q([i,n]).pipe(m(([a,s])=>{let{x:c,y:p}=Ue(t),l=pe(t),f=t.closest("table");return f&&t.parentElement&&(c+=f.offsetLeft+t.parentElement.offsetLeft,p+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:c-s.x+l.width/2-r/2,y:p-s.y+l.height+8}}}))}function Ge(e){let t=e.title;if(!t.length)return L;let r=`__tooltip_${wa++}`,o=Ct(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,H(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),T(i.pipe(b(({active:a})=>a)),i.pipe(be(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,de)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(_t(125,de),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ta(o,e).pipe(y(a=>i.next(a)),_(()=>i.complete()),m(a=>F({ref:e},a)))}).pipe(ze(ae))}function Sa(e,t){let r=H(()=>Q([zo(e),et(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=pe(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return vt(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),ye(+!o||1/0))))}function xn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return H(()=>{let i=new g,a=i.pipe(ee(),oe(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),yt(e).pipe(U(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),T(i.pipe(b(({active:s})=>s)),i.pipe(be(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,de)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(_t(125,de),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),d(n,"mousedown").pipe(U(a),ne(i)).subscribe(([s,{active:c}])=>{var p;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(c){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(p=Re())==null||p.blur()}}),r.pipe(U(a),b(s=>s===o),Ye(125)).subscribe(()=>e.focus()),Sa(e,t).pipe(y(s=>i.next(s)),_(()=>i.complete()),m(s=>F({ref:e},s)))})}function Oa(e){return e.tagName==="CODE"?R(".c, .c1, .cm",e):[e]}function Ma(e){let t=[];for(let r of Oa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,c]=a;if(typeof c=="undefined"){let p=i.splitText(a.index);i=p.splitText(s.length),t.push(p)}else{i.textContent=s,t.push(i);break}}}}return t}function yn(e,t){t.append(...Array.from(e.childNodes))}function lr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Ma(t)){let[,c]=s.textContent.match(/\((\d+)\)/);me(`:scope > li:nth-child(${c})`,e)&&(a.set(c,un(c,i)),s.replaceWith(a.get(c)))}return a.size===0?L:H(()=>{let s=new g,c=s.pipe(ee(),oe(!0)),p=[];for(let[l,f]of a)p.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(c)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of p)l?yn(f,u):yn(u,f)}),T(...[...a].map(([,l])=>xn(l,t,{target$:r}))).pipe(_(()=>s.complete()),le())})}function En(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return En(t)}}function wn(e,t){return H(()=>{let r=En(e);return typeof r!="undefined"?lr(r,e,t):L})}var Tn=jt(zr());var La=0;function Sn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Sn(t)}}function _a(e){return Ee(e).pipe(m(({width:t})=>({scrollable:xt(e).width>t})),X("scrollable"))}function On(e,t){let{matches:r}=matchMedia("(hover)"),o=H(()=>{let n=new g,i=n.pipe($r(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Tn.default.isSupported()&&(e.closest(".copy")||G("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${La++}`;let p=dn(c.id);c.insertBefore(p,e),G("content.tooltips")&&a.push(Ge(p))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=Sn(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||G("content.code.annotate"))){let p=lr(c,e,t);a.push(Ee(s).pipe(U(i),m(({width:l,height:f})=>l&&f),Y(),v(l=>l?p:L)))}}return _a(e).pipe(y(c=>n.next(c)),_(()=>n.complete()),m(c=>F({ref:e},c)),$e(...a))});return G("content.lazy")?yt(e).pipe(b(n=>n),ye(1),v(()=>o)):o}function Aa(e,{target$:t,print$:r}){let o=!0;return T(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),y(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Mn(e,t){return H(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Aa(e,t).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))})}var Ln=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var qr,ka=0;function Ha(){return typeof mermaid=="undefined"||mermaid instanceof Element?gt("https://unpkg.com/mermaid@10.7.0/dist/mermaid.min.js"):$(void 0)}function _n(e){return e.classList.remove("mermaid"),qr||(qr=Ha().pipe(y(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Ln,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),B(1))),qr.subscribe(()=>ro(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${ka++}`,r=E("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),qr.pipe(m(()=>({ref:e})))}var An=E("table");function Cn(e){return e.replaceWith(An),An.replaceWith(vn(e)),$({ref:e})}function $a(e){let t=e.find(r=>r.checked)||e[0];return T(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function kn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=R(":scope > input",e),i=Nr("prev");e.append(i);let a=Nr("next");return e.append(a),H(()=>{let s=new g,c=s.pipe(ee(),oe(!0));Q([s,Ee(e)]).pipe(U(c),Me(1,de)).subscribe({next([{active:p},l]){let f=Ue(p),{width:u}=pe(p);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=ir(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),Q([et(o),Ee(o)]).pipe(U(c)).subscribe(([p,l])=>{let f=xt(o);i.hidden=p.x<16,a.hidden=p.x>f.width-l.width-16}),T(d(i,"click").pipe(m(()=>-1)),d(a,"click").pipe(m(()=>1))).pipe(U(c)).subscribe(p=>{let{width:l}=pe(o);o.scrollBy({left:l*p,behavior:"smooth"})}),r.pipe(U(c),b(p=>n.includes(p))).subscribe(p=>p.click()),o.classList.add("tabbed-labels--linked");for(let p of n){let l=P(`label[for="${p.id}"]`);l.replaceChildren(E("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(c),b(f=>!(f.metaKey||f.ctrlKey)),y(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return G("content.tabs.link")&&s.pipe(Le(1),ne(t)).subscribe(([{active:p},{offset:l}])=>{let f=p.innerText.trim();if(p.hasAttribute("data-md-switching"))p.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of R("[data-tabs]"))for(let A of R(":scope > input",w)){let Z=P(`label[for="${A.id}"]`);if(Z!==p&&Z.innerText.trim()===f){Z.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),s.pipe(U(c)).subscribe(()=>{for(let p of R("audio, video",e))p.pause()}),$a(n).pipe(y(p=>s.next(p)),_(()=>s.complete()),m(p=>F({ref:e},p)))}).pipe(ze(ae))}function Hn(e,{viewport$:t,target$:r,print$:o}){return T(...R(".annotate:not(.highlight)",e).map(n=>wn(n,{target$:r,print$:o})),...R("pre:not(.mermaid) > code",e).map(n=>On(n,{target$:r,print$:o})),...R("pre.mermaid",e).map(n=>_n(n)),...R("table:not([class])",e).map(n=>Cn(n)),...R("details",e).map(n=>Mn(n,{target$:r,print$:o})),...R("[data-tabs]",e).map(n=>kn(n,{viewport$:t,target$:r})),...R("[title]",e).filter(()=>G("content.tooltips")).map(n=>Ge(n)))}function Ra(e,{alert$:t}){return t.pipe(v(r=>T($(!0),$(!1).pipe(Ye(2e3))).pipe(m(o=>({message:r,active:o})))))}function $n(e,t){let r=P(".md-typeset",e);return H(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ra(e,t).pipe(y(n=>o.next(n)),_(()=>o.complete()),m(n=>F({ref:e},n)))})}function Pa({viewport$:e}){if(!G("header.autohide"))return $(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ke(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),Y()),o=We("search");return Q([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),Y(),v(n=>n?r:$(!1)),q(!1))}function Rn(e,t){return H(()=>Q([Ee(e),Pa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),Y((r,o)=>r.height===o.height&&r.hidden===o.hidden),B(1))}function Pn(e,{header$:t,main$:r}){return H(()=>{let o=new g,n=o.pipe(ee(),oe(!0));o.pipe(X("active"),je(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=fe(R("[title]",e)).pipe(b(()=>G("content.tooltips")),re(a=>Ge(a)));return r.subscribe(o),t.pipe(U(n),m(a=>F({ref:e},a)),$e(i.pipe(U(n))))})}function Ia(e,{viewport$:t,header$:r}){return pr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=pe(e);return{active:o>=n}}),X("active"))}function In(e,t){return H(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=me(".md-content h1");return typeof o=="undefined"?L:Ia(o,t).pipe(y(n=>r.next(n)),_(()=>r.complete()),m(n=>F({ref:e},n)))})}function Fn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),Y()),n=o.pipe(v(()=>Ee(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),X("bottom"))));return Q([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:c},size:{height:p}}])=>(p=Math.max(0,p-Math.max(0,a-c,i)-Math.max(0,p+c-s)),{offset:a-i,height:p,active:a-i<=c})),Y((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Fa(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return $(...e).pipe(re(o=>d(o,"change").pipe(m(()=>o))),q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),B(1))}function jn(e){let t=R("input",e),r=E("meta",{name:"theme-color"});document.head.appendChild(r);let o=E("meta",{name:"color-scheme"});document.head.appendChild(o);let n=At("(prefers-color-scheme: light)");return H(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=c.getAttribute("data-md-color-scheme"),a.color.primary=c.getAttribute("data-md-color-primary"),a.color.accent=c.getAttribute("data-md-color-accent")}for(let[s,c]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,c);for(let s=0;sa.key==="Enter"),ne(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Te("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(Oe(ae)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Fa(t).pipe(U(n.pipe(Le(1))),at(),y(a=>i.next(a)),_(()=>i.complete()),m(a=>F({ref:e},a)))})}function Un(e,{progress$:t}){return H(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(y(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Kr=jt(zr());function ja(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Wn({alert$:e}){Kr.default.isSupported()&&new j(t=>{new Kr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ja(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(y(t=>{t.trigger.focus()}),m(()=>ge("clipboard.copied"))).subscribe(e)}function Dn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ua(e,t){let r=new Map;for(let o of R("url",e)){let n=P("loc",o),i=[Dn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of R("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(Dn(new URL(s),t))}}return r}function mr(e){return on(new URL("sitemap.xml",e)).pipe(m(t=>Ua(t,new URL(e))),he(()=>$(new Map)))}function Wa(e,t){if(!(e.target instanceof Element))return L;let r=e.target.closest("a");if(r===null)return L;if(r.target||e.metaKey||e.ctrlKey)return L;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),$(new URL(r.href))):L}function Nn(e){let t=new Map;for(let r of R(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Vn(e){for(let t of R("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return $(e)}function Da(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...G("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=me(o),i=me(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Nn(document);for(let[o,n]of Nn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Te("container");return Fe(R("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),L}),ee(),oe(document))}function zn({location$:e,viewport$:t,progress$:r}){let o=we();if(location.protocol==="file:")return L;let n=mr(o.base);$(document).subscribe(Vn);let i=d(document.body,"click").pipe(je(n),v(([c,p])=>Wa(c,p)),le()),a=d(window,"popstate").pipe(m(ve),le());i.pipe(ne(t)).subscribe(([c,{offset:p}])=>{history.replaceState(p,""),history.pushState(null,"",c)}),T(i,a).subscribe(e);let s=e.pipe(X("pathname"),v(c=>rn(c,{progress$:r}).pipe(he(()=>(st(c,!0),L)))),v(Vn),v(Da),le());return T(s.pipe(ne(e,(c,p)=>p)),e.pipe(X("pathname"),v(()=>e),X("hash")),e.pipe(Y((c,p)=>c.pathname===p.pathname&&c.hash===p.hash),v(()=>i),y(()=>history.back()))).subscribe(c=>{var p,l;history.state!==null||!c.hash?window.scrollTo(0,(l=(p=history.state)==null?void 0:p.y)!=null?l:0):(history.scrollRestoration="auto",Zo(c.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(X("offset"),be(100)).subscribe(({offset:c})=>{history.replaceState(c,"")}),s}var Qn=jt(Kn());function Yn(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,Qn.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function Ht(e){return e.type===1}function fr(e){return e.type===3}function Bn(e,t){let r=ln(e);return T($(location.protocol!=="file:"),We("search")).pipe(He(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:G("search.suggest")}}})),r}function Gn({document$:e}){let t=we(),r=De(new URL("../versions.json",t.base)).pipe(he(()=>L)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>d(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),ne(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let c=s.href;return!i.target.closest(".md-version")&&n.get(c)===a?L:(i.preventDefault(),$(c))}}return L}),v(i=>{let{version:a}=n.get(i);return mr(new URL(i)).pipe(m(s=>{let p=ve().href.replace(t.base,"");return s.has(p.split("#")[0])?new URL(`../${a}/${p}`,t.base):new URL(i)}))})))).subscribe(n=>st(n,!0)),Q([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(gn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let c of s)for(let p of n.aliases.concat(n.version))if(new RegExp(c,"i").test(p)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ie("outdated"))s.hidden=!1})}function Ka(e,{worker$:t}){let{searchParams:r}=ve();r.has("q")&&(Be("search",!0),e.value=r.get("q"),e.focus(),We("search").pipe(He(i=>!i)).subscribe(()=>{let i=ve();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=vt(e),n=T(t.pipe(He(Ht)),d(e,"keyup"),o).pipe(m(()=>e.value),Y());return Q([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),B(1))}function Jn(e,{worker$:t}){let r=new g,o=r.pipe(ee(),oe(!0));Q([t.pipe(He(Ht)),r],(i,a)=>a).pipe(X("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(X("focus")).subscribe(({focus:i})=>{i&&Be("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),Ka(e,{worker$:t}).pipe(y(i=>r.next(i)),_(()=>r.complete()),m(i=>F({ref:e},i)),B(1))}function Xn(e,{worker$:t,query$:r}){let o=new g,n=Yo(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=P(":scope > :first-child",e),s=P(":scope > :last-child",e);We("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(ne(r),Ir(t.pipe(He(Ht)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?ge("search.result.none"):ge("search.result.placeholder");break;case 1:a.textContent=ge("search.result.one");break;default:let u=ar(l.length);a.textContent=ge("search.result.other",u)}});let c=o.pipe(y(()=>s.innerHTML=""),v(({items:l})=>T($(...l.slice(0,10)),$(...l.slice(10)).pipe(Ke(4),jr(n),v(([f])=>f)))),m(hn),le());return c.subscribe(l=>s.appendChild(l)),c.pipe(re(l=>{let f=me("details",l);return typeof f=="undefined"?L:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(fr),m(({data:l})=>l)).pipe(y(l=>o.next(l)),_(()=>o.complete()),m(l=>F({ref:e},l)))}function Qa(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ve();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function Zn(e,t){let r=new g,o=r.pipe(ee(),oe(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),Qa(e,t).pipe(y(n=>r.next(n)),_(()=>r.complete()),m(n=>F({ref:e},n)))}function ei(e,{worker$:t,keyboard$:r}){let o=new g,n=Te("search-query"),i=T(d(n,"keydown"),d(n,"focus")).pipe(Oe(ae),m(()=>n.value),Y());return o.pipe(je(i),m(([{suggest:s},c])=>{let p=c.split(/([\s-]+)/);if(s!=null&&s.length&&p[p.length-1]){let l=s[s.length-1];l.startsWith(p[p.length-1])&&(p[p.length-1]=l)}else p.length=0;return p})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(fr),m(({data:s})=>s)).pipe(y(s=>o.next(s)),_(()=>o.complete()),m(()=>({ref:e})))}function ti(e,{index$:t,keyboard$:r}){let o=we();try{let n=Bn(o.search,t),i=Te("search-query",e),a=Te("search-result",e);d(e,"click").pipe(b(({target:c})=>c instanceof Element&&!!c.closest("a"))).subscribe(()=>Be("search",!1)),r.pipe(b(({mode:c})=>c==="search")).subscribe(c=>{let p=Re();switch(c.type){case"Enter":if(p===i){let l=new Map;for(let f of R(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}c.claim()}break;case"Escape":case"Tab":Be("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof p=="undefined")i.focus();else{let l=[i,...R(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(p))+l.length+(c.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}c.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(b(({mode:c})=>c==="global")).subscribe(c=>{switch(c.type){case"f":case"s":case"/":i.focus(),i.select(),c.claim();break}});let s=Jn(i,{worker$:n});return T(s,Xn(a,{worker$:n,query$:s})).pipe($e(...ie("search-share",e).map(c=>Zn(c,{query$:s})),...ie("search-suggest",e).map(c=>ei(c,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,qe}}function ri(e,{index$:t,location$:r}){return Q([t,r.pipe(q(ve()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>Yn(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let c=s.textContent,p=o(c);p.length>c.length&&n.set(s,p)}for(let[s,c]of n){let{childNodes:p}=E("span",null,c);s.replaceWith(...Array.from(p))}return{ref:e,nodes:n}}))}function Ya(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return Q([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),Y((i,a)=>i.height===a.height&&i.locked===a.locked))}function Qr(e,o){var n=o,{header$:t}=n,r=to(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:a}=Ue(i);return H(()=>{let s=new g,c=s.pipe(ee(),oe(!0)),p=s.pipe(Me(0,de));return p.pipe(ne(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),p.pipe(He()).subscribe(()=>{for(let l of R(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=pe(f);f.scrollTo({top:u-h/2})}}}),fe(R("label[tabindex]",e)).pipe(re(l=>d(l,"click").pipe(Oe(ae),m(()=>l),U(c)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),Ya(e,r).pipe(y(l=>s.next(l)),_(()=>s.complete()),m(l=>F({ref:e},l)))})}function oi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Lt(De(`${r}/releases/latest`).pipe(he(()=>L),m(o=>({version:o.tag_name})),Qe({})),De(r).pipe(he(()=>L),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Qe({}))).pipe(m(([o,n])=>F(F({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return De(r).pipe(m(o=>({repositories:o.public_repos})),Qe({}))}}function ni(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return De(r).pipe(he(()=>L),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Qe({}))}function ii(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return oi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ni(r,o)}return L}var Ba;function Ga(e){return Ba||(Ba=H(()=>{let t=__md_get("__source",sessionStorage);if(t)return $(t);if(ie("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return L}return ii(e.href).pipe(y(o=>__md_set("__source",o,sessionStorage)))}).pipe(he(()=>L),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),B(1)))}function ai(e){let t=P(":scope > :last-child",e);return H(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(bn(o)),t.classList.add("md-source__repository--active")}),Ga(e).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))})}function Ja(e,{viewport$:t,header$:r}){return Ee(document.body).pipe(v(()=>pr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),X("hidden"))}function si(e,t){return H(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(G("navigation.tabs.sticky")?$({hidden:!1}):Ja(e,t)).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))})}function Xa(e,{viewport$:t,header$:r}){let o=new Map,n=R(".md-nav__link",e);for(let s of n){let c=decodeURIComponent(s.hash.substring(1)),p=me(`[id="${c}"]`);typeof p!="undefined"&&o.set(s,p)}let i=r.pipe(X("height"),m(({height:s})=>{let c=Te("main"),p=P(":scope > :first-child",c);return s+.8*(p.offsetTop-c.offsetTop)}),le());return Ee(document.body).pipe(X("height"),v(s=>H(()=>{let c=[];return $([...o].reduce((p,[l,f])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=f.tagName;)c.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return p.set([...c=[...c,l]].reverse(),u)},new Map))}).pipe(m(c=>new Map([...c].sort(([,p],[,l])=>p-l))),je(i),v(([c,p])=>t.pipe(Rr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(s.height);for(;f.length;){let[,A]=f[0];if(A-p=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...c]]),Y((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,c])=>({prev:s.map(([p])=>p),next:c.map(([p])=>p)})),q({prev:[],next:[]}),Ke(2,1),m(([s,c])=>s.prev.length{let i=new g,a=i.pipe(ee(),oe(!0));if(i.subscribe(({prev:s,next:c})=>{for(let[p]of c)p.classList.remove("md-nav__link--passed"),p.classList.remove("md-nav__link--active");for(let[p,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",p===s.length-1)}),G("toc.follow")){let s=T(t.pipe(be(1),m(()=>{})),t.pipe(be(250),m(()=>"smooth")));i.pipe(b(({prev:c})=>c.length>0),je(o.pipe(Oe(ae))),ne(s)).subscribe(([[{prev:c}],p])=>{let[l]=c[c.length-1];if(l.offsetHeight){let f=sr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=pe(f);f.scrollTo({top:u-h/2,behavior:p})}}})}return G("navigation.tracking")&&t.pipe(U(a),X("offset"),be(250),Le(1),U(n.pipe(Le(1))),at({delay:250}),ne(i)).subscribe(([,{prev:s}])=>{let c=ve(),p=s[s.length-1];if(p&&p.length){let[l]=p,{hash:f}=new URL(l.href);c.hash!==f&&(c.hash=f,history.replaceState({},"",`${c}`))}else c.hash="",history.replaceState({},"",`${c}`)}),Xa(e,{viewport$:t,header$:r}).pipe(y(s=>i.next(s)),_(()=>i.complete()),m(s=>F({ref:e},s)))})}function Za(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Ke(2,1),m(([a,s])=>a>s&&s>0),Y()),i=r.pipe(m(({active:a})=>a));return Q([i,n]).pipe(m(([a,s])=>!(a&&s)),Y(),U(o.pipe(Le(1))),oe(!0),at({delay:250}),m(a=>({hidden:a})))}function pi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(ee(),oe(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(a),X("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),d(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),Za(e,{viewport$:t,main$:o,target$:n}).pipe(y(s=>i.next(s)),_(()=>i.complete()),m(s=>F({ref:e},s)))}function li({document$:e}){e.pipe(v(()=>R(".md-ellipsis")),re(t=>yt(t).pipe(U(e.pipe(Le(1))),b(r=>r),m(()=>t),ye(1))),b(t=>t.offsetWidth{let r=t.innerText,o=t.closest("a")||t;return o.title=r,Ge(o).pipe(U(e.pipe(Le(1))),_(()=>o.removeAttribute("title")))})).subscribe(),e.pipe(v(()=>R(".md-status")),re(t=>Ge(t))).subscribe()}function mi({document$:e,tablet$:t}){e.pipe(v(()=>R(".md-toggle--indeterminate")),y(r=>{r.indeterminate=!0,r.checked=!1}),re(r=>d(r,"change").pipe(Fr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ne(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function es(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function fi({document$:e}){e.pipe(v(()=>R("[data-md-scrollfix]")),y(t=>t.removeAttribute("data-md-scrollfix")),b(es),re(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function ui({viewport$:e,tablet$:t}){Q([We("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>$(r).pipe(Ye(r?400:100))),ne(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ts(){return location.protocol==="file:"?gt(`${new URL("search/search_index.js",Yr.base)}`).pipe(m(()=>__index),B(1)):De(new URL("search/search_index.json",Yr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var rt=No(),Rt=Jo(),wt=en(Rt),Br=Go(),_e=pn(),ur=At("(min-width: 960px)"),hi=At("(min-width: 1220px)"),bi=tn(),Yr=we(),vi=document.forms.namedItem("search")?ts():qe,Gr=new g;Wn({alert$:Gr});var Jr=new g;G("navigation.instant")&&zn({location$:Rt,viewport$:_e,progress$:Jr}).subscribe(rt);var di;((di=Yr.version)==null?void 0:di.provider)==="mike"&&Gn({document$:rt});T(Rt,wt).pipe(Ye(125)).subscribe(()=>{Be("drawer",!1),Be("search",!1)});Br.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=me("link[rel=prev]");typeof t!="undefined"&&st(t);break;case"n":case".":let r=me("link[rel=next]");typeof r!="undefined"&&st(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});li({document$:rt});mi({document$:rt,tablet$:ur});fi({document$:rt});ui({viewport$:_e,tablet$:ur});var tt=Rn(Te("header"),{viewport$:_e}),$t=rt.pipe(m(()=>Te("main")),v(e=>Fn(e,{viewport$:_e,header$:tt})),B(1)),rs=T(...ie("consent").map(e=>fn(e,{target$:wt})),...ie("dialog").map(e=>$n(e,{alert$:Gr})),...ie("header").map(e=>Pn(e,{viewport$:_e,header$:tt,main$:$t})),...ie("palette").map(e=>jn(e)),...ie("progress").map(e=>Un(e,{progress$:Jr})),...ie("search").map(e=>ti(e,{index$:vi,keyboard$:Br})),...ie("source").map(e=>ai(e))),os=H(()=>T(...ie("announce").map(e=>mn(e)),...ie("content").map(e=>Hn(e,{viewport$:_e,target$:wt,print$:bi})),...ie("content").map(e=>G("search.highlight")?ri(e,{index$:vi,location$:Rt}):L),...ie("header-title").map(e=>In(e,{viewport$:_e,header$:tt})),...ie("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Ur(hi,()=>Qr(e,{viewport$:_e,header$:tt,main$:$t})):Ur(ur,()=>Qr(e,{viewport$:_e,header$:tt,main$:$t}))),...ie("tabs").map(e=>si(e,{viewport$:_e,header$:tt})),...ie("toc").map(e=>ci(e,{viewport$:_e,header$:tt,main$:$t,target$:wt})),...ie("top").map(e=>pi(e,{viewport$:_e,header$:tt,main$:$t,target$:wt})))),gi=rt.pipe(v(()=>os),$e(rs),B(1));gi.subscribe();window.document$=rt;window.location$=Rt;window.target$=wt;window.keyboard$=Br;window.viewport$=_e;window.tablet$=ur;window.screen$=hi;window.print$=bi;window.alert$=Gr;window.progress$=Jr;window.component$=gi;})(); +//# sourceMappingURL=bundle.1e8ae164.min.js.map + diff --git a/assets/javascripts/bundle.1e8ae164.min.js.map b/assets/javascripts/bundle.1e8ae164.min.js.map new file mode 100644 index 00000000000..6c33b8e8e67 --- /dev/null +++ b/assets/javascripts/bundle.1e8ae164.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an