markji.types package

class markji.types.Path

路径

str 的别名

class markji.types.UserID

用户 ID

int 的别名

class markji.types.FolderID

文件夹 ID

str 的别名

class markji.types.DeckID

卡组 ID

str 的别名

class markji.types.ChapterID

章节 ID

str 的别名

class markji.types.ChapterSetID

章节集 ID

str 的别名

class markji.types.CardID

卡片 ID

str 的别名

class markji.types.CardRootID

卡片根 ID

str 的别名

class markji.types.FileID

文件 ID

str 的别名

class markji.types.AccessSettingID

访问设置 ID

str 的别名

class markji.types.UserGender(value)

基类：StrEnum

Enum 用户性别

• MALE: 男

• FEMALE: 女

• SECRECY: 保密

MALE = 'MALE'

FEMALE = 'FEMALE'

SECRECY = 'SECRECY'

class markji.types.Status(value)

基类：StrEnum

Enum 文件夹状态

• NORMAL: 正常

NORMAL = 'NORMAL'

class markji.types.ItemObjectClass(value)

基类：StrEnum

Enum 文件夹项目对象类

• FOLDER: 文件夹

• DECK: 卡组

• CARD: 卡片

FOLDER = 'FOLDER'

DECK = 'DECK'

CARD = 'CARD'

class markji.types.DeckSource(value)

基类：StrEnum

Enum 卡组来源

• SELF: 自己创建

• FORK: 收藏他人

SELF = 'SELF'

FORK = 'FORK'

class markji.types.FileSource(value)

基类：StrEnum

Enum 文件来源 (语音)

• UPLOAD: 上传

• TTS: 语音合成

UPLOAD = 'UPLOAD'

TTS = 'TTS'

class markji.types.LanguageCode(value)

基类：StrEnum

Enum 语言代码

• AR_DZ: 阿拉伯语 (阿尔及利亚)

• AR_AE: 阿拉伯语 (阿联酋)

• AR_EG: 阿拉伯语 (埃及)

• AR_BH: 阿拉伯语 (巴林)

• AR_QA: 阿拉伯语 (卡塔尔)

• AR_KW: 阿拉伯语 (科威特)

• AR_LY: 阿拉伯语 (利比亚)

• AR_MA: 阿拉伯语 (摩洛哥)

• AR_SA: 阿拉伯语 (沙特阿拉伯)

• AR_TN: 阿拉伯语 (突尼斯)

• AR_SY: 阿拉伯语 (叙利亚)

• AR_YE: 阿拉伯语 (也门)

• AR_IQ: 阿拉伯语 (伊拉克)

• AR_JO: 阿拉伯语 (约旦)

• AM_ET: 阿姆哈拉语 (埃塞俄比亚)

• GA_IE: 爱尔兰语 (爱尔兰)

• ET_EE: 爱沙尼亚语 (爱沙尼亚)

• BG_BG: 保加利亚语 (保加利亚)

• PL_PL: 波兰语 (波兰)

• FA_IR: 波斯语 (伊朗)

• DA_DK: 丹麦语 (丹麦)

• DE_AT: 德语 (奥地利)

• DE_DE: 德语 (德国)

• DE_CH: 德语 (瑞士)

• RU_RU: 俄语 (俄罗斯)

• FR_BE: 法语 (比利时)

• FR_FR: 法语 (法国)

• FR_CA: 法语 (加拿大)

• FR_CH: 法语 (瑞士)

• FIL_PH: 菲律宾语 (菲律宾)

• FI_FI: 芬兰语 (芬兰)

• KM_KH: 高棉语 (柬埔寨)

• GU_IN: 古吉拉特语 (印度)

• KO_KR: 韩语 (韩国)

• NL_BE: 荷兰语 (比利时)

• NL_NL: 荷兰语 (荷兰)

• GL_ES: 加利西亚语 (西班牙)

• CA_ES: 加泰罗尼亚语 (西班牙)

• CS_CZ: 捷克语 (捷克)

• HR_HR: 克罗地亚语 (克罗地亚)

• LV_LV: 拉脱维亚语 (拉脱维亚)

• LT_LT: 立陶宛语 (立陶宛)

• RO_RO: 罗马尼亚语 (罗马尼亚)

• MT_MT: 马耳他语 (马耳他)

