{"author":"Trevor Creech","author_email":"trevor@trevorcreech.com","bugtrack_url":null,"classifiers":["Environment :: Console","Framework :: Flake8","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Software Development :: Quality Assurance"],"description":"Flake8 Extension to enforce better comma placement.\n===================================================\n\n|Build Status| |PyPI - Version|\n\nUsage\n-----\n\nIf you are using flake8 it's as easy as:\n\n.. code:: shell\n\n pip install flake8-commas\n\nNow you can avoid those annoying merge conflicts on dictionary and list diffs.\n\nErrors\n------\n\nDifferent versions of python require commas in different places. Ignore the\nerrors for languages you don't use in your flake8 config:\n\n+------+-----------------------------------------+\n| Code | message |\n+======+=========================================+\n| C812 | missing trailing comma |\n+------+-----------------------------------------+\n| C813 | missing trailing comma in Python 3 |\n+------+-----------------------------------------+\n| C814 | missing trailing comma in Python 2 |\n+------+-----------------------------------------+\n| C815 | missing trailing comma in Python 3.5+ |\n+------+-----------------------------------------+\n| C816 | missing trailing comma in Python 3.6+ |\n+------+-----------------------------------------+\n| C818 | trailing comma on bare tuple prohibited |\n+------+-----------------------------------------+\n| C819 | trailing comma prohibited |\n+------+-----------------------------------------+\n\nExamples\n--------\n\n.. code:: Python\n\n lookup_table = {\n 'key1': 'value',\n 'key2': 'something' # <-- missing a trailing comma\n }\n\n json_data = json.dumps({\n \"key\": \"value\",\n }), # <-- incorrect trailing comma. json_data is now a tuple. Likely by accident.\n\nRelated tools\n-------------\n\nYou may wish to consider one of the following tools alongside or instead of ``flake8-commas``.\n\nFor automatic insertion of commas, though noting that these tools may implement\ndifferent rules around where commas should be placed:\n\n* `black `_, the uncompromising Python code formatter\n* `add-trailing-comma `_, which can do comma insertion automatically\n\n\n.. |Build Status| image:: https://github.com/PyCQA/flake8-commas/actions/workflows/.github/workflows/tests.yml/badge.svg?branch=main\n :target: https://github.com/PyCQA/flake8-commas/actions?query=branch%3Amain\n\n.. |PyPI - Version| image:: https://img.shields.io/pypi/v/flake8-commas\n :target: https://pypi.org/project/flake8-commas/\n\n\n4.0.0 (2024-05-16)\n------------------\n\n- Project renamed back to ``flake8-commas``. If upgrading from\n ``flake8-commas-x`` you should uninstall that package before\n installing this one as both packages install the same modules.\n\n3.0.0 (2024-03-12)\n------------------\n\n- Project renamed to ``flake8-commas-x`` to continue maintenance.\n- Support dropped for Python <3.8.\n- Support added for Python 3.12.\n- Drop explicit ``noqa`` handling; this is handled by flake8 now.\n- Remove use of ``pkg_resources`` in favour of ``importlib``.\n- CI moved to GitHub Actions.\n\n\n2.1.0 (2021-10-13)\n------------------\n\n- Remove upper bound on flake8.\n (`Issue #67 `_)\n- Note: this project is no longer maintained, and now black\n or https://github.com/asottile/add-trailing-comma is recommended instead.\n (`Issue #63 `_)\n (`Issue #69 `_)\n\n2.0.0 (2018-03-19)\n------------------\n\n- Hide ._base from flake8 --version.\n (`Issue #45 `_)\n- Update URL to https://github.com/PyCQA/flake8-commas/.\n (`Issue #51 `_)\n- Add check for trailing commas on bare tuples - C818, thanks to\n `Chris AtLee `_ and\n `Arkadiusz Adamski `_\n (`PR #52 `_)\n\n\n1.0.0 (2018-01-04)\n------------------\n\n- No changes from 0.5.1, just releasing the first major version.\n\n\n0.5.1 (2018-01-02)\n------------------\n\n- Refactor single/multi tuple/subscript to simply count commas in all cases.\n- Prohibit trailing commas in lambda parameter lists.\n- Fix a missing trailing comma false positive in subcripts with slices.\n- Fix a prohibited trailing comma false positve in subscripts with slices.\n- All (`Issue #48 `_)\n\n\n0.5.0 (2018-01-02)\n------------------\n\n- Remove EOL Python 3.3.\n (`Issue #47 `_)\n- Prohibit trailing commas where there is no following new line\n (or forming a single element tuple).\n (`Issue #46 `_)\n\n\n0.4.3 (2017-04-25)\n------------------\n\n- Enforce trailing commas in subscript tuples and slices again.\n Regression from 0.4.2\n (`Issue #42 `_)\n\n\n0.4.2 (2017-04-18)\n------------------\n\n- Prevent lambda params in a parenth form enforcing a trailing comma.\n (`Issue #41 `_)\n- Fix issue preventing execution on Python 2 with Flake8 3.\n (`Issue #35 `_)\n- Allow bare wrapped subscript notation access.\n (`Issue #39 `_)\n- Don't require comma in assert statement with parenth form.\n (`Issue #37 `_)\n\n\n0.4.1 (2017-01-18)\n------------------\n\n- Add the framework flake8 trove classifier.\n\n\n0.4.0 (2017-01-18)\n------------------\n\n- Support flake8 3.x.x.\n (`Issue #20 `_)\n- No trailing comma after any function def with unpack.\n- support Python 3.6 `issue9232 `_\n trailing commas.\n (`Issue #33 `_)\n\n\n0.3.1 (2017-01-18)\n------------------\n\n- Also parse unpacks with literals.\n (`Issue #30 `_)\n\n\n0.3.0 (2017-01-16)\n------------------\n\n- If there is a comment after the last item, do not report an error.\n (`Issue #18 `_)\n- If there is an empty, tuple, list, dict, or function, do not report an error.\n (`Issue #17 `_)\n- Support PEP 3132 Python 3.5+ extended unpacking.\n (`Issue #26 `_)\n- `*args` should not require a trailing comma.\n (`Issue #27 `_)\n\n\n0.2.0 (2017-01-13)\n------------------\n\n- First version of flake8-commas with changelog\n- Fix HTML readme render on PyPI.\n- Support various parenth_form edge cases.\n- Merge from flake8-trailing-commas\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/PyCQA/flake8-commas/","keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":"Peter Law","maintainer_email":"PeterJCLaw@gmail.com","name":"flake8-commas","package_url":"https://pypi.org/project/flake8-commas/","platform":null,"project_url":"https://pypi.org/project/flake8-commas/","project_urls":{"Homepage":"https://github.com/PyCQA/flake8-commas/"},"provides_extra":null,"release_url":"https://pypi.org/project/flake8-commas/4.0.0/","requires_dist":["flake8>=5"],"requires_python":">=3.8","summary":"Flake8 lint for trailing commas.","version":"4.0.0","yanked":false,"yanked_reason":null}

Package search

flake8-commas

project_urls

Dependencies

All package metadata

Releases