更新时间:2022-05-09 GMT+08:00
分享

Python SDK

本章节介绍新版Python SDK,您可以参考本章节进行快速集成开发。

准备工作

  • 已注册华为云帐号,并完成实名认证,帐号不能处于欠费或冻结状态。
  • 已具备开发环境,支持Python3及以上版本。
  • 登录“我的凭证 > 访问秘钥”页面,获取Access Key(AK)和Secret Access Key(SK)。
  • 登录“我的凭证”页面,获取“IAM用户名”“、帐号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息,请提前保存。

    本样例以“华北-北京四”区域为例,获取对应的项目ID(project_id)。

    图1 我的凭证

安装SDK

支持Python3及以上版本,执行python --version检查当前Python的版本信息。

使用SDK前,需要安装“huaweicloudsdkcore”和“huaweicloudsdkocr”,有两种安装方式,分别如下。

  • 使用pip安装
    # 安装核心库
    pip install huaweicloudsdkcore
    
    # 安装OCR服务库
    pip install huaweicloudsdkocr
  • 使用源码安装
    # 安装核心库
    cd huaweicloudsdkcore-${version}
    python setup.py install
    
    # 安装OCR服务库
    cd huaweicloudsdkocr-${version}
    python setup.py install

开始使用

详细的SDK介绍,使用异步客户端,配置日志请参见SDK中心Python SDK使用指导Python SDK使用视频

  1. 导入依赖模块
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkcore.http.http_config import HttpConfig
    # 导入指定云服务的库 huaweicloudsdk{service}
    from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
    from huaweicloudsdkocr.v1 import *
  2. 配置客户端连接参数
    • 默认配置
      # 使用默认配置,如出现'HttpConfig' is not defined报错,请检查是否已正确安装sdk
      config = HttpConfig.get_default_config()
    • 网络代理(可选)
      # 根据需要配置网络代理
      config.proxy_protocol = 'http'
      config.proxy_host = 'proxy.huaweicloud.com'
      config.proxy_port = 80
      config.proxy_user = 'username'
      config.proxy_password = 'password'
    • 超时配置(可选)
      # 默认连接超时时间为60秒,读取超时时间为120秒,支持统一指定超时时长timeout=timeout,或分别指定超时时长timeout=(connect timeout, read timeout)
      config.timeout = 120
    • SSL配置(可选)
      # 根据需要配置是否跳过SSL证书校验
      config.ignore_ssl_verification = True
      # 配置服务器端CA证书,用于SDK验证服务端证书合法性
      config.ssl_ca_cert = ssl_ca_cert
  3. 配置认证信息

    配置AK、SK、project_id信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。

    • 使用永久AK和SK
      credentials = BasicCredentials(ak, sk, project_id)
    • 使用临时AK和SK
      credentials = BasicCredentials(ak, sk, project_id).with_security_token(security_token)

    认证参数说明:

  4. 初始化客户端(二选一)
    • 指定region方式(推荐)
      # 增加region依赖
      from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
      
      # 初始化指定云服务的客户端 {Service}Client ,以初始化OCR服务的 OcrClient 为例
      client = OcrClient.new_builder() \
          .with_http_config(config) \
          .with_credentials(credentials) \
          .with_region(OcrRegion.value_of("cn-north-4")) \
          .build()
    • 指定云服务endpoint方式
      # 指定终端节点,以 OCR 服务北京四的 endpoint 为例
      endpoint = "https://ocr.cn-north-4.myhuaweicloud.com"
      
      # 初始化指定云服务的客户端 {Service}Client ,以初始化OCR服务的 OcrClient 为例
      client = OcrClient.new_builder() \
          .with_http_config(config) \
          .with_credentials(credentials) \
          .with_endpoint(endpoint) \
          .build()

      endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 地区和终端节点

  5. 发送请求并查看响应
    # 以调用通用表格识别接口 RecognizeGeneralTable 为例
    request = RecognizeGeneralTableRequest()
    request.body = GeneralTableRequestBody(
                url="图片的url"
            )
    response = client.recognize_general_table(request)
    print(response)
  6. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    二级分类

    二级分类说明

    ConnectionException

    连接类异常

    HostUnreachableException

    网络不可达、被拒绝。

    SslHandShakeException

    SSL认证异常。

    RequestTimeoutException

    响应超时异常

    CallTimeoutException

    单次请求,服务器处理超时未返回。

    RetryOutageException

    在重试策略消耗完成后,仍无有效的响应。

    ServiceResponseException

    服务器响应异常

    ServerResponseException

    服务端内部错误,Http响应码:[500,]。

    ClientRequestException

    请求参数不合法,Http响应码:[400, 500)

    # 异常处理
    try:
        request = RecognizeGeneralTableRequest()
        response = client.recognize_general_table(request)
        print(response)
    except exception.ClientResponseException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

代码示例自动生成

API Explorer提供API检索及平台调试,支持全量快速检索、可视化调试、帮助文档查看、在线咨询。

您只需要在API Explorer中修改接口参数,即可自动生成对应的代码示例。同时,可在集成开发环境CloudIDE中完成代码的构建、调试、运行等操作。

图2 API Explorer
分享:

    相关文档

    相关产品

close