Source code for kedro.contrib.io.networkx.networkx_local

# Copyright 2020 QuantumBlack Visual Analytics Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
# NONINFRINGEMENT. IN NO EVENT WILL THE LICENSOR OR OTHER CONTRIBUTORS
# BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
# The QuantumBlack Visual Analytics Limited ("QuantumBlack") name and logo
# (either separately or in combination, "QuantumBlack Trademarks") are
# trademarks of QuantumBlack. The License does not grant you any right or
# license to the QuantumBlack Trademarks. You may not use the QuantumBlack
# Trademarks or any confusingly similar mark as a trademark for your product,
#     or use the QuantumBlack Trademarks in any other manner that might cause
# confusion in the marketplace, including but not limited to in advertising,
# on websites, or on software.
#
# See the License for the specific language governing permissions and
# limitations under the License.


"""``NetworkXLocalDataSet`` loads and saves graphs to a local JSON file format using ``NetworkX``.
"""

import json
from pathlib import Path
from typing import Any, Dict

import networkx

from kedro.contrib.io import DefaultArgumentsMixIn
from kedro.io import AbstractVersionedDataSet, Version
from kedro.io.core import deprecation_warning


[docs]class NetworkXLocalDataSet(DefaultArgumentsMixIn, AbstractVersionedDataSet): """``NetworkXLocalDataSet`` loads and saves graphs to a local JSON file format using ``NetworkX``. See https://networkx.github.io/documentation/stable/tutorial.html for details. Example: :: >>> from kedro.contrib.io.networkx import NetworkXLocalDataSet >>> import networkx as nx >>> graph = nx.complete_graph(100) >>> graph_dataset = NetworkXLocalDataSet(filepath="test.json") >>> graph_dataset.save(graph) >>> reloaded = graph_dataset.load() >>> assert nx.is_isomorphic(graph, reloaded) """
[docs] def __init__( self, filepath: str, load_args: Dict[str, Any] = None, save_args: Dict[str, Any] = None, version: Version = None, ) -> None: """Creates a new instance of ``NetworkXLocalDataSet``. Args: filepath: The path to the NetworkX graph JSON file. load_args: Arguments passed on to ```networkx.node_link_graph``. See the details in https://networkx.github.io/documentation/networkx-1.9.1/reference/generated/networkx.readwrite.json_graph.node_link_graph.html save_args: Arguments passed on to ```networkx.node_link_data``. See the details in https://networkx.github.io/documentation/networkx-1.9.1/reference/generated/networkx.readwrite.json_graph.node_link_data.html version: If specified, should be an instance of ``kedro.io.core.Version``. If its ``load`` attribute is None, the latest version will be loaded. If its ``save`` attribute is None, save version will be autogenerated. """ deprecation_warning(self.__class__.__name__) super().__init__( filepath=Path(filepath), load_args=load_args, save_args=save_args, version=version, )
def _load(self) -> networkx.Graph: load_path = Path(self._get_load_path()) json_payload = json.loads(load_path.read_text()) graph = networkx.node_link_graph(json_payload, **self._load_args) return graph def _save(self, data: networkx.Graph) -> None: save_path = Path(self._get_save_path()) save_path.parent.mkdir(parents=True, exist_ok=True) json_graph = networkx.node_link_data(data, **self._save_args) with save_path.open("w") as output_file: json.dump(json_graph, output_file) def _exists(self) -> bool: path = self._get_load_path() return Path(path).is_file() def _describe(self) -> Dict[str, Any]: return dict( filepath=self._filepath, load_args=self._load_args, save_args=self._save_args, version=self._version, )