• MR_IN: 马拉地语 (印度)

• MS_MY: 马来语 (马来西亚)

• BN_BD: 孟加拉语 (孟加拉国)

• MY_MM: 缅甸语 (缅甸)

• AF_ZA: 南非荷兰语 (南非)

• NB_NO: 挪威博克马尔语 (挪威)

• PT_BR: 葡萄牙语 (巴西)

• PT_PT: 葡萄牙语 (葡萄牙)

• JA_JP: 日语 (日本)

• SV_SE: 瑞典语 (瑞典)

• SK_SK: 斯洛伐克语 (斯洛伐克)

• SL_SI: 斯洛文尼亚语 (斯洛文尼亚)

• SW_KE: 斯瓦希里语 (肯尼亚)

• SW_TZ: 斯瓦希里语 (坦桑尼亚)

• SO_SO: 索马里语 (索马里)

• TE_IN: 泰卢固语 (印度)

• TA_LK: 泰米尔语 (斯里兰卡)

• TA_SG: 泰米尔语 (新加坡)

• TA_IN: 泰米尔语 (印度)

• TH_TH: 泰语 (泰国)

• TR_TR: 土耳其语 (土耳其)

• CY_GB: 威尔士语 (英国)

• UR_PK: 乌尔都语 (巴基斯坦)

• UR_IN: 乌尔都语 (印度)

• UK_UA: 乌克兰语 (乌克兰)

• UZ_UZ: 乌兹别克语 (乌兹别克斯坦)

• ES_NI: 西班牙语 (尼加拉瓜)

• ES_AR: 西班牙语 (阿根廷)

• ES_PY: 西班牙语 (巴拉圭)

• ES_PA: 西班牙语 (巴拿马)

• ES_PR: 西班牙语 (波多黎各)

• ES_BO: 西班牙语 (玻利维亚)

• ES_GQ: 西班牙语 (赤道几内亚)

• ES_DO: 西班牙语 (多米尼加共和国)

• ES_EC: 西班牙语 (厄瓜多尔)

• ES_CO: 西班牙语 (哥伦比亚)

• ES_CR: 西班牙语 (哥斯达黎加)

• ES_CU: 西班牙语 (古巴)

• ES_HN: 西班牙语 (洪都拉斯)

• ES_US: 西班牙语 (美国)

• ES_PE: 西班牙语 (秘鲁)

• ES_MX: 西班牙语 (墨西哥)

• ES_SV: 西班牙语 (萨尔瓦多)

• ES_GT: 西班牙语 (危地马拉)

• ES_VE: 西班牙语 (委内瑞拉)

• ES_UY: 西班牙语 (乌拉圭)

• ES_ES: 西班牙语 (西班牙)

• ES_CL: 西班牙语 (智利)

• HE_IL: 希伯来语 (以色列)

• EL_GR: 希腊语 (希腊)

• HU_HU: 匈牙利语 (匈牙利)

• SU_ID: 巽他语 (印度尼西亚)

• IT_IT: 意大利语 (意大利)

• HI_IN: 印地语 (印度)

• ID_ID: 印尼语 (印度尼西亚)

• EN_IE: 英语 (爱尔兰)

• EN_AU: 英语 (澳大利亚)

• EN_PH: 英语 (菲律宾)

• EN_CA: 英语 (加拿大)

• EN_KE: 英语 (肯尼亚)

• EN_US: 英语 (美国)

• EN_ZA: 英语 (南非)

• EN_NG: 英语 (尼日利亚)

• EN_TZ: 英语 (坦桑尼亚)

• EN_HK: 英语 (香港)

• EN_SG: 英语 (新加坡)

• EN_NZ: 英语 (新西兰)

• EN_IN: 英语 (印度)

• EN_GB: 英语 (英国)

• VI_VN: 越南语 (越南)

• JV_ID: 爪哇语 (印度尼西亚)

• ZH_CN: 中文 (中国)

• ZH_TW: 中文 (台湾)

• ZH_HK: 中文 (香港)

• ZU_ZA: 祖鲁语 (南非)

AR_DZ = 'ar-DZ'

AR_AE = 'ar-AE'

AR_EG = 'ar-EG'

AR_BH = 'ar-BH'

AR_QA = 'ar-QA'

