formatting

Author: stared

README.md

@@ -113,14 +113,14 @@ In case when the same option is specified both in the YAML file and in as a comm
 
 When you run BDFR manually from your Terminal, if you pass `--progress-bar` you will get a short summary of results with a progress bar, instead of more detailed logs.
 
-```
-✅    52🔼 Helianthus Annuus: A beautiful sunflower grown from a birdseed mix. [OC]                     
-❌   124🔼 Olives                                                                                       
-✅    20🔼 Carpobrotus chilensis, Marina, California [3023x4032] [OC]                                   
-✅     0🔼 Game made with preserved ferns, acorns, meadowsweet flowers and moss [OC]                    
-✅   223🔼 Plinia cauliflora "Jabuticaba" and bees                                                      
-✅   367🔼 Frozen saxifraga cotyledon - or "fjelldronning" aka mountain queen - on a r...               
-✅   135🔼 Hibiscus syriacus - Minerva Rose of Sharon [OC]                         
+```bash
+✅    52🔼 Helianthus Annuus: A beautiful sunflower grown from a birdseed mix. [OC]
+❌   124🔼 Olives
+✅    20🔼 Carpobrotus chilensis, Marina, California [3023x4032] [OC]
+✅     0🔼 Game made with preserved ferns, acorns, meadowsweet flowers and moss [OC]
+✅   223🔼 Plinia cauliflora "Jabuticaba" and bees
+✅   367🔼 Frozen saxifraga cotyledon - or "fjelldronning" aka mountain queen - on a r...
+✅   135🔼 Hibiscus syriacus - Minerva Rose of Sharon [OC]
 Subreddits: 100%|███████████████████████████████████████| 5/5 [00:45<00:00,  9.09s/subreddit]
 ```
 

bdfr/__main__.py

@@ -41,7 +41,7 @@
     click.option("-t", "--time", type=click.Choice(("all", "hour", "day", "week", "month", "year")), default=None),
     click.option("-u", "--user", type=str, multiple=True, default=None),
     click.option("-v", "--verbose", default=None, count=True),
-    click.option('--progress-bar', is_flag=True, default=False),
+    click.option("--progress-bar", is_flag=True, default=False),
 ]
 
 _downloader_options = [
@@ -123,7 +123,7 @@ def cli_archive(context: click.Context, **_):
 def cli_clone(context: click.Context, **_):
     config = Configuration()
     config.process_click_arguments(context)
-    setup_logging(config.verbose, config.progress_bar), 
+    setup_logging(config.verbose, config.progress_bar),
     try:
         reddit_scraper = RedditCloner(config)
         reddit_scraper.download()
@@ -142,13 +142,13 @@ def filter(self, record: logging.LogRecord) -> bool:
 
     if progress_bar:
         logger.setLevel(logging.CRITICAL)
-        logging.getLogger('progress_bar').setLevel(logging.INFO)
+        logging.getLogger("progress_bar").setLevel(logging.INFO)
     else:
         logger.setLevel(1)
         stream = logging.StreamHandler(sys.stdout)
         stream.addFilter(StreamExceptionFilter())
 
-        formatter = logging.Formatter('[%(asctime)s - %(name)s - %(levelname)s] - %(message)s')
+        formatter = logging.Formatter("[%(asctime)s - %(name)s - %(levelname)s] - %(message)s")
         stream.setFormatter(formatter)
 
         logger.addHandler(stream)
@@ -159,11 +159,11 @@ def filter(self, record: logging.LogRecord) -> bool:
         else:
             stream.setLevel(9)
 
-        logging.getLogger('progress_bar').setLevel(logging.CRITICAL)        
+        logging.getLogger("progress_bar").setLevel(logging.CRITICAL)
 
-    logging.getLogger('praw').setLevel(logging.CRITICAL)
-    logging.getLogger('prawcore').setLevel(logging.CRITICAL)
-    logging.getLogger('urllib3').setLevel(logging.CRITICAL)
+    logging.getLogger("praw").setLevel(logging.CRITICAL)
+    logging.getLogger("prawcore").setLevel(logging.CRITICAL)
+    logging.getLogger("urllib3").setLevel(logging.CRITICAL)
 
 
 if __name__ == "__main__":

bdfr/downloader.py

@@ -9,21 +9,22 @@
 from datetime import datetime
 from multiprocessing import Pool
 from pathlib import Path
-from tqdm import tqdm
-from tqdm.contrib.logging import logging_redirect_tqdm
 
 import praw
 import praw.exceptions
 import praw.models
 import prawcore
+from tqdm import tqdm
+from tqdm.contrib.logging import logging_redirect_tqdm
 
 from bdfr import exceptions as errors
 from bdfr.configuration import Configuration
 from bdfr.connector import RedditConnector
 from bdfr.site_downloaders.download_factory import DownloadFactory
 
 logger = logging.getLogger(__name__)
-logger_progress_bar = logging.getLogger('progress_bar')
+logger_progress_bar = logging.getLogger("progress_bar")
+
 
 def _calc_hash(existing_file: Path):
     chunk_size = 1024 * 1024
@@ -36,6 +37,7 @@ def _calc_hash(existing_file: Path):
     file_hash = md5_hash.hexdigest()
     return existing_file, file_hash
 
+
 class RedditDownloader(RedditConnector):
     def __init__(self, args: Configuration):
         super(RedditDownloader, self).__init__(args)
@@ -48,23 +50,23 @@ def download(self):
                 for generator in tqdm(self.reddit_lists, desc="Subreddits", unit="subreddit", colour="red"):
                     desc = generator.url if isinstance(generator, praw.models.ListingGenerator) else "Posts"
                     for submission in tqdm(list(generator), desc=desc, unit="post", colour="green", leave=False):
-                        title_short = submission.title[:60] + (submission.title[60:] and '...')
-                        log_str = f'{submission.score:5d}🔼 {title_short}'
+                        title_short = submission.title[:60] + (submission.title[60:] and "...")
+                        log_str = f"{submission.score:5d}🔼 {title_short}"
                         try:
                             if self._download_submission(submission):
-                                logger_progress_bar.info(f'✅ {log_str}')
+                                logger_progress_bar.info(f"✅ {log_str}")
                             else:
-                                logger_progress_bar.info(f'❌ {log_str}')
+                                logger_progress_bar.info(f"❌ {log_str}")
                         except prawcore.PrawcoreException as e:
-                            logger.error(f'Submission {submission.id} failed to download due to a PRAW exception: {e}')
-                            logger_progress_bar.info(f'❌ {log_str}')
+                            logger.error(f"Submission {submission.id} failed to download due to a PRAW exception: {e}")
+                            logger_progress_bar.info(f"❌ {log_str}")
         else:
             for generator in self.reddit_lists:
                 for submission in generator:
                     try:
                         self._download_submission(submission)
                     except prawcore.PrawcoreException as e:
-                        logger.error(f'Submission {submission.id} failed to download due to a PRAW exception: {e}')
+                        logger.error(f"Submission {submission.id} failed to download due to a PRAW exception: {e}")
 
     def _download_submission(self, submission: praw.models.Submission):
         if submission.id in self.excluded_submission_ids:
@@ -163,7 +165,9 @@ def _download_submission(self, submission: praw.models.Submission):
             self.master_hash_list[resource_hash] = destination
             logger.debug(f"Hash added to master list: {resource_hash}")
         logger.info(f"Downloaded submission {submission.id} from {submission.subreddit.display_name}")
-        logger_progress_bar.info(f"✓ {submission.subreddit.display_name} ({submission.score}) {submission.title} - {submission.author}")
+        logger_progress_bar.info(
+            f"✓ {submission.subreddit.display_name} ({submission.score}) {submission.title} - {submission.author}"
+        )
         return True
 
     @staticmethod

setup.py

@@ -3,4 +3,9 @@
 
 from setuptools import setup
 
-setup(setup_requires=['pbr', 'appdirs'], pbr=True, data_files=[('config', ['bdfr/default_config.cfg'])], python_requires='>=3.9.0')
+setup(
+    setup_requires=["pbr", "appdirs"],
+    pbr=True,
+    data_files=[("config", ["bdfr/default_config.cfg"])],
+    python_requires=">=3.9.0",
+)