kedro.extras.datasets.geopandas.GeoJSONDataSet

class kedro.extras.datasets.geopandas.GeoJSONDataSet(filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None)[source]

Bases: kedro.io.core.AbstractVersionedDataSet

GeoJSONDataSet loads/saves data to a GeoJSON file using an underlying filesystem (eg: local, S3, GCS). The underlying functionality is supported by geopandas, so it supports all allowed geopandas (pandas) options for loading and saving GeoJSON files.

Example:

import geopandas as gpd
from shapely.geometry import Point
from kedro.extras.datasets.geopandas import GeoJSONDataSet

data = gpd.GeoDataFrame({'col1': [1, 2], 'col2': [4, 5],
                     'col3': [5, 6]}, geometry=[Point(1,1), Point(2,4)])
# data_set = GeoJSONDataSet(filepath="gcs://bucket/test.geojson",
                               save_args=None)
data_set = GeoJSONDataSet(filepath="test.geojson",
                               save_args=None)
data_set.save(data)
reloaded = data_set.load()

assert data.equals(reloaded)

Attributes

GeoJSONDataSet.DEFAULT_LOAD_ARGS

GeoJSONDataSet.DEFAULT_SAVE_ARGS

Methods

GeoJSONDataSet.exists()

Checks whether a data set’s output already exists by calling the provided _exists() method.

GeoJSONDataSet.from_config(name, config[, …])

Create a data set instance using the configuration provided.

GeoJSONDataSet.invalidate_cache()

Invalidate underlying filesystem cache.

GeoJSONDataSet.load()

Loads data by delegation to the provided load method.

GeoJSONDataSet.release()

Release any cached data.

GeoJSONDataSet.resolve_load_version()

Compute the version the dataset should be loaded with.

GeoJSONDataSet.resolve_save_version()

Compute the version the dataset should be saved with.

GeoJSONDataSet.save(data)

Saves data by delegation to the provided save method.
DEFAULT_LOAD_ARGS: Dict[str, Any] = {}
DEFAULT_SAVE_ARGS = {'driver': 'GeoJSON'}
__init__(filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None)[source]

Creates a new instance of GeoJSONDataSet pointing to a concrete GeoJSON file on a specific filesystem fsspec.

Parameters

  • filepath (str) – Filepath in POSIX format to a GeoJSON file prefixed with a protocol like s3://. If prefix is not provided file protocol (local filesystem) will be used. The prefix should be any protocol supported by fsspec. Note: http(s) doesn’t support versioning.

  • load_args (Optional[Dict[str, Any]]) – GeoPandas options for loading GeoJSON files. Here you can find all available arguments: https://geopandas.org/docs/reference/api/geopandas.read_file.html#geopandas.read_file

  • save_args (Optional[Dict[str, Any]]) – GeoPandas options for saving geojson files. Here you can find all available arguments: https://geopandas.org/docs/reference/api/geopandas.GeoDataFrame.to_file.html The default_save_arg driver is ‘GeoJSON’, all others preserved.

  • version (Optional[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

  • credentials (Optional[Dict[str, Any]]) – credentials required to access the underlying filesystem. Eg. for GCFileSystem it would look like {‘token’: None}.

  • fs_args (Optional[Dict[str, Any]]) – Extra arguments to pass into underlying filesystem class constructor (e.g. {“project”: “my-project”} for GCSFileSystem), as well as to pass to the filesystem’s open method through nested keys open_args_load and open_args_save. Here you can find all available arguments for open: https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.spec.AbstractFileSystem.open All defaults are preserved, except mode, which is set to wb when saving.

exists()

Checks whether a data set’s output already exists by calling the provided _exists() method.

Return type

bool

Returns

Flag indicating whether the output already exists.

Raises

DataSetError – when underlying exists method raises error.

classmethod from_config(name, config, load_version=None, save_version=None)

Create a data set instance using the configuration provided.

Parameters

  • name (str) – Data set name.

  • config (Dict[str, Any]) – Data set config dictionary.

  • load_version (Optional[str]) – Version string to be used for load operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.

  • save_version (Optional[str]) – Version string to be used for save operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.

Return type

AbstractDataSet

Returns

An instance of an AbstractDataSet subclass.

Raises

DataSetError – When the function fails to create the data set from its config.

invalidate_cache()[source]

Invalidate underlying filesystem cache.

Return type

None

load()

Loads data by delegation to the provided load method.

Return type

Any

Returns

Data returned by the provided load method.

Raises

DataSetError – When underlying load method raises error.

release()

Release any cached data.

Raises

DataSetError – when underlying release method raises error.

Return type

None

resolve_load_version()

Compute the version the dataset should be loaded with.

Return type

Optional[str]

resolve_save_version()

Compute the version the dataset should be saved with.

Return type

Optional[str]

save(data)

Saves data by delegation to the provided save method.

Parameters

data (Any) – the value to be saved by provided save method.

Raises

DataSetError – when underlying save method raises error.

Return type

None