iclientpy package

Subpackages

• iclientpy.codingui package
  • Subpackages
    • iclientpy.codingui.servicepublish package
      • Submodules
      • iclientpy.codingui.servicepublish.remotefilebrowser module
      • Module contents
  • Submodules
  • iclientpy.codingui.comon module
  • iclientpy.codingui.servicespage module
  • Module contents
• iclientpy.data package
  • Submodules
  • iclientpy.data.featuresconverter module
  • iclientpy.data.portal module
  • Module contents
• iclientpy.dtojson package
  • Module contents
• iclientpy.env package
  • Module contents
• iclientpy.jupyter package
  • Subpackages
    • iclientpy.jupyter.widgets package
      • Submodules
      • iclientpy.jupyter.widgets.basesetting module
      • iclientpy.jupyter.widgets.cloudtilelayer module
      • iclientpy.jupyter.widgets.echartslayer module
      • iclientpy.jupyter.widgets.heatlayer module
      • iclientpy.jupyter.widgets.mapview module
      • iclientpy.jupyter.widgets.mapvlayer module
      • iclientpy.jupyter.widgets.portalthumbnail module
      • iclientpy.jupyter.widgets.ranksymbolthemelayer module
      • iclientpy.jupyter.widgets.sparkjobstate module
      • iclientpy.jupyter.widgets.tilemaplayer module
      • Module contents
  • Submodules
  • iclientpy.jupyter.units module
  • Module contents
• iclientpy.locales package
  • Submodules
  • iclientpy.locales.conf module
  • iclientpy.locales.iclientpy module
  • iclientpy.locales.iclientpy_en module
  • iclientpy.locales.iclientpy_zh module
  • Module contents
• iclientpy.notebook package
  • Submodules
  • iclientpy.notebook.start_iclientpy module
  • iclientpy.notebook.start_online module
  • iclientpy.notebook.start_server module
  • Module contents
• iclientpy.rest package
  • Subpackages
    • iclientpy.rest.api package
      • Submodules
      • iclientpy.rest.api.abstracttypefields module
      • iclientpy.rest.api.cache module
      • iclientpy.rest.api.cacheutils module
      • iclientpy.rest.api.datacatalog module
      • iclientpy.rest.api.datasservice module
      • iclientpy.rest.api.distributedanalyst module
      • iclientpy.rest.api.groupsservice module
      • iclientpy.rest.api.management module
      • iclientpy.rest.api.mapsservice module
      • iclientpy.rest.api.model module
      • iclientpy.rest.api.mydepartments module
      • iclientpy.rest.api.node_service module
      • iclientpy.rest.api.onlinedatasservice module
      • iclientpy.rest.api.onlinemapsservice module
      • iclientpy.rest.api.restdata module
      • iclientpy.rest.api.restmap module
      • iclientpy.rest.api.securitymanagement module
      • iclientpy.rest.api.securityservice module
      • iclientpy.rest.api.servicespage module
      • iclientpy.rest.api.updatetileset module
      • Module contents
    • iclientpy.rest.cmd package
      • Subpackages
        • iclientpy.rest.cmd.wxreceiver package
          • Submodules
          • iclientpy.rest.cmd.wxreceiver.WXBizMsgCrypt module
          • iclientpy.rest.cmd.wxreceiver.ierror module
          • iclientpy.rest.cmd.wxreceiver.server module
          • Module contents
      • Submodules
      • iclientpy.rest.cmd.imgrwxreceiver module
      • iclientpy.rest.cmd.initserver module
      • iclientpy.rest.cmd.obaintoken module
      • iclientpy.rest.cmd.updatecache module
      • Module contents
  • Submodules
  • iclientpy.rest.apifactory module
  • iclientpy.rest.decorator module
  • iclientpy.rest.proxyfactory module
  • Module contents
• iclientpy.viz package
  • Submodules
  • iclientpy.viz.abstractmap module
  • iclientpy.viz.geolines module
  • iclientpy.viz.heatmap module
  • iclientpy.viz.mapvmap module
  • iclientpy.viz.ranksymbolthememap module
  • Module contents

Submodules

iclientpy.online module

class iclientpy.online.Online(username: str = None, password: str = None)

基类：object

create_map(layers: List[iclientpy.rest.api.model.Layer], epsgCode: int, map_title: str, center: tuple = None, extend: tuple = None, base_layer_type: iclientpy.online.OnlineBaseLayerType = <OnlineBaseLayerType.DEFAULT: 'DEFAULT'>, tags: List[str] = None)

create map

参数:

• layers -- map layers
• epsgCode -- epsg code
• map_title -- map title
• center -- map center point
• extend -- map extend
• base_layer_type -- base layer type
• tags -- map tags

返回:

map id

delete_data(data_id: str)

delete data

参数:data_id -- data id

delete_datas(data_ids: List[str])

delete multi data :param data_ids: data id list

delete_map(map_id: str)

delete map

参数:map_id -- map id

delete_maps(map_ids: List[str])

delete multi map

参数:map_ids -- map id list

get_data(data_id: str)

get data info by data id

参数:data_id -- data id 返回:data info

get_data_upload_progress(data_id: str)

get data upload progress

参数:data_id -- data id

Returns:

get_map(map_id: str)

get map by map's id

参数:map_id -- map's id 返回:地图信息

prepare_geojson_layer(data_id: str, layer_name: str)

prepare layer by geojson

参数:

• data_id -- geojson data id
• layer_name -- layer name

返回:

Layer信息

search_data(owners: List[str] = None, tags: List[str] = None, keywords: List[str] = None)

search data

参数:

• owners -- data owner
• tags -- data tags
• keywords -- data keywords

返回:

data info

search_map(owners: List[str] = None, tags: List[str] = None, keywords: List[str] = None)

search map

参数:

• owners -- map owner
• tags -- map tags
• keywords -- map keywords

返回:

map info

share_data(data_id: str, is_public: bool)

share data

参数:

• data_id -- data id
• is_public -- public or not

share_map(map_id: str, is_public: bool)

share map

参数:

• map_id -- map id
• is_public -- public or not

upload_data(data_name: str, data_content: io.IOBase, type: iclientpy.rest.api.model.DataItemType, callback: Callable = None)

upload data

参数:

• data_name -- data name
• data_content -- data stream
• type -- data type
• callback -- upload progress callback function

返回:

data id

upload_dataframe_as_json(data_name: str, df: pandas.core.frame.DataFrame, callback: Callable = None)

upload DataFrame as json type data

参数:

• data_name -- data name
• df -- DataFrame content

class iclientpy.online.OnlineBaseLayerType

基类：enum.Enum

An enumeration.

BAIDU = 'BAIDU'

BING = 'BING'

CHINABLUEDRAK = 'CHINABLUEDRAK'

CHINADARK = 'CHINADARK'

CHINALIGHT = 'CHINALIGHT'

DEFAULT = 'DEFAULT'

GAODE = 'GAODE'

GOOGLE = 'GOOGLE'

OPENSTREET = 'OPENSTREET'

TIANDITU = 'TIANDITU'

TIANDITUIMAGE = 'TIANDITUIMAGE'

TIANDITUTERRAIN = 'TIANDITUTERRAIN'

iclientpy.portal module

class iclientpy.portal.BaseLayerType

基类：enum.Enum

An enumeration.

DEFAULT = 'DEFAULT'

TIANDITU = 'TIANDITU'

class iclientpy.portal.DataShareSettingBuilder(settings: List[iclientpy.rest.api.model.IportalDataAuthorizeEntity] = None)

基类：object

build()

获得共享信息列表

返回:共享信息列表

share_to_everyone(type: iclientpy.rest.api.model.DataPermissionType)

共享数据给所有人

参数:type -- 共享权限

Returns:

share_to_group(group_id: str, type: iclientpy.rest.api.model.DataPermissionType)

共享数据给群组

参数:

• group_id -- 群组的id
• type -- 共享权限

Returns:

share_to_user(user_name: str, type: iclientpy.rest.api.model.DataPermissionType)

共享数据给指定用户

参数:

• user_name -- 用户名
• type -- 共享权限

Returns:

share_to_users(user_names: List[str], type: iclientpy.rest.api.model.DataPermissionType)

共享数据给多个用户

参数:

• user_names -- 用户列表
• type -- 共享权限

Returns:

class iclientpy.portal.MapShareSettingBuilder(settings: List[iclientpy.rest.api.model.MapShareSetting] = None)

基类：object

build()

获得共享信息列表

返回:共享信息列表

share_to_department(department_id: str, type: iclientpy.rest.api.model.PermissionType)

共享地图给指定组织

参数:

• department_id -- 组织的id
• type -- 共享权限

Returns:

share_to_everyone(type: iclientpy.rest.api.model.PermissionType)

共享地图给所有人

参数:type -- 共享权限

Returns:

share_to_group(group_id: int, type: iclientpy.rest.api.model.PermissionType)

共享地图给群组

参数:

• group_id -- 群组的id
• type -- 共享权限

Returns:

share_to_user(user_name: str, type: iclientpy.rest.api.model.PermissionType)

共享地图给指定用户

参数:

• user_name -- 用户名
• type -- 共享权限

Returns:

share_to_users(user_names: List[str], type: iclientpy.rest.api.model.PermissionType)

共享地图给多个用户

参数:

• user_names -- 用户名列表
• type -- 共享权限

Returns:

class iclientpy.portal.Portal(url, username: str = None, password: str = None, token: str = None)

基类：object

config_data_sharesetting(data_id, entities: List[iclientpy.rest.api.model.IportalDataAuthorizeEntity])

设置数据的共享权限

参数:

• data_id -- 数据的id
• entities -- 共享权限的列表

Returns:

config_map_sharesetting(map_id: str, entities: List[iclientpy.rest.api.model.MapShareSetting])

设置地图的共享权限

参数:

• map_id -- 地图的id
• entities -- 共享权限的列表

create_map(layers: List[iclientpy.rest.api.model.Layer], epsgCode: int, map_title: str, center: tuple = None, extend: tuple = None, base_layer_type: iclientpy.portal.BaseLayerType = <BaseLayerType.DEFAULT: 'DEFAULT'>, tags: List[str] = None)

创建地图

参数:

• layers -- 地图图层
• epsgCode -- 投影编码
• map_title -- 地图名称
• center -- 地图中心点
• extend -- 地图缩放范围
• base_layer_type -- 默认底图类型
• tags -- 地图标签

返回:

地图的id

create_role(name: str, users: List[str] = None, description: str = None, user_groups: List[str] = None, permissions: iclientpy.rest.api.model.RolePermissions = None)

创建角色

参数:

• name -- 角色名
• users -- 用户
• description -- 描述信息
• user_groups -- 用户组
• permissions -- 权限

create_user(name: str, password: str, roles: List[str] = None, description: str = None, user_groups: List[str] = None)

创建用户

参数:

• name -- 用户名
• password -- 密码
• roles -- 角色
• description -- 描述信息
• user_groups -- 用户组

delete_data(data_id: str)

删除一个数据

参数:data_id -- 数据的id

delete_datas(data_ids: List[str])

批量删除多个数据

参数:data_ids -- 数据的id列表

delete_map(map_id: str)

删除一个地图

参数:map_id -- 地图id

delete_maps(map_ids: List[str])

删除多个地图 :param map_ids: 地图的id列表

delete_role(name: str)

删除角色

参数:name -- 角色名

delete_roles(names: List[str])

批量删除角色

参数:names -- 角色名列表

delete_user(name: str)

删除用户

参数:name -- 用户名

delete_users(names: List[str])

批量删除用户

参数:names -- 用户名列表

get_data(data_id: str)

获取数据详细信息

参数:data_id -- 数据的id 返回:数据的信息

get_data_sharesetting(data_id: str)

获取数据的共享权限

参数:data_id -- 数据的id 返回:数据的共享权限

get_data_upload_progress(data_id: str)

获取数据上传进度

参数:data_id -- 数据的id

Returns:

get_map(map_id: str)

获取指定id的地图的详细信息

参数:map_id -- 地图的id 返回:地图信息

get_map_sharesetting(map_id: str)

返回地图的共享权限

参数:map_id -- 地图的id 返回:地图的共享权限

get_role(name: str) → iclientpy.rest.api.model.RoleEntity

获取角色信息

参数:name -- 角色名 返回:角色信息

get_roles() → List[iclientpy.rest.api.model.RoleEntity]

获取所有角色信息

返回:角色信息列表

get_user(name: str) → iclientpy.rest.api.model.UserInfo

获取用户信息

参数:name -- 用户名 返回:用户详细信息

get_users() → List[List[str]]

获取用户列表

返回:用户简略信息列表

prepare_geojson_layer(data_id: str, layer_name: str)

根据上传到iportal的geojson数据，生成Layer

参数:

• data_id -- 数据在iPortal中的id
• layer_name -- 图层名称

返回:

Layer信息

search_data(owners: List[str] = None, tags: List[str] = None, keywords: List[str] = None)

查找数据

参数:

• owners -- 数据所有者
• tags -- 数据标签
• keywords -- 数据关键字

返回:

数据信息的列表

search_group(owners: List[str] = None, tags: List[str] = None, keywords: List[str] = None)

查找群组

参数:

• owners -- 群组创建者
• tags -- 群组标签
• keywords -- 群组关键字

返回:

群组基本信息

search_map(owners: List[str] = None, tags: List[str] = None, keywords: List[str] = None)

查找地图

参数:

• owners -- 地图所有者
• tags -- 地图标签
• keywords -- 关键字

返回:

简略的地图信息列表