AR_KW = 'ar-KW'

AR_LY = 'ar-LY'

AR_MA = 'ar-MA'

AR_SA = 'ar-SA'

AR_TN = 'ar-TN'

AR_SY = 'ar-SY'

AR_YE = 'ar-YE'

AR_IQ = 'ar-IQ'

AR_JO = 'ar-JO'

AM_ET = 'am-ET'

GA_IE = 'ga-IE'

ET_EE = 'et-EE'

BG_BG = 'bg-BG'

PL_PL = 'pl-PL'

FA_IR = 'fa-IR'

DA_DK = 'da-DK'

DE_AT = 'de-AT'

DE_DE = 'de-DE'

DE_CH = 'de-CH'

RU_RU = 'ru-RU'

FR_BE = 'fr-BE'

FR_FR = 'fr-FR'

FR_CA = 'fr-CA'

FR_CH = 'fr-CH'

FIL_PH = 'fil-PH'

FI_FI = 'fi-FI'

KM_KH = 'km-KH'

GU_IN = 'gu-IN'

KO_KR = 'ko-KR'

NL_BE = 'nl-BE'

NL_NL = 'nl-NL'

GL_ES = 'gl-ES'

CA_ES = 'ca-ES'

CS_CZ = 'cs-CZ'

HR_HR = 'hr-HR'

LV_LV = 'lv-LV'

LT_LT = 'lt-LT'

RO_RO = 'ro-RO'

MT_MT = 'mt-MT'

MR_IN = 'mr-IN'

MS_MY = 'ms-MY'

BN_BD = 'bn-BD'

MY_MM = 'my-MM'

AF_ZA = 'af-ZA'

NB_NO = 'nb-NO'

PT_BR = 'pt-BR'

PT_PT = 'pt-PT'

JA_JP = 'ja-JP'

SV_SE = 'sv-SE'

SK_SK = 'sk-SK'

SL_SI = 'sl-SI'

SW_KE = 'sw-KE'

SW_TZ = 'sw-TZ'

SO_SO = 'so-SO'

TE_IN = 'te-IN'

TA_LK = 'ta-LK'

TA_SG = 'ta-SG'

TA_IN = 'ta-IN'

TH_TH = 'th-TH'

TR_TR = 'tr-TR'

CY_GB = 'cy-GB'

UR_PK = 'ur-PK'

UR_IN = 'ur-IN'

UK_UA = 'uk-UA'

UZ_UZ = 'uz-UZ'

ES_NI = 'es-NI'

ES_AR = 'es-AR'

ES_PY = 'es-PY'

ES_PA = 'es-PA'

ES_PR = 'es-PR'

ES_BO = 'es-BO'

ES_GQ = 'es-GQ'

ES_DO = 'es-DO'

ES_EC = 'es-EC'

ES_CO = 'es-CO'

ES_CR = 'es-CR'

ES_CU = 'es-CU'

ES_HN = 'es-HN'

ES_US = 'es-US'

ES_PE = 'es-PE'

ES_MX = 'es-MX'

ES_SV = 'es-SV'

ES_GT = 'es-GT'

ES_VE = 'es-VE'

ES_UY = 'es-UY'

ES_ES = 'es-ES'

ES_CL = 'es-CL'

HE_IL = 'he-IL'

EL_GR = 'el-GR'

HU_HU = 'hu-HU'

SU_ID = 'su-ID'

IT_IT = 'it-IT'

HI_IN = 'hi-IN'

ID_ID = 'id-ID'

EN_IE = 'en-IE'

EN_AU = 'en-AU'

EN_PH = 'en-PH'

EN_CA = 'en-CA'

EN_KE = 'en-KE'

EN_US = 'en-US'

EN_ZA = 'en-ZA'

EN_NG = 'en-NG'

EN_TZ = 'en-TZ'

EN_HK = 'en-HK'

EN_SG = 'en-SG'

EN_NZ = 'en-NZ'

EN_IN = 'en-IN'

EN_GB = 'en-GB'

VI_VN = 'vi-VN'

JV_ID = 'jv-ID'

ZH_CN = 'zh-CN'

ZH_TW = 'zh-TW'

ZH_HK = 'zh-HK'

ZU_ZA = 'zu-ZA'

class markji.types.Datetime

