Autoformat with Black and lint with Ruff

* Adjust linter from Flake8 to Ruff. Mostly because Flake8 wasn't
  adhering to pyproject.toml, and Ruff worked without using a wrapper.

* Autoformatted everything with Black

* Tweaked files accordingly for CI

Author: tomice

.github/workflows/ci.yml

@@ -27,11 +27,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 black
+        pip install ruff black
 
-    - name: Lint with Flake8
+    - name: Lint with Ruff
       run: |
-        flake8 git_py_stats
+        ruff git_py_stats
 
     - name: Check formatting with Black
       run: |

git_py_stats/arg_parser.py

@@ -9,6 +9,7 @@
 from argparse import ArgumentParser, Namespace
 from typing import List, Optional
 
+
 def parse_arguments(argv: Optional[List[str]] = None) -> Namespace:
     """
     Parse command-line arguments and return them.
@@ -23,10 +24,10 @@ def parse_arguments(argv: Optional[List[str]] = None) -> Namespace:
         args = parse_arguments(['--detailed-git-stats'])
         print(args.detailed_git_stats)  # True
     """
-    
+
     parser = ArgumentParser(
         description="Git Py Stats - A Python Implementation of Git Quick Stats.",
-        allow_abbrev=False, # Force users to be explicit. Makes testing sane.
+        allow_abbrev=False,  # Force users to be explicit. Makes testing sane.
     )
 
     # Generate Options

git_py_stats/generate_cmds.py

@@ -5,19 +5,14 @@
 import collections
 import csv
 import json
-import os
-import re
 from typing import Optional, Dict, Any, List, Union
 from datetime import datetime, timedelta
 
 from git_py_stats.git_operations import run_git_command
 
 
 # TODO: We should really refactor this; It's huge
-def detailed_git_stats(
-    config: Dict[str, Union[str, int]],
-    branch: Optional[str] = None
-) -> None:
+def detailed_git_stats(config: Dict[str, Union[str, int]], branch: Optional[str] = None) -> None:
     """
     Displays detailed contribution stats by author.
 
@@ -38,7 +33,6 @@ def detailed_git_stats(
 
     # Variables to track current commit metadata
     current_author = ""
-    current_email = ""
     current_date = 0
 
     # Grab the config options from our config.py.
@@ -100,7 +94,6 @@ def detailed_git_stats(
             # Commit metadata
             commit_hash, author_name, author_email, date_raw = parts
             current_author = author_name
-            current_email = author_email
             current_date = int(date_raw.split()[0])
 
             # Initialize stats for the current author if not already done
@@ -175,9 +168,7 @@ def detailed_git_stats(
         )
 
         # Calculate percentages
-        insertions_pct = (
-            (insertions / total_insertions * 100) if total_insertions else 0
-        )
+        insertions_pct = (insertions / total_insertions * 100) if total_insertions else 0
         deletions_pct = (deletions / total_deletions * 100) if total_deletions else 0
         files_pct = (files / total_files_changed * 100) if total_files_changed else 0
         commits_pct = (commits / total_commits * 100) if total_commits else 0
@@ -195,17 +186,14 @@ def detailed_git_stats(
         print(f"          last commit:   {last_commit}\n")
 
     # Perform final calculation of stats
-    print(f"         total:")
+    print("         total:")
     print(f"           insertions:    {total_insertions:<6} (100%)")
     print(f"           deletions:     {total_deletions:<6} (100%)")
     print(f"           files:         {total_files_changed:<6} (100%)")
     print(f"           commits:       {total_commits:<6} (100%)\n")
 
 
-def changelogs(
-    config: Dict[str, Union[str, int]],
-    author: Optional[str] = None
-) -> None:
+def changelogs(config: Dict[str, Union[str, int]], author: Optional[str] = None) -> None:
     """
     Shows commit messages grouped by date for the last 'limit' dates
     where commits occurred.
