Allow using pydevd as a regular dependency. #1586

nicolas-graves · 2024-05-17T05:31:05Z

This reopens #902

The new commit is rebased, builds on @Apteryks commit, and addresses the points in the review.

microsoft-github-policy-service · 2024-05-17T05:31:16Z

@nicolas-graves please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

jgarte · 2024-10-22T22:20:21Z

Hi, what's the status on this?

rchiodo · 2024-10-22T22:26:09Z

I suppose it should be okay as long as all of the tests pass.

rchiodo · 2024-10-22T22:26:44Z

/azp run

azure-pipelines · 2024-10-22T22:26:55Z

Azure Pipelines successfully started running 1 pipeline(s).

rchiodo · 2024-10-22T22:26:59Z

Tests are flakey right now so it's rather hard to tell.

rchiodo · 2024-10-22T22:27:32Z

This change may not be necessary anymore as well as we've updated our pydevd rather recently

rchiodo · 2024-10-22T22:28:12Z

I think we could actually just switch to use a git submodule and then pydevd changes would just end up here automatically.

rchiodo · 2024-10-22T22:53:55Z

Looks like a new dependency was added? I'm not sure why tox is failing.

jgarte · 2024-10-22T22:54:43Z

I think we could actually just switch to use a git submodule and then pydevd changes would just end up here automatically.

That would be great. :) Sounds like the way to go.

@nicolas-graves Would you like to update your branch adding that git submodule?

Apteryks · 2024-10-23T00:23:09Z

@rchiodo pydevd can be built as a distinct package. This pull request is about using that distinctly packaged pydevd, instead of bundling its sources directly within debugpy.

Using a git submodule would not address the use case here; it would simply change the way pydevd is bundled within the project (still better than checking in source code from another project, but not the same as what is proposed here).

rchiodo · 2024-10-23T00:26:48Z

@rchiodo pydevd can be built as a distinct package. This pull request is about using that distinctly packaged pydevd, instead of bundling its sources directly within debugpy.

I thought the reason for this was because pydevd wasn't being kept up to date. Are you saying you'd also want other versions of pydevd?

Apteryks · 2024-10-23T06:23:18Z

No, the reason was to have a single pydevd package offered by the distribution that can be used by other users (software), as a normal library would. The policy of using the least amount of bundled libraries is used for example in Debian and GNU Guix, among other GNU/Linux distributions, as it means updates and bug fixes can be applied to a single place. It's also more efficient (disk and compute wise).

nicolas-graves · 2024-11-03T13:16:29Z

The way BUNDLE_DEBUGPY was set was a bit fragile, it's now more robust, other than that I haven't changed anything. @rchiodo Could you run tests once again and if possible explain what's going wrong? Thanks!

Apteryks · 2024-11-04T12:15:09Z

@nicolas-graves Thank you for keeping this PR up-to-date!

rchiodo · 2024-11-04T17:02:16Z

/azp run

azure-pipelines · 2024-11-04T17:02:23Z

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

rchiodo · 2024-11-04T17:10:01Z

Okay for some reason our pipeline was locked down. We're trying to figure out why.

AdamYoblick · 2024-11-04T17:19:10Z

/azp run

azure-pipelines · 2024-11-04T17:19:20Z

Azure Pipelines successfully started running 1 pipeline(s).

setup.py

rchiodo · 2024-11-04T17:28:08Z

All of the tests are failing with this here:

/usr/bin/pwsh -NoLogo -NoProfile -NonInteractive -Command . '/home/vsts/work/_temp/55a17f57-bbfc-4ddd-b9e8-5eceb49ca29f.ps1'
tox environment: $toxEnv
py39: install_deps> python -I -m pip install -r tests/requirements.txt
.pkg: install_requires> python -I -m pip install setuptools wheel
.pkg: _optional_hooks> python /opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyproject_api/_backend.py True setuptools.build_meta
.pkg: get_requires_for_build_sdist> python /opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyproject_api/_backend.py True setuptools.build_meta
.pkg: get_requires_for_build_wheel> python /opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyproject_api/_backend.py True setuptools.build_meta
.pkg: prepare_metadata_for_build_wheel> python /opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyproject_api/_backend.py True setuptools.build_meta
.pkg: build_sdist> python /opt/hostedtoolcache/Python/3.9.20/x64/lib/python3.9/site-packages/pyproject_api/_backend.py True setuptools.build_meta
py39: install_package> python -I -m pip install --force-reinstall --no-deps /home/vsts/work/1/s/.tox/.tmp/package/1/debugpy-1.8.7+17.g219ffd50.tar.gz
py39: commands[0]> python -m pytest --junitxml=/home/vsts/work/1/a/tests.xml --debugpy-log-dir=/home/vsts/work/1/a/logs tests
ImportError while loading conftest '/home/vsts/work/1/s/tests/conftest.py'.
tests/__init__.py:55: in <module>
    import debugpy.server  # noqa
