pycloudmusic

https://fengliufeseliud.github.io/pycloudmusic/
Admin
An elegant async high-performance Python music API library for Netease Cloud Music with support for...
Tokens:39,625
Snippets:258
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install pycloudmusic

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Install the pycloudmusic library using pip.

```bash
pip install pycloudmusic
```

--------------------------------

### Get Daily Recommended Songs

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Retrieves daily recommended songs as a generator of Music objects. This method is asynchronous.

```python
async def recommend_songs(self) -> Generator[Music, None, None]:
```

--------------------------------

### Get and Print Song Information

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Fetches song information by ID and prints the formatted object. Requires Music163Api and asyncio.

```python
from pycloudmusic import Music163Api
import asyncio


async def main():
    musicapi = Music163Api()
    # 获取歌曲 421531
    # https://music.163.com/#/song?id=421531
    music = await musicapi.music(421531)
    # 打印歌曲信息
    print(music)
    print("=" * 50)

asyncio.run(main())
```

--------------------------------

### Get Daily Recommended Playlist

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Fetches the daily recommended playlist, returning a generator of ShortPlayList objects. This method is asynchronous.

```python
async def recommend_resource(self) -> Generator[ShortPlayList, None, None]:
```

--------------------------------

### Get Song Comments Using Page Helper

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Fetches all comments for a song using the Page helper for pagination. Requires Music163Api, Page, and asyncio.

```python
"""获取歌曲所有评论"""

from pycloudmusic import Music163Api, Page
import asyncio


async def main():
    musicapi = Music163Api()
    # 获取歌曲
    # https://music.163.com/song?id=1902224491&userid=492346933
    music = await musicapi.music(1902224491)
    # 按时间获取评论
    async for comments in Page(music.comments, hot=False):
        for comment in comments:
            print(f"{comment.user_str}:  {comment.content}")

asyncio.run(main())
```

--------------------------------

### Playmode Intelligence (Smart Play)

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Initiates smart play mode for a given song, optionally starting from a specific song or playlist. Returns a generator of Music objects.

```python
async def playmode_intelligence(self, music_id: Union[str, int], sid: Optional[Union[str, int]] = None, playlist_id: Optional[Union[str, int]] = None) -> Generator[Music, None, None]:
```

--------------------------------

### Initialize ShortMv

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortartist

Initializes a ShortMv object with basic MV details. Use this for displaying MV summaries.

```python
class ShortMv(_Mv):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        mv_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, mv_data)
        # mv id
        self.id = mv_data["vid"]
        # mv标题
        self.name = mv_data["title"]
        # mv歌手
        self.artists = mv_data["creator"]
        self.artists_str = "/".join([artists['userName'] for artists in self.artists])
        # mv封面
        self.cover = mv_data["coverUrl"]

```

--------------------------------

### GET /dj

Source: https://fengliufeseliud.github.io/pycloudmusic/Dj?id=class-djmusic

Retrieves radio station details and manages radio program pagination.

```APIDOC
## GET /dj

### Description
Fetches radio station data and provides methods to iterate through radio programs.

### Method
GET

### Endpoint
/dj/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The unique identifier of the radio station.

### Response
#### Success Response (200)
- **name** (string) - Radio title
- **id** (int) - Radio ID
- **cover** (string) - Radio cover URL
- **music_count** (int) - Total number of programs in the radio
- **subscribed_count** (int) - Number of subscribers
```

--------------------------------

### Initialize ShortAlbum

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortartist

Initializes a ShortAlbum object with key album details. Use this for displaying album summaries.

```python
class ShortAlbum(_Album):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        album_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, album_data)
        # 专辑id
        self.id = album_data["id"]
        # 专辑标题
        self.name = album_data["name"]
        # 专辑别名
        self.alias = album_data["alias"]
        self.alias_str = "/".join(self.alias)
        # 专辑所有作者
        self.artists = album_data["artists"]
        self.artists_str = "/".join([artists_data["name"] for artists_data in self.artists])
        # 专辑曲目数
        self.size = album_data["size"]
        # 专辑封面
        self.cover = album_data["picUrl"]
        # 专辑收藏时间
        self.sub_time = album_data["subTime"] if "subTime" in album_data else 0

```

--------------------------------

### Music Class Initialization

Source: https://fengliufeseliud.github.io/pycloudmusic/Music

The constructor initializes the Music object with headers and raw music data, mapping fields like ID, artist, album, and quality levels.

