python-flake8-quotes
Subpackage Descriptions
single |
Flake8 Extension to lint for quotes.
===========================================
:alt: Build Status
Major update in 2.0.0
---------------------
We automatically encourage avoiding escaping quotes as per [PEP 8]. To
disable this, use ``--no-avoid-escape`` (can be used in configuration file
via ``avoid-escape``).
Deprecation notice in 0.3.0
---------------------------
To anticipate multiline support, we are renaming ``--quotes to
--inline-quotes``. Please adjust your configurations appropriately.
Usage
-----
If you are using flake8 it's as easy as:
.. code:: shell
pip install flake8-quotes
Now you don't need to worry about people like @sectioneight constantly
complaining that you are using double-quotes and not single-quotes.
Warnings
--------
This package adds flake8 warnings with the prefix Q0. You might want to
enable this warning inside your flake8 configuration file. Typically that
will be ``.flake8`` inside the root folder of your project.
.. code:: ini
select = Q0
The current set of warnings is:
====
=========================================================================
Code Description
----
-------------------------------------------------------------------------
Q000 Remove bad quotes
Q001 Remove bad quotes from multiline string
Q002 Remove bad quotes from docstring
Q003 Change outer quotes to avoid escaping inner quotes
====
=========================================================================
Configuration
-------------
By default, we expect single quotes (') and look for unwanted double quotes
("). To expect double quotes (") and find unwanted single quotes ('), use
the CLI option:
.. code:: shell
flake8 --inline-quotes '"'
# We also support "double" and "single"
# flake8 --inline-quotes 'double'
#
# We also support configuration for multiline quotes
# flake8 --inline-quotes '"' --multiline-quotes "'"
# We also support "'''"
# flake8 --inline-quotes '"' --multiline-quotes "'''"
#
# We also support docstring quotes similarly
# flake8 --inline-quotes '"' --docstring-quotes "'"
# flake8 --inline-quotes '"' --docstring-quotes "'''"
# We also support disabling escaping quotes
# flake8 --no-avoid-escape
or configuration option in `tox.ini`/`setup.cfg`.
.. code:: ini
[flake8]
inline-quotes = "
# We also support "double" and "single"
# inline-quotes = double
#
# We also support configuration for multiline quotes
# multiline-quotes = '
# We also support "'''"
# multiline-quotes = '''
#
# We also support docstring quotes similarly
# docstring-quotes = '
# docstring-quotes = '''
#
# We also support disabling escaping quotes
# avoid-escape = False
Caveats
|
Configuration Switches (platform-specific settings discarded)
PY312 OFF Build using Python 3.12
PY313 ON Build using Python 3.13
Package Dependencies by Type
Download groups
main |
mirror://PYPI/f/flake8-quotes |
Distribution File Information
aad8492fb710a2d3eabe68c5f86a1428de650c8484127e14c43d0504ba30276c 14107 python-src/flake8-quotes-3.4.0.tar.gz
Ports that require python-flake8-quotes:v13
No other ports depend on this one. |