musicdl 2.1.11__py3-none-any.whl → 2.7.3__py3-none-any.whl

musicdl/musicdl.py

@@ -1,111 +1,209 @@
 '''
 Function:
-    音乐下载器
+    Implementation of MusicClient
 Author:
-    Charles
-微信公众号:
+    Zhenchao Jin
+WeChat Official Account (微信公众号):
     Charles的皮卡丘
 '''
 import sys
 import copy
+import click
+import json_repair
 if __name__ == '__main__':
-    from modules import *
     from __init__ import __version__
+    from modules import BuildMusicClient, LoggerHandle, MusicClientBuilder, smarttrunctable, colorize, printfullline
 else:
-    from .modules import *
     from .__init__ import __version__
+    from .modules import BuildMusicClient, LoggerHandle, MusicClientBuilder, smarttrunctable, colorize, printfullline
 
 
-'''basic info'''
-BASICINFO = '''************************************************************
-Function: 音乐下载器 V%s
-Author: Charles
-微信公众号: Charles的皮卡丘
-操作帮助:
-    输入r: 重新初始化程序(即返回主菜单)
-    输入q: 退出程序
-    下载多首歌曲: 选择想要下载的歌曲时,输入{1,2,5}可同时下载第1,2,5首歌
-歌曲保存路径:
-    当前路径下的%s文件夹内
-************************************************************'''
+'''BASIC_INFO'''
+BASIC_INFO = '''Function: Music Downloader v%s
+Author: Zhenchao Jin
+WeChat Official Account (微信公众号): Charles_pikachu (Charles的皮卡丘)
+Instructions:
+    Enter r: reinitialize the program (i.e., return to the main menu)
+    Enter q: exit the program
+    Download multiple songs: when selecting songs to download, enter "1,2,5" to download songs 1, 2, and 5 simultaneously
+Music Files Save Path:
+    %s (root dir is the current directory if using relative path).'''
+'''DEFAULT_MUSIC_SOURCES'''
+DEFAULT_MUSIC_SOURCES = ['MiguMusicClient', 'NeteaseMusicClient', 'QQMusicClient', 'KugouMusicClient', 'KuwoMusicClient', 'QianqianMusicClient']
 
 
-'''音乐下载器'''
-class musicdl():
-    def __init__(self, configpath=None, config=None, **kwargs):
-        self.config = loadConfig('config.json') if config is None else config
-        self.logger_handle = Logger(self.config['logfilepath'])
-        self.initializeAllSources()
-    '''非开发人员外部调用'''
-    def run(self, target_srcs=None):
+'''MusicClient'''
+class MusicClient():
+    def __init__(self, music_sources: list = [], init_music_clients_cfg: dict = {}, clients_threadings: dict = {}, requests_overrides: dict = {}, search_rules: dict = {}):
+        # assert
+        assert isinstance(music_sources, list) and isinstance(init_music_clients_cfg, dict) and isinstance(clients_threadings, dict) and \
+               isinstance(requests_overrides, dict) and isinstance(search_rules, dict)
+        music_sources, init_music_clients_cfg, clients_threadings, requests_overrides, search_rules = \
+            copy.deepcopy(music_sources), copy.deepcopy(init_music_clients_cfg), copy.deepcopy(clients_threadings), copy.deepcopy(requests_overrides), copy.deepcopy(search_rules)
+        # set attributes
+        self.work_dirs = {}
+        self.search_rules = search_rules
+        self.clients_threadings = clients_threadings
+        self.requests_overrides = requests_overrides
+        self.music_sources = music_sources if music_sources else DEFAULT_MUSIC_SOURCES
+        self.music_sources = list(set(self.music_sources))
+        # init
+        self.logger_handle, self.music_clients = LoggerHandle(), dict()
+        for music_source in self.music_sources:
+            if music_source not in MusicClientBuilder.REGISTERED_MODULES.keys(): continue
+            init_music_client_cfg = {
+                'search_size_per_source': 5, 'auto_set_proxies': False, 'random_update_ua': False, 'max_retries': 5,
+                'maintain_session': False, 'logger_handle': self.logger_handle, 'disable_print': True, 'work_dir': 'musicdl_outputs',
+                'proxy_sources': None, 'default_search_cookies': {}, 'default_download_cookies': {}, 'type': music_source,
+                'search_size_per_page': 10, 'strict_limit_search_size_per_page': True, 'quark_parser_config': {}
+            }
+            init_music_client_cfg.update(init_music_clients_cfg.get(music_source, {}))
+            self.music_clients[music_source] = BuildMusicClient(module_cfg=init_music_client_cfg)
+            self.work_dirs[music_source] = init_music_client_cfg['work_dir']
+            if music_source not in self.clients_threadings:
+                self.clients_threadings[music_source] = 5 if music_source not in ['GDStudioMusicClient'] else 10
+            if music_source not in self.requests_overrides:
+                self.requests_overrides[music_source] = {}
+            if music_source not in self.search_rules:
+                self.search_rules[music_source] = {}
+    '''printbasicinfo'''
+    def printbasicinfo(self):
+        printfullline(ch='-')
+        print(BASIC_INFO % (__version__, ', '.join([f'"{v} for {k}"' for k, v in self.work_dirs.items()])))
+        printfullline(ch='-')
+    '''printsearchresults'''
+    def printsearchresults(self, search_results: dict):
+        print_titles, print_items, song_infos, song_info_pointer = ['ID', 'Singers', 'Songname', 'Filesize', 'Duration', 'Album', 'Source'], [], {}, 0
+        for _, per_search_results in search_results.items():
+            for search_result in per_search_results:
+                song_info_pointer += 1
+                song_infos[str(song_info_pointer)] = search_result
+                print_items.append([
+                    colorize(str(song_info_pointer), 'number'), 
+                    colorize(search_result['singers'][:12] + '...' if len(search_result['singers']) > 15 else search_result['singers'], 'singer'), 
+                    search_result['song_name'], 
+                    search_result['file_size'] if search_result['ext'] not in ['flac', 'wav', 'alac', 'ape', 'wv', 'tta', 'dsf', 'dff'] else colorize(search_result['file_size'], 'flac'), 
+                    search_result['duration'], search_result['album'], 
+                    colorize('|'.join([s.upper() for s in [search_result['source'].removesuffix('MusicClient'), search_result['root_source']] if s]), 'highlight'),
+                ])
+        print(smarttrunctable(headers=print_titles, rows=print_items, no_trunc_cols=[0, 1, 3, 4, 6]))
+        return song_infos
+    '''startcmdui'''
+    def startcmdui(self):
         while True:
-            print(BASICINFO % (__version__, self.config.get('savedir')))
-            # 音乐搜索
-            user_input = self.dealInput('请输入歌曲搜索的关键词: ')
-            target_srcs = ['baiduFlac', 'kugou', 'kuwo', 'qq', 'qianqian', 'netease', 'migu', 'xiami', 'joox'] if target_srcs is None else target_srcs
-            search_results = self.search(user_input, target_srcs)
-            # 打印搜索结果
-            title = ['序号', '歌手', '歌名', '大小', '时长', '专辑', '来源']
-            items = []
-            records = {}
-            idx = 0
-            for key, values in search_results.items():
-                for value in values:
-                    items.append([str(idx), value['singers'], value['songname'], value['filesize'], value['duration'], value['album'], value['source']])
-                    records.update({str(idx): value})
-                    idx += 1
-            printTable(title, items)
-            # 音乐下载
-            user_input = self.dealInput('请输入想要下载的音乐编号: ')
-            need_download_numbers = user_input.replace(' ', '').split(',')
-            songinfos = []
-            for item in need_download_numbers:
-                songinfo = records.get(item, '')
-                if songinfo: songinfos.append(songinfo)
-            self.download(songinfos)
-    '''音乐搜索'''
-    def search(self, keyword, target_srcs):
-        search_results = {}
-        for target_src in target_srcs:
-            try:
-                search_results.update({target_src: getattr(self, target_src).search(keyword)})
-            except Exception as err:
-                self.logger_handle.error(str(err), True)
-                self.logger_handle.warning('无法在%s中搜索 ——> %s...' % (target_src, keyword))
+            self.printbasicinfo()
+            # process user inputs, music file search
+            user_input_keyword = self.processinputs('Please enter keywords to search for songs: ')
+            search_results = self.search(keyword=user_input_keyword)
+            # print search_results
+            song_infos = self.printsearchresults(search_results=search_results)
+            # process user inputs, music file download
+            user_input_select_song_info_pointer = self.processinputs('Please enter music IDs to download (e.g., "1,2"): ').replace(' ', '').split(',')
+            user_input_select_song_info_pointer = [idx for idx in user_input_select_song_info_pointer if idx in song_infos]
+            user_input_select_song_info_pointer = list(set(user_input_select_song_info_pointer))
+            selected_song_infos = []
+            for idx in user_input_select_song_info_pointer: selected_song_infos.append(song_infos[idx])
+            self.download(selected_song_infos)
+    '''search'''
+    def search(self, keyword):
+        self.logger_handle.info(f'Searching {colorize(keyword, "highlight")} From {colorize("|".join(self.music_sources), "highlight")}')
+        search_results = dict()
+        for music_source in self.music_sources:
+            search_results[music_source] = self.music_clients[music_source].search(
+                keyword=keyword, num_threadings=self.clients_threadings[music_source], 
+                request_overrides=self.requests_overrides[music_source], rule=self.search_rules[music_source]
+            )
         return search_results
