# This file exists within 'dob':
#
# https://github.com/hotoffthehamster/dob
#
# Copyright © 2018-2020 Landon Bouma, 2015-2016 Eric Goller. All rights reserved.
#
# 'dob' 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.
#
# 'dob' 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 can find the GNU General Public License reprinted in the file titled 'LICENSE',
# or visit <http://www.gnu.org/licenses/>.
from gettext import gettext as _
from ..clickux.query_assist import error_exit_no_results
from . import generate_usage_table
__all__ = ('usage_categories', )
[docs]def usage_categories(
controller,
show_usage=False,
show_duration=False,
output_format='table',
table_type='texttable',
max_width=-1,
output_path=None,
**kwargs
):
"""
List all categories' usage counts, with filtering and sorting options.
Returns:
None: If success.
"""
def _usage_categories():
err_context = _('categories')
results = controller.categories.get_all_by_usage(**kwargs)
results or error_exit_no_results(err_context)
generate_usage_table(
controller,
results,
name_header=_("Category Name"),
show_usage=show_usage,
show_duration=show_duration,
output_format=output_format,
table_type=table_type,
max_width=max_width,
output_path=output_path,
)
# ***
_usage_categories()