Skip to content

Commit

Permalink
fix: 类型注释向下适配
Browse files Browse the repository at this point in the history
  • Loading branch information
WindowsSov8forUs committed May 16, 2024
1 parent 1e1efa2 commit 90ed950
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 35 deletions.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name='tsugu-api-python',
version='1.1.4',
version='1.1.5',
author='WindowsSov8',
author_email='[email protected]',
description='Tsugu BanGDream Bot 的功能 API 统合包',
Expand Down
6 changes: 4 additions & 2 deletions tsugu_api/_bandoristation.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from typing import List

from tsugu_api import settings
from tsugu_api._network import Api
from tsugu_api._typing import _StationRoom
Expand Down Expand Up @@ -34,11 +36,11 @@ def submit_room_number(number: int, user_id: str, raw_message: str, source: str,
if response['status'] == 'failure':
raise RoomSubmitFailure(response['response'])

def query_room_number() -> list[_StationRoom]:
def query_room_number() -> List[_StationRoom]:
'''获取房间号
返回:
list[_StationRoom]: 房间信息列表
List[_StationRoom]: 房间信息列表
'''

# 构建参数
Expand Down
18 changes: 9 additions & 9 deletions tsugu_api/_tsugu.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Optional
from typing import List, Optional

from tsugu_api import settings
from tsugu_api._network import Api
Expand Down Expand Up @@ -124,7 +124,7 @@ def lsycx(server: _Server, tier: int, event_id: Optional[int] = None) -> _Respon
proxy=settings.backend_proxy
).post(data).json()

def room_list(room_list: list[_Room]) -> _Response:
def room_list(room_list: List[_Room]) -> _Response:
'''绘制车牌绘图
参数:
Expand All @@ -149,7 +149,7 @@ def room_list(room_list: list[_Room]) -> _Response:
proxy=settings.backend_proxy
).post(data).json()

def search_card(default_servers: list[_Server], text: str) -> _Response:
def search_card(default_servers: List[_Server], text: str) -> _Response:
'''查询卡片
参数:
Expand Down Expand Up @@ -177,7 +177,7 @@ def search_card(default_servers: list[_Server], text: str) -> _Response:
proxy=settings.backend_proxy
).post(data).json()

def search_character(default_servers: list[_Server], text: str) -> _Response:
def search_character(default_servers: List[_Server], text: str) -> _Response:
'''查询角色
参数:
Expand All @@ -204,7 +204,7 @@ def search_character(default_servers: list[_Server], text: str) -> _Response:
proxy=settings.backend_proxy
).post(data).json()

def search_event(default_servers: list[_Server], text: str) -> _Response:
def search_event(default_servers: List[_Server], text: str) -> _Response:
'''查询活动
参数:
Expand Down Expand Up @@ -232,7 +232,7 @@ def search_event(default_servers: list[_Server], text: str) -> _Response:
proxy=settings.backend_proxy
).post(data).json()

def search_gacha(default_servers: list[_Server], gacha_id: int) -> _Response:
def search_gacha(default_servers: List[_Server], gacha_id: int) -> _Response:
'''查询卡池
参数:
Expand Down Expand Up @@ -288,7 +288,7 @@ def search_player(player_id: int, server: _Server) -> _Response:
proxy=settings.backend_proxy
).post(data).json()

def search_song(default_servers: list[_Server], text: str) -> _Response:
def search_song(default_servers: List[_Server], text: str) -> _Response:
'''查询歌曲
参数:
Expand All @@ -315,7 +315,7 @@ def search_song(default_servers: list[_Server], text: str) -> _Response:
proxy=settings.backend_proxy
).post(data).json()

def song_chart(default_servers: list[_Server], song_id: int, difficulty_text: _DifficultyText) -> _Response:
def song_chart(default_servers: List[_Server], song_id: int, difficulty_text: _DifficultyText) -> _Response:
'''查询歌曲谱面
参数:
Expand Down Expand Up @@ -344,7 +344,7 @@ def song_chart(default_servers: list[_Server], song_id: int, difficulty_text: _D
proxy=settings.backend_proxy
).post(data).json()

def song_meta(default_servers: list[_Server], server: _Server) -> _Response:
def song_meta(default_servers: List[_Server], server: _Server) -> _Response:
'''查询歌曲分数表
参数:
Expand Down
13 changes: 7 additions & 6 deletions tsugu_api/_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

from typing import (
Any,
List,
Union,
Literal,
TypeAlias,
Expand Down Expand Up @@ -43,7 +44,7 @@ class _Data(TypedDict):
type: Literal['string', 'base64']
string: str

_Response: TypeAlias = list[_Data]
_Response: TypeAlias = List[_Data]

_DifficultyText: TypeAlias = Literal['easy', 'normal', 'hard', 'expert', 'special']
'''难度名'''
Expand Down Expand Up @@ -74,7 +75,7 @@ class _Room(TypedDict):
class _QueryResponse(TypedDict):
'''`/station/queryAllRoom` 响应结果'''
status: _Status
data: Union[str, list[_Room]]
data: Union[str, List[_Room]]

class _TsuguUserServer(TypedDict):
'''服务器数据'''
Expand All @@ -87,9 +88,9 @@ class _TsuguUser(TypedDict):
user_id: str
platform: str
server_mode: _ServerId
default_server: list[_ServerId]
default_server: List[_ServerId]
car: bool
server_list: list[_TsuguUserServer]
server_list: List[_TsuguUserServer]

class _GetUserDataResponse(TypedDict):
'''`/user/getUserData` 响应结果'''
Expand All @@ -101,9 +102,9 @@ class _Update(TypedDict):
user_id: NotRequired[str]
platform: NotRequired[str]
server_mode: NotRequired[_ServerId]
default_server: NotRequired[list[_ServerId]]
default_server: NotRequired[List[_ServerId]]
car: NotRequired[bool]
server_list: NotRequired[list[_TsuguUserServer]]
server_list: NotRequired[List[_TsuguUserServer]]

class _ChangeUserDataResponse(TypedDict):
'''`/user/changeUserData` 响应结果'''
Expand Down
6 changes: 4 additions & 2 deletions tsugu_api_async/_bandoristation.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from typing import List

from httpx import Response

from tsugu_api_async import settings
Expand Down Expand Up @@ -38,11 +40,11 @@ async def submit_room_number(number: int, user_id: str, raw_message: str, source
if response['status'] == 'failure':
raise RoomSubmitFailure(response['response'])

async def query_room_number() -> list[_StationRoom]:
async def query_room_number() -> List[_StationRoom]:
'''获取房间号
返回:
list[_StationRoom]: 房间信息列表
List[_StationRoom]: 房间信息列表
'''

# 构建参数
Expand Down
18 changes: 9 additions & 9 deletions tsugu_api_async/_tsugu.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Optional
from typing import List, Optional

from httpx import Response

Expand Down Expand Up @@ -134,7 +134,7 @@ async def lsycx(server: _Server, tier: int, event_id: Optional[int] = None) -> _
if isinstance(response, Response): return response.json()
return await response.json()

async def room_list(room_list: list[_Room]) -> _Response:
async def room_list(room_list: List[_Room]) -> _Response:
'''绘制车牌绘图
参数:
Expand All @@ -161,7 +161,7 @@ async def room_list(room_list: list[_Room]) -> _Response:
if isinstance(response, Response): return response.json()
return await response.json()

async def search_card(default_servers: list[_Server], text: str) -> _Response:
async def search_card(default_servers: List[_Server], text: str) -> _Response:
'''查询卡片
参数:
Expand Down Expand Up @@ -191,7 +191,7 @@ async def search_card(default_servers: list[_Server], text: str) -> _Response:
if isinstance(response, Response): return response.json()
return await response.json()

async def search_character(default_servers: list[_Server], text: str) -> _Response:
async def search_character(default_servers: List[_Server], text: str) -> _Response:
'''查询角色
参数:
Expand Down Expand Up @@ -220,7 +220,7 @@ async def search_character(default_servers: list[_Server], text: str) -> _Respon
if isinstance(response, Response): return response.json()
return await response.json()

async def search_event(default_servers: list[_Server], text: str) -> _Response:
async def search_event(default_servers: List[_Server], text: str) -> _Response:
'''查询活动
参数:
Expand Down Expand Up @@ -250,7 +250,7 @@ async def search_event(default_servers: list[_Server], text: str) -> _Response:
if isinstance(response, Response): return response.json()
return await response.json()

async def search_gacha(default_servers: list[_Server], gacha_id: int) -> _Response:
async def search_gacha(default_servers: List[_Server], gacha_id: int) -> _Response:
'''查询卡池
参数:
Expand Down Expand Up @@ -310,7 +310,7 @@ async def search_player(player_id: int, server: _Server) -> _Response:
if isinstance(response, Response): return response.json()
return await response.json()

async def search_song(default_servers: list[_Server], text: str) -> _Response:
async def search_song(default_servers: List[_Server], text: str) -> _Response:
'''查询歌曲
参数:
Expand Down Expand Up @@ -339,7 +339,7 @@ async def search_song(default_servers: list[_Server], text: str) -> _Response:
if isinstance(response, Response): return response.json()
return await response.json()

async def song_chart(default_servers: list[_Server], song_id: int, difficulty_text: _DifficultyText) -> _Response:
async def song_chart(default_servers: List[_Server], song_id: int, difficulty_text: _DifficultyText) -> _Response:
'''查询歌曲谱面
参数:
Expand Down Expand Up @@ -370,7 +370,7 @@ async def song_chart(default_servers: list[_Server], song_id: int, difficulty_te
if isinstance(response, Response): return response.json()
return await response.json()

async def song_meta(default_servers: list[_Server], server: _Server) -> _Response:
async def song_meta(default_servers: List[_Server], server: _Server) -> _Response:
'''查询歌曲分数表
参数:
Expand Down
13 changes: 7 additions & 6 deletions tsugu_api_async/_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

from typing import (
Any,
List,
Union,
Literal,
TypeAlias,
Expand Down Expand Up @@ -48,7 +49,7 @@ class _Data(TypedDict):
type: Literal['string', 'base64']
string: str

_Response: TypeAlias = list[_Data]
_Response: TypeAlias = List[_Data]

_DifficultyText: TypeAlias = Literal['easy', 'normal', 'hard', 'expert', 'special']
'''难度名'''
Expand Down Expand Up @@ -79,7 +80,7 @@ class _Room(TypedDict):
class _QueryResponse(TypedDict):
'''`/station/queryAllRoom` 响应结果'''
status: _Status
data: Union[str, list[_Room]]
data: Union[str, List[_Room]]

class _TsuguUserServer(TypedDict):
'''服务器数据'''
Expand All @@ -92,9 +93,9 @@ class _TsuguUser(TypedDict):
user_id: str
platform: str
server_mode: _ServerId
default_server: list[_ServerId]
default_server: List[_ServerId]
car: bool
server_list: list[_TsuguUserServer]
server_list: List[_TsuguUserServer]

class _GetUserDataResponse(TypedDict):
'''`/user/getUserData` 响应结果'''
Expand All @@ -106,9 +107,9 @@ class _Update(TypedDict):
user_id: NotRequired[str]
platform: NotRequired[str]
server_mode: NotRequired[_ServerId]
default_server: NotRequired[list[_ServerId]]
default_server: NotRequired[List[_ServerId]]
car: NotRequired[bool]
server_list: NotRequired[list[_TsuguUserServer]]
server_list: NotRequired[List[_TsuguUserServer]]

class _ChangeUserDataResponse(TypedDict):
'''`/user/changeUserData` 响应结果'''
Expand Down

0 comments on commit 90ed950

Please sign in to comment.