Keep your multi-line templated strings lookin' good 😎
This is a python version of tedent
Table of Contents
- What is it?
- What does the name stand for?
- Why create it?
- Simple Usage
- Questions about how the indentation works?
- Important Usage Notes
- Test
- A function similar to dedent just with different semantics
Te
mplate string- in
dent
ation
names are hard
- dedent didn't handle the following case like I wanted
formattedBoroughs = f"""\
[
'Brooklyn',
'Manhattan',
]
"""
print(
dedent(
f"""\
New York boroughs
${formattedBoroughs}
"""
)
)
#
# expected:
# New York boroughs
# [
# 'Brooklyn',
# 'Manhattan',
# ]
#
# actual:
# New York boroughs
# [
# 'Brooklyn',
# 'Manhattan',
# ]
#
import tedent from 'tedent'
#
# *note the lack of the backslash
#
print(
tedent(
"""
This will be indented
as you expect
"""
)
)
# writes:
# This will be indented
# as you expect
Because the indentation logic is both young and convoluted, please refer to the code and tests for details. The library is not that big and if you have any questions please create a github issue.
-
First of all, this library doesn't handle tabs. I will accept a PR with support
-
Secondly, if you always use
tedent
like the followingtedent( """ some text """ )
then you shouldn't run into any issues. However we all know input can be tricky so
tedent
has a few input requirements in order to format your string properly.
- if the argument isn't a string then an error will be thrown
- if you pass a string with three or more newlines, then
- the first and last lines must contain only whitespace
- the second line must contain a non-whitespace character
- an error will be thrown if the above two conditions are not met
- if you pass a string with fewer than 3 newlines
- if they only contain whitespace then an empty string is returned
- otherwise an error is thrown
- finally, all trailing whitespace from the result is stripped
If you have questions please raise a github issue.
#
# you must have poetry installed
#
$ poetry shell
$ poetry install
$ python runTests.py