:py:mod:`kwcoco.util.util_truncate`
===================================

.. py:module:: kwcoco.util.util_truncate

.. autoapi-nested-parse::

   Truncate utility based on python-slugify.

   https://pypi.org/project/python-slugify/1.2.2/



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   kwcoco.util.util_truncate._trunc_op
   kwcoco.util.util_truncate.smart_truncate



.. py:function:: _trunc_op(string, max_length, trunc_loc)

   .. rubric:: Example

   >>> from kwcoco.util.util_truncate import _trunc_op
   >>> string = 'DarnOvercastSculptureTipperBlazerConcaveUnsuitedDerangedHexagonRockband'
   >>> max_length = 16
   >>> trunc_loc = 0.5
   >>> _trunc_op(string, max_length, trunc_loc)

   >>> from kwcoco.util.util_truncate import _trunc_op
   >>> max_length = 16
   >>> string = 'a' * 16
   >>> _trunc_op(string, max_length, trunc_loc)

   >>> string = 'a' * 17
   >>> _trunc_op(string, max_length, trunc_loc)


.. py:function:: smart_truncate(string, max_length=0, separator=' ', trunc_loc=0.5)

   Truncate a string.
   :param string (str): string for modification
   :param max_length (int): output string length
   :param word_boundary (bool):
   :param save_order (bool): if True then word order of output string is like input string
   :param separator (str): separator between words
   :param trunc_loc (float): fraction of location where to remove the text
   :return: