gws.types

class gws.types.Enum

gws.types.Extent = typing.Tuple[float, float, float, float]

alias An array of 4 elements representing extent coordinates [minx, miny, maxx, maxy]

gws.types.Point = typing.Tuple[float, float]

alias Point coordinates [x, y]

gws.types.Size = typing.Tuple[float, float]

alias Size [width, height]

gws.types.Measurement = typing.Tuple[float, str]

alias A value with a unit

gws.types.Tag

alias of builtins.tuple

class gws.types.Axis

Axis orientation.

xy = 'xy'

yx = 'yx'

gws.types.Literal

alias of builtins.str

gws.types.FilePath

alias of builtins.str

gws.types.DirPath

alias of builtins.str

gws.types.Duration

alias of builtins.str

gws.types.Color

alias of builtins.str

gws.types.Regex

alias of builtins.str

gws.types.FormatStr

alias of builtins.str

gws.types.Crs

alias of builtins.str

gws.types.Date

alias of builtins.str

gws.types.DateTime

alias of builtins.str

gws.types.Url

alias of builtins.str

class gws.types.ext

class action

class Config

class Props

class auth

class method

class Config

class provider

class Config

class template

class Config

class Props

class db

class provider

class Config

class layer

class Config

class Props

class search

class provider

class Config

class storage

class Config

class helper

class Config

class ows

class provider

class Config

class service

class Config

class gws.types.Data(*args, **kwargs)

Basic data object.

get(k, default=None)

class gws.types.Config(*args, **kwargs)

Configuration base type

uid = ''

unique ID

class gws.types.WithType(*args, **kwargs)

type = None

object type

class gws.types.AccessType

allow = 'allow'

deny = 'deny'

class gws.types.Access(*args, **kwargs)

Access rights definition for authorization roles

type = None

access type (deny or allow)

role = None

a role to which this rule applies

class gws.types.WithAccess(*args, **kwargs)

access = None

access rights

class gws.types.WithTypeAndAccess(*args, **kwargs)

type = None

object type

access = None

access rights

class gws.types.AttributeType

bool = 'bool'

bytes = 'bytes'

date = 'date'

datetime = 'datetime'

float = 'float'

geometry = 'geometry'

int = 'int'

list = 'list'

str(bytes_or_buffer[, encoding[, errors]]) → str = 'str'

text = 'text'

time = 'time'

class gws.types.GeometryType

curve = 'CURVE'

geomcollection = 'GEOMCOLLECTION'

geometry = 'GEOMETRY'

linestring = 'LINESTRING'

multicurve = 'MULTICURVE'

multilinestring = 'MULTILINESTRING'

multipoint = 'MULTIPOINT'

multipolygon = 'MULTIPOLYGON'

multisurface = 'MULTISURFACE'

point = 'POINT'

polygon = 'POLYGON'

polyhedralsurface = 'POLYHEDRALSURFACE'

surface = 'SURFACE'

class gws.types.Attribute(*args, **kwargs)

title = ''

type = 'str'

value = None

editable = True

class gws.types.Params(*args, **kwargs)

projectUid = None

project uid

locale = None

locale for this request

class gws.types.NoParams(*args, **kwargs)

class gws.types.ResponseError(*args, **kwargs)

class gws.types.Response(*args, **kwargs)

class gws.types.HttpResponse(*args, **kwargs)

class gws.types.FileResponse(*args, **kwargs)

class gws.types.Props(*args, **kwargs)

Properties base type

class gws.types.Bounds(*args, **kwargs)

class gws.types.CorsOptions(*args, **kwargs)

class gws.types.DocumentRoot(*args, **kwargs)

class gws.types.FeatureProps(*args, **kwargs)

class gws.types.IBaseRequest

cookie(key: str, default: str = None) → str

env(key: str, default: str = None) → str

error_response(err) → gws.types.IResponse

file_response(path: str, mimetype: str, status: int = 200, attachment_name: str = None) → gws.types.IResponse

has_param(key: str) → bool

header(key: str, default: str = None) → str

init()

param(key: str, default: str = None) → str

redirect_response(location, status=302)

response(content: str, mimetype: str, status: int = 200) → gws.types.IResponse

struct_response(data: gws.types.Response, status: int = 200) → gws.types.IResponse

url_for(url: str) → str

class gws.types.IFeature

apply_data_model(model: Optional[gws.types.IModel] = None) → gws.types.IFeature

apply_templates(templates: List[ITemplate] = None, extra_context: dict = None, keys: List[str] = None) → gws.types.IFeature

attr(name: str)

to_geojson() → dict

to_svg(rv: gws.types.MapRenderView, style: Optional[gws.types.IStyle] = None) → str

to_svg_tags(rv: gws.types.MapRenderView, style: Optional[gws.types.IStyle] = None) → List[tuple]

transform_to(crs) → gws.types.IFeature

class gws.types.IObject

append_child(obj: gws.types.IObject) → gws.types.IObject

create_child(klass, cfg) → gws.types.IObject

get_children(klass) → List[gws.types.IObject]

get_closest(klass) → gws.types.IObject

initialize(cfg)

is_a(klass)

post_configure()

post_initialize()

props_for(user) → Optional[dict]

set_uid(uid)

var(key, default=None, parent=False)

class gws.types.IResponse

add_header(key, value)

delete_cookie(key, **kwargs)

set_cookie(key, **kwargs)

class gws.types.IRole

can_use(obj, parent=None)

class gws.types.ISession

get(key, default=None)

set(key, val)

class gws.types.IShape

intersects(shape: gws.types.IShape) → bool

to_multi() → gws.types.IShape

to_type(new_type: gws.types.GeometryType) → gws.types.IShape

tolerance_polygon(tolerance, resolution=None) → gws.types.IShape

transformed_to(to_crs, **kwargs) → gws.types.IShape

class gws.types.IStyle

class gws.types.IUser

attribute(key: str, default: str = '') → str

can_use(obj, parent=None) → bool

has_role(role: str) → bool

init_from_data(provider, uid, roles, attributes) → gws.types.IUser

init_from_source(provider, uid, roles=None, attributes=None) → gws.types.IUser

class gws.types.LayerLegend(*args, **kwargs)

class gws.types.MapRenderInput(*args, **kwargs)

class gws.types.MapRenderInputItem(*args, **kwargs)

class gws.types.MapRenderInputItemType

features = 'features'

fragment = 'fragment'

image = 'image'

image_layer = 'image_layer'

svg_layer = 'svg_layer'

class gws.types.MapRenderOutput(*args, **kwargs)

class gws.types.MapRenderOutputItem(*args, **kwargs)

class gws.types.MapRenderView(*args, **kwargs)

class gws.types.MetaContact(*args, **kwargs)

class gws.types.MetaData(*args, **kwargs)

class gws.types.MetaInspireDegreeOfConformity

conformant = 'conformant'

notConformant = 'notConformant'

notEvaluated = 'notEvaluated'

class gws.types.MetaInspireMandatoryKeyword

chainDefinitionService = 'chainDefinitionService'

comEncodingService = 'comEncodingService'

comGeographicCompressionService = 'comGeographicCompressionService'

comGeographicFormatConversionService = 'comGeographicFormatConversionService'

comMessagingService = 'comMessagingService'

comRemoteFileAndExecutableManagement = 'comRemoteFileAndExecutableManagement'

comService = 'comService'

comTransferService = 'comTransferService'

humanCatalogueViewer = 'humanCatalogueViewer'

humanChainDefinitionEditor = 'humanChainDefinitionEditor'

humanFeatureGeneralizationEditor = 'humanFeatureGeneralizationEditor'

humanGeographicDataStructureViewer = 'humanGeographicDataStructureViewer'

humanGeographicFeatureEditor = 'humanGeographicFeatureEditor'

humanGeographicSpreadsheetViewer = 'humanGeographicSpreadsheetViewer'

humanGeographicSymbolEditor = 'humanGeographicSymbolEditor'

humanGeographicViewer = 'humanGeographicViewer'

humanInteractionService = 'humanInteractionService'

humanServiceEditor = 'humanServiceEditor'

humanWorkflowEnactmentManager = 'humanWorkflowEnactmentManager'

infoCatalogueService = 'infoCatalogueService'

infoCoverageAccessService = 'infoCoverageAccessService'

infoFeatureAccessService = 'infoFeatureAccessService'

infoFeatureTypeService = 'infoFeatureTypeService'

infoGazetteerService = 'infoGazetteerService'

infoManagementService = 'infoManagementService'

infoMapAccessService = 'infoMapAccessService'

infoOrderHandlingService = 'infoOrderHandlingService'

infoProductAccessService = 'infoProductAccessService'

infoRegistryService = 'infoRegistryService'

infoSensorDescriptionService = 'infoSensorDescriptionService'

infoStandingOrderService = 'infoStandingOrderService'

metadataGeographicAnnotationService = 'metadataGeographicAnnotationService'

metadataProcessingService = 'metadataProcessingService'

metadataStatisticalCalculationService = 'metadataStatisticalCalculationService'

spatialCoordinateConversionService = 'spatialCoordinateConversionService'

spatialCoordinateTransformationService = 'spatialCoordinateTransformationService'

spatialCoverageVectorConversionService = 'spatialCoverageVectorConversionService'

spatialDimensionMeasurementService = 'spatialDimensionMeasurementService'

spatialFeatureGeneralizationService = 'spatialFeatureGeneralizationService'

spatialFeatureManipulationService = 'spatialFeatureManipulationService'

spatialFeatureMatchingService = 'spatialFeatureMatchingService'

spatialImageCoordinateConversionService = 'spatialImageCoordinateConversionService'

spatialImageGeometryModelConversionService = 'spatialImageGeometryModelConversionService'

spatialOrthorectificationService = 'spatialOrthorectificationService'

spatialPositioningService = 'spatialPositioningService'

spatialProcessingService = 'spatialProcessingService'

spatialProximityAnalysisService = 'spatialProximityAnalysisService'

spatialRectificationService = 'spatialRectificationService'

spatialRouteDeterminationService = 'spatialRouteDeterminationService'

spatialSamplingService = 'spatialSamplingService'

spatialSensorGeometryModelAdjustmentService = 'spatialSensorGeometryModelAdjustmentService'

spatialSubsettingService = 'spatialSubsettingService'

spatialTilingChangeService = 'spatialTilingChangeService'

subscriptionService = 'subscriptionService'

taskManagementService = 'taskManagementService'

temporalProcessingService = 'temporalProcessingService'

temporalProximityAnalysisService = 'temporalProximityAnalysisService'

temporalReferenceSystemTransformationService = 'temporalReferenceSystemTransformationService'

temporalSamplingService = 'temporalSamplingService'

temporalSubsettingService = 'temporalSubsettingService'

thematicChangeDetectionService = 'thematicChangeDetectionService'

thematicClassificationService = 'thematicClassificationService'

thematicFeatureGeneralizationService = 'thematicFeatureGeneralizationService'

thematicGeocodingService = 'thematicGeocodingService'

thematicGeographicInformationExtractionService = 'thematicGeographicInformationExtractionService'

thematicGeoparsingService = 'thematicGeoparsingService'

thematicGoparameterCalculationService = 'thematicGoparameterCalculationService'

thematicImageManipulationService = 'thematicImageManipulationService'

thematicImageProcessingService = 'thematicImageProcessingService'

thematicImageSynthesisService = 'thematicImageSynthesisService'

thematicImageUnderstandingService = 'thematicImageUnderstandingService'

thematicMultibandImageManipulationService = 'thematicMultibandImageManipulationService'

thematicObjectDetectionService = 'thematicObjectDetectionService'

thematicProcessingService = 'thematicProcessingService'

thematicReducedResolutionGenerationService = 'thematicReducedResolutionGenerationService'

