style: format code with black

Author: y-young

.pylintrc

@@ -243,7 +243,7 @@ variable-naming-style=snake_case
 expected-line-ending-format=
 
 # Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+ignore-long-lines=^\s*(# |'|\")?<?https?://\S+>?$
 
 # Number of spaces of indent required inside a hanging or continued line.
 indent-after-paren=4
@@ -253,7 +253,7 @@ indent-after-paren=4
 indent-string='    '
 
 # Maximum number of characters on a single line.
-max-line-length=100
+max-line-length=88
 
 # Maximum number of lines in a module.
 max-module-lines=1000

nazurin/__init__.py

@@ -9,4 +9,4 @@
 bot = NazurinBot(token=config.TOKEN, proxy=config.PROXY)
 dp = NazurinDispatcher(bot)
 
-__all__ = ['bot', 'dp']
+__all__ = ["bot", "dp"]

nazurin/__main__.py

@@ -15,10 +15,12 @@
 from nazurin.utils.exceptions import NazurinError
 from nazurin.utils.helpers import format_error
 
-@dp.message_handler(commands=['start', 'help'])
+
+@dp.message_handler(commands=["start", "help"])
 @chat_action(ChatActions.TYPING)
 async def show_help(message: Message):
-    await message.reply('''
+    await message.reply(
+        """
     小さな小さな賢将, can help you collect images from various sites.
     Commands:
     /ping - pong
@@ -34,14 +36,17 @@ async def show_help(message: Message):
     /clear_cache - clear download cache
     /help - get this help text
     PS: Send Pixiv/Danbooru/Yandere/Konachan/Twitter URL to download image(s)
-    ''')
+    """
+    )
+
 
-@dp.message_handler(commands=['ping'])
+@dp.message_handler(commands=["ping"])
 @chat_action(ChatActions.TYPING)
 async def ping(message: Message):
-    await message.reply('pong!')
+    await message.reply("pong!")
+
 
-@dp.message_handler(IDFilter(config.ADMIN_ID), commands=['clear_cache'])
+@dp.message_handler(IDFilter(config.ADMIN_ID), commands=["clear_cache"])
 async def clear_cache(message: Message):
     try:
         if os.path.exists(config.TEMP_DIR):
@@ -53,28 +58,30 @@ async def clear_cache(message: Message):
     except OSError as error:
         await message.reply(error.strerror)
 
+
 @dp.errors_handler()
 async def on_error(update: Update, exception: Exception):
     try:
         raise exception
     except ClientResponseError as error:
         traceback.print_exc()
-        await update.message.reply(
-            f'Response Error: {error.status} {error.message}')
+        await update.message.reply(f"Response Error: {error.status} {error.message}")
     except NazurinError as error:
         await update.message.reply(error.msg)
     except asyncio.TimeoutError:
         traceback.print_exc()
-        await update.message.reply('Error: Timeout, please try again.')
+        await update.message.reply("Error: Timeout, please try again.")
     except Exception as error:  # pylint: disable=broad-except
-        logger.exception('Update {} caused {}: {}', update, type(error), error)
+        logger.exception("Update {} caused {}: {}", update, type(error), error)
         if not isinstance(error, TelegramAPIError):
-            await update.message.reply(f'Error: {format_error(error)}')
+            await update.message.reply(f"Error: {format_error(error)}")
 
     return True
 
+
 def main():
     dp.start()
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     main()

nazurin/bot.py

@@ -15,6 +15,7 @@
 from nazurin.utils.exceptions import NazurinError
 from nazurin.utils.helpers import handle_bad_request, sanitize_caption
 
+
 class NazurinBot(Bot):
     send_message = retry_after(Bot.send_message)
 
@@ -28,29 +29,28 @@ def init(self):
         self.storage.load()
 
     @retry_after
-    async def send_single_group(self,
-                                imgs: List[Image],
-                                caption: str,
-                                chat_id: int,
-                                reply_to: Optional[int] = None):
+    async def send_single_group(
+        self,
+        imgs: List[Image],
+        caption: str,
+        chat_id: int,
+        reply_to: Optional[int] = None,
+    ):
         await self.send_chat_action(chat_id, ChatActions.UPLOAD_PHOTO)
         media = []
         for img in imgs:
             media.append(InputMediaPhoto(await img.display_url()))  # TODO
         media[0].caption = caption
-        await self.send_media_group(chat_id,
-                                    media,
-                                    reply_to_message_id=reply_to)
-
-    async def send_photos(self,
-                          illust: Illust,
-                          chat_id: int,
-                          reply_to: Optional[int] = None):
+        await self.send_media_group(chat_id, media, reply_to_message_id=reply_to)
+
+    async def send_photos(
+        self, illust: Illust, chat_id: int, reply_to: Optional[int] = None
+    ):
         caption = sanitize_caption(illust.caption)
         groups = []
         imgs = illust.images
         if len(imgs) == 0:
-            raise NazurinError('No image to send, try download option.')
+            raise NazurinError("No image to send, try download option.")
 
         while imgs:
             groups.append(imgs[:10])
@@ -59,22 +59,25 @@ async def send_photos(self,
         for group in groups:
             await self.send_single_group(group, caption, chat_id, reply_to)
 
-    async def send_illust(self,
-                          illust: Illust,
-                          message: Optional[Message] = None,
-                          chat_id: Optional[int] = None):
+    async def send_illust(
+        self,
+        illust: Illust,
+        message: Optional[Message] = None,
+        chat_id: Optional[int] = None,
+    ):
         reply_to = message.message_id if message else None
         if not chat_id:
             chat_id = message.chat.id
         elif chat_id != reply_to:  # Sending to different chat, can't reply
             reply_to = None
         try:
             if isinstance(illust, Ugoira):
-                await self.send_animation(chat_id,
-                                          InputFile(illust.video.path),
-                                          caption=sanitize_caption(
-                                              illust.caption),
-                                          reply_to_message_id=reply_to)
+                await self.send_animation(
+                    chat_id,
+                    InputFile(illust.video.path),
+                    caption=sanitize_caption(illust.caption),
+                    reply_to_message_id=reply_to,
+                )
             else:
                 await self.send_photos(illust, chat_id, reply_to)
         except BadRequest as error:
@@ -83,14 +86,13 @@ async def send_illust(self,
     @retry_after
     async def send_doc(self, file: File, chat_id, message_id=None):
         await self.send_chat_action(chat_id, ChatActions.UPLOAD_DOCUMENT)
-        await self.send_document(chat_id,
-                                 InputFile(file.path),
-                                 reply_to_message_id=message_id)
-
-    async def send_docs(self,
-                        illust: Illust,
-                        message: Optional[Message] = None,
-                        chat_id=None):
+        await self.send_document(
+            chat_id, InputFile(file.path), reply_to_message_id=message_id
+        )
+
+    async def send_docs(
+        self, illust: Illust, message: Optional[Message] = None, chat_id=None
+    ):
         if message:
             message_id = message.message_id
             if not chat_id:
@@ -100,32 +102,37 @@ async def send_docs(self,
         for file in illust.all_files:
             await self.send_doc(file, chat_id, message_id)
 
-    async def update_collection(self,
-                                urls: List[str],
-                                message: Optional[Message] = None):
+    async def update_collection(
+        self, urls: List[str], message: Optional[Message] = None
+    ):
         result = self.sites.match(urls)
         if not result:
-            raise NazurinError('No source matched')
-        logger.info('Collection update: site={}, match={}', result['site'],
-                    result['match'].groups())
+            raise NazurinError("No source matched")
+        logger.info(
+            "Collection update: site={}, match={}",
+            result["site"],
+            result["match"].groups(),
+        )
 
         illust = await self.sites.handle_update(result)
 
         # Send / Forward to gallery & Save to album
         download = asyncio.create_task(illust.download())
 
         if config.GALLERY_ID:
-            # If there're multiple images, then send a new message instead of
-            # forwarding an existing one, since we currently can't forward albums correctly.
-            if message and message.is_forward(
-            ) and not illust.has_multiple_images():
+            # If there're multiple images,
+            # then send a new message instead of forwarding an existing one,
+            # since we currently can't forward albums correctly.
+            if message and message.is_forward() and not illust.has_multiple_images():
                 save = asyncio.create_task(message.forward(config.GALLERY_ID))
             elif not illust.has_image():
                 save = asyncio.create_task(
-                    self.send_message(config.GALLERY_ID, '\n'.join(urls)))
+                    self.send_message(config.GALLERY_ID, "\n".join(urls))
+                )
             else:
                 save = asyncio.create_task(
-                    self.send_illust(illust, message, config.GALLERY_ID))
+                    self.send_illust(illust, message, config.GALLERY_ID)
+                )
             await asyncio.gather(save, download)
         else:
             await download

nazurin/config.py

@@ -6,42 +6,42 @@
 # read config from .env file if exists
 env.read_env()
 
-ENV = env.str('ENV', default='production')
-TOKEN = env.str('TOKEN')
+ENV = env.str("ENV", default="production")
+TOKEN = env.str("TOKEN")
 
 # Webhook url, eg: https://xxx.fly.dev/, should end with '/'
-WEBHOOK_URL = env.str('WEBHOOK_URL', default=None)
-HOST = env.str('HOST', default='0.0.0.0')
+WEBHOOK_URL = env.str("WEBHOOK_URL", default=None)
+HOST = env.str("HOST", default="0.0.0.0")
 # Port is automatically set if on Heroku or fly.io
-PORT = env.int('PORT', default=80)
+PORT = env.int("PORT", default=80)
 
-STORAGE = env.list('STORAGE', subcast=str, default=['Local'])
-STORAGE_DIR = env.str('STORAGE_DIR', default='Pictures')
+STORAGE = env.list("STORAGE", subcast=str, default=["Local"])
+STORAGE_DIR = env.str("STORAGE_DIR", default="Pictures")
 
-DATABASE = env.str('DATABASE', default='Local')
+DATABASE = env.str("DATABASE", default="Local")
 # Nazurin data collection in database
-NAZURIN_DATA = 'nazurin'
+NAZURIN_DATA = "nazurin"
 # Ignored items in image caption
-CAPTION_IGNORE = env.list('CAPTION_IGNORE', subcast=str, default=[])
+CAPTION_IGNORE = env.list("CAPTION_IGNORE", subcast=str, default=[])
 
-GALLERY_ID = env.int('GALLERY_ID', default=None)
+GALLERY_ID = env.int("GALLERY_ID", default=None)
 
-ADMIN_ID = env.int('ADMIN_ID')
-IS_PUBLIC = env.bool('IS_PUBLIC', default=False)
+ADMIN_ID = env.int("ADMIN_ID")
+IS_PUBLIC = env.bool("IS_PUBLIC", default=False)
 # If IS_PUBLIC is True, the following items will be ignored
-ALLOW_ID = env.list('ALLOW_ID', subcast=int, default=[])
-ALLOW_USERNAME = env.list('ALLOW_USERNAME', default=[])
-ALLOW_GROUP = env.list('ALLOW_GROUP', subcast=int, default=[])
+ALLOW_ID = env.list("ALLOW_ID", subcast=int, default=[])
+ALLOW_USERNAME = env.list("ALLOW_USERNAME", default=[])
+ALLOW_GROUP = env.list("ALLOW_GROUP", subcast=int, default=[])
 
-RETRIES = env.int('RETRIES', default=5)
-TIMEOUT = env.int('TIMEOUT', default=20)
-PROXY = env.str('HTTP_PROXY', default=None)
+RETRIES = env.int("RETRIES", default=5)
+TIMEOUT = env.int("TIMEOUT", default=20)
+PROXY = env.str("HTTP_PROXY", default=None)
 UA = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) \
     AppleWebKit/537.36 (KHTML, like Gecko) \
     Chrome/90.0.4430.85 \
     Safari/537.36"
 
 # Local directory to store database and temporary files
-DATA_DIR = 'data'
-TEMP_DIR = path.join(DATA_DIR, 'temp')
+DATA_DIR = "data"
+TEMP_DIR = path.join(DATA_DIR, "temp")
 ACCESS_LOG_FORMAT = '%a "%r" %s %b "%{Referer}i" "%{User-Agent}i"'

nazurin/database/__init__.py

@@ -3,10 +3,11 @@
 
 from nazurin.config import DATABASE
 
+
 class Database:
     """Nazurin database manager."""
+
     def __init__(self):
         """Dynamically load all database drivers."""
-        module = importlib.import_module('nazurin.database.' +
-                                         DATABASE.lower())
+        module = importlib.import_module("nazurin.database." + DATABASE.lower())
         self.driver = getattr(module, DATABASE)

nazurin/database/cloudant.py

@@ -4,19 +4,20 @@
 from nazurin.config import RETRIES, env
 from nazurin.utils.decorators import async_wrap
 
-with env.prefixed('CLOUDANT_'):
-    USERNAME = env.str('USER')
-    APIKEY = env.str('APIKEY')
-    DATABASE = env.str('DB', default='nazurin')
+with env.prefixed("CLOUDANT_"):
+    USERNAME = env.str("USER")
+    APIKEY = env.str("APIKEY")
+    DATABASE = env.str("DB", default="nazurin")
+
 
 class Cloudant:
     """Cloudant driver of IBM Cloud."""
+
     def __init__(self):
         """Connect to database."""
-        self.client = cloudant.iam(USERNAME,
-                                   APIKEY,
-                                   timeout=5,
-                                   adapter=HTTPAdapter(max_retries=RETRIES))
+        self.client = cloudant.iam(
+            USERNAME, APIKEY, timeout=5, adapter=HTTPAdapter(max_retries=RETRIES)
+        )
         self.client.connect()
         self.db = self.client[DATABASE]
         self._partition = None
@@ -44,7 +45,7 @@ def exists(self):
     @async_wrap
     def insert(self, key, data):
         self._document = str(key)
-        data['_id'] = self._id()
+        data["_id"] = self._id()
         return self.db.create_document(data)
 
     @async_wrap
@@ -59,7 +60,7 @@ def delete(self):
         return doc.delete()
 
     def _id(self):
-        return ':'.join((self._partition, self._document))
+        return ":".join((self._partition, self._document))
 
     def __del__(self):
         """Disconnect from database."""

nazurin/database/firebase.py

@@ -6,14 +6,16 @@
 
 from nazurin.config import env
 
+
 class Firebase:
     """Firestore driver of Firebase."""
+
     db: AsyncClient
 
     def __init__(self):
         """Load credentials and initialize Firebase app."""
-        cert = env.str('GOOGLE_APPLICATION_CREDENTIALS')
-        if cert.startswith('{'):
+        cert = env.str("GOOGLE_APPLICATION_CREDENTIALS")
+        if cert.startswith("{"):
             cert = json.loads(cert)
         cred = credentials.Certificate(cert)
         if len(firebase_admin._apps) == 0: