Interface

`interface`

Package containing a repo_factory that provides an interface to data sources following the repository pattern.

Example

A XPlangGML 6.0 file can be loaded like this:

repo = repo_factory("xplan.gml", "6.0", "xplan")
collection = repo.get_all()

`repo_factory(datasource='', version=None, data_type='xplan', repo_type=None)`

Factory method for Repositories.

Enables retrieving a collection of plan features from and writing to different files and DB Coretables.

Supported are:

GML
JSON-FG
DB (PostgreSQL, GPKG, SQLite)
Shapefiles

The corresponding wrapper is infered from the datasource input parameter. Currently, only the export to gml functionality of the GMLRepository is supported for INSPIRE data.

Parameters:

Name	Type	Description	Default
`datasource`	`str`	Name of the input source or output file.	`''`
`version`	`str \| None`	Version the plan data.	`None`
`data_type`	`Literal['xplan', 'plu']`	Specification of either xplan or INSPIRE plu.	`'xplan'`
`repo_type`	`Literal['gml', 'jsonfg', 'shape', 'db'] \| None`	Allows to explicitly select a Repository.	`None`

Raises:

Type	Description
`ValueError`	raises error for unknown/unspecified datasource

Returns:

Name	Type	Description
`BaseRepository`	`BaseRepository`	instance of repository class for manipulating a collection of plan features

Source code in xplan_tools/interface/__init__.py

def repo_factory(
    datasource: str = "",
    version: str | None = None,
    data_type: Literal["xplan", "plu"] = "xplan",
    repo_type: Literal["gml", "jsonfg", "shape", "db"] | None = None,
) -> "BaseRepository":
    """Factory method for Repositories.

    Enables retrieving a collection of plan features from and writing to different files and DB Coretables.

    Supported are:

    - GML
    - JSON-FG
    - DB (PostgreSQL, GPKG, SQLite)
    - Shapefiles

    The corresponding wrapper is infered from the datasource input parameter.
    Currently, only the export to gml functionality of the GMLRepository is supported for INSPIRE data.

    Args:
        datasource: Name of the input source or output file.
        version: Version the plan data.
        data_type: Specification of either xplan or INSPIRE plu.
        repo_type: Allows to explicitly select a Repository.

    Raises:
        ValueError: raises error for unknown/unspecified datasource

    Returns:
        BaseRepository: instance of repository class for manipulating a collection of plan features
    """
    if repo_type == "gml" or ".gml" in datasource:
        logger.debug("initializing GML repository")
        return locate("xplan_tools.interface.gml.GMLRepository")(
            datasource, version, data_type
        )
    elif repo_type == "jsonfg" or ".json" in datasource:
        logger.debug("initializing JSON-FG repository")
        return locate("xplan_tools.interface.jsonfg.JsonFGRepository")(
            datasource, version
        )
    elif repo_type == "shape" or ".shp" in datasource:
        return locate("xplan_tools.interface.shape.ShapeRepository")(
            datasource, version
        )
    elif repo_type == "db" or datasource[:4] in ["post", "gpkg", "sqli"]:
        logger.debug("initializing DB repository")
        return locate("xplan_tools.interface.db.DBRepository")(datasource, version)
    else:
        raise ValueError("Unknown datasource")

`BaseRepository(datasource, version=None)`

Bases: Protocol

Abstract base class for specific repositories, which re-implement supported methods for a given data source.

Initialize the Repository.

Parameters:

Name	Type	Description	Default
`datasource`	`str`	Generally a file path or URL. May also accept file-like objects.	required
`version`	`str \| None`	The application schema version.	`None`