# Pylint Per File Ignores 😲
This pylint plugin will enable per-file-ignores in your project!
## Install
```
# w/ poetry
poetry add pylint-per-file-ignores --group dev
# w/ pip
pip install pylint-per-file-ignores
```
## Add to Pylint Settings
```toml
[tool.pylint.MASTER]
load-plugins=[
"pylint_per_file_ignores",
...
]
```
## Usage
Add list of patterns and codes you would like to ignore.
### Using native pylint settings
Section "MESSAGES CONTROL". Examples:
```ini
# setup.cfg
[pylint.MESSAGES CONTROL]
per-file-ignores =
/folder_1/:missing-function-docstring,W0621,W0240,C0115
file.py:C0116,E0001
```
```toml
# pyproject.toml
[tool.pylint.'messages control']
per-file-ignores = [
"/folder_1/:missing-function-docstring,W0621,W0240,C0115",
"file.py:C0116,E0001"
]
```
### Using custom `pyproject.toml` section
For backwards compatibility only. Example:
```toml
[tool.pylint-per-file-ignores]
"/folder_1/"="missing-function-docstring,W0621,W0240,C0115"
"file.py"="C0116,E0001"
```
## Thanks
To pylint :) And the plugin `pylint-django` who produced most of the complex code.
## Contributing
This repo uses commitizen and semantic release. Please commit using `npm run commit` .
Raw data
{
"_id": null,
"home_page": "https://github.com/christopherpickering/pylint-per-file-ignores.git",
"name": "pylint-per-file-ignores",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Christopher Pickering",
"author_email": "christopher@going.bg",
"download_url": "https://files.pythonhosted.org/packages/a5/3d/21bec2f2f432519616c34a64ba0766ef972fdfb6234a86bb1b8baf4b0c7c/pylint_per_file_ignores-1.4.0.tar.gz",
"platform": null,
"description": "# Pylint Per File Ignores \ud83d\ude32\n\nThis pylint plugin will enable per-file-ignores in your project!\n\n## Install\n\n```\n# w/ poetry\npoetry add pylint-per-file-ignores --group dev\n\n# w/ pip\npip install pylint-per-file-ignores\n```\n\n## Add to Pylint Settings\n\n```toml\n[tool.pylint.MASTER]\nload-plugins=[\n \"pylint_per_file_ignores\",\n ...\n]\n```\n\n\n## Usage\n\nAdd list of patterns and codes you would like to ignore.\n\n### Using native pylint settings\n\nSection \"MESSAGES CONTROL\". Examples:\n\n```ini\n# setup.cfg\n\n[pylint.MESSAGES CONTROL]\nper-file-ignores =\n /folder_1/:missing-function-docstring,W0621,W0240,C0115\n file.py:C0116,E0001\n```\n\n```toml\n# pyproject.toml\n\n[tool.pylint.'messages control']\nper-file-ignores = [\n \"/folder_1/:missing-function-docstring,W0621,W0240,C0115\",\n \"file.py:C0116,E0001\"\n]\n```\n\n### Using custom `pyproject.toml` section\n\nFor backwards compatibility only. Example:\n\n```toml\n[tool.pylint-per-file-ignores]\n\"/folder_1/\"=\"missing-function-docstring,W0621,W0240,C0115\"\n\"file.py\"=\"C0116,E0001\"\n```\n\n## Thanks\n\nTo pylint :) And the plugin `pylint-django` who produced most of the complex code.\n\n## Contributing\n\nThis repo uses commitizen and semantic release. Please commit using `npm run commit` .\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A pylint plugin to ignore error codes per file.",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/christopherpickering/pylint-per-file-ignores.git",
"Repository": "https://github.com/christopherpickering/pylint-per-file-ignores.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "940ebf3473d86648a17e6dd6ee9e6abce526b077169031177f4f2031368f864a",
"md5": "765cfcd800123da78a9805c856319e34",
"sha256": "0cd82d22551738b4e63a0aa1dab2a1fc4016e8f27f1429159616483711e122fd"
},
"downloads": -1,
"filename": "pylint_per_file_ignores-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "765cfcd800123da78a9805c856319e34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 4888,
"upload_time": "2025-01-17T21:35:00",
"upload_time_iso_8601": "2025-01-17T21:35:00.371070Z",
"url": "https://files.pythonhosted.org/packages/94/0e/bf3473d86648a17e6dd6ee9e6abce526b077169031177f4f2031368f864a/pylint_per_file_ignores-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a53d21bec2f2f432519616c34a64ba0766ef972fdfb6234a86bb1b8baf4b0c7c",
"md5": "be66f9adca94f6993f894b3c9bab4df9",
"sha256": "c0de7b3d0169571aefaa1ac3a82a265641b8825b54a0b6f5ef27c3b76b988609"
},
"downloads": -1,
"filename": "pylint_per_file_ignores-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "be66f9adca94f6993f894b3c9bab4df9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 4419,
"upload_time": "2025-01-17T21:35:02",
"upload_time_iso_8601": "2025-01-17T21:35:02.383618Z",
"url": "https://files.pythonhosted.org/packages/a5/3d/21bec2f2f432519616c34a64ba0766ef972fdfb6234a86bb1b8baf4b0c7c/pylint_per_file_ignores-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-17 21:35:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "christopherpickering",
"github_project": "pylint-per-file-ignores",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pylint-per-file-ignores"
}
JSON
