`flake8-no-pytest-mark-only`
============================
A [Flake8](https://flake8.pycqa.org/) plugin to check for the usage of the `@pytest.mark.only` decorator.
Rationale
---------
The `@pytest.mark.only` decorator, coming from the [`pytest-only`](https://pypi.org/project/pytest-only/) plugin, is great.
It's super useful when developing your tests, so that you can run just the test (or set of tests) that you're working on,
without having to run your whole test suite.
The only problem with it is that when you forget to remove it after you've finished developing your tests,
and you accidentally commit it to your repository,
it's hard to notice that only a subset of tests are running in CI instead of the whole test suite.
This Flake8 plugin prevents that, by raising a lint error on usages of the `@pytest.mark.only` decorator,
so that you notice that you've committed changes with the decorator in them.
Usage
-----
Just install the `flake8-no-pytest-mark-only` package, and when you run Flake8,
it will automatically find the plugin and use it.
If you want to override the reporting from this plugin, you can filter for the error code `PNO001`:
```bash
# Turn on the errors from this plugin
flake8 --select PNO001 ...
# Turn off the errors from this plugin
flake8 --extend-ignore PNO001 ...
```
Raw data
{
"_id": null,
"home_page": "",
"name": "flake8-no-pytest-mark-only",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "flake8,pytest,mark,only",
"author": "",
"author_email": "Franti\u0161ek Nesveda <frantisek.nesveda@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6d/2a/4eca25a4271af5e9770d5cf836b42a26e29ce9c687c90f4f08fd7b02f292/flake8-no-pytest-mark-only-1.0.0.tar.gz",
"platform": null,
"description": "`flake8-no-pytest-mark-only`\n============================\n\nA [Flake8](https://flake8.pycqa.org/) plugin to check for the usage of the `@pytest.mark.only` decorator.\n\nRationale\n---------\n\nThe `@pytest.mark.only` decorator, coming from the [`pytest-only`](https://pypi.org/project/pytest-only/) plugin, is great.\nIt's super useful when developing your tests, so that you can run just the test (or set of tests) that you're working on,\nwithout having to run your whole test suite.\n\nThe only problem with it is that when you forget to remove it after you've finished developing your tests,\nand you accidentally commit it to your repository,\nit's hard to notice that only a subset of tests are running in CI instead of the whole test suite.\n\nThis Flake8 plugin prevents that, by raising a lint error on usages of the `@pytest.mark.only` decorator,\nso that you notice that you've committed changes with the decorator in them.\n\nUsage\n-----\n\nJust install the `flake8-no-pytest-mark-only` package, and when you run Flake8,\nit will automatically find the plugin and use it.\n\nIf you want to override the reporting from this plugin, you can filter for the error code `PNO001`:\n\n```bash\n# Turn on the errors from this plugin\nflake8 --select PNO001 ...\n\n# Turn off the errors from this plugin\nflake8 --extend-ignore PNO001 ...\n```\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Flake8 plugin to disallow the use of the pytest.mark.only decorator.",
"version": "1.0.0",
"project_urls": {
"Changelog": "https://github.com/fnesveda/flake8-no-pytest-mark-only/blob/master/CHANGELOG.md",
"Documentation": "https://github.com/fnesveda/flake8-no-pytest-mark-only",
"Homepage": "https://www.nesveda/com/projects/flake8-no-pytest-mark-only",
"Issue tracker": "https://github.com/fnesveda/flake8-no-pytest-mark-only/issues",
"Source": "https://github.com/fnesveda/flake8-no-pytest-mark-only"
},
"split_keywords": [
"flake8",
"pytest",
"mark",
"only"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b843af2c5ae6c6443483156db1bd6d7db2e81af84b1f3060c4667592fe09bf08",
"md5": "f72258b43ae5aba746f234ce549bc652",
"sha256": "dcbc6aff2f3a8d63cd9a16c7232351143f90fa04f0956673bc0f5c51528ffbb7"
},
"downloads": -1,
"filename": "flake8_no_pytest_mark_only-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f72258b43ae5aba746f234ce549bc652",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5066,
"upload_time": "2023-09-06T13:47:43",
"upload_time_iso_8601": "2023-09-06T13:47:43.214208Z",
"url": "https://files.pythonhosted.org/packages/b8/43/af2c5ae6c6443483156db1bd6d7db2e81af84b1f3060c4667592fe09bf08/flake8_no_pytest_mark_only-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d2a4eca25a4271af5e9770d5cf836b42a26e29ce9c687c90f4f08fd7b02f292",
"md5": "f740b085ec05a8dab48283cf2da0e203",
"sha256": "cf295fb4198ee7d30e86711aa36e56231a0660425482255fc4818b2fabe2c77b"
},
"downloads": -1,
"filename": "flake8-no-pytest-mark-only-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f740b085ec05a8dab48283cf2da0e203",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4893,
"upload_time": "2023-09-06T13:47:45",
"upload_time_iso_8601": "2023-09-06T13:47:45.779343Z",
"url": "https://files.pythonhosted.org/packages/6d/2a/4eca25a4271af5e9770d5cf836b42a26e29ce9c687c90f4f08fd7b02f292/flake8-no-pytest-mark-only-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-06 13:47:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fnesveda",
"github_project": "flake8-no-pytest-mark-only",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flake8-no-pytest-mark-only"
}
JSON
