• Search by Module
• Search by Words
• Search Projects

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• clikit-master
  • .github
    • workflows
      • push.yml
  • src
    • clikit
      • resolver
        • default_resolver.py
        • resolve_result.py
        • help_resolver.py
        • __init__.py
      • utils
        • terminal.py
        • string.py
        • _compat.py
        • __init__.py
        • command.py
        • time.py
      • console_application.py
      • formatter
        • null_formatter.py
        • ansi_formatter.py
        • plain_formatter.py
        • __init__.py
        • default_style_set.py
      • args
        • argv_args.py
        • token_parser.py
        • inputs
          • __init__.py
        • default_args_parser.py
        • __init__.py
        • string_args.py
      • ui
        • help
          • abstract_help.py
          • command_help.py
          • __init__.py
          • application_help.py
        • style
          • alignment.py
          • __init__.py
          • table_style.py
          • border_style.py
        • layout
          • __init__.py
          • block_layout.py
        • components
          • empty_line.py
          • paragraph.py
          • question.py
          • progress_indicator.py
          • table.py
          • exception_trace.py
          • name_version.py
          • progress_bar.py
          • confirmation_question.py
          • border_util.py
          • __init__.py
          • cell_wrapper.py
          • choice_question.py
          • labeled_paragraph.py
        • alignment
          • __init__.py
          • label_alignment.py
        • rectangle.py
        • component.py
        • __init__.py
      • api
        • resolver
          • command_resolver.py
          • exceptions.py
          • __init__.py
          • resolved_command.py
        • exceptions.py
        • formatter
          • formatter.py
          • style_set.py
          • __init__.py
          • style.py
        • args
          • raw_args.py
          • exceptions.py
          • format
            • args_format_builder.py
            • command_option.py
            • option.py
            • argument.py
            • abstract_option.py
            • args_format.py
            • __init__.py
            • command_name.py
          • args_parser.py
          • __init__.py
          • args.py
        • application
          • application.py
          • __init__.py
        • config
          • application_config.py
          • config.py
          • command_config.py
          • __init__.py
        • event
          • pre_handle_event.py
          • config_event.py
          • pre_resolve_event.py
          • console_events.py
          • event_dispatcher.py
          • event.py
          • __init__.py
        • io
          • output.py
          • flags.py
          • input_stream.py
          • input.py
          • io.py
          • __init__.py
          • output_stream.py
          • section_output.py
          • io_exception.py
        • __init__.py
        • command
          • exceptions.py
          • __init__.py
          • command.py
          • command_collection.py
      • config
        • default_application_config.py
        • __init__.py
      • adapter
        • __init__.py
        • style_converter.py
      • io
        • null_io.py
        • output_stream
          • error_output_stream.py
          • standard_output_stream.py
          • null_output_stream.py
          • buffered_output_stream.py
          • __init__.py
          • stream_output_stream.py
        • console_io.py
        • __init__.py
        • buffered_io.py
        • input_stream
          • stream_input_stream.py
          • standard_input_stream.py
          • string_input_stream.py
          • null_input_stream.py
          • __init__.py
      • __init__.py
      • handler
        • help
          • __init__.py
          • help_text_handler.py
          • help_handler.py
        • callback_handler.py
        • __init__.py
  • .pre-commit-config.yaml
  • LICENSE
  • CHANGELOG.md
  • README.md
  • tests
    • utils
      • __init__.py
      • test_command.py
      • test_terminal.py
    • args
      • test_argv_args.py
      • test_string_args.py
      • __init__.py
      • test_default_args_parser.py
    • ui
      • help
        • test_application_help.py
        • test_command_help.py
        • __init__.py
      • components
        • test_exception_trace.py
        • test_question.py
        • test_confirmation_question.py
        • test_progress_indicator.py
        • test_choice_question.py
        • test_progress_bar.py
        • test_table.py
        • __init__.py
        • helpers.py
      • __init__.py
    • test_console_aplication.py
    • api
      • args
        • format
          • test_args_format_builder.py
          • test_option.py
          • __init__.py
          • test_argument.py
        • __init__.py
      • event
        • test_event_dispatcher.py
        • __init__.py
        • test_event.py
      • io
        • test_section_output.py
        • test_input.py
        • __init__.py
      • __init__.py
    • __init__.py
    • handler
      • help
        • test_help_option.py
        • __init__.py
        • test_help_text_handler.py
      • __init__.py
    • conftest.py
  • pyproject.toml
  • .gitignore
  • tox.ini

from __future__ import unicode_literals

import re
import textwrap

from clikit.api.io import IO
from clikit.ui import Component


class LabeledParagraph(Component):
    """
    A paragraph with a label on its left.
    """

    def __init__(
        self, label, text, padding=2, aligned=True
    ):  # type: (str, str, int, bool) -> None
        self._label = label
        self._text = text
        self._padding = padding
        self._aligned = aligned
        self._alignment = None

    @property
    def label(self):  # type: () -> str
        return self._label

    @property
    def text(self):  # type: () -> str
        return self._text

    @property
    def padding(self):  # type: () -> int
        return self._padding

    def is_aligned(self):  # type: () -> bool
        return self._aligned

    def set_alignment(self, alignment):  # type: (LabelAlignment) -> None
        self._alignment = alignment

    def render(self, io, indentation=0):  # type: (IO, int) -> None
        line_prefix = " " * indentation
        visible_label = io.remove_format(self._label)
        style_tag_length = len(self._label) - len(visible_label)

        if self._aligned and self._alignment:
            text_offset = self._alignment.text_offset - indentation
        else:
            text_offset = 0

        text_offset = max(text_offset, len(visible_label) + self._padding)
        text_prefix = " " * text_offset

        # 1 trailing space
        text_width = io.terminal_dimensions.width - 1 - text_offset - indentation
        text = re.sub(
            r"\n(?!\n)",
            "\n" + line_prefix + text_prefix,
            "\n".join(textwrap.wrap(self._text, text_width)),
        )

        # Add the total length of the style tags ("<b>", ...)
        label_width = text_offset + style_tag_length

        io.write(
            "{}{:<{}}{}".format(
                line_prefix, self._label, label_width, text.rstrip()
            ).rstrip()
            + "\n"
        )