cutcutcodec.core.edit.operation.remove.remove_nodes

cutcutcodec.core.edit.operation.remove.remove_nodes(graph: MultiDiGraph, nodes: Iterable[str]) → dict[str | tuple[str, str, str], None | tuple[str, str, str]]

Delete several nodes from the graph.

Parameters

graphnetwork.MultiDiGraph

The assembly graph containing the nodes to be deleted. The operations on this graph will be performed in-place.

nodestyping.Iterable[str]

The name of the nodes to delete from the graph.

Returns

transformationsdict

Each old edge or node name is associated with its new name. If the new name is None, it means that the element has been deleted. This allows to be informed of all the operations performed.

Raises

KeyError

If one of the nodes is not in the graph.

Examples

>>> from pprint import pprint
>>> from cutcutcodec.core.classes.container import ContainerOutput
>>> from cutcutcodec.core.compilation.tree_to_graph import tree_to_graph
>>> from cutcutcodec.core.edit.operation.remove import remove_nodes
>>> from cutcutcodec.core.io.read_ffmpeg import ContainerInputFFMPEG
>>> from cutcutcodec.utils import get_project_root
>>> media = get_project_root().parent / "media" / "video" / "intro.webm"
>>> with (
...     ContainerInputFFMPEG(media) as container_1,
...     ContainerInputFFMPEG(media) as container_2,
...     ContainerInputFFMPEG(media) as container_3,
... ):
...     tree = ContainerOutput(
...         [*container_1.out_streams, *container_2.out_streams, *container_3.out_streams]
...     )
...
>>> graph = tree_to_graph(tree)
>>> pprint(list(graph.edges))
[('container_input_ffmpeg_1', 'container_output_1', '0->0'),
 ('container_input_ffmpeg_1', 'container_output_1', '1->1'),
 ('container_input_ffmpeg_1', 'container_output_1', '2->2'),
 ('container_input_ffmpeg_1', 'container_output_1', '3->3'),
 ('container_input_ffmpeg_2', 'container_output_1', '0->4'),
 ('container_input_ffmpeg_2', 'container_output_1', '1->5'),
 ('container_input_ffmpeg_2', 'container_output_1', '2->6'),
 ('container_input_ffmpeg_2', 'container_output_1', '3->7'),
 ('container_input_ffmpeg_3', 'container_output_1', '0->8'),
 ('container_input_ffmpeg_3', 'container_output_1', '1->9'),
 ('container_input_ffmpeg_3', 'container_output_1', '2->10'),
 ('container_input_ffmpeg_3', 'container_output_1', '3->11')]
>>> pprint(list(graph.nodes))
['container_output_1',
 'container_input_ffmpeg_1',
 'container_input_ffmpeg_2',
 'container_input_ffmpeg_3']
>>> pprint(remove_nodes(graph, ["container_input_ffmpeg_1", "container_input_ffmpeg_2"]))
{'container_input_ffmpeg_1': None,
 'container_input_ffmpeg_2': None,
 ('container_input_ffmpeg_1', 'container_output_1', '0->0'): None,
 ('container_input_ffmpeg_1', 'container_output_1', '1->1'): None,
 ('container_input_ffmpeg_1', 'container_output_1', '2->2'): None,
 ('container_input_ffmpeg_1', 'container_output_1', '3->3'): None,
 ('container_input_ffmpeg_2', 'container_output_1', '0->4'): None,
 ('container_input_ffmpeg_2', 'container_output_1', '1->5'): None,
 ('container_input_ffmpeg_2', 'container_output_1', '2->6'): None,
 ('container_input_ffmpeg_2', 'container_output_1', '3->7'): None,
 ('container_input_ffmpeg_3', 'container_output_1', '0->8'): ('container_input_ffmpeg_3',
                                                              'container_output_1',
                                                              '0->0'),
 ('container_input_ffmpeg_3', 'container_output_1', '1->9'): ('container_input_ffmpeg_3',
                                                              'container_output_1',
                                                              '1->1'),
 ('container_input_ffmpeg_3', 'container_output_1', '2->10'): ('container_input_ffmpeg_3',
                                                               'container_output_1',
                                                               '2->2'),
 ('container_input_ffmpeg_3', 'container_output_1', '3->11'): ('container_input_ffmpeg_3',
                                                               'container_output_1',
                                                               '3->3')}
>>> pprint(list(graph.edges))
[('container_input_ffmpeg_3', 'container_output_1', '0->0'),
 ('container_input_ffmpeg_3', 'container_output_1', '1->1'),
 ('container_input_ffmpeg_3', 'container_output_1', '2->2'),
 ('container_input_ffmpeg_3', 'container_output_1', '3->3')]
>>> pprint(list(graph.nodes))
['container_output_1', 'container_input_ffmpeg_3']
>>>