Terminale – Compétence | API (Application Programming Interface) 1/4

>>> type(artiste_datas)
<class 'lyricsgenius.types.artist.Artist'>

'artiste_datas' est un objet (une instance) de la classe 'Artist'.

Ses attributs et méthodes sont :
>>> dir(artiste_datas)
['__abstractmethods__', '__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__len__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__slots__', '__str__', '__subclasshook__', '__weakref__', '_abc_impl', '_body', '_client', 'add_song', 'api_path', 'header_image_url', 'id', 'image_url', 'is_meme_verified', 'is_verified', 'name', 'num_songs', 'save_lyrics', 'song', 'songs', 'to_dict', 'to_json', 'to_text', 'url']

>>> type(artiste_datas.songs)
<class 'list'>
>>> artiste_datas.songs
[Song(id, artist, ...), Song(id, artist, ...), Song(id, artist, ...)]

L'attribut 'songs' est de type 'list'. Il s'agit d'une liste d'objets (d'instances) de la classe 'Song'.

>>> dir(artiste_datas.songs[0])
['__abstractmethods__', '__class__', '__cmp__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__slots__', '__str__', '__subclasshook__', '__weakref__', '_abc_impl', '_body', '_client', 'annotation_count', 'api_path', 'artist', 'full_title', 'header_image_thumbnail_url', 'header_image_url', 'id', 'lyrics', 'lyrics_owner_id', 'lyrics_state', 'path', 'primary_artist', 'pyongs_count', 'save_lyrics', 'song_art_image_thumbnail_url', 'song_art_image_url', 'stats', 'title', 'title_with_featured', 'to_dict', 'to_json', 'to_text', 'url']

>>> type(artiste_datas.songs[0].lyrics)
<class 'str'>

L'attribut 'lyrics' est une chaîne de caractères. Il contient les paroles de la chanson.

print(artiste_datas.songs[0].lyrics)

La démarche est analogue à la précédente.
On s'intéresse à la méthode 'save_lyrics'.

>>> type(artiste_datas.songs[0].save_lyrics)
<class 'method'>

>>> help(artiste_datas.songs[0].save_lyrics)
Help on method save_lyrics in module lyricsgenius.types.song:

save_lyrics(filename=None, extension='json', overwrite=False, ensure_ascii=True, sanitize=True, verbose=True) method of lyricsgenius.types.song.Song instance
    Save Song(s) lyrics and metadata to a JSON or TXT file.
    
    If the extension is 'json' (the default), the lyrics will be saved
    alongside the song's information. Take a look at the example below.
    
    Args:
        filename (:obj:`str`, optional): Output filename, a string.
            If not specified, the result is returned as a string.
        extension (:obj:`str`, optional): Format of the file (`json` or `txt`).
        overwrite (:obj:`bool`, optional): Overwrites preexisting file if `True`.
            Otherwise prompts user for input.
        ensure_ascii (:obj:`bool`, optional): If ensure_ascii is true
            (the default), the output is guaranteed to have all incoming
            non-ASCII characters escaped.
        sanitize (:obj:`bool`, optional): Sanitizes the filename if `True`.
        verbose (:obj:`bool`, optional): prints operation result.
    
    Warning:
        If you set :obj:`sanitize` to `False`, the file name may contain
        invalid characters, and thefore cause the saving to fail.

artiste_datas.songs[0].save_lyrics(filename=artiste_datas.songs[0].title, extension="txt")

print(artiste_datas.songs[0].lyrics)

Là encore on suit la même démarche :

>>> dir(artiste_datas)
['__abstractmethods__', '__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__len__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__slots__', '__str__', '__subclasshook__', '__weakref__', '_abc_impl', '_body', '_client', 'add_song', 'api_path', 'header_image_url', 'id', 'image_url', 'is_meme_verified', 'is_verified', 'name', 'num_songs', 'save_lyrics', 'song', 'songs', 'to_dict', 'to_json', 'to_text', 'url']

>>> type(artiste_datas.image_url)
<class 'str'>

print(artiste_datas.image_url)

Là encore on suit la même démarche :

>>> dir(artiste_datas)
['__abstractmethods__', '__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__len__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__slots__', '__str__', '__subclasshook__', '__weakref__', '_abc_impl', '_body', '_client', 'add_song', 'api_path', 'header_image_url', 'id', 'image_url', 'is_meme_verified', 'is_verified', 'name', 'num_songs', 'save_lyrics', 'song', 'songs', 'to_dict', 'to_json', 'to_text', 'url']

>>> type(artiste_datas.url)
<class 'str'>

print(artiste_datas.url)

>>> type(webbrowser)
<class 'module'>

>>> dir(webbrowser)
['BackgroundBrowser', 'BaseBrowser', 'Chrome', 'Chromium', 'Elinks', 'Error', 'Galeon', 'GenericBrowser', 'Grail', 'Konqueror', 'Mozilla', 'Netscape', 'Opera', 'UnixBrowser', 'WindowsDefault', '__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', '_browsers', '_lock', '_os_preferred_browser', '_synthesize', '_tryorder', 'get', 'main', 'open', 'open_new', 'open_new_tab', 'os', 'register', 'register_X_browsers', 'register_standard_browsers', 'shlex', 'shutil', 'subprocess', 'sys', 'threading']

>>> help(webbrowser)
Help on module webbrowser:

NAME
    webbrowser - Interfaces for launching and remotely controlling Web browsers.

MODULE REFERENCE
    https://docs.python.org/3.9/library/webbrowser
    
    The following documentation is automatically generated from the Python
    source files.  It may be incomplete, incorrect or include features that
    are considered implementation detail and may vary between Python
    implementations.  When in doubt, consult the module reference at the
    location listed above.
.../...
FUNCTIONS
    get(using=None)
        Return a browser launcher instance appropriate for the environment.
    
    open(url, new=0, autoraise=True)
        Display url using the default browser.
        
        If possible, open url in a location determined by new.
        - 0: the same browser window (the default).
        - 1: a new browser window.
        - 2: a new browser page ("tab").
        If possible, autoraise raises the window (the default) or not.
    
    open_new(url)
        Open url in a new window of the default browser.
        
        If not possible, then open url in the only browser window.
    
    open_new_tab(url)
        Open url in a new page ("tab") of the default browser.
        
        If not possible, then the behavior becomes equivalent to open_new().
    
    register(name, klass, instance=None, *, preferred=False)
        Register a browser connector.
.../...

>>> type(webbrowser.open_new_tab)
<class 'function'>

>>> help(webbrowser.open_new_tab)
Help on function open_new_tab in module webbrowser:

open_new_tab(url)
    Open url in a new page ("tab") of the default browser.
    
    If not possible, then the behavior becomes equivalent to open_new().

webbrowser.open_new_tab(artiste_datas.image_url)

>>> type(webbrowser.open_new_tab)
<class 'function'>

>>> help(webbrowser.open_new_tab)
Help on function open_new_tab in module webbrowser:

open_new_tab(url)
    Open url in a new page ("tab") of the default browser.
    
    If not possible, then the behavior becomes equivalent to open_new().

webbrowser.open_new_tab(artiste_datas.url)