Class KeyFilesTallies

src/summarycode/tallies.py:291–318

Compute tallies of a scan at the codebase level for only key files.

@post_scan_impl
class KeyFilesTallies(PostScanPlugin):
    """
    Compute tallies of a scan at the codebase level for only key files.
    """
    run_order = 150
    sort_order = 150

    # mapping of tally data at the codebase level for key files
    codebase_attributes = dict(tallies_of_key_files=attr.ib(default=attr.Factory(dict)))

    options = [
        PluggableCommandLineOption(('--tallies-key-files',),
            is_flag=True, default=False,
            help='Compute tallies for license, copyright and other scans for key, '
                 'top-level files. Key files are top-level codebase files such '
                 'as COPYING, README and package manifests as reported by the '
                 '--classify option "is_legal", "is_readme", "is_manifest" '
                 'and "is_top_level" flags.',
            help_group=POST_SCAN_GROUP,
            required_options=['classify', 'tallies']
        )
    ]

    def is_enabled(self, tallies_key_files, **kwargs):
        return tallies_key_files

    def process_codebase(self, codebase, tallies_key_files, **kwargs):
        tally_codebase_key_files(codebase, **kwargs)


def tally_codebase_key_files(codebase, field='tallies', **kwargs):