Module timvt.layer¶

timvt models.

Variables¶

tile_settings

Classes¶

Function¶

class Function(
    __pydantic_self__,
    **data: Any
)

Function Reader.

Attributes¶

Name	Type	Description	Default
id	str	Layer's name.	None
bounds	list	Layer's bounds (left, bottom, right, top).	None
minzoom	int	Layer's min zoom level.	None
maxzoom	int	Layer's max zoom level.	None
tileurl	str	Layer's tiles url.	None
type	str	Layer's type.	None
function_name	str	Nane of the SQL function to call. Defaults to `id`.	`id`
sql	str	Valid SQL function which returns Tile data.	None
options	list	options available for the SQL function.	None

Ancestors (in MRO)¶

timvt.layer.Layer
pydantic.main.BaseModel
pydantic.utils.Representation

Class variables¶

Config

Static methods¶

construct¶

def construct(
    _fields_set: Union[ForwardRef('SetStr'), NoneType] = None,
    **values: Any
) -> 'Model'

Creates a new model setting dict and fields_set from trusted or pre-validated data.

Default values are respected, but no other validation is performed. Behaves as if Config.extra = 'allow' was set since it adds all passed values

from_file¶

def from_file(
    id: str,
    infile: str,
    **kwargs: Any
)

load sql from file

from_orm¶

def from_orm(
    obj: Any
) -> 'Model'

function_name_default¶

def function_name_default(
    values
)

Define default function's name to be same as id.

parse_file¶

def parse_file(
    path: Union[str, pathlib.Path],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

parse_obj¶

def parse_obj(
    obj: Any
) -> 'Model'

parse_raw¶

def parse_raw(
    b: Union[str, bytes],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

schema¶

def schema(
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}'
) -> 'DictStrAny'

schema_json¶

def schema_json(
    *,
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}',
    **dumps_kwargs: Any
) -> 'unicode'

update_forward_refs¶

def update_forward_refs(
    **localns: Any
) -> None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate¶

def validate(
    value: Any
) -> 'Model'

Methods¶

copy¶

def copy(
    self: 'Model',
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    update: Union[ForwardRef('DictStrAny'), NoneType] = None,
    deep: bool = False
) -> 'Model'

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

Name	Type	Description	Default
include	None	fields to include in new model	None
exclude	None	fields to exclude from new model, as with values this takes precedence over include	None
update	None	values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data	None
deep	None	set to `True` to make a deep copy of the model	None

Returns:

Type	Description
None	new model instance

dict¶

def dict(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False
) -> 'DictStrAny'

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

get_tile¶

def get_tile(
    self,
    pool: buildpg.asyncpg.BuildPgPool,
    tile: morecantile.commons.Tile,
    tms: morecantile.models.TileMatrixSet,
    **kwargs: Any
)

Get Tile Data.

json¶

def json(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    encoder: Union[Callable[[Any], Any], NoneType] = None,
    models_as_dict: bool = True,
    **dumps_kwargs: Any
) -> 'unicode'

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

FunctionRegistry¶

class FunctionRegistry(

)

function registry

Class variables¶

funcs

Static methods¶

get¶

def get(
    key: str
)

lookup function by name

register¶

def register(
    *args: timvt.layer.Function
)

register function(s)

values¶

def values(

)

get all values.

Layer¶

class Layer(
    __pydantic_self__,
    **data: Any
)

Layer's Abstract BaseClass.

Attributes¶

Name	Type	Description	Default
id	str	Layer's name.	None
bounds	list	Layer's bounds (left, bottom, right, top).	None
minzoom	int	Layer's min zoom level.	None
maxzoom	int	Layer's max zoom level.	None
default_tms	str	TileMatrixSet name for the min/max zoom.	None
tileurl	str	Layer's tiles url.	None

Ancestors (in MRO)¶

pydantic.main.BaseModel
pydantic.utils.Representation

Descendants¶

timvt.layer.Table
timvt.layer.Function

Class variables¶

Config

Static methods¶

construct¶

def construct(
    _fields_set: Union[ForwardRef('SetStr'), NoneType] = None,
    **values: Any
) -> 'Model'

Creates a new model setting dict and fields_set from trusted or pre-validated data.

Default values are respected, but no other validation is performed. Behaves as if Config.extra = 'allow' was set since it adds all passed values

from_orm¶

def from_orm(
    obj: Any
) -> 'Model'

parse_file¶

def parse_file(
    path: Union[str, pathlib.Path],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

parse_obj¶

def parse_obj(
    obj: Any
) -> 'Model'

parse_raw¶

def parse_raw(
    b: Union[str, bytes],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

schema¶

def schema(
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}'
) -> 'DictStrAny'

schema_json¶

def schema_json(
    *,
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}',
    **dumps_kwargs: Any
) -> 'unicode'

update_forward_refs¶

def update_forward_refs(
    **localns: Any
) -> None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate¶

def validate(
    value: Any
) -> 'Model'

Methods¶

copy¶

