debugpy
An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).
Backend: pants.backend.python
Config section: [debugpy]
Basic options
[]
Arguments to pass directly to debugpy, e.g. --debugpy-args='--log-to-stderr'
.
Advanced options
debugpy==1.6.0
Requirement string for the tool.
extra_requirements
extra_requirements
--debugpy-extra-requirements="['<str>', '<str>', ...]"
PANTS_DEBUGPY_EXTRA_REQUIREMENTS
[]
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.
interpreter_constraints
interpreter_constraints
--debugpy-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_DEBUGPY_INTERPRETER_CONSTRAINTS
[ "CPython>=3.7,<3.11" ]
Python interpreter constraints for this tool.
<default>
Path to a lockfile used for installing the tool.
Set to the string <default>
to use a lockfile provided by Pants, so long as you have not changed the --version
and --extra-requirements
options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior
). See https://github.com/pantsbuild/pants/blob/release_2.14.2rc2/src/python/pants/backend/python/subsystems/debugpy.lock for the default lockfile contents.
Set to the string <none>
to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds and supply-chain security.
To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=debugpy
.
Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash
. Set [python].invalid_lockfile_behavior = 'ignore'
so that Pants does not complain about missing lockfile headers.
None
The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.
debugpy
The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.
Deprecated options
None
Updated 7 months ago