```python
class Music(_Music):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        music_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, music_data)
        # 资源类型
        self.data_type = DATA_TYPE[0]
        # 歌曲id
        self.id = music_data['id']
        # 标题列表 [大标题, 副标题]
        self.name = [music_data['name'], music_data["alia"][0] if music_data["alia"] != [] else ""]
        self.name_str = self.name[0] + self.name[1]
        # 作者列表 [作者, 作者, ...]
        self.artist = [{"id": artist["id"], "name": artist["name"]} for artist in music_data['ar']]
        self.artist_str = "/".join([author["name"] for author in self.artist])
        # 专辑列表
        self.album_data = music_data["al"]
        self.album_str = self.album_data["name"]
        # 所有音质
        self.quality = {
            "h": music_data["h"],
            "m": music_data["m"],
            "l": music_data["l"],
            "sq": music_data["sq"],
            "hr": music_data["hr"],
        }
        # mv id
        self.mv_id = music_data["mv"]
        self.publish_time = music_data["publishTime"]
        # 推荐理由
        self.reason = music_data["reason"] if "reason" in music_data else None
```

--------------------------------

### Iterate User Dynamics with Event

Source: https://fengliufeseliud.github.io/pycloudmusic/Event

Demonstrates how to initialize the Event object and iterate through a user's dynamic feed using a loop.

```python
"""迭代 Event"""
from pycloudmusic import Music163Api
import asyncio


async def mian():
    musicapi = Music163Api("你网易云的 Cookie")
    
    # 验证 cookie 有效性, 并返回 my 对象
    my = await musicapi.my()
    # 打印 Cookie 用户信息
    print(my)
    print("=" * 60)
    
    # 初始化
    event, last_time, count = my.event(), -1, 0
    while True:
        try:
            # 获取动态并重设 last_time
            # https://music.163.com/#/user/home?id=1452176465
            last_time = (await event.read_user(1452176465, last_time))["lasttime"]
        except KeyError:
            # 没有动态时不会有 lasttime 会发生 KeyError, 依赖这个判断跳出循环
            break
        
        # 打印动态
        for event_item in event:
            print(event_item.user_str, event_item.msg["msg"], event_item.id)
            count += 1

    # 打印总动态数
    print(f"总动态数: {count}")

asyncio.run(mian())
```

--------------------------------

### Initialize ShortPlayList

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortartist

Initializes a ShortPlayList object with essential playlist data. Use this when only a summary of a playlist is needed.

```python
class ShortPlayList(_PlayList):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        playlist_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, playlist_data)
        # 资源类型
        self.data_type = DATA_TYPE[2]
        # 歌单id
        self.id = playlist_data["id"]
        # 歌单标题
        self.name = playlist_data["name"]
        # 歌单封面
        self.cover = playlist_data['picUrl']
        # 歌单创建者
        self.user = playlist_data['creator']
        self.user_str = playlist_data['creator']["nickname"]
        # 歌单播放量
        self.play_count = playlist_data["playcount"]
        # 歌单创建时间
        self.create_time = playlist_data["createTime"]
        self.track_count = playlist_data["trackCount"]
        # 推荐理由
        self.reason = playlist_data["copywriter"] if "copywriter" in playlist_data else None

```

--------------------------------

### Define a custom CommentItemObject implementation

Source: https://fengliufeseliud.github.io/pycloudmusic/CommentObject

Example of extending CommentItemObject to map specific API response fields to class attributes.

```python
class Music163CommentItem(CommentItemObject):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        comment_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, comment_data)
        # 评论 id
        self.id = comment_data["commentId"]
        # 资源 id 
        self.thread_id =  comment_data["threadId"]
        # 用户 id
        self.user = comment_data["user"]
        # 用户名
        self.user_str = comment_data["user"]["nickname"]
        # 评论内容
        self.content = comment_data["content"]
        # 评论时间
        self.time = comment_data["time"]
        self.time_str = comment_data["timeStr"]
        # 评论点赞数
        self.liked_count = comment_data["likedCount"]
        # 是否点赞了该评论
        self.liked = comment_data["liked"]
```

--------------------------------

### Initialize My Class

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Initializes the My class with headers and user data, inheriting from the User class. It extracts and formats login IP and time.

```python
class My(User):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        user_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, user_data)
        """包括 User 的所有实例变量"""
        # 登录ip
        self.login_ip = user_data["profile"]["lastLoginIP"]
        # 登录时间
        self.login_time = int(user_data["profile"]["lastLoginTime"] / 1000)
        self.login_time_str = time.strftime("%Y/%m/%d %H:%M:%S", time.localtime(self.login_time))
```

--------------------------------

### Get Subscribed Topics

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Retrieves a paginated list of topics subscribed to by the cookie user. Returns a dictionary containing topic data.

```python
async def sublist_topic(self, page: int = 0, limit: int = 50) -> dict[str, Any]:
```

--------------------------------

### Iterate over PlayList tracks

Source: https://fengliufeseliud.github.io/pycloudmusic/PlayList

Demonstrates how to fetch a playlist and iterate through its tracks to print music details.

```python
"""迭代 PlayList"""
from pycloudmusic import Music163Api
import asyncio


async def main():
    musicapi = Music163Api()
    # 获取歌单 7487291782
    playlist = await musicapi.playlist(7487291782)
    # 迭代 PlayList 打印歌单曲目
    for music in playlist:
        print(music.name, music.artist_str, music.id)

asyncio.run(main())
```

--------------------------------

### Get Song Comments Using Custom Iteration

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Fetches all comments for a song by manually paginating through comment results. Requires math, Music163Api, and asyncio.

```python
"""获取歌曲所有评论"""

import math
from pycloudmusic import Music163Api
import asyncio


async def main():
    musicapi = Music163Api()
    
    # https://music.163.com/song?id=1899317143
    music = await musicapi.music(1899317143)

    count, comments = await music.comments(hot=False)
    page = math.ceil(count / 20)

    all_count = 0
    while page > -1:
        count, comments = await music.comments(hot=False, page=page)

        for comment in comments:
            print(comment)

        page -= 1

asyncio.run(main())
```

--------------------------------

### My.sign Method

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Allows the user to sign in and gain experience points.

```APIDOC
## My.sign

### Description

Signs in the user, awarding experience points.

### Method

`async def sign(self, type_: bool = True) -> dict[str, Any]`

### Parameters

#### Query Parameters

- **type_** (bool) - Optional - `True` for 3 experience points (Android client sign-in), `False` for 2 experience points (web sign-in).

### Response Example

```json
{
  "message": "Sign-in successful",
  "experience_gained": 3
}
```
```

--------------------------------

### Initialize ShortAlbum

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject

Initializes a ShortAlbum object with essential album details. Requires album_data dictionary containing 'id', 'name', 'alias', 'artists', 'size', 'picUrl', and optionally 'subTime'.

```python
class ShortAlbum(_Album):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        album_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, album_data)
        # 专辑id
        self.id = album_data["id"]
        # 专辑标题
        self.name = album_data["name"]
        # 专辑别名
        self.alias = album_data["alias"]
        self.alias_str = "/".join(self.alias)
        # 专辑所有作者
        self.artists = album_data["artists"]
        self.artists_str = "/".join([artists_data["name"] for artists_data in self.artists])
        # 专辑曲目数
        self.size = album_data["size"]
        # 专辑封面
        self.cover = album_data["picUrl"]
        # 专辑收藏时间
        self.sub_time = album_data["subTime"] if "subTime" in album_data else 0
```

--------------------------------

### Fm.read - Get FM Songs

Source: https://fengliufeseliud.github.io/pycloudmusic/Fm

Fetches a list of personalized FM songs. This method updates the internal data used for iterating through FM tracks.

```APIDOC
## GET /fm/read

### Description
Fetches FM songs and updates the Fm object for iteration.

### Method
GET

### Endpoint
/fm/read

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **dict[str, Any]**: JSON data containing FM songs.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Login Using Email

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Simulates a login using email and password, returning a status code, cookie, and Music163Api instance. Requires LoginMusic163 and asyncio.

```python
from pycloudmusic import LoginMusic163
import asyncio


async def main():
    login = LoginMusic163()
    # 邮箱登录
    code, cookie, musicapi = await login.email("you login email", "you login password")
    # 验证登录
    print("=" * 60)
    print(code, cookie, musicapi)
    print("=" * 60)
    print(await musicapi.my())

asyncio.run(main())
```

--------------------------------

### Get Subscribed MVs

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Retrieves a paginated list of MVs subscribed to by the cookie user. Returns a tuple containing the total count and a generator of ShortMv objects.

```python
async def sublist_mv(self, page: int = 0, limit: int = 25) -> tuple[int, Generator[ShortMv, None, None]]:
```

--------------------------------

### Initialize ShortArtist

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject

Initializes a ShortArtist object with core artist information. Requires artist_data dictionary containing 'id', 'name', 'alias', 'albumSize', 'mvSize', and 'picUrl'.

```python
class ShortArtist(_Artist):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        artist_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, artist_data)
        # 歌手id
        self.id = artist_data["id"]
        # 歌手
        self.name = artist_data["name"]
        # 歌手
        self.alias = artist_data["alias"]
        self.alias_str = "/".join(self.alias)
        # 专辑数
        self.album_size = artist_data["albumSize"]
        # mv数
        self.mv_size = artist_data["mvSize"]
        # 头像
        self.cover = artist_data["picUrl"]