基类：datetime

继承自 datetime.datetime

class markji.types.UserLevel(level: int, description: str)

基类：DataClassJsonMixin

用户等级

参数:

• level (int) -- 等级

• description (str) -- 等级描述

level: int

description: str

class markji.types.UserOAuth(type: str, appid: str, username: str)

基类：DataClassJsonMixin

用户授权

参数:

• type (str) -- 授权类型

• appid (str) -- 授权AppID

• username (str) -- 用户名

type: str

appid: str

username: str

class markji.types.FolderItem(object_id: str, object_class: ItemObjectClass)

基类：DataClassJsonMixin

文件夹项目

参数:

• object_id (str) -- 对象ID

• object_class (ItemObjectClass) -- 对象类

object_id: str

object_class: ItemObjectClass

class markji.types.DeckAccessSettingBasic(validation_enabled: bool)

基类：DataClassJsonMixin

卡组基本访问设置

参数:

validation_enabled (bool) -- 是否启用验证

validation_enabled: bool

class markji.types.DeckAccessSettingBrief(validation_enabled: bool, id: AccessSettingID, deck_id: DeckID, is_private: bool, is_searchable: bool)

基类：DeckAccessSettingBasic

卡组简要访问设置

更改是否可搜索且不启用验证时返回

参数:

• validation_enabled (bool) -- 是否启用验证

• deck_id (DeckID) -- 卡组ID

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

Id:

AccessSettingID id: 访问设置ID

id: AccessSettingID

deck_id: DeckID

is_private: bool

is_searchable: bool

class markji.types.DeckAccessSettingInfo(validation_enabled: bool, id: AccessSettingID, deck_id: DeckID, is_private: bool, is_searchable: bool, validation_request_access: bool, validation_password_enabled: bool, validation_redeem_code: bool)

基类：DeckAccessSettingBrief

卡组访问设置信息

启用验证但不启用密码时返回

参数:

• validation_enabled (bool) -- 是否启用验证

• deck_id (DeckID) -- 卡组ID

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• validation_request_access (bool) -- 是否需要验证

• validation_password_enabled (bool) -- 是否启用密码验证

• validation_redeem_code (bool) -- 是否启用验证撤回码（暂无）

Id:

AccessSettingID id: 访问设置ID

validation_request_access: bool

validation_password_enabled: bool

validation_redeem_code: bool

class markji.types.DeckAccessSetting(validation_enabled: bool, id: AccessSettingID, deck_id: DeckID, is_private: bool, is_searchable: bool, validation_request_access: bool, validation_password_enabled: bool, validation_redeem_code: bool, validation_password: str)

基类：DeckAccessSettingInfo

卡组访问设置

启用验证密码时返回

参数:

• validation_enabled (bool) -- 是否启用验证

• deck_id (DeckID) -- 卡组ID

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• validation_request_access (bool) -- 是否需要验证

• validation_password_enabled (bool) -- 是否启用密码验证

• validation_redeem_code (bool) -- 是否启用验证撤回码（暂无）

• validation_password (str) -- 验证密码

Id:

AccessSettingID id: 访问设置ID

validation_password: str

class markji.types.CardReference(id: CardRootID, type: ItemObjectClass = ItemObjectClass.CARD)

基类：DataClassJsonMixin

卡片引用

参数:

• id (CardRootID) -- 对象ID

• type (ItemObjectClass) -- 对象类

id: CardRootID

type: ItemObjectClass = 'CARD'

class markji.types.TTSItem(text: str, locale: LanguageCode)

基类：DataClassJsonMixin

语音合成项目

参数:

• text (str) -- 文本

• locale (LanguageCode) -- 语言代码

text: str

locale: LanguageCode

class markji.types.MaskInfo(description: str | None = None)

基类：DataClassJsonMixin

图片遮罩信息

全新上传的遮罩不含 description 字段

参数:

description (str) -- 描述

description: str | None = None

class markji.types.ImageInfo(width: int, height: int, description: str)

基类：DataClassJsonMixin

图片信息

参数:

• width (int) -- 宽度

• height (int) -- 高度

• description (str) -- 描述

width: int

height: int

description: str

class markji.types.AudioInfo(source: FileSource)

基类：DataClassJsonMixin

音频信息

参数:

source (FileSource) -- 文件来源

source: FileSource

class markji.types.TTSInfo(source: FileSource, content_slices: list[TTSItem])

基类：AudioInfo

语音合成信息

参数:

• source (FileSource) -- 文件来源

• content_slices (list[TTSItem]) -- 语音合成信息

content_slices: list[TTSItem]

class markji.types.File(info: MaskInfo | ImageInfo | AudioInfo | TTSInfo, size: int, mime: str, url: str, id: FileID, expire_time: Datetime)

基类：DataClassJsonMixin

文件

参数:

• info (MaskInfo | ImageInfo | AudioInfo | TTSInfo) -- 文件信息

• size (int) -- 文件大小

• mime (str) -- MIME类型

• url (str) -- 文件Url

• id (FileID) -- 文件ID

• expire_time (Datetime) -- 过期时间

info: MaskInfo | ImageInfo | AudioInfo | TTSInfo

size: int

mime: str

url: str

id: FileID

expire_time: Datetime

class markji.types.MaskItem(top: int, left: int, width: int, height: int, index: int, type: str = 'rect')

基类：DataClassJsonMixin

遮罩项目

参数:

• top (int) -- 顶部位置

• left (int) -- 左侧位置

• width (int) -- 宽度

• height (int) -- 高度

• index (int) -- 索引

• type (str) -- 类型

top: int

left: int

width: int

height: int

index: int

type: str = 'rect'

Submodules

markji.types.card module

class markji.types.card.CardBase(id: CardID, content: str, content_type: int, status: Status, creator: UserID, deck_id: DeckID, root_id: CardRootID, files: list[File], is_modified: bool, revision: int, grammar_version: int, source: DeckSource, created_time: Datetime, updated_time: Datetime)

基类：DataClassJsonMixin

基本卡片

参数:

• id (CardID) -- 卡片 ID

• content (str) -- 内容

• content_type (int) -- 内容类型

• status (Status) -- 状态

• creator (UserID) -- 创建者

• deck_id (DeckID) -- 所属卡组 ID

• root_id (CardRootID) -- 卡片根 ID

• files (list[File]) -- 文件列表

• is_modified (bool) -- 是否修改

• revision (int) -- 修订版本

• grammar_version (int) -- 语法版本

• source (DeckSource) -- 来源

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

id: CardID

content: str

content_type: int

status: Status

creator: UserID

deck_id: DeckID

root_id: CardRootID

files: list[File]

is_modified: bool

revision: int

grammar_version: int

source: DeckSource

created_time: Datetime

updated_time: Datetime

class markji.types.card.Card(id: CardID, content: str, content_type: int, status: Status, creator: UserID, deck_id: DeckID, root_id: CardRootID, files: list[File], is_modified: bool, revision: int, grammar_version: int, source: DeckSource, created_time: Datetime, updated_time: Datetime, card_rids: list[CardRootID])

基类：CardBase

卡片

参数:

• id (CardID) -- 卡片 ID

• content (str) -- 内容

• content_type (int) -- 内容类型

• status (Status) -- 状态

• creator (UserID) -- 创建者

• deck_id (DeckID) -- 所属卡组 ID

• root_id (CardRootID) -- 卡片根 ID

• files (list[File]) -- 文件列表

• is_modified (bool) -- 是否修改

• revision (int) -- 修订版本

• grammar_version (int) -- 语法版本

• source (DeckSource) -- 来源

• card_rids (list[CardRootID]) -- 卡片根 ID 列表

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

card_rids: list[CardRootID]

class markji.types.card.CardResult(id: CardID, content: str, content_type: int, status: Status, creator: UserID, deck_id: DeckID, root_id: CardRootID, files: list[File], is_modified: bool, revision: int, grammar_version: int, source: DeckSource, created_time: Datetime, updated_time: Datetime, references: list[CardReference], deck: DeckBasic)

基类：CardBase

卡片搜索结果

参数:

• id (CardID) -- 卡片 ID

• content (str) -- 内容

• content_type (int) -- 内容类型

• status (Status) -- 状态

• creator (UserID) -- 创建者

• deck_id (DeckID) -- 所属卡组 ID

• root_id (CardRootID) -- 卡片根 ID

• files (list[File]) -- 文件列表

• references (list[CardReference]) -- 引用列表

