###########
flake2lint
###########
.. start short_desc
**Tool and pre-commit hook to augment Flake8 noqa comments with PyLint comments.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/flake2lint/latest?logo=read-the-docs
:target: https://flake2lint.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/flake2lint/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/flake2lint/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/flake2lint/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/flake2lint/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/flake2lint/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/flake2lint/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/flake2lint/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/flake2lint/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/flake2lint/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/flake2lint?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/flake2lint?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/flake2lint
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/flake2lint
:target: https://pypi.org/project/flake2lint/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/flake2lint?logo=python&logoColor=white
:target: https://pypi.org/project/flake2lint/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/flake2lint
:target: https://pypi.org/project/flake2lint/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/flake2lint
:target: https://pypi.org/project/flake2lint/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/domdfcoding/flake2lint
:target: https://github.com/domdfcoding/flake2lint/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/flake2lint
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/flake2lint/v0.4.3
:target: https://github.com/domdfcoding/flake2lint/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/flake2lint
:target: https://github.com/domdfcoding/flake2lint/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/flake2lint
:target: https://pypi.org/project/flake2lint/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``flake2lint`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install flake2lint
.. end installation
Usage
--------
.. code-block:: bash
flake2lint [-v] [-r] [FILENAMES]
``-v / --verbose``
^^^^^^^^^^^^^^^^^^
Show verbose output.
``-r / --recursive``
^^^^^^^^^^^^^^^^^^^^^
Permits the use of the pattern ``**`` to match any files, directories and subdirectories.
See `the documentation <https://flake2lint.readthedocs.io/en/latest/usage.html>`_ for more details.
Supported Flake8 Codes
------------------------
``flake2lint`` currently augments the following flake8 codes:
* ``A001`` ➞ ``redefined-builtin``
* ``A002`` ➞ ``redefined-builtin``
* ``A003`` ➞ ``redefined-builtin``
Contributions to add support for more codes are more than welcome. The relevant code is `here <https://github.com/domdfcoding/flake2lint/blob/98da9322512d28921bd9cbabb66d6f476066f1f8/flake2lint/__init__.py#L53-L56>`_.
Example
-----------
Before:
.. code-block:: python
class FancyDialog(wx.Dialog):
def __init__(
self,
parent,
id=wx.ID_ANY, # noqa: A002
title="My Fancy Dialog",
pos=wx.DefaultPosition,
size=wx.DefaultSize,
style=wx.DEFAULT_DIALOG_STYLE,
name=wx.DialogNameStr,
data=None
): ...
After:
.. code-block:: python
class FancyDialog(wx.Dialog):
def __init__(
self,
parent,
id=wx.ID_ANY, # noqa: A002 # pylint: disable=redefined-builtin
title="My Fancy Dialog",
pos=wx.DefaultPosition,
size=wx.DefaultSize,
style=wx.DEFAULT_DIALOG_STYLE,
name=wx.DialogNameStr,
data=None
): ...
Raw data
{
"_id": null,
"home_page": "https://github.com/domdfcoding/flake2lint",
"name": "flake2lint",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "flake8,pre-commit,pylint",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/16/06/5f62d3e0b13c42ea51eee1ccb3508182fc812d95085bb68cf48bb807859a/flake2lint-0.4.3.tar.gz",
"platform": "Windows",
"description": "\n###########\nflake2lint\n###########\n\n.. start short_desc\n\n**Tool and pre-commit hook to augment Flake8 noqa comments with PyLint comments.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/flake2lint/latest?logo=read-the-docs\n\t:target: https://flake2lint.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/flake2lint/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/flake2lint/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/flake2lint/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/flake2lint/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/flake2lint/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/flake2lint/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/flake2lint/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/flake2lint/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/flake2lint/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/flake2lint/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/flake2lint?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/flake2lint?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/flake2lint\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/flake2lint\n\t:target: https://pypi.org/project/flake2lint/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/flake2lint?logo=python&logoColor=white\n\t:target: https://pypi.org/project/flake2lint/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/flake2lint\n\t:target: https://pypi.org/project/flake2lint/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/flake2lint\n\t:target: https://pypi.org/project/flake2lint/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/flake2lint\n\t:target: https://github.com/domdfcoding/flake2lint/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/flake2lint\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/flake2lint/v0.4.3\n\t:target: https://github.com/domdfcoding/flake2lint/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/flake2lint\n\t:target: https://github.com/domdfcoding/flake2lint/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/flake2lint\n\t:target: https://pypi.org/project/flake2lint/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``flake2lint`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install flake2lint\n\n.. end installation\n\n\nUsage\n--------\n\n.. code-block:: bash\n\n\tflake2lint [-v] [-r] [FILENAMES]\n\n``-v / --verbose``\n^^^^^^^^^^^^^^^^^^\n\nShow verbose output.\n\n``-r / --recursive``\n^^^^^^^^^^^^^^^^^^^^^\n\nPermits the use of the pattern ``**`` to match any files, directories and subdirectories.\n\n\nSee `the documentation <https://flake2lint.readthedocs.io/en/latest/usage.html>`_ for more details.\n\nSupported Flake8 Codes\n------------------------\n\n``flake2lint`` currently augments the following flake8 codes:\n\n* ``A001`` \u279e ``redefined-builtin``\n* ``A002`` \u279e ``redefined-builtin``\n* ``A003`` \u279e ``redefined-builtin``\n\nContributions to add support for more codes are more than welcome. The relevant code is `here <https://github.com/domdfcoding/flake2lint/blob/98da9322512d28921bd9cbabb66d6f476066f1f8/flake2lint/__init__.py#L53-L56>`_.\n\n\nExample\n-----------\n\nBefore:\n\n.. code-block:: python\n\n\tclass FancyDialog(wx.Dialog):\n\n\t\tdef __init__(\n\t\t\t\tself,\n\t\t\t\tparent,\n\t\t\t\tid=wx.ID_ANY, # noqa: A002\n\t\t\t\ttitle=\"My Fancy Dialog\",\n\t\t\t\tpos=wx.DefaultPosition,\n\t\t\t\tsize=wx.DefaultSize,\n\t\t\t\tstyle=wx.DEFAULT_DIALOG_STYLE,\n\t\t\t\tname=wx.DialogNameStr,\n\t\t\t\tdata=None\n\t\t\t\t): ...\n\nAfter:\n\n.. code-block:: python\n\n\tclass FancyDialog(wx.Dialog):\n\n\t\tdef __init__(\n\t\t\t\tself,\n\t\t\t\tparent,\n\t\t\t\tid=wx.ID_ANY, # noqa: A002 # pylint: disable=redefined-builtin\n\t\t\t\ttitle=\"My Fancy Dialog\",\n\t\t\t\tpos=wx.DefaultPosition,\n\t\t\t\tsize=wx.DefaultSize,\n\t\t\t\tstyle=wx.DEFAULT_DIALOG_STYLE,\n\t\t\t\tname=wx.DialogNameStr,\n\t\t\t\tdata=None\n\t\t\t\t): ...\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tool and pre-commit hook to augment Flake8 noqa comments with PyLint comments.",
"version": "0.4.3",
"project_urls": {
"Documentation": "https://flake2lint.readthedocs.io/en/latest",
"Homepage": "https://github.com/domdfcoding/flake2lint",
"Issue Tracker": "https://github.com/domdfcoding/flake2lint/issues",
"Source Code": "https://github.com/domdfcoding/flake2lint"
},
"split_keywords": [
"flake8",
"pre-commit",
"pylint"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c49b17b15c84460dd85bcc90f51657adfef71a4815a66bd3498c6edbbd5cd07",
"md5": "4205a77edf675a97f22b60a727d4edf1",
"sha256": "271c46d464d1ad2906f89a10fa38b90c37788c5318082bb8d009c55ca705a0b3"
},
"downloads": -1,
"filename": "flake2lint-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4205a77edf675a97f22b60a727d4edf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17422,
"upload_time": "2023-05-23T14:21:30",
"upload_time_iso_8601": "2023-05-23T14:21:30.129124Z",
"url": "https://files.pythonhosted.org/packages/5c/49/b17b15c84460dd85bcc90f51657adfef71a4815a66bd3498c6edbbd5cd07/flake2lint-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16065f62d3e0b13c42ea51eee1ccb3508182fc812d95085bb68cf48bb807859a",
"md5": "ca2af648736dacb28365e05090cea14a",
"sha256": "a09883486e713ce2f7688da3489d54a32f91d6de3ae201829d5df7a58dad70ae"
},
"downloads": -1,
"filename": "flake2lint-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "ca2af648736dacb28365e05090cea14a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6352,
"upload_time": "2023-05-23T14:21:33",
"upload_time_iso_8601": "2023-05-23T14:21:33.289492Z",
"url": "https://files.pythonhosted.org/packages/16/06/5f62d3e0b13c42ea51eee1ccb3508182fc812d95085bb68cf48bb807859a/flake2lint-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-23 14:21:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "domdfcoding",
"github_project": "flake2lint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "flake2lint"
}
JSON
