get_freq_modified_fns.py

from pydriller import Repository
from argparse import ArgumentParser
from dataclasses import dataclass
from datetime import datetime
from dateutil.relativedelta import relativedelta

@dataclass
class ModifiedFunction:
    name: str
    first_commit_date: datetime
    last_commit_date: datetime
    num_commits: int

def main():
    parser = ArgumentParser()
    parser.add_argument('--path', help='path to the repository', type=str, required=True)
    parser.add_argument('--topn', help='number of top modified functions to show', type=int, default=10)
    parser.add_argument('--mainbranch', help='name of main branch that will be analyzed', type=str, default="main")
    parser.add_argument('--lastyearonly', help='only analyze commits from the last year', default=False, action='store_true')
    args = parser.parse_args()

    modified_functions = {}

    if args.lastyearonly:
        date_limit = datetime.now() - relativedelta(years=1)
    else:
        date_limit = None

    commits = Repository(args.path, since=date_limit, only_in_branch=args.mainbranch,only_modifications_with_file_types=['.py','.js','.java','.ts']).traverse_commits()
    commits = list(commits)

    for commit in commits:
        for modified_file in commit.modified_files:
            changed_methods = modified_file.changed_methods
            for changed_method in changed_methods:
                method_path = f"{modified_file.new_path}#{changed_method.name}"

                if method_path not in modified_functions.keys():
                    modified_functions[method_path] = ModifiedFunction(name=changed_method.name, first_commit_date=commit.committer_date, last_commit_date=commit.committer_date, num_commits=1)
                else:
                    modified_functions[method_path].num_commits += 1

                    if commit.committer_date < modified_functions[method_path].first_commit_date:
                        modified_functions[method_path].first_commit_date = commit.committer_date

                    if commit.committer_date > modified_functions[method_path].last_commit_date:
                        modified_functions[method_path].last_commit_date = commit.committer_date

    sorted_modified_functions = sorted(modified_functions.items(), key=lambda x: x[1].num_commits, reverse=True)

    print("## Top modified functions in this repo")


    print(f"The repo has {len(commits)} commits that modified source code files.")
    print(f"These commits have a total of {len(modified_functions)} unique modified functions\n")
   
    print(f"Top {args.topn} modified functions:\n")

    print(f"| Function | # commits | Date Range |") 
    print(f"| --- | --: | --: |")
    for function in sorted_modified_functions[:args.topn]:
        # show date as Oct 12 2021 - Oct 13 2021
        print(f"| `{function[0]}` | {function[1].num_commits} | {function[1].first_commit_date.strftime('%B %d, %Y')} - {function[1].last_commit_date.strftime('%B %d, %Y')} |")

if __name__ == "__main__":
    main()