osci/transformers/licenses.py

"""Copyright since 2020, EPAM Systems

   This file is part of OSCI.

   OSCI is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   OSCI is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with OSCI.  If not, see <http://www.gnu.org/licenses/>."""
from pyspark.sql import DataFrame, functions as f
from pyspark.sql import functions as f


def get_licenses_commits(df: DataFrame, company: str, license: str, commits_id_field: str,
                         result_field: str = 'Commits') -> DataFrame:
    """Get licenses commits

    :param df: PushEventsCommits
    :param company: company name field
    :param license: license in commits
    :param commits_id_field: Commit identifier (such as SHA)
    :param result_field: Field in output df which must contains amount of commits
    :return:
    """
    return df.select(f.col(company), f.col(license), f.col(commits_id_field)) \
        .groupby(company, license) \
        .agg(f.count(commits_id_field).alias(result_field)) \
        .sort(result_field, ascending=False)