用于smash.gg的公共api的python sdk

smashggp的Python项目详细描述


扣球

smashggpy是一个包绕public smash.gg graphql api的sdk。 它实现了一系列易于使用的对象,并具有一个后台线程 管理未完成的查询以处理GraphQL的速率限制功能。

    作者>作者
    • 布兰登·库克(brandoncokedev@gmail.com)布兰登·库克(brandoncokedev@gmail.com)

开始

fromsmashggpy.models.EventimportEventfromsmashggpy.utilimportInitializerfromsmashggpy.util.QueryQueueDaemonimportQueryQueueDaemonif__name__=='__main__':Initializer.initialize('API_KEY','info')to12_melee=Event.get('tipped-off-12-presented-by-the-lab-gaming-center','melee-singles')sets=to12_melee.get_sets()forggsetinsets:print("{0}: {1}{2} - {3}{4}".format(ggset.full_round_text,ggset.player1,ggset.score1,ggset.score2,ggset.player2))QueryQueueDaemon.kill_daemon()

结果如下:

Winners Final: MVG FOX | Mew2King 2 - 0 OeS | NIX
Losers Semi-Final: Gas$ 0 - 2 bobby big ballz
Winners Semi-Final: MVG FOX | Mew2King 2 - 0 Gas$
Winners Semi-Final: OeS | NIX 2 - 0 bobby big ballz
Losers Quarter-Final: bobby big ballz 2 - 0 DarkGenex
Losers Quarter-Final: Gas$ 2 - 0 Cynax
Losers Round 3: Greenmario 1 - 2 Cynax
Losers Round 3: DarkGenex 2 - 0 CV | Cloud-9
....

文档

初始值设定项

方法

  • 初始化(API密钥[,日志级别])
    • 初始化sdk
    • 参数
      • 密钥
        • 字符串
        • 访问smash.gg api的api密钥
      • 可选:日志级别
        • 字符串
        • 内置记录器的日志级别
        • 允许值:
          • "关键"
          • "错误"
          • "警告"
          • "信息"
          • "调试"

QueryQueueDaemon

方法

  • 杀死守护进程()
    • 结束监视queryqueue的并行线程
    • 注意如果需要终止程序,请调用此命令,否则忽略

锦标赛

属性

  • id
    • 锦标赛对象的ID
  • 姓名
    • 字符串
    • 比赛名称
  • 弹头
    • 字符串
    • 锦标赛的url slug
  • 开始时间
    • 比赛开始时间的Unix纪元
  • 结束时间
    • 比赛结束时间的Unix纪元
  • 时区
    • 字符串
    • 比赛的时区
  • 场地
  • 组织者

方法

静态
  • 获取(锦标赛蛞蝓)
    • 从smashgg获取相应锦标赛slug的锦标赛数据
    • 参数
      • 锦标赛
        • 字符串
        • 比赛用的长名字弹头
          • 函数-3-递归-级数
          • 自告奋勇12-由实验室提供-游戏中心
          • CEO-2016
    • 返回锦标赛
  • 分析(数据)
    • 将smash.gg api数据解析为锦标赛对象
    • 参数
      • 数据
        • json
        • 来自smash.gg api调用的http响应数据
    • 返回锦标赛
  • 获取事件()
    • 获取给定比赛的所有项目
    • 返回事件[]
  • 获取相位()
    • 获取给定锦标赛的所有阶段
    • 返回阶段[]
  • 获取相位组()
    • 得到g的所有相位组艾文锦标赛
    • 返回相位组
  • 获取与会者()
    • 为给定比赛邀请所有与会者
    • 返回与会者
  • 获取参与者()
    • 获取给定锦标赛的所有参赛者
    • 返回进入者
  • 获取集合()
    • 获得给定锦标赛的所有比赛集
    • 返回ggset[]
  • 获取不完整的集合()
    • 获取给定锦标赛的所有不完整集
    • 返回ggset[]
  • 获取已完成的集合()
    • 获取给定锦标赛的所有已完成集
    • 返回ggset[]
实例
  • 获取ID()
    • 获取锦标赛的id属性
    • 返回int
  • 获取名称()
    • 获取锦标赛的name属性
    • 返回字符串
  • 获取_slug()
    • 获得锦标赛的slug属性
    • 返回字符串
  • 获取开始时间()
    • 获取锦标赛的开始时间属性
    • 返回int
  • 获取结束时间()
    • 获取锦标赛的结束时间属性
    • 返回int
  • 获取时区()
    • 获取锦标赛的时区属性
    • 返回字符串
  • 获取地点()
    • 获取锦标赛的场地属性
    • 返回场馆
  • 获取组织者()
    • 获取锦标赛的组织者属性
    • 返回组织者

