Snyk offers security scanning to test your projects for vulnerabilities, both through your CLI and through different integrations from our UI.
The following describes how to use Snyk to scan your Python projects:
|
Package managers/Features |
CLI support |
Git support |
License scanning |
Remediation |
Runtime monitoring |
|
|---|---|---|---|---|---|---|
 |
✔︎ |
✔︎ |
✔︎ |
✔︎ |
||
 |
✔︎ |
|
✔︎ |
|
||
|
|
setup.py |
✔︎ |
|
✔︎ |
✔︎ |
|
 |
✔︎ |
|
✔︎ |
✔︎ |
Once we’ve built the tree, we can use our vulnerability database to find vulnerabilities in any of the packages anywhere in the dependency tree.
The way by which Snyk analyzes and builds the tree varies depending on the language and package manager of the project, as well as the location of your project.
The way by which Snyk analyzes and builds the tree varies depending on the language and package manager of the project.
Pip
In order to build the dependency tree Snyk analyzes the first requirements.txt file that it finds. We also scan for installed packages to ensure we don’t miss any packages, even when not explicitly specified in your manifest file.
Pipenv
In order to build the dependency tree Snyk analyzes the Pipfile file.
setup.py
In order to build the dependency tree Snyk analyzes the setup.py file, and detects packages listed in the install_requires key.
There is no auto-discovery for this file, it must be specified manually:
snyk test --file=setup.pyYou can convert setup.py to requirements.txt by installing the packages into a virtual environment then running pip freeze.
Poetry
To find issues in a Python Poetry application Snyk uses pyproject.toml and poetry.lock files. Note both these files must be present for Snyk to identify Poetry dependencies and test for issues.
Additional support details
https://github.com/snyk/snyk-python-plugin/blob/master/lib/types.ts
CLI parameters for Python
Prerequisites
Parameters
When scanning your Python project for vulnerabilities, use these options to modify commands:
|
Option |
Description |
|---|---|
|
|
Snyk uses Python in order to scan and find your dependencies. Snyk needs the Python version to start scanning, and defaults to "python" If you are using multiple Python versions, use this parameter to specify the correct Python command for execution. For example: See Using different Python versions for more details |
|
|
Skip packages when they can’t be found in the environment (for example, private packages that can’t be accessed from the machine running the scan). |
|
|
Specify a specific file to test. By default, Snyk scans the requirements.txt file on the top level of the project. If explicitly specified with this parameter, Snyk can recognize any manifest files named *req*.txt, where: Each (*) is a wildcard and req can appear anywhere in the file name. For example, Snyk recognizes your manifest file when you have renamed it to requirements-dev.txt. |
|
|
This parameter is mandatory if you specify a value for the --file parameter that is not to a requirements.txt file. The test fails without this parameter.Specify this parameter with the value pip. |
Python projects can be imported from any of the Git repositories we support.
In order to test your Python projects using pip as a package manager, we analyze your requirements.txt file, and so you must have this file in your repository before importing.
If you’ve renamed your requirements.txt files (for example, if you have renamed a file to requirements-dev.txt), we try to import every file that follows the *req*.txt convention as a Python project.
If you are using a package manager that creates different manifest file formats other than requirements.txt, then either convert or import (depending on the package manager/supported files) the manifest file to the requirements.txt format.
For example:
dephell deps convert --from=conda --to=requirements.txt
Some Python projects may have dependencies that are only valid using Python 3. By default, Snyk scans with Python 2.
You can adjust the version of Python Snyk uses to scan dependencies, in both the CLI and Git integration.
Setting Python version in the CLI
Add the following parameter to snyk test or snyk monitor
--command=python3
You can also set a specific Python version by adding the following to a .snyk policy file.
language-settings:
python: '3.7.2'
Setting Python version in Git projects
By default Snyk tests using Python 2.
To define which Python major version Snyk uses to test your Git imported projects, use either organization settings, or a .snyk policy file.
To define Python version for all projects in an organization:
-
Go to Settings > Languages:
-
Click Edit settings for Python.
- Select to use Python 2 or Python 3 when testing projects for this organization
We recommend you create different organizations to work with different Python versions.
If you prefer to use one organization but require projects to use different Python versions, you may add a .snyk file to a project repository, and specify the desired version.
The.snyk file must be in the same directory as the project manifest file.
Major and minor versions
On finding a .snyk file, Snyk detects the major version specified, and uses this to control whether the project is tested with Python 2 or Python 3. It does not use the exact version specified.
For example, for projects imported via Git:
language-settings:
python: '3.7.2'
This example tells Snyk to use a recent version of Python 3, but Snyk will not use the exact minor and patch version specified.