A tool for indentation in text files
Project description
Canonicalise the leading indentation of blank lines in text files.
Synopsis
For the purposes of this tool, a “blank line” is a line containing only whitespace characters.
Intentionally Blank can apply one or more formatters to a text file for the purposes of modifying the arrangement or representation of whitespace.
To get command-line help, use the --help option:
$ intentionally-blank --help Usage: intentionally-blank [OPTIONS] COMMAND [ARGS]... Options: --verbosity [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] The logging level to use. --version Show the version and exit. --help Show this message and exit. Commands: describe-format format list-formats
To list the available formatters, used the list-formats command:
$ intentionally-blank list-formats empty identity leading visible
To describe the action of particular formatter, use the describe-format command:
$ intentionally-blank describe-format --format=leading Blank lines have leading whitespace equal to that on the previous non-blank line.
To actually reformat a text file, we can use the format command. To get help on a particular command, like format, use the command and the --help option:
$ intentionally-blank format --help Usage: intentionally-blank format [OPTIONS] INPUT OUTPUT Options: --format [empty|identity|leading|visible] --help Show this message and exit.
Now, use the format command to adjust whitespace:
$ intentionally-blank format --format=leading infile.txt outfile.txt
To have blank lines be completely empty save for the terminating newline sequence, use --format=empty:
$ intentionally-blank format --format=empty infile.txt outfile.txt
Multiple --format options can be provided, and they will be applied in the order given. Here we apply the “leading” format, and then the “visible” format which makes whitespace characters visible:
$ intentionally-blank format --format=leading --format=visible infile.txt outfile.txt
Either the INPUT or OUTPUT positional arguments can be replaced with a hyphen - to cause input to be read from stdin or output to be written to stdout:
$ intentionally-blank format --format=leading --format=visible infile.txt - """Model␣for␣aircraft␣flights."""↵ ↵ ↵ class␣Flight:↵ ␣␣␣␣"""A␣flight␣with␣a␣particular␣passenger␣aircraft."""↵ ␣␣␣␣↵ ␣␣␣␣def␣__init__(self,␣number,␣aircraft):↵ ␣␣␣␣␣␣␣␣if␣not␣number[:2].isalpha():↵ ␣␣␣␣␣␣␣␣␣␣␣␣raise␣ValueError(f"No␣airline␣code␣in␣'{number}'")↵ ␣␣␣␣␣␣␣␣␣␣␣␣↵
## CI/CD
LOL.
To release, there is a short manual process:
$ bumpversion patch $ python setup.py sdist bdist_wheel $ twine upload dist/* –config-file=path/to/sixty-north.pypirc
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for intentionally-blank-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5549325de5e057e7a25e7907abe5d2e3ba29102db6e111f4a14b4996b30646c |
|
MD5 | 4b7c1e64b9581f720962156490afa23f |
|
BLAKE2b-256 | 305ccba11ea4054746686bd5fc9c2886a9ad5c9e33e2f0a470c2b68abb1f2b00 |
Hashes for intentionally_blank-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e41f014855f10e0f52ed14f246b9f761c63d2bfda1ce4dfc6b3bc88ece932f61 |
|
MD5 | 25bde0f8f4fddf9c713f89b3741f7501 |
|
BLAKE2b-256 | 35ccf99bc0ed956ca48f7e42c1f21c941caa378646b1752cc21d654ac4dd3c3d |