• is_modified (bool) -- 是否修改

• revision (int) -- 修订版本

• grammar_version (int) -- 语法版本

• source (DeckSource) -- 来源

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

• deck (DeckBasic) -- 所属卡组基本信息

references: list[CardReference]

deck: DeckBasic

markji.types.chapter module

class markji.types.chapter.Chapter(id: ChapterID, deck_id: DeckID, name: str, creator: UserID, revision: int, card_ids: list[CardID], is_modified: bool, created_time: Datetime, updated_time: Datetime)

基类：DataClassJsonMixin

章节

参数:

• id (ChapterID) -- 章节ID

• deck_id (DeckID) -- 卡组ID

• name (str) -- 名称

• creator (UserID) -- 创建者

• revision (int) -- 修订版本

• card_ids (list[CardID]) -- 卡片ID列表

• is_modified (bool) -- 是否修改

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

id: ChapterID

deck_id: DeckID

name: str

creator: UserID

revision: int

card_ids: list[CardID]

is_modified: bool

created_time: Datetime

updated_time: Datetime

class markji.types.chapter.ChapterSet(id: ChapterSetID, deck_id: DeckID, revision: int, chapter_ids: list[ChapterID], is_modified: bool, created_time: Datetime, updated_time: Datetime)

基类：DataClassJsonMixin

章节集合

参数:

• id (ChapterSetID) -- 章节集合ID

• deck_id (DeckID) -- 卡组ID

• revision (int) -- 修订版本

• chapter_ids (list[ChapterID]) -- 章节ID列表

• is_modified (bool) -- 是否修改

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

id: ChapterSetID

deck_id: DeckID

revision: int

chapter_ids: list[ChapterID]

is_modified: bool

created_time: Datetime

updated_time: Datetime

class markji.types.chapter.ChapterDiff(new_chapter: Chapter, old_chapter: Chapter)

基类：DataClassJsonMixin

章节变化

参数:

• new_chapter (Chapter) -- 新章节

• old_chapter (Chapter) -- 旧章节

new_chapter: Chapter

old_chapter: Chapter

markji.types.deck module

class markji.types.deck.DeckBasic(id: DeckID, source: DeckSource, creator: UserID, status: Status, name: str, authors: list[UserID], description: str, is_modified: bool, is_private: bool, is_searchable: bool, like_count: int, revision: int, card_count: int, chapter_count: int, created_time: Datetime, updated_time: Datetime)

基类：DataClassJsonMixin

卡组基本信息

参数:

• id (DeckID) -- 卡组ID

• source (DeckSource) -- 卡组来源

• creator (UserID) -- 创建者ID

• status (Status) -- 状态

• name (str) -- 名称

• authors (list[UserID]) -- 作者ID列表

• description (str) -- 描述

• is_modified (bool) -- 是否已修改

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• like_count (int) -- 点赞数

• revision (int) -- 版本

• card_count (int) -- 卡片数

• chapter_count (int) -- 章节数

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

id: DeckID

source: DeckSource

creator: UserID

status: Status

name: str

authors: list[UserID]

description: str

is_modified: bool

is_private: bool

is_searchable: bool

like_count: int

revision: int

card_count: int

chapter_count: int

created_time: Datetime

updated_time: Datetime

class markji.types.deck.DeckBrief(id: DeckID, source: DeckSource, creator: UserID, status: Status, name: str, authors: list[UserID], description: str, is_modified: bool, is_private: bool, is_searchable: bool, like_count: int, revision: int, card_count: int, chapter_count: int, created_time: Datetime, updated_time: Datetime, is_semantic_learning: bool, card_price: int, tags: list)

基类：DeckBasic

卡组简要信息

参数:

• id (DeckID) -- 卡组ID

• source (DeckSource) -- 卡组来源

• creator (UserID) -- 创建者ID

• status (Status) -- 状态

• name (str) -- 名称

• authors (list[UserID]) -- 作者ID列表

• description (str) -- 描述

• is_modified (bool) -- 是否已修改

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• like_count (int) -- 点赞数

• revision (int) -- 版本

• card_count (int) -- 卡片数

• chapter_count (int) -- 章节数

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

• is_semantic_learning (bool) -- 是否语义学习

• card_price (int) -- 卡片价格

• tags (list) -- 标签

is_semantic_learning: bool

card_price: int

tags: list

class markji.types.deck.DeckInfo(id: DeckID, source: DeckSource, creator: UserID, status: Status, name: str, authors: list[UserID], description: str, is_modified: bool, is_private: bool, is_searchable: bool, like_count: int, revision: int, card_count: int, chapter_count: int, created_time: Datetime, updated_time: Datetime, is_semantic_learning: bool, card_price: int, tags: list, root_creator: UserBasic)

基类：DeckBrief

卡组信息

参数:

• id (DeckID) -- 卡组ID

• source (DeckSource) -- 卡组来源

• creator (UserID) -- 创建者ID

• status (Status) -- 状态

• name (str) -- 名称

• authors (list[UserID]) -- 作者ID列表

• description (str) -- 描述

• is_modified (bool) -- 是否已修改

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• like_count (int) -- 点赞数

• revision (int) -- 版本

• card_count (int) -- 卡片数

• chapter_count (int) -- 章节数

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

• is_semantic_learning (bool) -- 是否语义学习

• card_price (int) -- 卡片价格

• tags (list) -- 标签

• root_creator (UserBasic) -- 根创建者

root_creator: UserBasic

class markji.types.deck.DeckForked(id: DeckID, source: DeckSource, creator: UserID, status: Status, name: str, authors: list[UserID], description: str, is_modified: bool, is_private: bool, is_searchable: bool, like_count: int, revision: int, card_count: int, chapter_count: int, created_time: Datetime, updated_time: Datetime, card_price: int, is_semantic_learning: bool, parent_id: DeckID)

基类：DeckBasic

收藏卡组信息

参数:

• id (DeckID) -- 卡组ID

• source (DeckSource) -- 卡组来源

• creator (UserID) -- 创建者ID

• status (Status) -- 状态

• name (str) -- 名称

• authors (list[UserID]) -- 作者ID列表

• description (str) -- 描述

• is_modified (bool) -- 是否已修改

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• like_count (int) -- 点赞数

• revision (int) -- 版本

• card_count (int) -- 卡片数

• chapter_count (int) -- 章节数

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

• card_price (int) -- 卡片价格

• is_semantic_learning (bool) -- 是否语义学习

• parent_id (DeckID) -- 父卡组ID

card_price: int

is_semantic_learning: bool

parent_id: DeckID

class markji.types.deck.Deck(id: DeckID, source: DeckSource, creator: UserID, status: Status, name: str, authors: list[UserID], description: str, is_modified: bool, is_private: bool, is_searchable: bool, like_count: int, revision: int, card_count: int, chapter_count: int, created_time: Datetime, updated_time: Datetime, is_semantic_learning: bool, card_price: int, tags: list, root_creator: UserBasic, is_anki: bool, access_setting: DeckAccessSettingBasic)

基类：DeckInfo

卡组

参数:

• id (DeckID) -- 卡组ID

• source (DeckSource) -- 卡组来源

• creator (UserID) -- 创建者ID

• status (Status) -- 状态

• name (str) -- 名称

• authors (list[UserID]) -- 作者ID列表

• description (str) -- 描述

• is_modified (bool) -- 是否已修改

• is_private (bool) -- 是否私有

• is_searchable (bool) -- 是否可搜索

• is_semantic_learning (bool) -- 是否语义学习

• like_count (int) -- 点赞数

• revision (int) -- 版本

• card_count (int) -- 卡片数

• card_price (int) -- 卡片价格

• chapter_count (int) -- 章节数

• tags (list) -- 标签

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新时间

• is_anki (bool) -- 是否从Anki导入

• root_creator (UserBasic) -- 根创建者

• access_setting (DeckAccessSettingBasic) -- 访问设置

is_anki: bool

access_setting: DeckAccessSettingBasic

markji.types.folder module

class markji.types.folder.RootFolder(id: FolderID, creator: UserID, status: Status, items: list[FolderItem], name: str, created_time: Datetime, updated_time: Datetime)

基类：DataClassJsonMixin

根文件夹

参数:

• id (FolderID) -- 文件夹ID

• creator (UserID) -- 创建者ID

• status (Status) -- 文件夹状态

• items (list[FolderItem]) -- 文件夹项目

