Add `--debug-adapter` flag to `run` #15829

thejcannon · 2022-06-15T00:30:12Z

run's counterpart to #15799. Support is added for pex_binary (which will be spiritually lifted to the python_source with #15849)

[ci skip-rust]
[ci skip-build-wheels]

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

kaos

Nice incremental introduction.

Eric-Arellano

I don't recommend landing the public option until it can be used for something. That's confusing for users why they would ever use it.

What's the motivation to land this now?

thejcannon · 2022-06-15T19:01:42Z

I suppose I can hold off until https://docs.google.com/document/d/1R9m-DtM8Y5UKx5iam5ipeK531tZR40_P7El4ucYq4Po is in

thejcannon · 2022-06-20T00:57:03Z

I've pushed some code which gets--debug-adapter working for module-only entry-points which aren't run in sandbox. It has a few rough edges so holding off for now.

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

src/python/pants/core/goals/run.py

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon · 2022-06-24T15:35:13Z

Not a draft anymore thanks to debugpy.main_spec_args.

I'll make a follow-up PR to integrate that into the test goal, as well as move the options to a new subsystem so its more global.

Also, I'm struggling to find a reasonable way to automated-test these, which we very much should. Ideas welcome!

src/python/pants/backend/python/subsystems/debugpy.py

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon · 2022-06-24T16:38:50Z

I'm going to wait until #15928 is in and use it here.
Additionally, I'll split the main_spec_args into a dedicated PR just to play nice.

stuhood · 2022-06-24T16:57:55Z

Also: does this need any doc updates? Perhaps to the python run page?

thejcannon · 2022-06-25T00:05:20Z

Also: does this need any doc updates? Perhaps to the python run page?

Yeah I owe docs for run and test for --debug-adapter.

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano

THanks! All my feedback applies to the test docs too

docs/markdown/Python/python-goals/python-run-goal.md

docs/markdown/Python/python-goals/python-test-goal.md

docs/markdown/Python/python-goals/python-run-goal.md

src/python/pants/backend/python/goals/run_pex_binary.py

Eric-Arellano · 2022-06-27T15:09:41Z

src/python/pants/backend/python/goals/run_pex_binary.py

+            ResolvePexEntryPointRequest(field_set.entry_point),
+        ),
+        Get(RunRequest, PexBinaryFieldSet, field_set),
+        Get(Pex, PexRequest, debugpy.to_pex_request()),


Should we avoid installing debugpy if you aren't using it? That saves time and avoids possible issues with the PEX not being installable.

This is in a RunDebugAdapterRequest rule, so when would we not be using it?

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano

Thanks! Looks good other than grammar

src/python/pants/backend/python/goals/run_pex_binary.py

Eric-Arellano · 2022-06-27T16:46:47Z

docs/markdown/Python/python-goals/python-run-goal.md

->    using the `[debug-adapter]` subsystem).
+> 1. In your editor, set your breakpoints and any other debug settings (like break-on-exception).
+> 2. Run your code with `./pants run --debug-adapter`.
+> 3. Connect your editor to the server. The server host and port are logged by Pants when executing `run --debug-adaptor`. (They can also be configured using the `[debug-adapter]` subsystem).


How do you connect to the server?

That's largely editor specific 🤷‍♂️

With VSCode? I'm wondering if we should link to a certain guide, for example.

For instance, in VS Code for Python you set up a "Python: Remote Attach" launch.json configuration and with the default values, you start it (F5).

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano · 2022-06-27T19:09:17Z

src/python/pants/backend/python/goals/run_pex_binary.py