```

--------------------------------

### Get Subscribed Albums

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Retrieves a paginated list of albums subscribed to by the cookie user. Returns a tuple containing the total count and a generator of ShortAlbum objects.

```python
async def sublist_album(self, page: int = 0, limit: int = 25) -> tuple[int, Generator[ShortAlbum, None, None]]:
```

--------------------------------

### Sign In Method

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Allows the user to sign in. Use `type_=True` for Android sign-in (3 experience points) or `type_=False` for web sign-in (2 experience points).

```python
async def sign(self, type_: bool = True) -> dict[str, Any]:
```

--------------------------------

### Get Subscribed Artists

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Retrieves a paginated list of artists subscribed to by the cookie user. Returns a tuple containing the total count and a generator of ShortArtist objects.

```python
async def sublist_artist(self, page: int = 0, limit: int = 25) -> tuple[int, Generator[ShortArtist, None, None]]:
```

--------------------------------

### Iterate Dj radio programs

Source: https://fengliufeseliud.github.io/pycloudmusic/Dj

Demonstrates how to fetch a radio station and iterate through its programs by reading pages.

```python
"""迭代 Dj"""
from pycloudmusic import Music163Api
import asyncio


async def mian():
    musicapi = Music163Api()
    # 获取电台
    # https://music.163.com/#/djradio?id=342290050
    dj = await musicapi.dj(342290050)

    # 计算电台页数
    dj_music_page = int(dj.music_count / 30)
    while dj_music_page > 0:
        # 获取电台节目
        await dj.read(dj_music_page, asc=True)
        # 打印电台节目
        for music in dj:
            print(music.name, music.id)
        
        dj_music_page -= 1

asyncio.run(mian())
```

--------------------------------

### Get Subscribed DJs

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Retrieves a paginated list of DJ programs subscribed to by the cookie user. Returns a tuple containing the total count and a generator of ShortDj objects.

```python
async def sublist_dj(self, page: int = 0, limit: int = 25) -> tuple[int, Generator[ShortDj, None, None]]:
```

--------------------------------

### Initialize ShortPlayList

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject

Initializes a ShortPlayList object with essential playlist data. Requires playlist_data dictionary containing 'id', 'name', 'picUrl', 'creator', 'playcount', 'createTime', 'trackCount', and optionally 'copywriter'.

```python
class ShortPlayList(_PlayList):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        playlist_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, playlist_data)
        # 资源类型
        self.data_type = DATA_TYPE[2]
        # 歌单id
        self.id = playlist_data["id"]
        # 歌单标题
        self.name = playlist_data["name"]
        # 歌单封面
        self.cover = playlist_data['picUrl']
        # 歌单创建者
        self.user = playlist_data['creator']
        self.user_str = playlist_data['creator']["nickname"]
        # 歌单播放量
        self.play_count = playlist_data["playcount"]
        # 歌单创建时间
        self.create_time = playlist_data["createTime"]
        self.track_count = playlist_data["trackCount"]
        # 推荐理由
        self.reason = playlist_data["copywriter"] if "copywriter" in playlist_data else None
```

--------------------------------

### Get Cloud Drive Data

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Fetches cloud drive data and instantiates a Cloud object. Returns API error information in JSON format if instantiation fails. Supports pagination.

```python
async def cloud(self, page: int = 0, limit: int = 30) -> Cloud:
```

--------------------------------

### QR Code Login with LoginMusic163

Source: https://fengliufeseliud.github.io/pycloudmusic/LoginMusic163

Initiates a QR code login process. First, obtain a `qr_key` using `qr_key()`. Then, generate a QR code from the provided URL. Use `qr()` with the `qr_key` to wait for and complete the login, returning the session cookie and a Music163Api object.

```python
from pycloudmusic import LoginMusic163
import asyncio


async def main():
    login = LoginMusic163()
    # 获取二维码 key
    qr_key = await login.qr_key()
    # 去 https://cli.im/ 生成二维码或者自己生成二维码
    print(f"请使用该 url 生成二维码: {qr_key[1]}")
    # 等待扫码
    cookie, musicapi = await login.qr(qr_key[0])
    # 验证登录
    print(cookie, musicapi)
    print("=" * 60)
    print(await musicapi.my())

asyncio.run(main())
```

--------------------------------

### Initialize ShortDj

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortartist

Initializes a ShortDj object with essential radio station data. This is useful for displaying radio summaries.

```python
class ShortDj(_Dj):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        dj_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, dj_data)
        # 电台标题
        self.name = dj_data["name"]
        # 电台id
        self.id = dj_data["id"]
        # 电台封面
        self.cover = dj_data['picUrl']
        # 电台创建者
        self.user = dj_data['dj']
        self.user_str = self.user["nickname"]
        # 电台描述
        self.description = dj_data["desc"]
        # 电台小描述
        self.rcmd_text = dj_data["rcmdtext"]
        # 电台标签
        self.tags = [
            {"id": dj_data['categoryId'], "name": dj_data['category']}
        ]
        self.tags_str = self.tags[0]["name"]
        # 电台收藏量
        self.subscribed_count = dj_data["subCount"]
        # 电台单曲数
        self.music_count = dj_data["programCount"]
        # 电台创建时间
        self.create_time = dj_data["createTime"]
        # 最后上传电台节目 id
        self.last_music_id = dj_data["lastProgramId"]
        # 最后上传电台节目时间
        self.last_music_create_time = dj_data["lastProgramCreateTime"]
        # 最后上传电台节目标题
        self.last_music_name = dj_data["lastProgramName"]


```

--------------------------------

### My.recommend_resource Method

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Fetches a personalized playlist of recommended songs for the day.

```APIDOC
## My.recommend_resource

### Description

Gets the daily recommended playlist and returns a generator of `ShortPlayList` objects.

### Method

`async def recommend_resource(self) -> Generator[ShortPlayList, None, None]`

### Response

#### Success Response (200)

- **Generator[ShortPlayList, None, None]** - A generator yielding `ShortPlayList` objects.

### Response Example

```json
[
  {
    "id": 67890,
    "name": "Daily Mix",
    "creator": "PyCloudMusic"
  }
]
```
```

--------------------------------

### Album Class Initialization

Source: https://fengliufeseliud.github.io/pycloudmusic/Album

Shows the internal structure and attributes of the Album class, including ID, name, artist, size, description, and counts. This is a class definition and not directly executable as a standalone snippet.

```python
class Album(_Album):

    def __init__(
        self,
        headers: Optional[dict[str, str]],
        album_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, album_data)
        # 专辑id
        self.id = album_data["album"]["id"]
        # 专辑标题
        self.name = album_data["album"]["name"]
        # 专辑类型
        self.sub_type = album_data["album"]["subType"]
        # 专辑别名
        self.alias = album_data["album"]["alias"]
        self.alias_str = "/".join(self.alias)
        # 专辑主作者
        self.artist = album_data["album"]["artist"]
        # 专辑所有作者
        self.artists = album_data["album"]["artists"]
        self.artists_str = "/".join([artists_data["name"] for artists_data in self.artists])
        # 专辑曲目数
        self.size = album_data["album"]["size"]
        # 专辑简介
        self.description = album_data["album"]["description"]
        # 未知
        self.liked = album_data["album"]["info"]["liked"]
        # 专辑评论数
        self.comment_count = album_data["album"]["info"]["commentCount"]
        # 专辑分享数
        self.share_count = album_data["album"]["info"]["shareCount"]
        # 未知
        self.liked_count = album_data["album"]["info"]["likedCount"]
        # 专辑封面
        self.cover = album_data["album"]['picUrl']
        # 专辑曲目 (json)
        self.music_list = album_data["songs"]
```

--------------------------------

### Initialize User Class

Source: https://fengliufeseliud.github.io/pycloudmusic/User

Defines the User class structure and initializes instance variables from user data.

```python
class User(Api):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        user_data: dict[str, Any]
    ) -> None:
        super().__init__(headers)
        _user_data = user_data["profile"] if "profile" in user_data else user_data
        # 用户uid
        self.id = _user_data["userId"]
        # 用户名称
        self.name = _user_data["nickname"]
        # 用户签名
        self.signature = _user_data["signature"]
        # 用户等级
        self.level = user_data["level"] if "level" in user_data else None
        # 头像
        self.cover = _user_data['avatarUrl']
        # 会员 0 无
        self.vip = _user_data["vipType"]
        self.like_playlist_id = None
```

--------------------------------

### Initialize ShortDj

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject

Initializes a ShortDj object with key radio station data. Requires dj_data dictionary containing 'name', 'id', 'picUrl', 'dj', 'desc', 'rcmdtext', 'categoryId', 'category', 'subCount', 'programCount', 'createTime', 'lastProgramId', 'lastProgramCreateTime', and 'lastProgramName'.

```python
class ShortDj(_Dj):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        dj_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, dj_data)
        # 电台标题
        self.name = dj_data["name"]
        # 电台id
        self.id = dj_data["id"]
        # 电台封面
        self.cover = dj_data['picUrl']
        # 电台创建者
        self.user = dj_data['dj']
        self.user_str = self.user["nickname"]
        # 电台描述
        self.description = dj_data["desc"]
        # 电台小描述
        self.rcmd_text = dj_data["rcmdtext"]
        # 电台标签
        self.tags = [
            {"id": dj_data['categoryId'], "name": dj_data['category']}
        ]
        self.tags_str = self.tags[0]["name"]
        # 电台收藏量
        self.subscribed_count = dj_data["subCount"]
        # 电台单曲数
        self.music_count = dj_data["programCount"]
        # 电台创建时间
        self.create_time = dj_data["createTime"]
        # 最后上传电台节目 id
        self.last_music_id = dj_data["lastProgramId"]
        # 最后上传电台节目时间
        self.last_music_create_time = dj_data["lastProgramCreateTime"]
        # 最后上传电台节目标题
        self.last_music_name = dj_data["lastProgramName"]
```

--------------------------------

### Iterate Album Tracks

Source: https://fengliufeseliud.github.io/pycloudmusic/Album

Demonstrates how to fetch an album by its ID and iterate through its tracks, printing music details. Requires asyncio for asynchronous operations.

```python
import asyncio
from pycloudmusic import Music163Api

async def main():
    musicapi = Music163Api()
    # 获取歌单 62338
    album = await musicapi.album(62338)
    # 迭代 album 打印专辑曲目
    for music in album:
        print(music.name, music.artist_str, music.id)

asyncio.run(main())
```

--------------------------------

### Download Playlist Tracks Using Task List

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Fetches a playlist and creates a list of asyncio tasks to play each track, then waits for all tasks to complete. Requires Music163Api and asyncio.

```python
from pycloudmusic import Music163Api
import asyncio


async def main():
    musicapi = Music163Api()
    # 获取歌单 7487291782
    # https://music.163.com/#/playlist?id=7487291782
    playlist = await musicapi.playlist(7487291782)
    # 创建任务
    tasks = [asyncio.create_task(music.play()) for music in playlist]
    # 等待任务
    await asyncio.wait(tasks)

asyncio.run(main())
```

--------------------------------

### DjMusic class instance variables

Source: https://fengliufeseliud.github.io/pycloudmusic/Dj

Shows the initialization and mapping of radio program data fields to instance variables.

```python
class DjMusic(Music163Comment):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        dj_music_data: dict[str, Any]
    ) -> None:
        super().__init__(headers)
        self.data_type = DATA_TYPE[4]
        # 电台节目id
        self.id = dj_music_data["id"]
        # 电台节目标题
        self.name = dj_music_data["name"]
        # 电台节目简介
        self.description = dj_music_data["description"]
        # 电台节目封面
        self.cover = dj_music_data["coverUrl"]
        # 电台节目创建时间
        self.create_time = dj_music_data["createTime"]
        # 电台节目播放量
        self.play_count = dj_music_data["listenerCount"]
        # 电台节目点赞量
        self.like_count = dj_music_data["likedCount"]
        # 电台节目评论量
        self.comment_count = dj_music_data["commentCount"]
```

--------------------------------

### Iterate and Fetch Fm Songs

Source: https://fengliufeseliud.github.io/pycloudmusic/Fm

This snippet demonstrates how to initialize the Music163Api, authenticate with a cookie, retrieve user information, and then continuously fetch and print personalized FM songs every 3 seconds. Ensure your NetEase Cloud Music cookie is valid.

```python
import pycloudmusic
import asyncio
import time

async def mian():
    musicapi = pycloudmusic.Music163Api("你网易云的 Cookie")

    # 验证 cookie 有效性, 并返回 my 对象
    my = await musicapi.my()
    # 打印 Cookie 用户信息
    print(my)
    print("=" * 60)

    """
    每 3 秒, 获取一次 Fm 歌曲
    """

    # 返回 fm 对象
    fm = my.fm()
    while True:
        # 获取 Fm 歌曲
        await fm.read()
        # 打印 Fm 歌曲
        for music in fm:
            print(music.name, music.artist_str, music.id)
        
        # 休息 3 秒
        time.sleep(3)

asyncio.run(mian())
```

--------------------------------

### Initialize ShortArtist

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortartist

Initializes a ShortArtist object with basic artist information. This is useful for displaying artist summaries.

```python
class ShortArtist(_Artist):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        artist_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, artist_data)
        # 歌手id
        self.id = artist_data["id"]
        # 歌手
        self.name = artist_data["name"]
        # 歌手
        self.alias = artist_data["alias"]
        self.alias_str = "/".join(self.alias)
        # 专辑数
        self.album_size = artist_data["albumSize"]
        # mv数
        self.mv_size = artist_data["mvSize"]
        # 头像
        self.cover = artist_data["picUrl"]

```

--------------------------------

### Dj class instance variables

Source: https://fengliufeseliud.github.io/pycloudmusic/Dj

Shows the initialization and mapping of radio station data fields to instance variables.

```python
class Dj(_Dj):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        dj_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, dj_data)
        # 电台标题
        self.name = dj_data["name"]
        # 电台id
        self.id = dj_data["id"]
        # 电台封面
        self.cover = dj_data['picUrl']
        # 电台创建者
        self.user = dj_data['dj']
        self.user_str = self.user["nickname"]
        # 电台描述
        self.description = dj_data["desc"]
        # 电台小描述
        self.rcmd_text = dj_data["rcmdText"]
        # 电台标签
        self.tags = [
            {"id": dj_data['categoryId'], "name": dj_data['category']},
            {"id": dj_data['secondCategoryId'], "name": dj_data['secondCategory']},
        ]
        self.tags_str = "/".join([tag["name"] for tag in self.tags])
        # 电台分享量
        self.share_count = dj_data["shareCount"]
        # 电台收藏量
        self.subscribed_count = dj_data["subCount"]
        # 电台单曲数
        self.music_count = dj_data["programCount"]
        # 电台评论数
        self.count = dj_data["commentCount"]
        # 电台创建时间
        self.create_time = dj_data["createTime"]
        # 是否收藏了电台
        self.subed =  dj_data["subed"]
        # 最后上传电台节目 id
        self.last_music_id = dj_data["lastProgramId"]
        # 最后上传电台节目时间
        self.last_music_create_time = dj_data["lastProgramCreateTime"]
