Add Lyric Image support

proguy914629bot · proguy914629bot · commit 516a85dc54e0 · 2021-11-05T16:54:34.000+07:00
diff --git a/docs/api.rst b/docs/api.rst
@@ -30,6 +30,10 @@ Translate
 Results
 -------
 
+.. autoclass:: openrobot.api_wrapper.LyricImages()
+    :members:
+    :inherited-members:
+
 .. autoclass:: openrobot.api_wrapper.LyricResult()
     :members:
     :inherited-members:
diff --git a/examples/async/lyrics.py b/examples/async/lyrics.py
@@ -6,4 +6,6 @@
 
 lyrics.title # Never gonna give you up
 lyrics.artist # ...
-lyrics.lyric
+lyrics.lyric # ...
+lyrics.images.background # https://cdn.openrobot.xyz/lyrics/...
+lyrics.images.track # https://cdn.openrobot.xyz/lyrics/...
diff --git a/examples/sync/lyrics.py b/examples/sync/lyrics.py
@@ -6,4 +6,6 @@
 
 lyrics.title # Never gonna give you up
 lyrics.artist # ...
-lyrics.lyric
+lyrics.lyric # ...
+lyrics.images.background # https://cdn.openrobot.xyz/lyrics/...
+lyrics.images.track # https://cdn.openrobot.xyz/lyrics/...
diff --git a/openrobot/api_wrapper/__init__.py b/openrobot/api_wrapper/__init__.py
@@ -6,4 +6,4 @@
 
 from . import _async, _sync, translate, results, error
 
-__version__ = '0.2.0'
+__version__ = '0.2.1'
diff --git a/openrobot/api_wrapper/results.py b/openrobot/api_wrapper/results.py
@@ -13,6 +13,22 @@ class OpenRobotAPIBaseResult:
     def __init__(self, js):
         self.raw = js
 
+class LyricImages:
+    """
+    The Lyric's Track Images.
+    
+    Attributes
+    ----------
+    background: Optional[:class:`str`]
+        The background image of the track.
+    track: Optional[:class:`str`]
+        The track image.
+    """
+
+    def __init__(self, js):
+        self.background: typing.Optional[str] = js.get('background')
+        self.track: typing.Optional[str] = js.get('track')
+
 class LyricResult(OpenRobotAPIBaseResult):
     """
     The result of the /api/lyrics endpoint.
@@ -25,6 +41,8 @@ class LyricResult(OpenRobotAPIBaseResult):
         The artist of the song.
     lyrics :class:`str`
         The lyrics of the song. 
+    images: :class:`LyricImages`
+        Represents The Lyric's Track Images.
     """
 
     def __init__(self, js):
@@ -34,6 +52,8 @@ def __init__(self, js):
         self.artist: str = js['artist']
         self.lyrics: str = js['lyrics']
 
+        self.images = LyricImages(js.get('images', {}))
+
 class NSFWLabel:
     """
     NSFW Label.

Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@`
`6`	`6`
`7`	`7`	`from . import _async, _sync, translate, results, error`
`8`	`8`
`9`		`-__version__ = '0.2.0'`
	`9`	`+__version__ = '0.2.1'`