update_role(name: str, users: List[str] = None, description: str = None, user_groups: List[str] = None, permissions: iclientpy.rest.api.model.RolePermissions = None)

更新角色

参数:

• name -- 角色名
• users -- 用户
• description -- 描述信息
• user_groups -- 用户组
• permissions -- 权限

update_user(name: str, password: str = None, roles: List[str] = None, description: str = None, user_groups: List[str] = None)

更新用户信息

参数:

• name -- 用户名
• password -- 密码
• roles -- 角色
• description -- 描述信息
• user_groups -- 用户组

upload_data(data_name: str, data_content: io.IOBase, type: iclientpy.rest.api.model.DataItemType, callback: Callable = None)

上传数据

参数:

• data_name -- 数据名称
• data_content -- 数据流
• type -- 数据类型
• callback -- 上传进度回调方法

返回:

数据的id

upload_dataframe_as_json(data_name: str, df: pandas.core.frame.DataFrame, callback: Callable = None)

上传DataFrame为JSON类型数据

参数:

• data_name -- 上传后数据名称
• df -- DataFrame数据

iclientpy.server module

class iclientpy.server.Server(base_url: str, username: str = None, passwd: str = None, token: str = None, proxy: str = None, api_factory_clz=<class 'iclientpy.rest.apifactory.APIFactory'>)

基类：object

bigdatas

create_role(name: str, users: List[str] = None, description: str = None, user_groups: List[str] = None, permissions: iclientpy.rest.api.model.RolePermissions = None)

创建角色

参数:

• name -- 角色名
• users -- 用户
• description -- 描述信息
• user_groups -- 用户组
• permissions -- 权限

create_user(name: str, password: str, roles: List[str] = None, description: str = None, user_groups: List[str] = None)

创建用户

参数:

• name -- 用户名
• password -- 密码
• roles -- 角色
• description -- 描述信息
• user_groups -- 用户组

create_users_from_csv(path: str, name_key: str = 'name', password_key: str = 'password', roles_key: List[str] = 'roles', description_key: str = 'description', user_groups_key: List[str] = 'usergroups', sep=', ', encoding: str = 'utf8')

从csv文件里面读取用户信息，并在iServer上创建用户

参数:

• path -- csv文件路径
• name_key -- 名称的列名
• password_key -- 密码的列名
• roles_key -- 角色的列名
• description_key -- 描述的列名
• user_groups_key -- 用户组的列名
• sep -- csv文件的分隔符
• encoding -- csv文件编码

delete_role(name: str)

删除角色

参数:name -- 角色名

delete_roles(names: List[str])

批量删除角色

参数:names -- 角色名列表

delete_user(name: str)

删除用户

参数:name -- 用户名

delete_users(names: List[str])

批量删除用户

参数:names -- 用户名列表

get_instance(instance_name: str) → iclientpy.rest.api.model.ServiceInstance

获取服务实例

参数:instance_name -- 实例名称 返回:服务实例信息

get_instances() → List[iclientpy.rest.api.model.ServiceInstance]

获取所有服务实例

返回:服务实例信息列表

get_role(name: str) → iclientpy.rest.api.model.RoleEntity

获取角色信息

参数:name -- 角色名 返回:角色信息

get_roles() → List[iclientpy.rest.api.model.RoleEntity]

获取所有角色信息

返回:角色信息列表

get_user(name: str) → iclientpy.rest.api.model.UserInfo

获取用户信息

参数:name -- 用户名 返回:用户详细信息

get_users() → List[List[str]]

获取用户列表

返回:用户简略信息列表

grant_privileges_instances(instances_name: List[str], authorize_type: iclientpy.rest.api.model.AuthorizeType, denied_roles: List[str] = None, permitted_roles: List[str] = None)

为服务示例授权

参数:

• instances_name -- 服务实例名称列表
• authorize_type -- 验证类型
• denied_roles -- 禁止访问的角色列表
• permitted_roles -- 允许访问的角色列表

prepare_workspace_for_publish()

service_names

services

update_role(name: str, users: List[str] = None, description: str = None, user_groups: List[str] = None, permissions: iclientpy.rest.api.model.RolePermissions = None)

更新角色

参数:

• name -- 角色名
• users -- 用户
• description -- 描述信息
• user_groups -- 用户组
• permissions -- 权限

update_user(name: str, password: str = None, roles: List[str] = None, description: str = None, user_groups: List[str] = None)

更新用户信息

参数:

• name -- 用户名
• password -- 密码
• roles -- 角色
• description -- 描述信息
• user_groups -- 用户组

iclientpy.typeassert module

iclientpy.typeassert.typeassert(func)

Module contents