thematicSpatialCountingService = 'thematicSpatialCountingService'

thematicSubsettingService = 'thematicSubsettingService'

workflowEnactmentService = 'workflowEnactmentService'

class gws.types.MetaInspireResourceType

dataset = 'dataset'

series = 'series'

service = 'service'

class gws.types.MetaInspireSpatialDataServiceType

discovery = 'discovery'

download = 'download'

invoke = 'invoke'

other = 'other'

transformation = 'transformation'

view = 'view'

class gws.types.MetaInspireTheme

ac = 'ac'

ad = 'ad'

af = 'af'

am = 'am'

au = 'au'

br = 'br'

bu = 'bu'

cp = 'cp'

ef = 'ef'

el = 'el'

er = 'er'

ge = 'ge'

gg = 'gg'

gn = 'gn'

hb = 'hb'

hh = 'hh'

hy = 'hy'

lc = 'lc'

lu = 'lu'

mf = 'mf'

mr = 'mr'

nz = 'nz'

of = 'of'

oi = 'oi'

pd = 'pd'

pf = 'pf'

ps = 'ps'

rs = 'rs'

sd = 'sd'

so = 'so'

sr = 'sr'

su = 'su'

tn = 'tn'

us = 'us'

class gws.types.MetaIsoMaintenanceFrequencyCode

annually = 'annually'

asNeeded = 'asNeeded'

biannually = 'biannually'

continual = 'continual'

daily = 'daily'

fortnightly = 'fortnightly'

irregular = 'irregular'

monthly = 'monthly'

notPlanned = 'notPlanned'

quarterly = 'quarterly'

unknown = 'unknown'

weekly = 'weekly'

class gws.types.MetaIsoOnLineFunction

download = 'download'

information = 'information'

offlineAccess = 'offlineAccess'

order = 'order'

search = 'search'

class gws.types.MetaIsoScope

attribute = 'attribute'

attributeType = 'attributeType'

collectionHardware = 'collectionHardware'

collectionSession = 'collectionSession'

dataset = 'dataset'

dimensionGroup = 'dimensionGroup'

feature = 'feature'

featureType = 'featureType'

fieldSession = 'fieldSession'

initiative = 'initiative'

model = 'model'

nonGeographicDataset = 'nonGeographicDataset'

otherAggregate = 'otherAggregate'

platformSeries = 'platformSeries'

productionSeries = 'productionSeries'

propertyType = 'propertyType'

sensor = 'sensor'

sensorSeries = 'sensorSeries'

series = 'series'

service = 'service'

software = 'software'

stereomate = 'stereomate'

tile = 'tile'

transferAggregate = 'transferAggregate'

class gws.types.MetaIsoSpatialRepresentationType

grid = 'grid'

stereoModel = 'stereoModel'

textTable = 'textTable'

tin = 'tin'

vector = 'vector'

video = 'video'

class gws.types.MetaIsoTopicCategory

biota = 'biota'

boundaries = 'boundaries'

climatologyMeteorologyAtmosphere = 'climatologyMeteorologyAtmosphere'

economy = 'economy'

elevation = 'elevation'

environment = 'environment'

farming = 'farming'

geoscientificInformation = 'geoscientificInformation'

health = 'health'

imageryBaseMapsEarthCover = 'imageryBaseMapsEarthCover'

inlandWaters = 'inlandWaters'

intelligenceMilitary = 'intelligenceMilitary'

location = 'location'

oceans = 'oceans'

planningCadastre = 'planningCadastre'

society = 'society'

structure = 'structure'

transportation = 'transportation'

utilitiesCommunication = 'utilitiesCommunication'

class gws.types.MetaLink(*args, **kwargs)

class gws.types.ModelProps(*args, **kwargs)

class gws.types.ModelRule(*args, **kwargs)

class gws.types.OwsOperation

class gws.types.Projection(*args, **kwargs)

class gws.types.RewriteRule(*args, **kwargs)

class gws.types.SearchArgs(*args, **kwargs)

