RokeJulianLockhart
commented
1 month ago In retrospect, apologies for the insane examples. Luckily, I've managed to reduce the character set necessary to reproduce it. Specifically, the undermentioned path:
[]`{:"",: ""}`{.}...works:
```log RokeJulianLockhart@sayw4i:~/Documents/test_environment/[]`{:"",: ""}`{.}$ cd /home/RokeJulianLockhart/Documents/test_environment/\[\]\`\{:\"\",:\ \"\"\}\`\{.\} ; /usr/bin/env /usr/bin/python3 /home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher 38487 -- /home/RokeJulianLockhart/Documents/test_environment/\[\]\`\{:\"\",:\ \"\"\}\`\{.\}/test_file.py for k, v in platform_uname_as_dict.items() system = Linux node = sayw4i release = 6.10.10-200.fc40.x86_64 version = microsoft/vscode-python-debugger#1 SMP PREEMPT_DYNAMIC Thu Sep 12 18:26:09 UTC 2024 machine = x86_64 processor = RokeJulianLockhart@sayw4i:~/Documents/test_environment/[]`{:"",: ""}`{.}$ ^C ```
...whereas the undermentioned path:
[]`{:"", : ""}`{.}...does not:
```log RokeJulianLockhart@sayw4i:~/Documents/test_environment/[]`{:"",: ""}`{.}$ cd /home/RokeJulianLockhart/Documents/test_environment/\[\]\`\{:\"\",:\ \"\"\}\`\{.\} ; /usr/bin/env /usr/bin/python3 /home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher 59639 -- /home/RokeJulianLockhart/Documents/test_environment/\[\]\`\{:\"\",:\ \"\"\}\`\{.\}/test_file.py bash: cd: /home/RokeJulianLockhart/Documents/test_environment/[]`{:"",: ""}`{.}: No such file or directory Traceback (most recent call last): File "/usr/lib64/python3.12/runpy.py", line 198, in _run_module_as_main return _run_code(code, main_globals, None, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/lib64/python3.12/runpy.py", line 88, in _run_code exec(code, run_globals) File "/home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher/../../debugpy/__main__.py", line 71, incli.main() File "/home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher/../../debugpy/../debugpy/server/cli.py", line 486, in main run() File "/home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher/../../debugpy/../debugpy/server/cli.py", line 336, in run_file runpy.run_path(target, run_name="__main__") File "/home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/_vendored/pydevd/_pydevd_bundle/pydevd_runpy.py", line 320, in run_path code, fname = _get_code_from_file(run_name, path_name) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/_vendored/pydevd/_pydevd_bundle/pydevd_runpy.py", line 289, in _get_code_from_file with io_open_code(decoded_path) as f: ^^^^^^^^^^^^^^^^^^^^^^^^^^ FileNotFoundError: [Errno 2] No such file or directory: '/home/RokeJulianLockhart/Documents/test_environment/[]`{:"",: ""}`{.}/test_file.py' RokeJulianLockhart@sayw4i:~/Documents/test_environment/[]`{:"",: ""}`{.}$ ```
The sole difference is a single tab character, so it's a combination of the tab character and others which breaks parsing, because a directory name which is merely a tab ( ) does function, as the undermentioned log demonstrates:
```log RokeJulianLockhart@sayw4i:~/Documents/test_environment/[]`{:"",: ""}`{.}$ cd /home/RokeJulianLockhart/Documents/test_environment/\ / ; /usr/bin/env /usr/bin/python3 /home/RokeJulianLockhart/.vscode-insiders/extensions/ms-python.debugpy-2024.11.2024082901-linux-x64/bundled/libs/debugpy/adapter/../../debugpy/launcher 51191 -- /home/RokeJulianLockhart/Documents/test_environment/\ //test_file.py for k, v in platform_uname_as_dict.items() system = Linux node = sayw4i release = 6.10.10-200.fc40.x86_64 version = microsoft/vscode-python-debugger#1 SMP PREEMPT_DYNAMIC Thu Sep 12 18:26:09 UTC 2024 machine = x86_64 processor = RokeJulianLockhart@sayw4i:~/Documents/test_environment/ $ ```
rchiodo
debonte
Summary
I've managed to break the path parsing. Specifically, including certain characters in the parent directories of the file being debugged causes the debugger to crash.
I don't know what specific characters cause this, but I'll update the report when(/if) I do.
Reproduction
Directory-Caused Crash
The undermentioned path, which contains a normal filename (
testfile.py) but an abnormally named immediate parent directory:...causes
ms-python.debugpyto crash:Merely one directory in the absolute path of the file need contain such characters for the parsing to fail, as the undermentioned "Terminal" log from
ms-python.debugpydemonstrates:If I put the file deep enough (like [this example](https://gitlab.com/rokejulianlockhart/sg5n9q/-/blob/5ee5d9dddd190aa306092bdbec2bdf048196801f/%20%20%5B-%5D%09%60%7Btitle:%20%22Non-Metadata%22,%09id:%20%22s1gvg2%22%7D%60%7B.JSON5%7D.dir/%20%20%5B-%5D%09%60%7Btitle:%20%22Technical%22,%09id:%20%22s20cxw%22%7D%60%7B.JSON5%7D.dir/%20%20%5B-%5D%09%60%7Btitle:%20%22Applications%22,%09id:%20%22%22%7D%60%7B.JSON5%7D.dir/%20%20%5B-%5D%09%60%7Btitle:%20%22Configurator%22,%09id:%20%22s3wrcl%22%7D%60%7B.JSON5%7D.dir/%20%20%5B-%5D%09%60%7Btitle:%20%22Code%22,%09id:%20%22%22%7D%60%7B.JSON5%7D.dir/.%20%5B-%5D%09%60%60%7Btitle:%20%22%60platform.uname()%60%7B.Py%7D%20Field%20Output%22,%09id:%20%22sgskr5%22%7D%60%60%7B.JSON5%7D.txt.Py)) it completely breaks. Enter doesn't work because the path is incorrectly escaped, so
^Cis necessary to exit the transient debug state:This causes https://github.com/microsoft/debugpy/issues/1677 to occur:
Debugger Functioning with Unusual Filename
Note that this doesn't apply to the file's name. Consider the undermentioned example:
As the undermentioned "Terminal" log demonstrates, it functions:
Environment
Filename Character Support
One must be using a filesystem and OS that support such characters. I use BTRFS on Fedora 40, but anything comparable (see https://en.wikipedia.org/w/index.php?title=Filename&oldid=1245592690#Comparison_of_filename_limitations) should work.
Versions
Code
Debugger
https://marketplace.visualstudio.com/_apis/public/gallery/publishers/ms-python/vsextensions/debugpy/2024.11.2024082901/vspackage?targetPlatform=linux-x64 (from https://github.com/microsoft/vscode-python-debugger/releases/download/v2024.11.2024082901/extension.vsixmanifest).
Miscellaneous
Potentially related to https://github.com/microsoft/vscode-python-debugger/issues/233#issue-2152958262, although I doubt it, because
/home/RokeJulianLockhart/Documents/Text File.txt.pyworks.