| Name | dlint JSON |
| Version |
0.14.1
JSON |
| download |
| home_page | https://github.com/dlint-py/dlint |
| Summary | Dlint is a tool for encouraging best coding practices and helping ensure Python code is secure. |
| upload_time | 2023-04-10 19:34:22 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# Dlint
[](https://github.com/dlint-py/dlint/actions/workflows/ci.yml)
[](https://coveralls.io/github/dlint-py/dlint?branch=master)
[](https://pypi.org/project/dlint/)
[](https://pypi.org/project/dlint/)
Dlint is a tool for encouraging best coding practices and helping ensure Python code is secure.
> The most important thing I have done as a programmer in recent years is to
> aggressively pursue static code analysis. Even more valuable than the
> hundreds of serious bugs I have prevented with it is the change in mindset
> about the way I view software reliability and code quality.
>
> - [John Carmack, 2011](https://www.gamasutra.com/view/news/128836/InDepth_Static_Code_Analysis.php)
> For a static analysis project to succeed, developers must feel they benefit
> from and enjoy using it.
>
> - [Lessons from Building Static Analysis Tools at Google](https://cacm.acm.org/magazines/2018/4/226371-lessons-from-building-static-analysis-tools-at-google/fulltext)
For documentation and a list of rules see [docs](https://github.com/dlint-py/dlint/tree/master/docs).
# Installing
```bash
$ python -m pip install dlint
```
And double check that it was installed correctly:
```bash
$ python -m flake8 -h
Usage: flake8 [options] file file ...
...
Installed plugins: dlint: 0.14.1, mccabe: 0.5.3, pycodestyle: 2.2.0, pyflakes: 1.3.0
```
Note the `dlint: 0.14.1`.
# Using
Dlint builds on `flake8` to perform its linting. This provides many
useful features without re-inventing the wheel.
## CLI
Let's run a simple check:
```bash
$ cat << EOF > test.py
print("TEST1")
exec('print("TEST2")')
EOF
```
```bash
$ python test.py
TEST1
TEST2
```
```bash
$ python -m flake8 --select=DUO test.py
test.py:2:1: DUO105 use of "exec" is insecure
```
- _Why is this insecure? To learn more visit [`/docs/linters/DUO105.md`](https://github.com/dlint-py/dlint/blob/master/docs/linters/DUO105.md)._
- _Why `DUO`? Dlint was originally developed by the [Duo Labs](https://duo.com/blog/introducing-dlint-robust-static-analysis-for-python) team._
The `--select=DUO` flag tells `flake8` to only run Dlint lint rules.
From here, we can easily run Dlint against a directory of Python code:
```bash
$ python -m flake8 --select=DUO /path/to/code
```
To fine-tune your linting, check out the `flake8` help:
```bash
$ python -m flake8 --help
```
## Inline Editor
Dlint results can also be included inline in your editor for fast feedback.
This typically requires an editor plugin or extension. Here are some starting
points for common editors:
- Vim: [https://github.com/vim-syntastic/syntastic](https://github.com/vim-syntastic/syntastic)
- Emacs: [https://github.com/flycheck/flycheck](https://github.com/flycheck/flycheck)
- Sublime: [https://github.com/SublimeLinter/SublimeLinter-flake8](https://github.com/SublimeLinter/SublimeLinter-flake8)
- PyCharm: [https://foxmask.net/post/2016/02/17/pycharm-running-flake8/](https://foxmask.net/post/2016/02/17/pycharm-running-flake8/)
- Atom: [https://atom.io/packages/linter-flake8](https://atom.io/packages/linter-flake8)
- Visual Studio Code: [https://code.visualstudio.com/docs/python/linting#\_flake8](https://code.visualstudio.com/docs/python/linting#_flake8)
# Integrating
Dlint can easily be integrated into CI pipelines, or anything really.
For more information and examples see ['How can I integrate Dlint into XYZ?'](https://github.com/dlint-py/dlint/tree/master/docs#how-can-i-integrate-dlint-into-xyz).
# Custom Plugins
Dlint's custom plugins are built on a [simple naming convention](https://packaging.python.org/guides/creating-and-discovering-plugins/#using-naming-convention),
and rely on [Python modules](https://docs.python.org/3/distutils/examples.html#pure-python-distribution-by-module).
To make a Dlint custom plugin use the following conventions:
- The Python module name **must** start with `dlint_plugin_`.
- The linter class name **must** start with `Dlint`.
- The linter class **should** inherit from `dlint.linters.base.BaseLinter`.
- If for some reason you'd like to avoid this, then you **must** implement
the `get_results` function appropriately and inherit from `ast.NodeVisitor`.
See an [example plugin](https://github.com/dlint-py/dlint-plugin-example) for further details.
# Developing
First, install development packages:
```bash
$ python -m pip install -r requirements.txt
$ python -m pip install -r requirements-dev.txt
$ python -m pip install -e .
```
## Testing
```bash
$ pytest
```
## Linting
```bash
$ flake8
```
## Coverage
```bash
$ pytest --cov
```
## Benchmarking
```bash
$ pytest -k test_benchmark_run --benchmark-py-file /path/to/file.py tests/test_benchmark/
```
Or get benchmark results for linters individually:
```bash
$ pytest -k test_benchmark_individual --benchmark-py-file /path/to/file.py tests/test_benchmark/
```
Or run against a single linter:
```bash
$ pytest -k test_benchmark_individual[DUO138-BadReCatastrophicUseLinter] --benchmark-py-file /path/to/file.py tests/test_benchmark/
```
Raw data
{
"_id": null,
"home_page": "https://github.com/dlint-py/dlint",
"name": "dlint",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# Dlint\n\n[](https://github.com/dlint-py/dlint/actions/workflows/ci.yml)\n[](https://coveralls.io/github/dlint-py/dlint?branch=master)\n[](https://pypi.org/project/dlint/)\n[](https://pypi.org/project/dlint/)\n\nDlint is a tool for encouraging best coding practices and helping ensure Python code is secure.\n\n> The most important thing I have done as a programmer in recent years is to\n> aggressively pursue static code analysis. Even more valuable than the\n> hundreds of serious bugs I have prevented with it is the change in mindset\n> about the way I view software reliability and code quality.\n>\n> - [John Carmack, 2011](https://www.gamasutra.com/view/news/128836/InDepth_Static_Code_Analysis.php)\n\n> For a static analysis project to succeed, developers must feel they benefit\n> from and enjoy using it.\n>\n> - [Lessons from Building Static Analysis Tools at Google](https://cacm.acm.org/magazines/2018/4/226371-lessons-from-building-static-analysis-tools-at-google/fulltext)\n\nFor documentation and a list of rules see [docs](https://github.com/dlint-py/dlint/tree/master/docs).\n\n# Installing\n\n```bash\n$ python -m pip install dlint\n```\n\nAnd double check that it was installed correctly:\n\n```bash\n$ python -m flake8 -h\nUsage: flake8 [options] file file ...\n\n...\n\nInstalled plugins: dlint: 0.14.1, mccabe: 0.5.3, pycodestyle: 2.2.0, pyflakes: 1.3.0\n```\n\nNote the `dlint: 0.14.1`.\n\n# Using\n\nDlint builds on `flake8` to perform its linting. This provides many\nuseful features without re-inventing the wheel.\n\n## CLI\n\nLet's run a simple check:\n\n```bash\n$ cat << EOF > test.py\nprint(\"TEST1\")\nexec('print(\"TEST2\")')\nEOF\n```\n\n```bash\n$ python test.py\nTEST1\nTEST2\n```\n\n```bash\n$ python -m flake8 --select=DUO test.py\ntest.py:2:1: DUO105 use of \"exec\" is insecure\n```\n\n- _Why is this insecure? To learn more visit [`/docs/linters/DUO105.md`](https://github.com/dlint-py/dlint/blob/master/docs/linters/DUO105.md)._\n- _Why `DUO`? Dlint was originally developed by the [Duo Labs](https://duo.com/blog/introducing-dlint-robust-static-analysis-for-python) team._\n\nThe `--select=DUO` flag tells `flake8` to only run Dlint lint rules.\n\nFrom here, we can easily run Dlint against a directory of Python code:\n\n```bash\n$ python -m flake8 --select=DUO /path/to/code\n```\n\nTo fine-tune your linting, check out the `flake8` help:\n\n```bash\n$ python -m flake8 --help\n```\n\n## Inline Editor\n\nDlint results can also be included inline in your editor for fast feedback.\nThis typically requires an editor plugin or extension. Here are some starting\npoints for common editors:\n\n- Vim: [https://github.com/vim-syntastic/syntastic](https://github.com/vim-syntastic/syntastic)\n- Emacs: [https://github.com/flycheck/flycheck](https://github.com/flycheck/flycheck)\n- Sublime: [https://github.com/SublimeLinter/SublimeLinter-flake8](https://github.com/SublimeLinter/SublimeLinter-flake8)\n- PyCharm: [https://foxmask.net/post/2016/02/17/pycharm-running-flake8/](https://foxmask.net/post/2016/02/17/pycharm-running-flake8/)\n- Atom: [https://atom.io/packages/linter-flake8](https://atom.io/packages/linter-flake8)\n- Visual Studio Code: [https://code.visualstudio.com/docs/python/linting#\\_flake8](https://code.visualstudio.com/docs/python/linting#_flake8)\n\n# Integrating\n\nDlint can easily be integrated into CI pipelines, or anything really.\n\nFor more information and examples see ['How can I integrate Dlint into XYZ?'](https://github.com/dlint-py/dlint/tree/master/docs#how-can-i-integrate-dlint-into-xyz).\n\n# Custom Plugins\n\nDlint's custom plugins are built on a [simple naming convention](https://packaging.python.org/guides/creating-and-discovering-plugins/#using-naming-convention),\nand rely on [Python modules](https://docs.python.org/3/distutils/examples.html#pure-python-distribution-by-module).\nTo make a Dlint custom plugin use the following conventions:\n\n- The Python module name **must** start with `dlint_plugin_`.\n- The linter class name **must** start with `Dlint`.\n- The linter class **should** inherit from `dlint.linters.base.BaseLinter`.\n - If for some reason you'd like to avoid this, then you **must** implement\n the `get_results` function appropriately and inherit from `ast.NodeVisitor`.\n\nSee an [example plugin](https://github.com/dlint-py/dlint-plugin-example) for further details.\n\n# Developing\n\nFirst, install development packages:\n\n```bash\n$ python -m pip install -r requirements.txt\n$ python -m pip install -r requirements-dev.txt\n$ python -m pip install -e .\n```\n\n## Testing\n\n```bash\n$ pytest\n```\n\n## Linting\n\n```bash\n$ flake8\n```\n\n## Coverage\n\n```bash\n$ pytest --cov\n```\n\n## Benchmarking\n\n```bash\n$ pytest -k test_benchmark_run --benchmark-py-file /path/to/file.py tests/test_benchmark/\n```\n\nOr get benchmark results for linters individually:\n\n```bash\n$ pytest -k test_benchmark_individual --benchmark-py-file /path/to/file.py tests/test_benchmark/\n```\n\nOr run against a single linter:\n\n```bash\n$ pytest -k test_benchmark_individual[DUO138-BadReCatastrophicUseLinter] --benchmark-py-file /path/to/file.py tests/test_benchmark/\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Dlint is a tool for encouraging best coding practices and helping ensure Python code is secure.",
"version": "0.14.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53c324b522504d918b1a6c55d177559dbb1d36800f366e7e5d2aa17d2c85d8cb",
"md5": "79cc4091ecd54bef220d77f6a024ed27",
"sha256": "8caa4271ab6f69bba2785bb565b636eeb40baffd446c85380f848fb4abd6aa2d"
},
"downloads": -1,
"filename": "dlint-0.14.1-py3-none-any.whl",
"has_sig": true,
"md5_digest": "79cc4091ecd54bef220d77f6a024ed27",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 77705,
"upload_time": "2023-04-10T19:34:22",
"upload_time_iso_8601": "2023-04-10T19:34:22.085438Z",
"url": "https://files.pythonhosted.org/packages/53/c3/24b522504d918b1a6c55d177559dbb1d36800f366e7e5d2aa17d2c85d8cb/dlint-0.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-10 19:34:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "dlint-py",
"github_project": "dlint",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "dlint"
}
