Skip to main content

like dedent but more flexible

Project description

Tedent

Keep your multi-line templated strings lookin' good :sunglasses:

This is a python version of tedent


Table of Contents


What is it?

  • A function similar to dedent just with different semantics

What does the name stand for?

  • Template string
  • indentation

names are hard


Why create it?

  • 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',
# ]
#

Simple Usage

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

Questions about how the indentation works?

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.


Important Usage Notes

  • First of all, this library doesn't handle tabs. I will accept a PR with support

  • Secondly, if you always use tedent like the following

    tedent(
        """
        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.

input requirements

  • 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.


Test

#
# you must have poetry installed
#
$ poetry shell
$ poetry install
$ python runTests.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tedent, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size tedent-0.1.0-py3-none-any.whl (31.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size tedent-0.1.0.tar.gz (11.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page