• name (str) -- 文件夹名称

• created_time (Datetime) -- 创建时间

id: FolderID

creator: UserID

status: Status

items: list[FolderItem]

name: str

created_time: Datetime

updated_time: Datetime

class markji.types.folder.Folder(id: FolderID, creator: UserID, status: Status, items: list[FolderItem], name: str, created_time: Datetime, updated_time: Datetime, parent_id: FolderID)

基类：RootFolder

文件夹

参数:

• id (FolderID) -- 文件夹ID

• creator (UserID) -- 创建者ID

• status (Status) -- 文件夹状态

• items (list[FolderItem]) -- 文件夹项目

• name (str) -- 文件夹名称

• created_time (Datetime) -- 创建时间

• updated_time (Datetime) -- 更新

• parent_id (FolderID) -- 父文件夹ID

parent_id: FolderID

class markji.types.folder.FolderDiff(new_folder: Folder, old_folder: Folder)

基类：DataClassJsonMixin

文件夹差异

参数:

• new_folder (Folder) -- 新文件夹

• old_folder (Folder) -- 旧文件夹

new_folder: Folder

old_folder: Folder

markji.types.user module

class markji.types.user.UserBasic(nickname: str, avatar: str, id: UserID)

基类：DataClassJsonMixin

用户基础信息

参数:

• nickname (str) -- 昵称

• avatar (str) -- 头像Url

• id (UserID) -- 用户ID

nickname: str

avatar: str

id: UserID

class markji.types.user.UserBrief(nickname: str, avatar: str, id: UserID, level: UserLevel, description: str, gender: UserGender)

基类：UserBasic

用户简要信息

参数:

• nickname (str) -- 昵称

• avatar (str) -- 头像

• level (UserLevel) -- 等级

• description (str) -- 描述

• gender (UserGender) -- 性别

• id (UserID) -- 用户ID

level: UserLevel

description: str

gender: UserGender

class markji.types.user.User(nickname: str, avatar: str, id: UserID, description: str, gender: UserGender, status: Status, self_deck_count: int, mark_contribution_count: int, deck_count: int)

基类：UserBasic

用户信息

参数:

• nickname (str) -- 昵称

• avatar (str) -- 头像

• description (str) -- 描述

• gender (UserGender) -- 性别

• id (UserID) -- 用户ID

• status (Status) -- 状态

• self_deck_count (int) -- 自己的卡组数

• mark_contribution_count (int) -- 标记贡献数

• deck_count (int) -- 卡组数

description: str

gender: UserGender

status: Status

self_deck_count: int

mark_contribution_count: int

deck_count: int

class markji.types.user.Profile(nickname: str, avatar: str, id: UserID, level: UserLevel, description: str, gender: UserGender, email: str, email_verified: bool, phone: str, phone_verified: bool, oauths: list[UserOAuth], city: str, school: str, constellation: str, alipay_oauth: dict, birthday: Datetime)

基类：UserBrief

用户简介

参数:

• nickname (str) -- 昵称

• avatar (str) -- 头像

• level (UserLevel) -- 等级

• email (str) -- 邮箱

• email_verified (bool) -- 邮箱是否验证

• phone (str) -- 手机号

• phone_verified (bool) -- 手机号是否验证

• oauths (list[UserOAuth]) -- OAuth信息

• gender (UserGender) -- 性别

• city (str) -- 城市

• school (str) -- 学校

• description (str) -- 描述

• constellation (str) -- 星座 (暂无)

• alipay_oauth (dict) -- 支付宝信息 (暂无)

• id (UserID) -- 用户ID

• birthday (Datetime) -- 生日

email: str

email_verified: bool

phone: str

phone_verified: bool

oauths: list[UserOAuth]

city: str

school: str

constellation: str

alipay_oauth: dict

birthday: Datetime

class markji.types.user.Collaborator(nickname: str, avatar: str, id: UserID, level: UserLevel, description: str, gender: UserGender, is_collaborator: bool)

基类：UserBrief

协作者

参数:

• nickname (str) -- 昵称

• avatar (str) -- 头像

• level (UserLevel) -- 等级

• description (str) -- 描述

• gender (UserGender) -- 性别

• id (UserID) -- 用户ID

• is_collaborator (bool) -- 是否是协作者

is_collaborator: bool