class gws.types.SearchFilter(*args, **kwargs)

class gws.types.SelectArgs(*args, **kwargs)

class gws.types.ShapeProps(*args, **kwargs)

class gws.types.SourceLayer(*args, **kwargs)

class gws.types.SourceStyle(*args, **kwargs)

class gws.types.SpecValidator

method_spec(name)

read_value(val, type_name, path='', strict=True)

class gws.types.SqlTable(*args, **kwargs)

class gws.types.SqlTableColumn(*args, **kwargs)

class gws.types.StorageDirectory(*args, **kwargs)

class gws.types.StorageElement(*args, **kwargs)

class gws.types.StorageEntry(*args, **kwargs)

class gws.types.StorageRecord(*args, **kwargs)

class gws.types.StyleGeometryOption

all = 'all'

none = 'none'

class gws.types.StyleLabelAlign

center = 'center'

left = 'left'

right = 'right'

class gws.types.StyleLabelFontStyle

italic = 'italic'

normal = 'normal'

class gws.types.StyleLabelFontWeight

bold = 'bold'

normal = 'normal'

class gws.types.StyleLabelOption

all = 'all'

none = 'none'

class gws.types.StyleLabelPlacement

end = 'end'

middle = 'middle'

start = 'start'

class gws.types.StyleMarker

arrow = 'arrow'

circle = 'circle'

cross = 'cross'

square = 'square'

class gws.types.StyleProps(*args, **kwargs)

class gws.types.StyleStrokeLineCap

butt = 'butt'

round = 'round'

square = 'square'

class gws.types.StyleStrokeLineJoin

bevel = 'bevel'

miter = 'miter'

round = 'round'

class gws.types.StyleType

css = 'css'

cssSelector = 'cssSelector'

class gws.types.StyleValues(*args, **kwargs)

class gws.types.SvgFragment(*args, **kwargs)

class gws.types.TemplateLegendMode

html = 'html'

image = 'image'

class gws.types.TemplateOutput(*args, **kwargs)

class gws.types.TemplateProps(*args, **kwargs)

class gws.types.TemplateQualityLevel(*args, **kwargs)

class gws.types.UserProps(*args, **kwargs)

class gws.types.IApi

class gws.types.IApplication

developer_option(name)

find_action(action_type, project_uid=None)

require_helper(key)

class gws.types.IAuthManager

authenticate(method: gws.types.IAuthMethod, login, password, **kw) → Optional[gws.types.IUser]

close_session(sess: gws.types.ISession, req: gws.types.IRequest, res: gws.types.IResponse) → gws.types.ISession

create_stored_session(type: str, method: gws.types.IAuthMethod, user: gws.types.IUser) → gws.types.ISession

delete_stored_sessions()

destroy_stored_session(sess: gws.types.ISession)

find_stored_session(uid)

get_method(type: str) → Optional[gws.types.IAuthMethod]

get_provider(uid: str) → Optional[gws.types.IAuthProvider]

get_role(name: str) → gws.types.IRole

get_user(user_fid: str) → Optional[gws.types.IUser]

login(method: gws.types.IAuthMethod, login: str, password: str, req: gws.types.IRequest) → gws.types.ISession

logout(sess: gws.types.ISession, req: gws.types.IRequest) → gws.types.ISession

new_session(**kwargs)

open_session(req: gws.types.IRequest) → gws.types.ISession

save_stored_session(sess: gws.types.ISession)

serialize_user(user: gws.types.IUser) → str

stored_session_records() → List[dict]

unserialize_user(s: str) → gws.types.IUser

class gws.types.IAuthMethod

close_session(auth: gws.types.IAuthManager, sess: gws.types.ISession, req: gws.types.IRequest, res: gws.types.IResponse)

login(auth: gws.types.IAuthManager, login: str, password: str, req: gws.types.IRequest) → Optional[gws.types.ISession]

logout(auth: gws.types.IAuthManager, sess: gws.types.ISession, req: gws.types.IRequest) → gws.types.ISession