```

--------------------------------

### My.cloud Method

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Fetches user's cloud drive data and returns a `Cloud` object.

```APIDOC
## My.cloud

### Description

Fetches user's cloud drive data and initializes a `Cloud` object. Returns API error information (JSON) if initialization fails.

### Method

`async def cloud(self, page: int = 0, limit: int = 30) -> Cloud:`

### Parameters

#### Query Parameters

- **page** (int) - Optional - The page number of results to retrieve. Defaults to 0.
- **limit** (int) - Optional - The number of results per page. Defaults to 30.

### Response

#### Success Response (200)

- **Cloud** - An instance of the `Cloud` class representing the user's cloud drive data.

#### Error Response (e.g., 400)

- **dict[str, Any]** - API error information in JSON format.

### Response Example (Success)

```json
{
  "status": "initialized",
  "file_count": 150
}
```

### Response Example (Error)

```json
{
  "error": "Failed to fetch cloud drive data"
}
```
```

--------------------------------

### My.fm Method

Source: https://fengliufeseliud.github.io/pycloudmusic/My

Initializes and returns a `Fm` object for personalized radio.

```APIDOC
## My.fm

### Description

Initializes a private FM object and returns it.

### Method

`def fm(self) -> Fm:`

### Response

#### Success Response (200)

- **Fm** - An instance of the `Fm` class.

### Response Example

```json
{
  "status": "initialized",
  "radio_id": "fm_radio_1"
}
```
```

--------------------------------

### PlayList class definition and instance variables

Source: https://fengliufeseliud.github.io/pycloudmusic/PlayList

Shows the internal structure of the PlayList class and how it maps playlist data to instance attributes.

```python
class PlayList(_PlayList):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        playlist_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, playlist_data)
        # 资源类型
        self.data_type = DATA_TYPE[2]
        # 歌单id
        self.id = playlist_data["id"]
        # 歌单标题
        self.name = playlist_data["name"]
        # 歌单封面
        self.cover = playlist_data['coverImgUrl']
        # 歌单创建者
        self.user = playlist_data['creator']
        self.user_str = playlist_data['creator']["nickname"]
        # 歌单tags
        self.tags = playlist_data['tags']
        self.tags_str = "/".join(playlist_data['tags'])
        # 歌单描述
        self.description = playlist_data["description"]
        # 歌单播放量
        self.play_count = playlist_data["playCount"]
        # 歌单收藏量
        self.subscribed_count = playlist_data["subscribedCount"]
        # 歌单创建时间
        self.create_time = playlist_data["createTime"]
        # 歌单歌曲
        self.music_list = playlist_data["tracks"]
```

--------------------------------

### Page.all Method

Source: https://fengliufeseliud.github.io/pycloudmusic/Tools?id=class-page

Retrieves all data from the bound API at once.

```APIDOC
## Page.all

### Description
Fetches all data from the bound API in a single operation, as opposed to iterative fetching.

### Parameters
- **call_fun** (Callable[[dict], int]) - Optional - A callback function that accepts API data and returns the maximum page count.
```

--------------------------------

### PlayList.add

Source: https://fengliufeseliud.github.io/pycloudmusic/PlayList

Adds one or more songs to the playlist.

```APIDOC
## PlayList.add

### Description
Adds one or more songs to the playlist.

### Method
`async def add(self, music_id: Union[str, int, list[Union[str, int]]]) -> dict[str, Any]`

### Parameters
#### Request Body
- **music_id** (Union[str, int, list[Union[str, int]]]) - Required - The ID of the song(s) to add. Can be a single ID or a list of IDs.

### Request Example
```json
{
  "music_id": [123456789, 987654321]
}
```

### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Initialize Mv Class

Source: https://fengliufeseliud.github.io/pycloudmusic/Mv

The Mv class constructor initializes instance variables from the provided mv_data dictionary.

```python
class Mv(_Mv):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        mv_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, mv_data)
        # mv id
        self.id = mv_data["id"]
        # mv标题
        self.name = mv_data["name"]
        # mv介绍
        self.desc = mv_data["desc"]
        # mv歌手
        self.artists = mv_data["artists"]
        self.artists_str = "/".join([artists['name'] for artists in self.artists])
        # mv tags
        self.tags = mv_data["videoGroup"]
        self.tags_str = "/".join([tags['name'] for tags in self.tags])
        # mv封面
        self.cover = mv_data["cover"]
        # mv播放数
        self.play_count = mv_data["playCount"]
        # mv收藏数
        self.subscribe_count = mv_data["subCount"]
        # mv评论数
        self.comment_count = mv_data["commentCount"]
        # mv分享数
        self.share_count = mv_data["shareCount"]
        # mv质量
        self.quality = mv_data["brs"]
        # 发布时间
        self.publish_time = mv_data["publishTime"]
```