.tox/py39/lib/python3.9/site-packages/debugpy/server/__init__.py:36: in <module>
    pydevd_constants.MAXIMUM_VARIABLE_REPRESENTATION_SIZE = 2**32
E   NameError: name 'pydevd_constants' is not defined
py39: exit 4 (1.40 seconds) /home/vsts/work/1/s> python -m pytest --junitxml=/home/vsts/work/1/a/tests.xml --debugpy-log-dir=/home/vsts/work/1/a/logs tests pid=2965
  py39: FAIL code 4 (123.82=setup[122.43]+cmd[1.40] seconds)
  evaluation failed :( (124.30 seconds)

You should be able to reproduce test failures locally following the directions in the CONTRIBUTING.md about running tests.

nicolas-graves · 2024-11-04T21:01:29Z

Actually I use pytest on Guix and it works well, bundled or unbundled. I'm going to have to go with little touches and iterations and your pipeline, because tox is difficult to use properly using GNU Guix. Here's a first light iteration to try and define pydevd_constants after importing force_pydevd

nicolas-graves · 2024-11-05T14:12:58Z

/azp run

azure-pipelines · 2024-11-05T14:13:05Z

Commenter does not have sufficient privileges for PR 1586 in repo microsoft/debugpy

rchiodo · 2024-11-05T17:02:24Z

/azp run

azure-pipelines · 2024-11-05T17:02:35Z

Azure Pipelines successfully started running 1 pipeline(s).

nicolas-graves · 2024-11-05T17:25:26Z

@rchiodo Are you sure the failures come from my changes? I indeed see some failures, but at least some of them seem unrelated to what I've done here. Things like:
OSError: [Errno 6] Device not configured: '/dev/tty' or ConnectionResetError: [Errno 54] Connection reset by peer doesn't seem related.

rchiodo · 2024-11-05T17:32:04Z

That connection reset may be a side effect of the process dying (it's not the error, but the output from when the error occurs).

It looks like all of the attach tests are failing. Do they fail locally for you too?

nicolas-graves · 2024-11-05T17:38:24Z

I can run them with pytest in a sandboxed environment without issues. (Currently only tested with GNU Guix/pytest@7/[email protected]).
Taking a look at https://dev.azure.com/debugpy/e46219b7-01aa-4c94-bbb2-412729bafcd4/_apis/build/builds/4324/logs/137 , the only "error" strings there are those OSError.

rchiodo · 2024-11-05T17:43:26Z

Error isn't going to help much. You'd have to reproduce the issue and then see why the test isn't passing.

These are the tests that are consistently failing through all of those examples:

2024-11-05T17:19:33.3069251Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-launch-startDebugging-True]
2024-11-05T17:19:33.3069723Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(cli)-startDebugging-None]
2024-11-05T17:19:33.3070240Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(cli)-debugpyAttach-True]
2024-11-05T17:19:33.3071988Z FAILED tests/debugpy/test_multiproc.py::test_subprocess_replace[program-launch(console=internalConsole)]
2024-11-05T17:19:33.3072728Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-launch-debugpyAttach-None]
2024-11-05T17:19:33.3073424Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-launch-startDebugging-None]
2024-11-05T17:19:33.3074111Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(api)-startDebugging-True]
2024-11-05T17:19:33.3075039Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(api)-startDebugging-None]
2024-11-05T17:19:33.3075533Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-launch--None]
2024-11-05T17:19:33.3076042Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(api)-debugpyAttach-None]
2024-11-05T17:19:33.3076565Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(cli)-debugpyAttach-None]
2024-11-05T17:19:33.3077091Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(cli)-debugpyAttach-True]
2024-11-05T17:19:33.3077602Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(cli)--None]
2024-11-05T17:19:33.3078314Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(api)-debugpyAttach-True]
2024-11-05T17:19:33.3078850Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(api)-startDebugging-None]
2024-11-05T17:19:33.3079363Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(api)--True]
2024-11-05T17:19:33.3079861Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(api)--None]
2024-11-05T17:19:33.3080382Z FAILED tests/debugpy/test_multiproc.py::test_subprocess_replace[program-launch(console=integratedTerminal)]
2024-11-05T17:19:33.3080869Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(cli)-startDebugging-None]
2024-11-05T17:19:33.3081404Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(cli)-debugpyAttach-None]
2024-11-05T17:19:33.3081865Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(cli)--None]
2024-11-05T17:19:33.3082587Z FAILED tests/debugpy/test_multiproc.py::test_subprocess_replace[program-launch(console=externalTerminal)]
2024-11-05T17:19:33.3083060Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-launch--True]
2024-11-05T17:19:33.3083570Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-launch-debugpyAttach-True]
2024-11-05T17:19:33.3084116Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(cli)-startDebugging-True]
2024-11-05T17:19:33.3084640Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(api)--None]
2024-11-05T17:19:33.3085317Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(cli)-startDebugging-True]
2024-11-05T17:19:33.3085876Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(api)-debugpyAttach-None]
2024-11-05T17:19:33.3086582Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(api)-debugpyAttach-True]
2024-11-05T17:19:33.3087210Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(cli)--True]
2024-11-05T17:19:33.3087748Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(cli)--True]
2024-11-05T17:19:33.3088435Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_listen(api)--True]
2024-11-05T17:19:33.3088949Z FAILED tests/debugpy/test_multiproc.py::test_subprocess[program-attach_connect(api)-startDebugging-True]