open_session(auth: gws.types.IAuthManager, req: gws.types.IRequest) → Optional[gws.types.ISession]

class gws.types.IAuthProvider

authenticate(method: gws.types.IAuthMethod, login: str, password: str, **kwargs) → Optional[gws.types.IUser]

get_user(user_uid: str) → Optional[gws.types.IUser]

user_from_dict(d: dict) → gws.types.IUser

user_to_dict(u: gws.types.IUser) → dict

class gws.types.IClient

class gws.types.IDbProvider

class gws.types.ILayer

configure_legend() → gws.types.LayerLegend

configure_metadata(provider_meta=None) → gws.types.MetaData

configure_search()

edit_access(user)

edit_operation(operation: str, feature_props: List[FeatureProps]) → List[gws.types.IFeature]

get_features(bounds: gws.types.Bounds, limit: int = 0) → List[gws.types.IFeature]

mapproxy_config(mc)

ows_enabled(service: gws.types.IOwsService) → bool

render_box(rv: gws.types.MapRenderView, extra_params=None)

render_html_legend(context=None) → str

render_legend(context=None) → Optional[str]

render_legend_image(context=None) → bytes

render_svg(rv: gws.types.MapRenderView, style: Optional[gws.types.IStyle] = None) → str

render_svg_tags(rv: gws.types.MapRenderView, style: Optional[gws.types.IStyle] = None) → List[tuple]

render_xyz(x, y, z)

class gws.types.IMap

class gws.types.IModel

apply(atts: List[gws.types.Attribute]) → List[gws.types.Attribute]

apply_to_dict(d: dict) → List[gws.types.Attribute]

class gws.types.IMonitor

add_directory(path, pattern)

add_path(path)

start()

class gws.types.IOwsProvider

find_features(args: gws.types.SearchArgs) → List[gws.types.IFeature]

operation(name: str) → gws.types.OwsOperation

class gws.types.IOwsService

error_response(err: Exception) → gws.types.HttpResponse

handle(req: gws.types.IRequest) → gws.types.HttpResponse

class gws.types.IPrinter

class gws.types.IProject

class gws.types.IRequest

acquire(klass: str, uid: str) → Optional[gws.types.IObject]

auth_close(res: gws.types.IResponse)

auth_open()

login(login: str, password: str)

logout()

require(klass: str, uid: str) → gws.types.IObject

require_layer(uid: str) → gws.types.ILayer

require_project(uid: str) → gws.types.IProject

class gws.types.IRootObject

create(klass, cfg=None)

create_object(klass, cfg, parent=None)

create_shared_object(klass, uid, cfg)

create_unbound_object(klass, cfg)

find(klass, uid=None) → gws.types.IObject

find_all(klass=None) → List[gws.types.IObject]

find_by_uid(uid) → gws.types.IObject

find_first(klass) → gws.types.IObject

class gws.types.ISearchProvider

can_run(args: gws.types.SearchArgs)

context_shape(args: gws.types.SearchArgs) → gws.types.IShape

run(layer: gws.types.ILayer, args: gws.types.SearchArgs) → List[gws.types.IFeature]

class gws.types.ITemplate

add_headers_and_footers(context: dict, in_path: str, out_path: str, format: str) → str

dpi_for_quality(quality)

normalize_context(context: dict) → dict

render(context: dict, mro: Optional[gws.types.MapRenderOutput] = None, out_path: str = None, legends: dict = None, format: str = None) → gws.types.TemplateOutput

class gws.types.IWebSite

url_for(req, url)

class gws.types.ISqlProvider

describe(table: gws.types.SqlTable) → Dict[str, gws.types.SqlTableColumn]

edit_operation(operation: str, table: gws.types.SqlTable, features: List[IFeature]) → List[gws.types.IFeature]

select(args: gws.types.SelectArgs, extra_connect_params: dict = None) → List[gws.types.IFeature]

class gws.types.IVectorLayer

connect_feature(feature: gws.types.IFeature) → gws.types.IFeature