Skip to main content
Version: 2.13 (deprecated)

debugpy

An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).

Backend: pants.backend.python

Config section: [debugpy]

Basic options​

args​

--debugpy-args="[<shell_str>, <shell_str>, ...]"
PANTS_DEBUGPY_ARGS
pants.toml
[debugpy]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to debugpy, e.g. --debugpy-args='--log-to-stderr'.

Advanced options​

console_script​

--debugpy-console-script=<str>
PANTS_DEBUGPY_CONSOLE_SCRIPT
pants.toml
[debugpy]
console_script = <str>
default: 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.

entry_point​

--debugpy-entry-point=<str>
PANTS_DEBUGPY_ENTRY_POINT
pants.toml
[debugpy]
entry_point = <str>
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.

extra_requirements​

--debugpy-extra-requirements="['<str>', '<str>', ...]"
PANTS_DEBUGPY_EXTRA_REQUIREMENTS
pants.toml
[debugpy]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
default: []

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​

--debugpy-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_DEBUGPY_INTERPRETER_CONSTRAINTS
pants.toml
[debugpy]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.7,<3.11"
]

Python interpreter constraints for this tool.

lockfile​

--debugpy-lockfile=<str>
PANTS_DEBUGPY_LOCKFILE
pants.toml
[debugpy]
lockfile = <str>
default: <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.13.1/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.

To use a custom lockfile, set this option to a file path relative to the build root, then run /home/josh/work/scie-pants/dist/pants generate-lockfiles --resolve=debugpy.

As explained at https://www.pantsbuild.org/v2.13/docs/python-third-party-dependencies, lockfile generation via generate-lockfiles does not always work and you may want to manually generate the lockfile. You will want to set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

version​

--debugpy-version=<str>
PANTS_DEBUGPY_VERSION
pants.toml
[debugpy]
version = <str>
default: debugpy==1.6.0

Requirement string for the tool.

Deprecated options​

None

None