pylint-per-file-ignores


Namepylint-per-file-ignores JSON
Version 1.3.2 PyPI version JSON
download
home_pagehttps://github.com/christopherpickering/pylint-per-file-ignores.git
SummaryA pylint plugin to ignore error codes per file.
upload_time2023-09-20 06:45:01
maintainer
docs_urlNone
authorChristopher Pickering
requires_python>=3.8.1,<4.0.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pylint Per File Ignores 😲

This pylint plugin will enable per-file-ignores in your project!

## Install

```
# w/ poetry
poetry add --dev pylint-per-file-ignores

# 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": "",
    "docs_url": null,
    "requires_python": ">=3.8.1,<4.0.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Christopher Pickering",
    "author_email": "christopher@going.bg",
    "download_url": "https://files.pythonhosted.org/packages/c7/4d/44bc55d37c4d8abe96b1a3b57baecc0a1534264ec85b946bbcf35fa21618/pylint_per_file_ignores-1.3.2.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 --dev pylint-per-file-ignores\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.3.2",
    "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": "ff8961ca7d4fa42a235dbe1fd72a025c019e7a2e380cef31219073c933e3d5ee",
                "md5": "f38577824f782fdf75421dee35b5965c",
                "sha256": "4a2a2d7b88484ef1d1b1170029e542954f70efbab13ac3b977606ea5617d04c1"
            },
            "downloads": -1,
            "filename": "pylint_per_file_ignores-1.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f38577824f782fdf75421dee35b5965c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1,<4.0.0",
            "size": 4686,
            "upload_time": "2023-09-20T06:44:59",
            "upload_time_iso_8601": "2023-09-20T06:44:59.490224Z",
            "url": "https://files.pythonhosted.org/packages/ff/89/61ca7d4fa42a235dbe1fd72a025c019e7a2e380cef31219073c933e3d5ee/pylint_per_file_ignores-1.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c74d44bc55d37c4d8abe96b1a3b57baecc0a1534264ec85b946bbcf35fa21618",
                "md5": "b318cdb19edffe8850555d98a02a99c1",
                "sha256": "3c641f69c316770749a8a353556504dae7469541cdaef38e195fe2228841451e"
            },
            "downloads": -1,
            "filename": "pylint_per_file_ignores-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b318cdb19edffe8850555d98a02a99c1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1,<4.0.0",
            "size": 4361,
            "upload_time": "2023-09-20T06:45:01",
            "upload_time_iso_8601": "2023-09-20T06:45:01.193478Z",
            "url": "https://files.pythonhosted.org/packages/c7/4d/44bc55d37c4d8abe96b1a3b57baecc0a1534264ec85b946bbcf35fa21618/pylint_per_file_ignores-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-20 06:45:01",
    "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"
}
        
Elapsed time: 2.02881s