blackt 2024.0.2

Description:

blackt 2024.0.2

BlackT

Black (https://github.com/psf/black/) but with tabs
Note: you may wish to consider https://github.com/jsh9/cercis
Here are the configuration options to fall back to Blackt's behavior. Put them in
pyproject.toml:
[tool.cercis]
line-length = 88
single-quote = false
use-tabs = true
function-definition-extra-indent = false
other-line-continuation-extra-indent = false
closing-bracket-extra-indent = false
wrap-line-with-long-string = true
collapse-nested-brackets = false
wrap-comments = true
wrap-pragma-comments = true

Here is a more opinionated example
[tool.cercis]
line-length = 120
single-quote = false
use-tabs = true
target-version = ["py38"]


Using (snippet from upstream)

Command line options


Documentation
Install With PIP
Language information

Built for


Install Python on Windows

Chocolatey
Windows - Python.org


Install Python on Linux

Apt
Dnf


Install Python on MacOS

Homebrew
MacOS - Python.org


How to run

Windows
Linux/ MacOS


Download Project

Clone

Using The Command Line
Using GitHub Desktop


Download Zip File


Community Files

Licence
Changelog
Code of Conduct
Contributing
Security
Support
Rationale



Using (snippet from upstream)
To get started right away with sensible defaults:
black {source_file_or_directory}

You can run Black as a package if running it as a script doesn't work:
python -m black {source_file_or_directory}

Command line options
Black doesn't provide many options. You can list them by running black --help:
Usage: black [OPTIONS] SRC ...

The uncompromising code formatter.

Options:
-c, --code TEXT Format the code passed in as a string.
-l, --line-length INTEGER How many characters per line to allow.
[default: 100]
-t, --target-version [py27|py33|py34|py35|py36|py37|py38|py39]
Python versions that should be supported by
Black's output. [default: per-file auto-
detection]
--pyi Format all input files like typing stubs
regardless of file extension (useful when
piping source on standard input).
--ipynb Format all input files like Jupyter
Notebooks regardless of file extension
(useful when piping source on standard
input).
-S, --skip-string-normalization
Don't normalize string quotes or prefixes.
-C, --skip-magic-trailing-comma
Don't use trailing commas as a reason to
split lines.
--check Don't write the files back, just return the
status. Return code 0 means nothing would
change. Return code 1 means some files would
be reformatted. Return code 123 means there
was an internal error.
--diff Don't write the files back, just output a
diff for each file on stdout.
--color / --no-color Show colored diff. Only applies when
`--diff` is given.
--fast / --safe If --fast given, skip temporary sanity
checks. [default: --safe]
--required-version TEXT Require a specific version of Black to be
running (useful for unifying results across
many environments e.g. with a pyproject.toml
file).
--include TEXT A regular expression that matches files and
directories that should be included on
recursive searches. An empty value means all
files are included regardless of the name.
Use forward slashes for directories on all
platforms (Windows, too). Exclusions are
calculated first, inclusions later.
[default: (\.pyi?|\.ipynb)$]
--exclude TEXT A regular expression that matches files and
directories that should be excluded on
recursive searches. An empty value means no
paths are excluded. Use forward slashes for
directories on all platforms (Windows, too).
Exclusions are calculated first, inclusions
later. [default: /(\.direnv|\.eggs|\.git|\.h
g|\.mypy_cache|\.nox|\.tox|\.venv|venv|\.svn
|_build|buck-out|build|dist)/]
--extend-exclude TEXT Like --exclude, but adds additional files
and directories on top of the excluded ones.
(Useful if you simply want to add to the
default)
--force-exclude TEXT Like --exclude, but files and directories
matching this regex will be excluded even
when they are passed explicitly as
arguments.
--stdin-filename TEXT The name of the file when passing it through
stdin. Useful to make sure Black will
respect --force-exclude option on some
editors that rely on using stdin.
-q, --quiet Don't emit non-error messages to stderr.
Errors are still emitted; silence those with
2>/dev/null.
-v, --verbose Also emit messages to stderr about files
that were not changed or were ignored due to
exclusion patterns.
--version Show the version and exit.
--config FILE Read configuration from FILE path.
-h, --help Show this message and exit.

Black is a well-behaved Unix-style command-line tool:

it does nothing if no sources are passed to it;
it will read from standard input and write to standard output if - is used as the
filename;
it only outputs messages to users on standard error;
exits with code 0 unless an internal error occurred (or --check was used).

For more info see https://github.com/psf/black/blob/master/README.md
Documentation
A high-level overview of how the documentation is organized organized will help you know
where to look for certain things:


The Technical Reference documents APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.


Install With PIP
pip install blackt

Head to https://pypi.org/project/blackt/ for more info
Language information
Built for
This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11
Install Python on Windows
Chocolatey
choco install python

Windows - Python.org
To install Python, go to https://www.python.org/downloads/windows/ and download the latest
version.
Install Python on Linux
Apt
sudo apt install python3.x

Dnf
sudo dnf install python3.x

Install Python on MacOS
Homebrew
brew install [email protected]

MacOS - Python.org
To install Python, go to https://www.python.org/downloads/macos/ and download the latest
version.
How to run
Windows


Module
py -3.x -m [module] or [module] (if module installs a script)


File
py -3.x [file] or ./[file]


Linux/ MacOS


Module
python3.x -m [module] or [module] (if module installs a script)


File
python3.x [file] or ./[file]


Building
This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This
command generates the documentation, updates the requirements.txt and builds the library artefacts
Note the functionality provided by fhmake can be approximated by the following
handsdown --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build

fhmake audit can be run to perform additional checks
Testing
For testing with the version of python used by poetry use
poetry run pytest

Alternatively use tox to run tests over python 3.8 - 3.11
tox

Download Project
Clone
Using The Command Line


Press the Clone or download button in the top right


Copy the URL (link)


Open the command line and change directory to where you wish to
clone to


Type 'git clone' followed by URL in step 2
git clone https://github.com/FHPythonUtils/blackt



More information can be found at
https://help.github.com/en/articles/cloning-a-repository
Using GitHub Desktop

Press the Clone or download button in the top right
Click open in desktop
Choose the path for where you want and click Clone

More information can be found at
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
Download Zip File

Download this GitHub repository
Extract the zip archive
Copy/ move to the desired location

Community Files
Licence
MIT License
Copyright (c) FredHappyface
(See the LICENSE for more information.)
Changelog
See the Changelog for more information.
Code of Conduct
Online communities include people from many backgrounds. The Project
contributors are committed to providing a friendly, safe and welcoming
environment for all. Please see the
Code of Conduct
for more information.
Contributing
Contributions are welcome, please see the
Contributing Guidelines
for more information.
Security
Thank you for improving the security of the project, please see the
Security Policy
for more information.
Support
Thank you for using this project, I hope it is of use to you. Please be aware that
those involved with the project often do so for fun along with other commitments
(such as work, family, etc). Please see the
Support Policy
for more information.
Rationale
The rationale acts as a guide to various processes regarding projects such as
the versioning scheme and the programming styles used. Please see the
Rationale
for more information.