事件

属性

  • id
    • 事件的数字标识
  • 姓名
    • 字符串
    • 事件的名称
  • 弹头
    • 字符串
    • 事件的url slug
  • 状态
    • 字符串
    • 活动进度
    • 可能值:
      • 已创建
      • 活动
      • 已完成
      • 就绪
      • 无效
      • 呼叫
      • 排队
  • 从开始
    • 事件开始时间的Unix纪元
  • 参赛人数
    • 参加活动的人数
  • 签入缓冲区
    • 在事件开始前多长时间的秒数将结束签入
  • 入住时间
    • 登记将持续多长时间的秒数
  • 已启用签入功能
    • 布尔
    • 此事件是否使用签入的T/F
  • 是否联机
    • 布尔
    • 此活动是否在线的T/F
  • 允许使用团队名称
    • 布尔
    • t/f此事件是否允许团队名称
  • 团队管理截止日期
    • 不再允许团队管理的Unix时代

方法

静力学
  • 获得(锦标赛、赛事)
    • 为相应的锦标赛和事件slug获取事件对象
    • 参数
      • 锦标赛
        • 字符串
        • 比赛用的长名字弹头
          • 函数-3-递归-级数
          • 自告奋勇输入< /LI>
          • CEO-2016
      • 事件段塞
        • 字符串
        • 目标事件的重击
          • 近战单打
          • 龙珠飞
          • Smash Bros旗舰版
    • 返回事件
  • 分析(数据)
    • 将smash.gg api数据解析为事件对象
    • 参数
      • 数据
        • json
        • 来自smash.gg api调用的http响应数据
    • 返回事件
  • 获取相位()
    • 获取事件的阶段
    • 返回阶段[]
  • 获取相位组()
    • 获取事件的阶段组
    • 返回相位组
  • 获取集合()
    • 获取给定事件的所有播放集
    • 返回ggset[]
  • 获取不完整的集合()
    • 获取给定事件的所有不完整集
    • 返回ggset[]
  • 获取已完成的集合()
    • 获取给定事件的所有已完成集
    • 返回ggset[]
实例
  • 获取ID()
    • 获取事件的id属性
    • 返回int
  • 获取名称()
    • 获取事件的name属性
    • 返回字符串
  • 获取_slug()
    • 获取事件的slug属性
    • 返回字符串
  • 获取状态()
    • 获取事件的state属性
    • 返回字符串
  • 获取开始位置()
    • 获取事件的start_at属性
    • 返回int
  • 获得更多参赛者()
    • 获取事件的num_entrants属性
    • 返回int
  • 获取缓冲区中的"检查"
    • 获取事件的check-in-buffer属性
    • 返回int
  • 在"持续时间"中获取"检查"
    • 获取事件的check-in-duration属性
    • 返回int
  • 在已启用的情况下获取检查功能()
    • 获取事件的check-in-enabled属性
    • 返回bool
  • 获取联机状态()
    • 获取事件的is_online属性
    • 返回bool
  • 允许获取团队名称()
    • 获取事件的Team_name_allowed属性
    • 返回bool
  • 获取团队管理的最后期限()
    • 获取事件的团队管理截止日期属性
    • 返回int

相位

属性

  • id
    • 相位的数字标识
  • 姓名
    • 字符串
    • 阶段名称
  • 种子数
    • 处于该阶段的种子数
  • 组计数
    • 处于该阶段的相组数

方法

静力学
  • 获取(阶段id)
    • 从smash.gg api获取数据并从中获取phase对象
    • 参数
        <相>
        • 相位的数字标识
    • 返回相位
  • 分析(数据)
    • 将smash.gg api数据解析为阶段对象
    • 参数
      • 数据
        • json
        • 来自smash.gg api调用的http响应数据
        • 返回相位
      • 获取相位组()
        • 获取给定相位的相位组
        • 返回相位组
      • 获取集合()
        • 获取给定阶段的所有播放集
        • 返回ggset[]
      • 获取不完整的集合()
        • 获取给定阶段的所有不完整集
        • 返回ggset[]
      • 获取已完成的集合()
        • 获取给定阶段的所有已完成集
        • 返回ggset[]
      实例
      • 获取ID()
        • 获取阶段的id属性
        • 返回int
      • 获取名称()
        • 获取阶段的name属性
        • 返回字符串
      • 获取种子数()
        • 获取相位的num_seeds属性
        • 返回int
      • 获取组计数()
        • 获取阶段的组计数属性
        • 返回int

      相位组

      属性

      • id
        • 相位组的数字标识
      • 显示标识符
        • 字符串
        • 相组的名称
      • 第一轮时间
        • 此阶段组第一轮开始的Unix纪元
      • 状态
        • 相组的进展
      • 阶段id
        • 此阶段组所属阶段的数字标识
      • 波形id
        • 此相位组所属波的数字标识
      • tiebreak\u订单
        • json
        • 此阶段组的tiebreak顺序

      方法

      静力学
      • 获取(阶段组id)
        • 从smash.gg获取数据并从中获取phaseGroup对象
        • 参数
          • 阶段组ID
            • 相位组的数字标识
      • 分析(数据)
        • 将smash.gg api数据解析为phaseGroup对象
        • 参数
          • 数据
            • json
            • 来自smash.gg api调用的http响应数据
        • 返回相位组
      • 获取集合()
        • 获取给定相位组的所有播放集
        • 返回ggset[]
      • 获取不完整的集合()
        • 获取给定相位组的所有不完整集
        • 返回ggset[]
      • 获取已完成的集合()
        • 获取给定阶段组的所有已完成集
        • 返回ggset[]
      实例
      • 获取ID()
        • 获取相位组的id属性
        • 返回int
      • 获取显示标识符()
        • 获取相位组的display_identifier属性
        • 返回字符串
      • 第一轮获得时间()
        • 获取相组的第一轮时间属性
        • 返回int
      • 获取状态()
        • 获取相位组的状态属性
        • 返回int
      • 获取阶段id()
        • 获取相位组的相位id属性
        • 返回int
      • 获取波形id()
        • 获取相位组的波形id属性
        • 返回int
      • 获取tiebreak订单()
        • 获取相组的tiebreak_order属性
        • 返回json

      集热器

      属性

      • id
        • 集合的数字标识
      • 事件ID
        • 此集合所属事件的数字标识
      • 相组ID
        • 此集合所属阶段组的数字标识
      • 显示得分
        • 字符串
        • 显示此集合的字符串。
          • 格式:smashtag1 score1-score2 smashtag2
      • 整轮文本
        • 字符串
        • 此集合在中发生的回合的全名
      • 圆形
        • 此集合在中发生的圆的数字标识符
      • 开始于
        • 此集合开始于
      • 完成时间
        • 此集合结束于
      • 获胜者id
        • 获胜的参赛者的ID号
      • 全部游戏
        • 此组中玩的游戏总数
      • 状态
        • 集合的进度
      • 播放程序1
      • 播放程序2
      • 分数1
        • 一号选手在该组的得分
      • 得分2
        • 组内2号选手得分

      方法

      静力学
      • 分析(数据)
        • 将smash.gg api数据解析为ggset对象
        • 参数
          • 数据
            • json
            • 来自smash.gg api调用的http响应数据
        • 返回ggset
      • 分析显示分数(显示分数)
        • 分析ggset的display score属性
        • 参数
          • 数据
            • 字符串
            • 显示GGSET对象中的分数字符串
        • 返回自定义对象:
            <李>
            • 字符串或无
            • 玩家1的smashtag
          • P1-评分
            • 玩家1的得分
          • 2Y-TAG
            • 字符串或无
            • 玩家2的smashtag
            • 玩家2的得分
      实例
      • 获取ID()
        • 获取事件的id属性
        • 返回int
      • 获取事件ID()
        • 获取事件的event_id属性
        • 返回int
      • 获取阶段组id()
        • 获取事件的phase_group_id属性
        • 返回int
      • 获取显示分数()
        • 获取事件的display_score属性
        • 返回字符串
      • 获取完整的圆形文本()
        • 获取事件的full_round_text属性
        • 返回字符串
      • 取整(get_round)
        • 获取事件的round属性
        • 返回int
      • 开始使用(at)
        • 获取事件的started属性
        • 返回int
      • 获取已完成的内容
        • 获取事件的completed属性
        • 返回INT
      • 获取优胜者id()
        • 获取活动的winner\u id属性
        • 返回int
      • 获取所有游戏()
        • 获取事件的Total_Games属性
        • 返回int
      • 获取状态()
        • 获取事件的state属性
        • 返回int
      • 获取玩家1()
        • 获取事件的player1属性
        • 返回播放器
      • 获取播放器2()
        • 获取事件的player2属性
        • 返回播放器
      • 获取分数1()
        • 获取事件的score1属性
        • 返回int
      • 获取分数2()
        • 获取事件的score2属性
        • 返回int

      播放器

      属性

      • 标记
        • 字符串
        • 此播放器的smashtag/标识符
      • 参赛者ID
        • 此玩家的唯一参赛者ID号
      • 与会者ID
        • 内景[]
        • 构成此播放器的与会者的与会者ID数组

      方法

      静力学
      • 分析(标记、数据)
        • 将smash.gg api数据解析为player对象
        • 参数
            标签
            • 字符串
            • 玩家的扣球标签
          • 数据
            • json
            • 将来自sMashGG的数据解析为参赛者和与会者ID
        • 返回播放器
      实例
      • 获取标签()
        • 获取此播放器的tag属性
        • 返回字符串
      • 获取进入者id()
        • 获取此玩家的进入者ID属性
        • 返回int
      • 获取与会者ID()
        • 获取此播放机的"与会者ID"属性
        • 返回int[]

      参赛者

      属性

      • id
        • 参赛者身份证号码
      • 姓名
        • 字符串
        • 参赛者姓名
      • 事件ID
        • 此参赛者所属事件的ID号
      • 技巧
        • 参赛者技能数
      • 与会者数据
        • 与会者[]
        • 附加到此参赛者的与会者数据数组

      方法

      静力学
      • 分析(数据)
        • 将smash.gg api数据解析为进入对象
        • 参数
          • 数据
            • json
            • 来自smash.gg api调用的http响应数据
        • 返回进入者
      实例
      • 获取ID()
        • 获取进入者的id属性
        • 返回
      • 获取名称()
        • 获取进入者的name属性
        • 返回
      • 获取事件ID()
        • 获取进入者的事件id属性
        • 返回
      • 获得技能()
        • 获得参赛者的技能属性
        • 返回
      • 获取与会者数据()
        • 获取参赛者的Attendee_数据属性
        • 返回

      与会者

      属性

      • id
        • 与会者的数字标识
      • 玩家标签
        • 字符串
        • 与会者的精彩表演
      • 前缀
        • 字符串
        • 与会者的赞助商标签(如PG或RC)
      • 创建于
        • 创建此与会者对象的Unix纪元
      • 索赔
        • 布尔
        • 如果有人认领或没有认领与会者,则为T/F
      • 已验证
        • 布尔
        • T/F表示参加者是否被证实确实参加了比赛
      • 玩家ID
        • 相应对象的id号
      • 电话号码
        • 字符串
        • 与会者的电话号码
      • 已连接的帐户
        • json
        • 对象,显示连接到此与会者的所有帐户
      • 联系信息
        • json
        • 与会者的联系方式
      • 事件ID
        • 内景[]
        • 此与会者输入的所有活动的ID号

      方法

      静力学
      • 分析(数据)
        • 将smash.gg API数据解析为Attendee对象
        • 参数
          • 数据
            • json
            • 来自smash.gg api调用的http响应数据
        • 返回与会者
      实例
      • 获取ID()
        • 获取与会者的id属性
        • 返回
      • 获取游戏玩家标签()
        • 获取与会者的gamer_tag属性
        • 返回
      • 获取前缀()
        • 获取与会者的前缀属性
        • 返回
      • 获取已创建的内容
        • 获取与会者的created_at属性
        • 返回
      • 获得索赔()
        • 获取与会者的声明财产
        • 返回
      • 获得验证()
        • 获取与会者的已验证属性
        • 返回
      • 获取玩家ID()
        • 获取与会者的玩家ID属性
        • 返回
      • 获取电话号码()
        • 获取与会者的电话号码属性
        • 返回
      • 获取已连接的帐户()
        • 获取与会者的"已连接帐户"属性
        • 返回
      • 获取联系人信息()
        • 获取与会者的联系人信息属性
        • 返回
      • 获取事件ID()
        • 获取与会者的事件ID属性
        • 返回

      属性

      • id
        • 流的数字标识
      • 事件ID
        • 此流所属事件的数字标识
      • 锦标赛
        • 锦标赛的数字标识此流是
      • 流名称
        • 字符串
        • 流的名称
      • 数字设置
        • 流上的设置数
      • 流源
        • 字符串
        • 流的Web源,如Twitch
      • 流类型
        • 字符串
        • 当前流的类型
      • 流类型ID
        • 当前流的数字类型
      • 是否联机
        • 布尔
        • 如果当前流联机,则为T/F
      • 已启用
        • 布尔
        • t/f,如果当前流已启用
      • 跟随者计数
          <L流的关注者数
      • 删除任务
        • 布尔
        • t/f表示当前流是否删除任务
      • 流状态
        • 字符串
        • 当前流的状态
      • 流媒体游戏
        • 字符串
        • 当前流正在直播的游戏
      • 流媒体徽标
        • 字符串
        • 流的徽标图像的URL

      方法

      静力学
      • 获取(id)
        • 从smashgg获取给定id的原始流数据
        • 参数
          • ID
            • 流的标识号
        • 返回流
      • 分析(数据)
        • 将smash.gg api数据解析为流对象
        • 参数
          • 数据
            • json
            • 来自smash.gg api调用的http响应数据
        • 返回流
      实例
      • 获取ID()
        • 获取流的id属性
        • 返回
      • 获取事件ID()
        • 获取流的event\u id属性
        • 返回
      • 获取锦标赛ID()
        • 获取流的锦标赛ID属性
        • 返回
      • 获取流名称()
        • 获取流的stream\u name属性
        • 返回
      • 获取数值设置()
        • 获取流的num_setups属性
        • 返回
      • 获取流源代码()
        • 获取流的stream_source属性
        • 返回
      • 获取流类型()
        • 获取流的stream_type属性
        • 返回
      • 获取流类型id()
        • 获取流的stream_type_id属性
        • 返回
      • 获取联机状态()
        • 获取流的is_online属性
        • 返回
      • 启用"获取"
        • 获取流的enabled属性
        • 返回
      • 获取跟随者计数()
        • 获取流的follower_count属性
        • 返回
      • 获取/删除任务()
        • 获取流的removes_tasks属性
        • 返回
      • 获取流状态()
        • 获取流的stream_status属性
        • 返回
      • 获取流游戏()
        • 获取流的stream_game属性
        • 返回
      • 获取流徽标()
        • 获取流的stream_logo属性
        • 返回

      流队列

      属性

      • id
        • 此流队列所属锦标赛的ID
        • 流此队列与
      • 设置
        • ggset[]
        • 在队列中设置

      方法

      • 获取(锦标赛ID)

        • 获取给定锦标赛ID的原始流队列数据
        • 参数
          • 锦标赛
            • 锦标赛的识别号
        • 返回streamqueue
      • 分析(数据)

        • 将smash.gg api数据解析为streamqueue对象
        • 参数
          • 数据
            • json
            • 来自smash的http响应数据。gg api调用
        • 返回streamqueue
      实例
      • 获取流()
        • 获取streamqueue的stream属性
      • 获取集合()
        • 获取streamqueue的sets属性
        • ggset[]

      如何运行

      注意:为了正确使用,您需要创建一个.env文件,其中包含api_标记,它应该如下所示: api_token=<;在此处插入smash.gg api token>; 如果已经安装了docker,可以在/docker目录中运行脚本。 您需要在运行容器之前构建它,所以在运行之前运行buildbeforerun。 如果您想连续地执行这两个操作,可以运行build和run脚本。

      欢迎加入QQ群-->: 979659372 Python中文网_新手群

      推荐PyPI第三方库


热门话题
使用SerializationUtils时java ClassNotFoundException。克隆()   java Cucumber+spring:如何通过测试触发SmartLifecycle事件?   java如何使ProGuard以简单的方式工作?   java JSP页面显示来自集合的日期   谷歌地图检查坐标是否位于JAVA中谷歌地图API的多边形中   java如何在终端中使用“tokens”打印令牌?   java获取编译错误:包com。威里奥。sdk不存在   java会使用JAXB或类似工具自动填充HATEAOS链接吗?   Javascript(GraalJS)与Java中未签名的右移>>>>   如何在Java代码中创建jdbc请求的Jmeter测试   java如何在CellList中添加或删除单个元素?   java Progressbar:如何创建原始对象的深度副本