Function tally_codebase_key_files

src/summarycode/tallies.py:321–362

Summarize codebase key files.

(codebase, field='tallies', **kwargs)

def tally_codebase_key_files(codebase, field='tallies', **kwargs):
    """
    Summarize codebase key files.
    """
    talliables = codebase.attributes.tallies.keys()
    if TRACE: logger_debug('tallieables:', talliables)

    # TODO: we cannot summarize packages with "key files" for now
    talliables = [k for k in talliables if k in TALLYABLE_ATTRS]

    # create one counter for each summarized attribute
    talliable_values_by_key = dict([(key, []) for key in talliables])

    # filter to get only key files
    key_files = (res for res in codebase.walk(topdown=True)
                 if (res.is_file and res.is_top_level
                     and (res.is_readme or res.is_legal or res.is_manifest)))

    for resource in key_files:
        for key, values in talliable_values_by_key.items():
            # note we assume things are stored as extra-data, not as direct
            # Resource attributes
            res_tallies = get_resource_tallies(resource, key=key, as_attribute=False) or []
            for tally in res_tallies:
                # each tally is a mapping with value/count: we transform back to values
                tally_value = tally.get('value')
                if tally_value:
                    values.extend([tally_value] * tally['count'])

    tally_counters = []
    for key, values in talliable_values_by_key.items():
        if key not in TALLYABLE_ATTRS:
            continue
        tallied = tally_values(values, key)
        tally_counters.append((key, tallied))

    sorted_tallies = dict(
        [(key, sorted_counter(counter)) for key, counter in tally_counters])

    codebase.attributes.tallies_of_key_files = sorted_tallies

    if TRACE: logger_debug('codebase tallies_of_key_files:', sorted_tallies)


@post_scan_impl