获取作品

获取作品信息

解析作品ID

使用getWorkIdFromUrl方法从作品url中提取作品的id。

def getWorkIdFromUrl(url : str) -> str

示例：

from icodeapi import getWorkIdFromUrl
print(getWorkIdFromUrl('https://icodeshequ.youdao.com/work/a1f09b5eb34a48dfbdc8dee59d130ec6'))

输出：

a1f09b5eb34a48dfbdc8dee59d130ec6

获取作品信息

使用getWorkDetail方法获取一个作品的基本信息。

def getWorkDetail(self, 
    workId : str, 
    addBrowseNum : bool = True
) -> dict

workId ： 作品id addBrowseNum ： 是否增加浏览量

返回的字典格式通常如下：

{
    'id': str,  # 作品id
    'title': str,  # 作品标题
    'imgUrl': str,  # 作品封面url
    'description': str, # 作品简介
    'type': int, # 作品类型
    'userId': str, # 发布者用户id
    'status': int, # 发布状态（1为未发布,2为已发布）
    'likeNum': int, # 点赞数
    'browseNum': int, # 浏览量
    'enshrineNum': int, # 收藏量
    'code': str,  # 作品源码
    'userName': str,  # 发布者用户名
    'userImage': str,  # 发布者用户头像url
    'haveLiked': bool ,  # 是否已点赞
    'haveEnshrined': bool,  # 是否收藏
    'createTimeStr': str,   # 创建时间
    'updateTimeStr': str,  # 更新时间
    'codeLanguage': str,  # 代码语言（blocky, scratch或python）
    'shortLink': str,  # 分享链接
    'theme': str,  # 作品主题
    'subTheme': str,  # 作品发布主题
    'iframeUrl': str,  # 作品iframe地址
    'scratchFile': str,  # scratch作品文件url
    'codeType': str,  # 代码类型
    'firstPopups': bool , # 是否在作品发布者点进该作品后显示弹窗
    'forkAuthorizationStatus': bool,  # 是否允许他人fork
    'isFirstPublish': bool, # 是否为首次发布
    'haveReported': bool # 是否已举报
}

使用getWorkSubmitInfo方法获取一个作品在发布时向后台提交的数据。（与submitWork方法发送的数据几乎相同）。

def getWorkSubmitInfo(self, workId : str) -> dict

返回的字典格式通常如下：

{
    'avatar': str,  # 作者头像url
    'category': str,  # 不明意义
    'codeType': str,  # 代码类型
    'commit': str,  # 提交时间
    'createtime': str,  # 创建时间
    'description': str,  # 作品简介
    'fork': int,  # 是否允许fork
    'forkcommit': str,  # 不明意义
    'forkfrom': str,  # 从哪里fork（一个workId）
    'likes': int,  # 点赞数
    'owner': str,  # 不明意义
    'publish': int,  # 是否公开（1为不公开，2为公开）
    'qrCodeImage': str,  # 作品二维码图片url
    'shareMessage': str,  # 分享信息
    'shareText': str,  # 分享文本
    'shareTitle': str,  # 分享标题
    'subtheme': str,  # 发布主题
    'theme': str,  # 主题
    'thumbnail': str,  # 封面url
    'thumbnailList': list,  # 封面列表
    'title': str,  # 标题
    'username': str,  # 作者名
    'visits': int,  # 浏览量
    'workid': str  # 作品id
}