hydromt.data_catalog.sources.GeoDataFrameSource#
- class hydromt.data_catalog.sources.GeoDataFrameSource(*, name: str, uri: str, data_adapter: ~hydromt.data_catalog.adapters.geodataframe.GeoDataFrameAdapter = <factory>, driver: ~hydromt.data_catalog.drivers.geodataframe.geodataframe_driver.GeoDataFrameDriver, uri_resolver: ~hydromt.data_catalog.uri_resolvers.uri_resolver.URIResolver = <factory>, root: str | None = None, version: str | int | float | None = None, provider: str | None = None, metadata: ~hydromt._typing.metadata.SourceMetadata = <factory>)[source]#
DataSource for GeoDataFrames.
Reads and validates DataCatalog entries.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- __init__(**data: Any) None#
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Methods
__init__(**data)Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])copy(*[, include, exclude, update, deep])Returns a copy of the model.
detect_bbox([gdf])Detect the bounding box and crs of the dataset.
dict(*[, include, exclude, by_alias, ...])from_orm(obj)get_bbox([crs, detect])Return the bounding box and espg code of the dataset.
json(*[, include, exclude, by_alias, ...])model_construct([_fields_set])Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy
model_dump(*[, mode, include, exclude, ...])Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump
model_dump_json(*[, indent, include, ...])Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json
model_json_schema([by_alias, ref_template, ...])Generates a JSON schema for a model class.
model_parametrized_name(params)Compute the class name for parametrizations of generic classes.
model_post_init(context, /)We need to both initialize private attributes and call the user-defined model_post_init method.
model_rebuild(*[, force, raise_errors, ...])Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, ...])Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])Usage docs: https://docs.pydantic.dev/2.10/concepts/json/#json-parsing
model_validate_strings(obj, *[, strict, context])Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])parse_obj(obj)parse_raw(b, *[, content_type, encoding, ...])read_data(*[, bbox, mask, buffer, ...])Use the driver and data adapter to read and harmonize the data.
schema([by_alias, ref_template])schema_json(*[, by_alias, ref_template])summary()Return a summary of the DataSource.
to_file(file_path, *[, driver_override, ...])Write the GeoDataFrameSource to a local file.
to_stac_catalog([handle_nodata])Convert a geodataframe into a STAC Catalog representation.
update_forward_refs(**localns)validate(value)Attributes
data_typefull_uriJoin root with uri.
model_computed_fieldsmodel_configConfiguration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extraGet extra fields set during validation.
model_fieldsmodel_fields_setReturns the set of fields that have been explicitly set on this model instance.
driverdata_adapternameuriuri_resolverrootversionprovidermetadata