So it looks like something in this code is breaking subprocess debugging.

nicolas-graves requested a review from a team as a code owner May 17, 2024 05:31

nicolas-graves force-pushed the allow-unbundled-builds branch from 7709b5d to 9543d56 Compare May 17, 2024 05:34

nicolas-graves force-pushed the allow-unbundled-builds branch 2 times, most recently from be17dd6 to 65710cf Compare November 3, 2024 13:14

nicolas-graves force-pushed the allow-unbundled-builds branch from 65710cf to f44cf65 Compare November 3, 2024 15:07

rchiodo reviewed Nov 4, 2024

View reviewed changes

setup.py Show resolved Hide resolved

Allow using pydevd as a regular dependency.

c9edf76

nicolas-graves force-pushed the allow-unbundled-builds branch from f44cf65 to c9edf76 Compare November 4, 2024 21:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow using pydevd as a regular dependency. #1586

Allow using pydevd as a regular dependency. #1586

nicolas-graves commented May 17, 2024

microsoft-github-policy-service bot commented May 17, 2024

Contribution License Agreement

jgarte commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

azure-pipelines bot commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

jgarte commented Oct 22, 2024

Apteryks commented Oct 23, 2024

rchiodo commented Oct 23, 2024

Apteryks commented Oct 23, 2024

nicolas-graves commented Nov 3, 2024

Apteryks commented Nov 4, 2024

rchiodo commented Nov 4, 2024

azure-pipelines bot commented Nov 4, 2024

rchiodo commented Nov 4, 2024

AdamYoblick commented Nov 4, 2024

azure-pipelines bot commented Nov 4, 2024

rchiodo commented Nov 4, 2024

nicolas-graves commented Nov 4, 2024

nicolas-graves commented Nov 5, 2024

azure-pipelines bot commented Nov 5, 2024

rchiodo commented Nov 5, 2024

azure-pipelines bot commented Nov 5, 2024

nicolas-graves commented Nov 5, 2024

rchiodo commented Nov 5, 2024

nicolas-graves commented Nov 5, 2024 •

edited

Loading

rchiodo commented Nov 5, 2024

Allow using pydevd as a regular dependency. #1586

Are you sure you want to change the base?

Allow using pydevd as a regular dependency. #1586

Conversation

nicolas-graves commented May 17, 2024

microsoft-github-policy-service bot commented May 17, 2024

Contribution License Agreement

jgarte commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

azure-pipelines bot commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

rchiodo commented Oct 22, 2024

jgarte commented Oct 22, 2024

Apteryks commented Oct 23, 2024

rchiodo commented Oct 23, 2024

Apteryks commented Oct 23, 2024

nicolas-graves commented Nov 3, 2024

Apteryks commented Nov 4, 2024

rchiodo commented Nov 4, 2024

azure-pipelines bot commented Nov 4, 2024

rchiodo commented Nov 4, 2024

AdamYoblick commented Nov 4, 2024

azure-pipelines bot commented Nov 4, 2024

rchiodo commented Nov 4, 2024

nicolas-graves commented Nov 4, 2024

nicolas-graves commented Nov 5, 2024

azure-pipelines bot commented Nov 5, 2024

rchiodo commented Nov 5, 2024

azure-pipelines bot commented Nov 5, 2024

nicolas-graves commented Nov 5, 2024

rchiodo commented Nov 5, 2024

nicolas-graves commented Nov 5, 2024 • edited Loading

rchiodo commented Nov 5, 2024

nicolas-graves commented Nov 5, 2024 •

edited

Loading