--------------------------------

### Initialize PersonalizedDj Instance Variables

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortmv

Initializes instance variables for PersonalizedDj, extracting essential details for recommended radio stations such as ID, name, cover image URL, creator information, tags, and description. This class supports all radio station-related APIs.

```python
class PersonalizedDj(_Dj):

    def __init__(
        self,
        headers: Optional[dict[str, str]],
        dj_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, dj_data)
        # 电台id
        self.id = dj_data["id"]
        # 电台标题
        self.name = dj_data["name"]
        # 电台封面
        self.cover = dj_data['coverUrl']
        # 电台创建者
        self.user = dj_data['dj']
        self.user_str = self.user["nickname"]
        # 电台标签
        self.tags = dj_data["channels"]
        # 电台描述
        self.description = dj_data["description"]
```

--------------------------------

### My Class Instance Variables

Source: https://fengliufeseliud.github.io/pycloudmusic/My

The My class inherits from User and includes additional instance variables related to user login information.

```APIDOC
## My Class Instance Variables

The `My` class supports all instance methods and variables of the `User` object and can call APIs related to Cookie users.

### Instance Variables

Access data externally using `.`.

- **login_ip** (str) - The IP address of the user's last login.
- **login_time** (int) - The timestamp of the user's last login.
- **login_time_str** (str) - A formatted string representing the user's last login time.
```

--------------------------------

### Handle Music163BadCode Errors

Source: https://fengliufeseliud.github.io/pycloudmusic?id=%E4%BB%8B%E7%BB%8D

Demonstrates how to catch and handle Music163BadCode exceptions, accessing the error code and data. Requires Music163Api, Music163BadCode, and asyncio.

```python
from pycloudmusic import Music163Api, Music163BadCode
import asyncio


async def main():
    musicapi = Music163Api()

    try:
        playlist = await musicapi.playlist(7487291782)
    except Music163BadCode as err:
        print(err, err.code, err.data)

asyncio.run(main())
```

--------------------------------

### Fetch All Music Comments at Once with Page.all

Source: https://fengliufeseliud.github.io/pycloudmusic/Tools?id=class-page

Use the Page.all() method to fetch all comments for a song in a single request. This is different from direct iteration, which fetches data page by page. Requires Music163Api and Page imports.

```python
from pycloudmusic import Music163Api, Page
import asyncio


async def main():
    musicapi = Music163Api()
    # https://music.163.com/song?id=1902224491&userid=492346933
    music = await musicapi.music(1902224491)
    # 一次性请求所有数据
    for count, comments in await Page(music.comments, hot=False).all():
        # 遍历一页的数据
        for comment in comments:
            print(f"{comment.user_str}:  {comment.content}")

asyncio.run(main())
```

--------------------------------

### Initialize PersonalizedMusic Instance Variables

Source: https://fengliufeseliud.github.io/pycloudmusic/ShortObject?id=class-shortartist

Initializes instance variables for a PersonalizedMusic object, extracting details like song ID, name, artists, album, audio quality, and MV ID from music data. This class is suitable for representing individual music tracks with comprehensive metadata.

```python
class PersonalizedMusic(_Music):

    def __init__(
        self, 
        headers: Optional[dict[str, str]], 
        music_data: dict[str, Any]
    ) -> None:
        super().__init__(headers, music_data)
        # 资源类型
        self.data_type = DATA_TYPE[0]
        # 歌曲id
        self.id = music_data['id']
        # 标题列表 [大标题, 副标题]
        self.name = [music_data["name"], " ".join(music_data["alias"])]
        self.name_str = f"{self.name[0]} {self.name[1]}"
        # 作者列表 [作者, 作者, ...]
        self.artist = [{"id": artist["id"], "name": artist["name"]} for artist in music_data['artists']]
        self.artist_str = "/".join([author["name"] for author in self.artist])
        # 专辑列表
        self.album_data = music_data["album"]
        self.album_str = music_data["album"]["name"]
        # 所有音质
        self.quality = {
            "b": music_data["bMusic"],
            "h": music_data["hMusic"],
            "m": music_data["mMusic"],
            "l": music_data["lMusic"],
            "sq": music_data.get("sqMusic"),
            "hr": music_data.get("hrMusic"),
        }
        # mv id
        self.mv_id = music_data["mvid"]
        # 发表时间
        self.album_data["publishTime"]
```
Tokens:
Raw