IndentTrimmer

Utility for removing indentation for sections and lines.

Handsdown API Index / Handsdown / Utils / IndentTrimmer

Auto-generated documentation for handsdown.utils.indent_trimmer module.

IndentTrimmer

Utility for removing indentation for sections and lines.

Signature

class IndentTrimmer:
    ...

IndentTrimmer.get_line_indent

Show source in indent_trimmer.py:119

Get indent length of the line.

Examples

IndentTrimmer.get_line_indent('   test')
3

IndentTrimmer.get_line_indent('test')
0

Arguments

line - Line of text.

Returns

A number of indentation characters in a beginning of the line.

Signature

@staticmethod
def get_line_indent(line: str) -> int:
    ...

IndentTrimmer.indent_line

Show source in indent_trimmer.py:140

Indent line with givent length indent.

Examples

IndentTrimmer.indent_line('test', 2)
'  test'

Arguments

line - Line to indent.
indent - Length of indent in spaces.

Returns

An indented line.

Signature

@staticmethod
def indent_line(line: str, indent: int) -> str:
    ...

IndentTrimmer.trim_empty_lines

Show source in indent_trimmer.py:15

Trim empty lines in the begging and the end of the text.

Examples

text = '\n  \n test\ntest2\n \n '
IndentTrimmer.trim_empty_lines(text)
' test\ntest2'

Returns

A stripped string.

Signature

@staticmethod
def trim_empty_lines(text: str) -> str:
    ...

IndentTrimmer.trim_line

Show source in indent_trimmer.py:92

Trim indent from line if it is empty.

Examples

IndentTrimmer.trim_line('     test', 2)
'   test'

IndentTrimmer.trim_line('     test', 6)
'test'

IndentTrimmer.trim_line('     test', 1)
'    test'

Arguments

line - A line of text.

Returns

A line with removed indent.

Signature

@staticmethod
def trim_line(line: str, indent: int) -> str:
    ...

IndentTrimmer.trim_lines

Show source in indent_trimmer.py:57

Trim minimum indent from each line of text.

Examples

IndentTrimmer.trim_lines([
    '  asd',
    ' asd',
    '   asd',
])
[
    ' asd',
    'asd',
    '  asd',
]

Arguments

lines - List of lines.

Returns

A list of lines with trimmed indent.

Signature

@classmethod
def trim_lines(cls, lines: Iterable[str]) -> List[str]:
    ...

IndentTrimmer.trim_text

Show source in indent_trimmer.py:37

Trim minimum indent from each line of text.

Examples

IndentTrimmer.trim_text('  asd\n asd\n   asd\n')
' asd\nasd\n  asd\n'

Arguments

text - Multiline text.

Returns

A text with trimmed indent.

Signature

@classmethod
def trim_text(cls, text: str) -> str:
    ...