def copy(
    self: 'Model',
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    update: Union[ForwardRef('DictStrAny'), NoneType] = None,
    deep: bool = False
) -> 'Model'

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

Name	Type	Description	Default
include	None	fields to include in new model	None
exclude	None	fields to exclude from new model, as with values this takes precedence over include	None
update	None	values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data	None
deep	None	set to `True` to make a deep copy of the model	None

Returns:

Type	Description
None	new model instance

dict¶

def dict(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False
) -> 'DictStrAny'

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

get_tile¶

def get_tile(
    self,
    pool: buildpg.asyncpg.BuildPgPool,
    tile: morecantile.commons.Tile,
    tms: morecantile.models.TileMatrixSet,
    **kwargs: Any
) -> bytes

Return Tile Data.

Parameters:

Name	Type	Description	Default
pool	asyncpg.BuildPgPool	AsyncPG database connection pool.	None
tile	morecantile.Tile	Tile object with X,Y,Z indices.	None
tms	morecantile.TileMatrixSet	Tile Matrix Set.	None
kwargs	any, optiona	Optional parameters to forward to the SQL function.	None

Returns:

Type	Description
bytes	Mapbox Vector Tiles.

json¶

def json(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    encoder: Union[Callable[[Any], Any], NoneType] = None,
    models_as_dict: bool = True,
    **dumps_kwargs: Any
) -> 'unicode'

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Table¶

class Table(
    __pydantic_self__,
    **data: Any
)

Table Reader.

Attributes¶

Name	Type	Description	Default
id	str	Layer's name.	None
bounds	list	Layer's bounds (left, bottom, right, top).	None
minzoom	int	Layer's min zoom level.	None
maxzoom	int	Layer's max zoom level.	None
tileurl	str	Layer's tiles url.	None
type	str	Layer's type.	None
table	str	Table's name.	None
schema	str	Table's database schema (e.g public).	None
description	str	Table's description.	None
id_column	str	name of id column	None
geometry_columns	list	List of geometry columns.	None
properties	list	List of property columns.	None

Ancestors (in MRO)¶

timvt.layer.Layer
timvt.dbmodel.Table
pydantic.main.BaseModel
pydantic.utils.Representation

Class variables¶

Config

Static methods¶

bounds_default¶

def bounds_default(
    values
)

Get default bounds from the first geometry columns.

construct¶

def construct(
    _fields_set: Union[ForwardRef('SetStr'), NoneType] = None,
    **values: Any
) -> 'Model'

Creates a new model setting dict and fields_set from trusted or pre-validated data.

Default values are respected, but no other validation is performed. Behaves as if Config.extra = 'allow' was set since it adds all passed values

from_orm¶

def from_orm(
    obj: Any
) -> 'Model'

parse_file¶

def parse_file(
    path: Union[str, pathlib.Path],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

parse_obj¶

def parse_obj(
    obj: Any
) -> 'Model'

parse_raw¶

def parse_raw(
    b: Union[str, bytes],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

schema¶

def schema(
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}'
) -> 'DictStrAny'

schema_json¶

def schema_json(
    *,
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}',
    **dumps_kwargs: Any
) -> 'unicode'

update_forward_refs¶

def update_forward_refs(
    **localns: Any
) -> None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate¶

def validate(
    value: Any
) -> 'Model'

Instance variables¶

id_column_info

Return Column for a unique identifier.

Methods¶

columns¶

def columns(
    self,
    properties: Union[List[str], NoneType] = None
) -> List[str]

Return table columns optionally filtered to only include columns from properties.

copy¶

def copy(
    self: 'Model',
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    update: Union[ForwardRef('DictStrAny'), NoneType] = None,
    deep: bool = False
) -> 'Model'

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

Name	Type	Description	Default
include	None	fields to include in new model	None
exclude	None	fields to exclude from new model, as with values this takes precedence over include	None
update	None	values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data	None
deep	None	set to `True` to make a deep copy of the model	None

Returns:

Type	Description
None	new model instance

dict¶

def dict(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False
) -> 'DictStrAny'

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

get_column¶

def get_column(
    self,
    property_name: str
) -> Union[timvt.dbmodel.Column, NoneType]

Return column info.

get_datetime_column¶

def get_datetime_column(
    self,
    name: Union[str, NoneType] = None
) -> Union[timvt.dbmodel.Column, NoneType]

Return the Column for either the passed in tstz column or the first tstz column.

get_geometry_column¶

def get_geometry_column(
    self,
    name: Union[str, NoneType] = None
) -> Union[timvt.dbmodel.GeometryColumn, NoneType]

Return the name of the first geometry column.

get_tile¶

def get_tile(
    self,
    pool: buildpg.asyncpg.BuildPgPool,
    tile: morecantile.commons.Tile,
    tms: morecantile.models.TileMatrixSet,
    **kwargs: Any
)

Get Tile Data.

json¶

def json(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    encoder: Union[Callable[[Any], Any], NoneType] = None,
    models_as_dict: bool = True,
    **dumps_kwargs: Any
) -> 'unicode'

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().