+            softwrap(
+                f"""
+                Using `run --debug-adapter` on the target {field_set.address}, which sets the field
+                `run_in_sandbox` set to `True`. This will likely cause your breakpoints to not be hit,


You still say "set" twice.

Sorry, I normally wouldn't be this picky if it were a comment. But because it's documentation, I think it matters more.

No need to apologize, I wanna get this right as well. Sorry my self-review-goggles are fuzzy today,

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

run's counterpart to pantsbuild#15799. Support is added for pex_binary (which will be spiritually lifted to the python_source with pantsbuild#15849) [ci skip-rust] [ci skip-build-wheels]

`run`'s counterpart to #15799. Support is added for `pex_binary` (which will be spiritually lifted to the `python_source` with #15849) [ci skip-rust] [ci skip-build-wheels]

Add debug adapter to run

27ae8bd

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon added the category:new feature label Jun 15, 2022

thejcannon requested review from kaos, stuhood and Eric-Arellano and removed request for stuhood June 15, 2022 00:30

test

03346c2

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

kaos approved these changes Jun 15, 2022

View reviewed changes

thejcannon mentioned this pull request Jun 15, 2022

Add --debug-adapter flag to test goal #15799

Merged

Eric-Arellano reviewed Jun 15, 2022

View reviewed changes

thejcannon marked this pull request as draft June 15, 2022 20:19

thejcannon added 3 commits June 17, 2022 12:21

Merge branch 'main' into dap2

cad6870

almost there

74fc753

working PoC

fa9c413

doesnt gotta be venv

ec6a519

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon commented Jun 24, 2022

View reviewed changes

src/python/pants/core/goals/run.py Outdated Show resolved Hide resolved

Handle anything

904b76e

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon marked this pull request as ready for review June 24, 2022 15:32

comment

27e63eb

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon commented Jun 24, 2022

View reviewed changes

src/python/pants/backend/python/subsystems/debugpy.py Outdated Show resolved Hide resolved

new subsystem

c094252

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

stuhood approved these changes Jun 24, 2022

View reviewed changes

Generecise

ec61845

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon added 8 commits June 25, 2022 12:46

merge

e31ec67

tests too

d94e1a2

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

merge

6601275

merge

51e010a

Merge branch 'main' into dap2

5b9a7a0

docs

c03a839

docs

f5cc775

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

no replace

244dc45

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

thejcannon added the needs-cherrypick label Jun 27, 2022

thejcannon added this to the 2.13.x milestone Jun 27, 2022

thejcannon added 2 commits June 26, 2022 19:24

better log

4a5cabd

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

fix test

d86cf33

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano reviewed Jun 27, 2022

View reviewed changes

Eric's

667d17b

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano reviewed Jun 27, 2022

View reviewed changes

grammar

3b64bee

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano reviewed Jun 27, 2022

View reviewed changes

set set

0cc4972

# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]

Eric-Arellano approved these changes Jun 27, 2022

View reviewed changes

thejcannon merged commit bf25e12 into pantsbuild:main Jun 27, 2022

thejcannon deleted the dap2 branch June 27, 2022 21:36

thejcannon mentioned this pull request Jun 28, 2022

Add --debug-adapter flag to run (Cherry-pick of #15829) #15986

Closed

thejcannon removed the needs-cherrypick label Jun 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `--debug-adapter` flag to `run` #15829

Add `--debug-adapter` flag to `run` #15829

thejcannon commented Jun 15, 2022 •

edited

Loading

kaos left a comment

Eric-Arellano left a comment

thejcannon commented Jun 15, 2022

thejcannon commented Jun 20, 2022

thejcannon commented Jun 24, 2022

thejcannon commented Jun 24, 2022

stuhood commented Jun 24, 2022

thejcannon commented Jun 25, 2022

Eric-Arellano left a comment

Eric-Arellano Jun 27, 2022

thejcannon Jun 27, 2022

Eric-Arellano left a comment

Eric-Arellano Jun 27, 2022

thejcannon Jun 27, 2022

Eric-Arellano Jun 27, 2022

thejcannon Jun 27, 2022

Eric-Arellano Jun 27, 2022

thejcannon Jun 27, 2022

Add --debug-adapter flag to run #15829

Add --debug-adapter flag to run #15829

Conversation

thejcannon commented Jun 15, 2022 • edited Loading

kaos left a comment

Choose a reason for hiding this comment

Eric-Arellano left a comment

Choose a reason for hiding this comment

thejcannon commented Jun 15, 2022

thejcannon commented Jun 20, 2022

thejcannon commented Jun 24, 2022

thejcannon commented Jun 24, 2022

stuhood commented Jun 24, 2022

thejcannon commented Jun 25, 2022

Eric-Arellano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eric-Arellano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `--debug-adapter` flag to `run` #15829

Add `--debug-adapter` flag to `run` #15829

thejcannon commented Jun 15, 2022 •

edited

Loading