@@ -234,8 +222,8 @@ def changelogs(
     limit = int(config.get("limit", 10))
 
     # Original git command:
-    # git -c log.showSignature=false log --use-mailmap $_merges --format="%cd" --date=short "${_author}"
-    #     "$_since" "$_until" $_log_options $_pathspec
+    # git -c log.showSignature=false log --use-mailmap $_merges --format="%cd"
+    #     --date=short "${_author}" "$_since" "$_until" $_log_options $_pathspec
     cmd = [
         "git",
         "-c",
@@ -371,7 +359,7 @@ def my_daily_status(config: Dict[str, Union[str, int]]) -> None:
     today = datetime.now().strftime("%Y-%m-%d")
     since = f"--since={today}T00:00:00"
     until = f"--until={today}T23:59:59"
-    
+
     # Build the final git log command
     log_cmd = [
         "git",
@@ -387,7 +375,7 @@ def my_daily_status(config: Dict[str, Union[str, int]]) -> None:
         "--pretty=%H",  # Output only commit hashes
         log_options,
     ]
-    
+
     # Remove any empty space from the log_cmd
     log_cmd = [arg for arg in log_cmd if arg]
     # Execute the git log command

git_py_stats/interactive_mode.py

@@ -23,38 +23,26 @@ def handle_interactive_mode(config: Dict[str, Union[str, int]]) -> None:
     """
     interactive_map = {
         "1": lambda: generate_cmds.detailed_git_stats(config),
-        "2": lambda: generate_cmds.detailed_git_stats(
-            config, input("Enter branch name: ")
-        ),
+        "2": lambda: generate_cmds.detailed_git_stats(config, input("Enter branch name: ")),
         "3": lambda: generate_cmds.changelogs(config),
-        "4": lambda: generate_cmds.changelogs(
-            config, input("Enter author name: ")
-        ),
+        "4": lambda: generate_cmds.changelogs(config, input("Enter author name: ")),
         "5": lambda: generate_cmds.my_daily_status(config),
         "6": lambda: generate_cmds.output_daily_stats_csv(config),
         "7": lambda: generate_cmds.save_git_log_output_json(config),
         "8": lambda: list_cmds.branch_tree(config),
         "9": list_cmds.branches_by_date,
         "10": lambda: list_cmds.contributors(config),
-        "11": lambda: list_cmds.new_contributors(
-            config, input("Enter cutoff date (YYYY-MM-DD): ")
-        ),
+        "11": lambda: list_cmds.new_contributors(config, input("Enter cutoff date (YYYY-MM-DD): ")),
         "12": lambda: list_cmds.git_commits_per_author(config),
         "13": lambda: list_cmds.git_commits_per_date(config),
         "14": lambda: list_cmds.git_commits_per_month(config),
         "15": lambda: list_cmds.git_commits_per_year(config),
         "16": lambda: list_cmds.git_commits_per_weekday(config),
-        "17": lambda: list_cmds.git_commits_per_weekday(
-            config, input("Enter author name: ")
-        ),
+        "17": lambda: list_cmds.git_commits_per_weekday(config, input("Enter author name: ")),
         "18": lambda: list_cmds.git_commits_per_hour(config),
-        "19": lambda: list_cmds.git_commits_per_hour(
-            config, input("Enter author name: ")
-        ),
+        "19": lambda: list_cmds.git_commits_per_hour(config, input("Enter author name: ")),
         "20": lambda: list_cmds.git_commits_per_timezone(config),
-        "21": lambda: list_cmds.git_commits_per_timezone(
-            config, input("Enter author name: ")
-        ),
+        "21": lambda: list_cmds.git_commits_per_timezone(config, input("Enter author name: ")),
         "22": lambda: suggest_cmds.suggest_reviewers(config),
     }
 

git_py_stats/list_cmds.py

@@ -4,7 +4,7 @@
 
 import collections
 import re
-from datetime import datetime, timezone
+from datetime import datetime
 from typing import Dict, Union, Optional
 
 from git_py_stats.git_operations import run_git_command
@@ -13,7 +13,7 @@
 def branch_tree(config: Dict[str, Union[str, int]]) -> None:
     """
     Displays a visual graph of recent commits across all branches.
-    
+
     Args:
         config: Dict[str, Union[str, int]]: Config dictionary holding env vars.
 
@@ -24,19 +24,22 @@ def branch_tree(config: Dict[str, Union[str, int]]) -> None:
     # Grab the config options from our config.py.
     # config.py should give fallbacks for these, but for sanity, lets
     # also provide some defaults just in case.
-    merges = config.get("merges", "--no-merges")
     since = config.get("since", "")
     until = config.get("until", "")
     log_options = config.get("log_options", "")
     limit = config.get("limit", 10)
 
     # Format string for git --format so it gets interpreted correctly
-    format_str = "--format=--+ Commit:  %h%n  | Date:    %aD (%ar)%n  | Message: %s %d%n  + Author:  %aN %n"
+    format_str = (
+        "--format=--+ Commit:  %h%n  | Date:    %aD (%ar)%n  | "
+        "Message: %s %d%n  + Author:  %aN %n"
+    )
 
     # Original command:
     # git -c log.showSignature=false log --use-mailmap --graph --abbrev-commit \
     #     "$_since" "$_until" --decorate \
-    #      --format=format:'--+ Commit:  %h %n  | Date:    %aD (%ar) %n''  | Message: %s %d %n''  + Author:  %aN %n' \
+    #      --format=format:'--+ Commit:  %h %n  | Date:    %aD (%ar) %n''  \
+    #                       | Message: %s %d %n''  + Author:  %aN %n' \
     #      --all $_log_options | head -n $((_limit*5))
     cmd = [
         "git",
@@ -69,9 +72,9 @@ def branch_tree(config: Dict[str, Union[str, int]]) -> None:
         for line in limited_lines:
             print(f"{line}")
 
-        commit_count = sum(
-            1 for line in limited_lines if line.strip().startswith("--+ Commit:")
-        )
+        # commit_count = sum(
+        #    1 for line in limited_lines if line.strip().startswith("--+ Commit:")
+        # )
     else:
         print("No data available.")
 
@@ -175,19 +178,14 @@ def contributors(config: Dict[str, Union[str, int]]) -> None:
         limited_authors = sorted_authors[:limit]
 
         # Number the authors similar to 'cat -n' and print
-        numbered_authors = [
-            f"{idx + 1}  {author}" for idx, author in enumerate(limited_authors)
-        ]
+        numbered_authors = [f"{idx + 1}  {author}" for idx, author in enumerate(limited_authors)]
         for author in numbered_authors:
             print(f"\t{author}")
     else:
         print("No contributors found.")
 
 
-def new_contributors(
-    config: Dict[str, Union[str, int]],
-    new_date: str
-) -> None:
+def new_contributors(config: Dict[str, Union[str, int]], new_date: str) -> None:
     """
     Lists all new contributors to a repo since the specified date.
 
@@ -248,10 +246,7 @@ def new_contributors(
                 email, timestamp = line.split("|")
                 timestamp = int(timestamp)
                 # If the contributor is not in the dictionary or the current timestamp is earlier
-                if (
-                    email not in contributors_dict
-                    or timestamp < contributors_dict[email]
-                ):
+                if email not in contributors_dict or timestamp < contributors_dict[email]:
                     contributors_dict[email] = timestamp
             except ValueError:
                 continue  # Skip lines that don't match format
@@ -298,9 +293,7 @@ def new_contributors(
         # and print all of this out
         if new_contributors_list:
             print(f"New contributors since {new_date}:\n")
-            sorted_new_contributors = sorted(
-                new_contributors_list, key=lambda x: (x[0], x[1])
-            )
+            sorted_new_contributors = sorted(new_contributors_list, key=lambda x: (x[0], x[1]))
             for idx, (name, email) in enumerate(sorted_new_contributors, 1):
                 if name:
                     print(f"{name} <{email}>")
@@ -315,7 +308,7 @@ def new_contributors(
 def git_commits_per_author(config: Dict[str, Union[str, int]]) -> None:
     """
     Shows the number of commits per author.
-    
+
     Args:
         config: Dict[str, Union[str, int]]: Config dictionary holding env vars.
 
@@ -443,7 +436,7 @@ def extract_name(author_info: str) -> Optional[str]:
 def git_commits_per_date(config: Dict[str, Union[str, int]]) -> None:
     """
     Displays commits grouped by date.
-    
+
     Args:
         config: Dict[str, Union[str, int]]: Config dictionary holding env vars.
 
@@ -575,9 +568,6 @@ def git_commits_per_month(config: Dict[str, Union[str, int]]) -> None:
             if month in commit_counts:
                 commit_counts[month] += 1
 
-        # Calculate total commits
-        total_commits = sum(commit_counts.values())
-
         # Determine the maximum count to set the scaling factor
         max_count = max(commit_counts.values()) if commit_counts else 0
 
@@ -610,7 +600,7 @@ def git_commits_per_month(config: Dict[str, Union[str, int]]) -> None:
 def git_commits_per_year(config: Dict[str, Union[str, int]]) -> None:
     """
     Displays commits grouped by year.
-    
+
     Args:
         config: Dict[str, Union[str, int]]: Config dictionary holding env vars.
 
@@ -681,10 +671,6 @@ def git_commits_per_year(config: Dict[str, Union[str, int]]) -> None:
         max_count = max(commit_counts.values())
         scaling_factor = (max_bar_length / max_count) if max_count > 0 else 0
 
-        # Determine the width for alignment
-        year_width = len(str(end_year))
-        count_width = len(str(max_count))
-
         # Print the header row
         header_year = "Year"
         header_sum = "Sum"
@@ -706,8 +692,7 @@ def git_commits_per_year(config: Dict[str, Union[str, int]]) -> None:
 
 
 def git_commits_per_weekday(
-    config: Dict[str, Union[str, int]],
-    author: Optional[str] = None
+    config: Dict[str, Union[str, int]], author: Optional[str] = None
 ) -> None:
     """
     Shows commits grouped by weekday. If an author is provided, it shows
@@ -784,9 +769,6 @@ def git_commits_per_weekday(
         max_count = max(commit_counts.values())
         scaling_factor = (max_bar_length / max_count) if max_count > 0 else 0
 
-        # Determine the width for alignment based on max_count
-        count_width = len(str(max_count))
-
         # Print the header row
         header_day = "Day"
         header_sum = "Sum"
@@ -816,10 +798,7 @@ def git_commits_per_weekday(
             print("No commits found.")
 
 
-def git_commits_per_hour(
-    config: Dict[str, Union[str, int]],
-    author: Optional[str] = None
-) -> None:
+def git_commits_per_hour(config: Dict[str, Union[str, int]], author: Optional[str] = None) -> None:
     """
     Shows commits grouped by hour of the day. If an author is provided,
     it shows commits grouped by hour for that specific author.
@@ -896,9 +875,6 @@ def git_commits_per_hour(
         max_count = max(commit_counts.values())
         scaling_factor = (max_bar_length / max_count) if max_count > 0 else 0
 
-        # Determine the width for alignment based on max_count
-        count_width = len(str(max_count))
-
         # Print the header row
         header_hour = "Hour"
         header_sum = "Sum"
@@ -929,8 +905,7 @@ def git_commits_per_hour(
 
 
 def git_commits_per_timezone(
-    config: Dict[str, Union[str, int]],
-    author: Optional[str] = None
+    config: Dict[str, Union[str, int]], author: Optional[str] = None
 ) -> None:
     """
     Displays commits grouped by timezone. If an author is provided, it shows

git_py_stats/menu.py

@@ -65,9 +65,7 @@ def interactive_menu(config: Dict[str, Union[str, int]]) -> str:
     print(f"{NUMS}   21){TEXT} Git commits per timezone by author")
     print(f"\n{TITLES} Suggest:{NORMAL}")
     print(f"{NUMS}   22){TEXT} Code reviewers (based on git history)")
-    print(
-        f"\n{HELP_TXT}Please enter a menu option or {EXIT_TXT}press Enter to exit.{NORMAL}"
-    )
+    print(f"\n{HELP_TXT}Please enter a menu option or {EXIT_TXT}press Enter to exit.{NORMAL}")
 
     choice = input(f"{TEXT}> {NORMAL}")