Source code for dataprocessor.pipes.merge_nodelist

# coding=utf-8

import json

from .. import nodes
from .. import utility


def merge_nodelist(node_list, json_filename):
    """ Merge another node_list.

    Parameters
    ----------
    json_fn : str
        filename of JSON file including another node_list

    Example
    -------
    >>> from tempfile import NamedTemporaryFile
    >>> nl1 = [{
    ...     u"path": u"/path/1",
    ...     u"type": u"run",
    ...     u"children": [u"/path/2"],
    ...     u"parents": [],
    ... }, {
    ...     u"path": u"/path/2",
    ...     u"type": u"run",
    ...     u"children": [],
    ...     u"parents": [u"/path/1"],
    ... }]
    >>> with NamedTemporaryFile(suffix=".json", delete=False) as f:
    ...     json.dump(nl1, f)
    >>> nl2 = [{
    ...     u"path": u"/path/1",
    ...     u"type": u"run",
    ...     u"children": [u"/path/3"],
    ...     u"parents": [],
    ... }, {
    ...     u"path": u"/path/3",
    ...     u"type": u"run",
    ...     u"children": [],
    ...     u"parents": [u"/path/1"],
    ... }]
    >>> nl = merge_nodelist(nl2, f.name)
    >>> nl == [{
    ...     u"path": u"/path/1",
    ...     u"type": u"run",
    ...     u"children": [u"/path/2", u"/path/3"],
    ...     u"parents": [],
    ... }, {
    ...     u"path": u"/path/3",
    ...     u"type": u"run",
    ...     u"children": [],
    ...     u"parents": [u"/path/1"],
    ... }, {
    ...     u"path": u"/path/2",
    ...     u"type": u"run",
    ...     u"children": [],
    ...     u"parents": [u"/path/1"],
    ... }]
    True

    """
    fn = utility.check_file(json_filename)
    with open(fn) as f:
        another_nl = json.load(f)
    for node in another_nl:
        nodes.add(node_list, node,
                  strategy="modest_update",
                  skip_validate_link=True)
    for node in node_list:
        nodes.validate_link(node_list, node, silent=True)
    return node_list


def register(pipes_dics):
    pipes_dics["merge_nodelist"] = {
        "func": merge_nodelist,
        "args": [("json_filename", {
            "help": "path of another JSON file"
        })],
        "kwds": [],
        "desc": "Merge another node_list",
    }