Bump version to 2.7.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,9 +7,10 @@ assignees: ''
 
 ---
 
+- [ ] I have read the [Opening an issue](https://github.com/aliparlakci/bulk-downloader-for-reddit/blob/master/docs/CONTRIBUTING.md#opening-an-issue)
 - [ ] I am reporting a bug.
 - [ ] I am running the latest version of BDfR
-- [ ] I have read the [Opening an issue](https://github.com/aliparlakci/bulk-downloader-for-reddit/blob/master/docs/CONTRIBUTING.md#opening-an-issue)
+- [ ] I am not asking a question about the BDFR (please use Discussions for this)
 
 ## Description
 
@@ -28,6 +29,8 @@ Paste here the command(s) that causes the bug
 
 ## Logs
 
+These are my **unaltered** logs:
+
 ```text
 Paste the log output here.
 ```

.github/workflows/scripts-test.yml

@@ -0,0 +1,29 @@
+name: Scripts Test
+
+on:
+  push:
+    paths:
+      - "scripts/*.sh"
+      - "scripts/*.ps1"
+  pull_request:
+    paths:
+      - "scripts/*.sh"
+      - "scripts/*.ps1"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'true'
+    - name: Bats tests
+      run: |
+        cd scripts/tests/
+        bats/bin/bats *.bats
+
+    - name: Pester tests
+      shell: pwsh
+      run: |
+        cd scripts/tests/
+        Invoke-Pester -CI -PassThru .

.github/workflows/test.yml

@@ -7,12 +7,14 @@ on:
       - "**.md"
       - ".markdown_style.rb"
       - ".mdlrc"
+      - "scripts/"
   pull_request:
     branches: [ master, development ]
     paths-ignore:
       - "**.md"
       - ".markdown_style.rb"
       - ".mdlrc"
+      - "scripts/"
 
 jobs:
   test:
@@ -35,7 +37,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip Flake8-pyproject pytest pytest-cov
+        python -m pip install --upgrade pip pytest pytest-cov ruff
         pip install .
 
     - name: Make configuration for tests
@@ -44,16 +46,20 @@ jobs:
       run: |
         ./devscripts/configure${{ matrix.ext }}
 
-    - name: Lint with flake8
+    - name: Critical ruff lint
       run: |
-        flake8 . --select=E9,F63,F7,F82
+        ruff check --select=E9,F63,F7,F82 .
 
     - name: Test with pytest
       run: |
-        pytest -m 'not slow' --verbose --cov=./bdfr/ --cov-report term:skip-covered --cov-report html
+        pytest -m "not slow" --verbose --cov=./bdfr/ --cov-report term:skip-covered --cov-report html
 
     - name: Upload coverage report
       uses: actions/upload-artifact@v3
       with:
         name: coverage_report
         path: htmlcov/
+
+    - name: Full ruff lint
+      run: |
+        ruff check . --exit-zero

.gitignore

@@ -128,6 +128,9 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
+# ruff
+.ruff_cache/
+
 # Pyre type checker
 .pyre/
 
@@ -141,4 +144,4 @@ cython_debug/
 test_config.cfg
 
 .vscode/
-.idea/
+.idea/

.markdown_style.rb

@@ -1,4 +1,4 @@
 all
-exclude_tag :line_length
+rule 'MD013', :line_length => 120, :code_blocks => false
 rule 'MD007', :indent => 4
 rule 'MD029', :style => 'ordered'

.pre-commit-config.yaml

@@ -2,24 +2,34 @@
 # See https://pre-commit.com/hooks.html for more hooks
 
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.12.0
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.13
     hooks:
-      - id: black
+      - id: validate-pyproject
+        name: validate-pyproject
 
-  - repo: https://github.com/pycqa/isort
-    rev: 5.11.4
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
     hooks:
-      - id: isort
-        name: isort (python)
+      - id: black
+        name: black
 
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.1.13
     hooks:
-      - id: flake8
-        additional_dependencies: [Flake8-pyproject]
+      - id: ruff
+        name: ruff
+        args: ["--fixable=I","--fix"]
 
   - repo: https://github.com/markdownlint/markdownlint
     rev: v0.12.0
     hooks:
       - id: markdownlint
+        name: markdownlint
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.13.0
+    hooks:
+      - id: blacken-docs
+        name: blacken-docs
+        additional_dependencies: [black>=23.1.0]

bdfr/__init__.py

@@ -1,4 +1,3 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
-__version__ = "2.6.2"
+__version__ = "2.7.0"

bdfr/__main__.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 import logging
 import sys
@@ -20,10 +19,11 @@
     click.argument("directory", type=str),
     click.option("--authenticate", is_flag=True, default=None),
     click.option("--config", type=str, default=None),
-    click.option("--disable-module", multiple=True, default=None, type=str),
-    click.option("--exclude-id", default=None, multiple=True),
-    click.option("--exclude-id-file", default=None, multiple=True),
-    click.option("--file-scheme", default=None, type=str),
+    click.option("--disable-module", type=str, multiple=True, default=None),
+    click.option("--downvoted", is_flag=True, default=None),
+    click.option("--exclude-id", type=str, multiple=True, default=None),
+    click.option("--exclude-id-file", type=str, multiple=True, default=None),
+    click.option("--file-scheme", type=str, default=None),
     click.option("--filename-restriction-scheme", type=click.Choice(("linux", "windows")), default=None),
     click.option("--folder-scheme", default=None, type=str),
     click.option("--ignore-user", type=str, multiple=True, default=None),
@@ -65,25 +65,30 @@
 _archiver_options = [
     click.option("--all-comments", is_flag=True, default=None),
     click.option("--comment-context", is_flag=True, default=None),
-    click.option("-f", "--format", type=click.Choice(("xml", "json", "yaml")), default=None),
+    click.option("-f", "--format", type=click.Choice(("xml", "json", "yaml")), default=None, multiple=True),
+    click.option("--skip-comments", is_flag=True, default=None),
 ]
 
 
-def _add_options(opts: list):
-    def wrap(func):
+def _add_options(opts: list):  # noqa: ANN202
+    def wrap(func):  # noqa: ANN001,ANN202
         for opt in opts:
             func = opt(func)
         return func
 
     return wrap
 
 
-def _check_version(context, param, value):
+def _check_version(context: click.core.Context, _param, value: bool) -> None:
     if not value or context.resilient_parsing:
         return
     current = __version__
-    latest = requests.get("https://pypi.org/pypi/bdfr/json").json()["info"]["version"]
-    print(f"You are currently using v{current} the latest is v{latest}")
+    try:
+        latest = requests.get("https://pypi.org/pypi/bdfr/json", timeout=10).json()["info"]["version"]
+        print(f"You are currently using v{current} the latest is v{latest}")
+    except TimeoutError:
+        logger.exception(f"Timeout reached fetching current version from Pypi - BDFR v{current}")
+        raise
     context.exit()
 
 
@@ -97,7 +102,7 @@ def _check_version(context, param, value):
     callback=_check_version,
     help="Check version and exit.",
 )
-def cli():
+def cli() -> None:
     """BDFR is used to download and archive content from Reddit."""
     pass
 
@@ -107,7 +112,7 @@ def cli():
 @_add_options(_downloader_options)
 @click.help_option("-h", "--help")
 @click.pass_context
-def cli_download(context: click.Context, **_):
+def cli_download(context: click.Context, **_) -> None:
     """Used to download content posted to Reddit."""
     config = Configuration()
     config.process_click_arguments(context)
@@ -117,18 +122,18 @@ def cli_download(context: click.Context, **_):
         reddit_downloader = RedditDownloader(config, [stream])
         reddit_downloader.download()
     except Exception:
-        logger.exception("Downloader exited unexpectedly")
+        logger.exception(f"Downloader exited unexpectedly - BDFR Downloader v{__version__}")
         raise
     else:
-        logger.info("Program complete")
+        logger.info(f"Program complete - BDFR Downloader v{__version__}")
 
 
 @cli.command("archive")
 @_add_options(_common_options)
 @_add_options(_archiver_options)
 @click.help_option("-h", "--help")
 @click.pass_context
-def cli_archive(context: click.Context, **_):
+def cli_archive(context: click.Context, **_) -> None:
     """Used to archive post data from Reddit."""
     config = Configuration()
     config.process_click_arguments(context)
@@ -138,10 +143,10 @@ def cli_archive(context: click.Context, **_):
         reddit_archiver = Archiver(config, [stream])
         reddit_archiver.download()
     except Exception:
-        logger.exception("Archiver exited unexpectedly")
+        logger.exception(f"Archiver exited unexpectedly - BDFR Archiver v{__version__}")
         raise
     else:
-        logger.info("Program complete")
+        logger.info(f"Program complete - BDFR Archiver v{__version__}")
 
 
 @cli.command("clone")
@@ -150,7 +155,7 @@ def cli_archive(context: click.Context, **_):
 @_add_options(_downloader_options)
 @click.help_option("-h", "--help")
 @click.pass_context
-def cli_clone(context: click.Context, **_):
+def cli_clone(context: click.Context, **_) -> None:
     """Combines archive and download commands."""
     config = Configuration()
     config.process_click_arguments(context)
@@ -160,17 +165,17 @@ def cli_clone(context: click.Context, **_):
         reddit_scraper = RedditCloner(config, [stream])
         reddit_scraper.download()
     except Exception:
-        logger.exception("Scraper exited unexpectedly")
+        logger.exception(f"Scraper exited unexpectedly - BDFR Scraper v{__version__}")
         raise
     else:
-        logger.info("Program complete")
+        logger.info(f"Program complete - BDFR Cloner v{__version__}")
 
 
-@cli.command("completion")
+@cli.command("completions")
 @click.argument("shell", type=click.Choice(("all", "bash", "fish", "zsh"), case_sensitive=False), default="all")
 @click.help_option("-h", "--help")
 @click.option("-u", "--uninstall", is_flag=True, default=False, help="Uninstall completion")
-def cli_completion(shell: str, uninstall: bool):
+def cli_completion(shell: str, uninstall: bool) -> None:
     """\b
     Installs shell completions for BDFR.
     Options: all, bash, fish, zsh
@@ -183,7 +188,7 @@ def cli_completion(shell: str, uninstall: bool):
         Completion(shell).uninstall()
         return
     if shell not in ("all", "bash", "fish", "zsh"):
-        print(f"{shell} is not a valid option.")
+        print(f"{shell!r} is not a valid option.")
         print("Options: all, bash, fish, zsh")
         return
     if click.confirm(f"Would you like to install {shell} completions for BDFR"):
@@ -212,7 +217,7 @@ def filter(self, record: logging.LogRecord) -> bool:
     return stream
 
 
-def silence_module_loggers():
+def silence_module_loggers() -> None:
     logging.getLogger("praw").setLevel(logging.CRITICAL)
     logging.getLogger("prawcore").setLevel(logging.CRITICAL)
     logging.getLogger("urllib3").setLevel(logging.CRITICAL)

bdfr/archive_entry/__init__.py

@@ -1,2 +1 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-

bdfr/archive_entry/base_archive_entry.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 from abc import ABC, abstractmethod
 from typing import Union
@@ -8,7 +7,7 @@
 
 
 class BaseArchiveEntry(ABC):
-    def __init__(self, source: Union[Comment, Submission]):
+    def __init__(self, source: Union[Comment, Submission]) -> None:
         self.source = source
         self.post_details: dict = {}
 

bdfr/archive_entry/comment_archive_entry.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 import logging
 
@@ -11,8 +10,8 @@
 
 
 class CommentArchiveEntry(BaseArchiveEntry):
-    def __init__(self, comment: praw.models.Comment):
-        super(CommentArchiveEntry, self).__init__(comment)
+    def __init__(self, comment: praw.models.Comment) -> None:
+        super().__init__(comment)
 
     def compile(self) -> dict:
         self.source.refresh()