-    '''音乐下载'''
-    def download(self, songinfos):
-        for songinfo in songinfos:
-            getattr(self, songinfo['source']).download([songinfo])
-    '''初始化所有支持的搜索/下载源'''
-    def initializeAllSources(self):
-        supported_sources = {
-            'qq': qq,
-            'kuwo': kuwo,
-            'joox': joox,
-            'migu': migu,
-            'kugou': kugou,
-            'xiami': xiami,
-            'netease': netease,
-            'qianqian': qianqian,
-            'baiduFlac': baiduFlac,
-        }
-        for key, value in supported_sources.items():
-            setattr(self, key, value(copy.deepcopy(self.config), self.logger_handle))
-    '''处理用户输入'''
-    def dealInput(self, tip=''):
-        user_input = input(tip)
+    '''download'''
+    def download(self, song_infos):
+        classified_song_infos = {}
+        for song_info in song_infos:
+            if song_info['source'] in classified_song_infos:
+                classified_song_infos[song_info['source']].append(song_info)
+            else:
+                classified_song_infos[song_info['source']] = [song_info]
+        for source, source_song_infos in classified_song_infos.items():
+            self.music_clients[source].download(
+                song_infos=source_song_infos, num_threadings=self.clients_threadings[source], request_overrides=self.requests_overrides[source]
+            )
+    '''processinputs'''
+    def processinputs(self, input_tip='', prefix: str = '\n'):
+        # accept user inputs
+        user_input = input(prefix + input_tip)
+        # quit
         if user_input.lower() == 'q':
-            self.logger_handle.info('ByeBye...')
+            self.logger_handle.info('Goodbye — thanks for using musicdl; come back anytime!')
             sys.exit()
+        # restart
         elif user_input.lower() == 'r':
-            self.initializeAllSources()
-            self.run()
+            self.startcmdui()
+        # common inputs
         else:
             return user_input
+    '''str'''
+    def __str__(self):
+        return 'Welcome to use musicdl!\nYou can visit https://github.com/CharlesPikachu/musicdl for more details.'
 
 
-'''run'''
+'''MusicClientCMD'''
+@click.command()
+@click.version_option()
+@click.option(
+    '-k', '--keyword', default=None, help='The keywords for the music search. If left empty, an interactive terminal will open automatically.', type=str, show_default=True,
+)
+@click.option(
+    '-m', '--music-sources', '--music_sources', default=','.join(DEFAULT_MUSIC_SOURCES), help='The music search and download sources.', type=str, show_default=True, 
+)
+@click.option(
+    '-i', '--init-music-clients-cfg', '--init_music_clients_cfg', default=None, help='Config such as `work_dir` for each music client as a JSON string.', type=str, show_default=True,
+)
+@click.option(
+    '-r', '--requests-overrides', '--requests_overrides', default=None, help='Requests.get / Requests.post kwargs such as `headers` and `proxies` for each music client as a JSON string.', type=str, show_default=True,
+)
+@click.option(
+    '-c', '--clients-threadings', '--clients_threadings', default=None, help='Number of threads used for each music client as a JSON string.', type=str, show_default=True,
+)
+@click.option(
+    '-s', '--search-rules', '--search_rules', default=None, help='Search rules for each music client as a JSON string.', type=str, show_default=True,
+)
+def MusicClientCMD(keyword: str, music_sources: str, init_music_clients_cfg: str, requests_overrides: str, clients_threadings: str, search_rules: str):
+    # load json string
+    def _safe_load(string):
+        if string is not None:
+            result = json_repair.loads(string) or {}
+        else:
+            result = {}
+        return result
+    init_music_clients_cfg = _safe_load(init_music_clients_cfg)
+    requests_overrides = _safe_load(requests_overrides)
+    clients_threadings = _safe_load(clients_threadings)
+    search_rules = _safe_load(search_rules)
+    # instance music client
+    music_sources = music_sources.replace(' ', '').split(',')
+    music_client = MusicClient(
+        music_sources=music_sources, init_music_clients_cfg=init_music_clients_cfg, clients_threadings=clients_threadings, 
+        requests_overrides=requests_overrides, search_rules=search_rules,
+    )
+    # switch according to keyword
+    if keyword is None:
+        music_client.startcmdui()
+    else:
+        print(music_client)
+        # --search
+        search_results = music_client.search(keyword=keyword)
+        # print search_results
+        song_infos = music_client.printsearchresults(search_results=search_results)
+        # process user inputs, music file download
+        user_input_select_song_info_pointer = music_client.processinputs('Please enter music IDs to download (e.g., "1,2"): ').replace(' ', '').split(',')
+        user_input_select_song_info_pointer = [idx for idx in user_input_select_song_info_pointer if idx in song_infos]
+        user_input_select_song_info_pointer = list(set(user_input_select_song_info_pointer))
+        selected_song_infos = []
+        for idx in user_input_select_song_info_pointer: selected_song_infos.append(song_infos[idx])
+        # --download
+        music_client.download(song_infos=selected_song_infos)
+
+
+'''tests'''
 if __name__ == '__main__':
-    dl_client = musicdl('config.json')
-    dl_client.run()
+    music_client = MusicClient()
+    music_client.startcmdui()

musicdl-2.7.3.dist-info/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2022-2030 CharlesPikachu. All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022-2030 CharlesPikachu.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.