mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-11-26 23:00:36 +00:00
100 lines
3.1 KiB
Plaintext
100 lines
3.1 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: flake8-quotes
|
||
|
|
Version: 1.0.0
|
||
|
|
Summary: Flake8 lint for quotes.
|
||
|
|
Home-page: http://github.com/zheller/flake8-quotes/
|
||
|
|
Author: Zachary Wright Heller
|
||
|
|
Author-email: zheller@gmail.com
|
||
|
|
License: MIT
|
||
|
|
Keywords: flake8 lint quotes
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Development Status :: 3 - Alpha
|
||
|
|
Classifier: Environment :: Console
|
||
|
|
Classifier: Framework :: Flake8
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: Operating System :: OS Independent
|
||
|
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 2
|
||
|
|
Classifier: Programming Language :: Python :: 2.7
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.4
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||
|
|
Classifier: Topic :: Software Development :: Quality Assurance
|
||
|
|
Requires-Dist: flake8
|
||
|
|
|
||
|
|
Flake8 Extension to lint for quotes.
|
||
|
|
===========================================
|
||
|
|
|
||
|
|
.. image:: https://travis-ci.org/zheller/flake8-quotes.svg?branch=master
|
||
|
|
:target: https://travis-ci.org/zheller/flake8-quotes
|
||
|
|
:alt: Build Status
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
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 "'''"
|
||
|
|
|
||
|
|
|
||
|
|
or configuration option in `tox.ini`/`setup.cfg`.
|
||
|
|
|
||
|
|
.. code:: ini
|
||
|
|
|
||
|
|
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 = '''
|
||
|
|
|
||
|
|
Caveats
|
||
|
|
-------
|
||
|
|
|
||
|
|
We follow the `PEP8 conventions <https://www.python.org/dev/peps/pep-0008/#string-quotes>`_ to avoid backslashes in the string. So, no matter what configuration you are using (single or double quotes) these are always valid strings
|
||
|
|
|
||
|
|
.. code:: python
|
||
|
|
|
||
|
|
s = 'double "quotes" wrapped in singles are ignored'
|
||
|
|
s = "single 'quotes' wrapped in doubles are ignored"
|
||
|
|
|
||
|
|
|