netunicorn.base.nodes.Nodes

class Nodes[source]

Bases: ABC

A base class that represents a pool of nodes. Not to be used directly, but to be inherited from.

Methods

dispatch_and_deserialize

Deserializes a JSON representation of the object and returns an instance of the object.

filter

Returns a pool of nodes that match the given filter function.

from_json

Class-specific implementation of deserialization from JSON.

set_property

Sets a property for all nodes in the pool.

skip

Returns a pool of nodes consisting of the nodes after the first 'count' nodes.

take

Returns a sequence of nodes consisting of the first count nodes.

static dispatch_and_deserialize(data)[source]

Deserializes a JSON representation of the object and returns an instance of the object.

Parameters:

data (NodesRepresentation) – JSON representation of the object

Returns:

Nodes – instance of the object

abstract classmethod from_json(data, metadata=None)[source]

Class-specific implementation of deserialization from JSON.

Parameters:
  • data (List[Union[NodeRepresentation, NodesRepresentation]]) – JSON representation of the object

  • metadata (Optional[Any], default: None) – optional additional information for the pool instantiation

Returns:

Nodes – instance of the object

abstract filter(function)[source]

Returns a pool of nodes that match the given filter function.

Parameters:

function (Callable[[Node], bool]) – filter function returning True if the node should be included in the result

Returns:

Nodes – pool of nodes

abstract take(count)[source]

Returns a sequence of nodes consisting of the first count nodes.

Parameters:

count (int) – number of nodes to take

Returns:

Sequence[Node] – sequence of nodes

abstract skip(count)[source]

Returns a pool of nodes consisting of the nodes after the first ‘count’ nodes.

Parameters:

count (int) – number of nodes to skip

Returns:

Nodes – pool of nodes

abstract set_property(name, value)[source]

Sets a property for all nodes in the pool.

Parameters:
  • name (str) – name of the property

  • value (Union[str, float, int, Set[str], None]) – property value

Returns:

Nodes – self