Support for ptvsd version 4 + Other Improvements

AlansCodeLog · AlansCodeLog · commit c4b193f59f0c · 2018-09-09T02:18:59.000-03:00
- Fixes #8 - Improved python path searching code. - Added documentation regarding usage with virtual environments. - Added link to single file scripts workaround issue. Closes #4
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -1,25 +1,26 @@
-<!-- If filing a bug report please follow the troubleshooting steps in the README. If none of those helped please fill out the following: -->
-
-OS:
-
-Add-on Version:
-
-Blender Version:
-
-VS Code Version:
-
-VS Code Python Extension Version:
-
-<!-- ...or Visual Studio Version: -->
-
-PTVSD Version:
-
-Paths listed by `where python` or the corresponding command:
-
-Does VS Code / Visual Studio connect to the troubleshooting script?
-
-Python path/interpreter detected/selected by VS Code / Visual Studio: <!-- See Connecting VS Code in the README -->
-
-## Notes:
-
+<!-- Before reporting a bug please follow the troubleshooting steps in the README first. -->
+<!-- If none of those helped please fill out the following: -->
+
+OS:
+
+Add-on Version:
+
+Blender Version:
+
+VS Code Version:
+
+<!-- ...or Visual Studio Version: -->
+
+VS Code Python Extension Version:
+
+PTVSD Version:
+
+Paths listed by `where python` or the corresponding command:
+
+Does VS Code / Visual Studio connect to the troubleshooting script?
+
+Python path/interpreter detected/selected by VS Code/Visual Studio: <!-- See Connecting VS Code in the README -->
+
+## Notes:
+
 <!-- Describe your problem and the steps to reproduce it, including any specific errors. -->
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Blender Debugger for VS Code (and Visual Studio)
+﻿# Blender Debugger for VS Code (and Visual Studio)
 
 Inspired by [Blender-VScode-Debugger](https://github.com/Barbarbarbarian/Blender-VScode-Debugger) which was itself inspired by this [remote_debugger](https://github.com/sybrenstuvel/random-blender-addons/blob/master/remote_debugger.py) for pycharm as explained in this [Blender Developer's Blog post](https://code.blender.org/2015/10/debugging-python-code-with-pycharm/). 
 
@@ -17,6 +17,8 @@ Now it can:
 
 I have made a video (click the image below) for those who just started messing with python in Blender or programming in general, but if you're semi-familiar with Python, VS Code, and the command line the following should make sense. If you have any questions or suggestions, don't hesitate to file an issue.
 
+<strong>NOTE: ptvsd doesn't have to be version 3.0.0 anymore, so you can now ignore that and just `pip install ptvsd`</strong>
+
 <p align="center" style="position:relative;">
    <a href="https://www.youtube.com/watch?v=UVDf2VSmRvk" title="Click to go to Video">
       <img alt="youtube video" src="https://img.youtube.com/vi/UVDf2VSmRvk/maxresdefault.jpg" height="300" style="margin:0 auto;" />
@@ -32,10 +34,11 @@ If you download the add-on from the releases page, please make sure to rename th
 ## Installing Python and Getting PTVSD
 
 Install Python 3 with pip and check add to PATH.<sup id="n1">[1](#f1)</sup>
-   - If you already have python installed and you can run it from the command line (aka PATH is set), the addon should find it. It uses `where python` or `whereis python` or `which python` depending on the OS to determine where python is and uses the first path given<sup id="n2">[2](#f2)</sup>.
+   - If you already have python installed and you can run it from the command line (aka PATH is set), the addon should find it. It checks `where python` or `whereis python` or `which python` to try and determine where python is and uses the first path given<sup id="n2">[2](#f2)</sup>.
+   - If you are using something like Conda and want to use a virtual environment, to have the addon auto-detect the path you can: activate the environment, run Blender from the command line, and it should work.
 
-`pip install ptvsd==3.0.0`
-   - Newer versions will not work, the add-on will warn you in the console if the version is above 3.0.0. Later versions aren't supported yet in VS Code, and it will throw an error when trying to connect. See [Debugging Python with VS Code](https://code.visualstudio.com/docs/python/debugging#_remote-debugging) and [#514](https://github.com/Microsoft/vscode-python/issues/514).
+`pip install ptvsd`
+   - The following is no longer the case, the latest ptvsd version should work just fine now. <strike>Newer versions will not work, the add-on will warn you in the console if the version is above 3.0.0. Later versions aren't supported yet in VS Code, and it will throw an error when trying to connect. See [Debugging Python with VS Code](https://code.visualstudio.com/docs/python/debugging#_remote-debugging) and [#514](https://github.com/Microsoft/vscode-python/issues/514).</strike>
    - For Visual Studio, later versions should work depending on the Visual Studio version. I have never used Visual Studio, but you can find more info on setting everything up here: [Remotely Debugging Python Code on Linux](https://docs.microsoft.com/en-us/visualstudio/python/debugging-python-code-on-remote-linux-machines#connection-troubleshooting). (it is not Linux specific)
 
 ## Setting up your Addon
@@ -68,7 +71,7 @@ Open up Blender's search (default shortcut: space), type "Debug".
 
 Click `Debug: Start Debug Server for VS Code`. Note: you can only start the server once. You cannot stop it, at least from what I understand. If you run it again it'll just tell you it's already running and start the timer again to check for a confirmation.
 
-## Connecting VS Code
+## Connecting the Editor
 
 Open your addon folder (e.g. "C:\Code\Blender Stuff\addons\myaddon").
 
@@ -86,7 +89,6 @@ Go to the Debugging tab and add a configuration. Pick Python. You'll want the co
       "localRoot": "${workspaceFolder}",
       "remoteRoot": "${workspaceFolder}",
       "port": 3000,
-      "secret": "my_secret",
       "host": "localhost"
    },
 ```
@@ -99,7 +101,7 @@ At this point you should be able to add a breakpoint and when you trigger it in
 
 Note though that if you make changes to the file, Blender will not detect them. Have open `User Preferences > Addons` so you can toggle your addon on and off when you make changes. If anyone knows any way to improve this I'd love to know.
 
-### Editing Source Code
+### Debugging/Editing Source Code
 
 It is possible to edit the Blender source code but it can be a bit tricky to get it to detect changes (nevermind live editing is buggy anyways).
 
@@ -108,10 +110,16 @@ From blender you can right click just about anything and click "Edit Source" to
 Open the file in VS Code, connect to the debugging server, make a change and save it.
 
 Now in Blender the text editor will show this little red button in the top left. Click that and reload the file. Then in `Text Editor > Properties` turn on `Live Edit` if you haven't already. Now to actually get Blender to detect any changes you made just type a single character (like add a space anywhere) and *then* it will detect your changes.
+ 
+ 
+### Debugging/Editing Scripts
+
+   See [Issue #4](https://github.com/AlansCodeLog/blender-debugger-for-vscode/issues/4) for a workaround. 
+   In the future if I have some time, I might see if there's something I can do to make this easier.
 
 # Troubleshooting
 
-- Check you installed the correct ptvsd version.
+- Check you installed the correct ptvsd version. With VS Code this should no longer be an issue, but I believe different versions of Visual Studio need different versions of ptvsd (see [Installing Python Support](https://docs.microsoft.com/en-us/visualstudio/python/installing-python-support-in-visual-studio)).
 - To determine whether the problem is on Blender's side or your editor's: Close Blender and download/copy this [test script](https://gist.github.com/AlansCodeLog/ff1b246a8e31938e1c3dbfdcbb90522f) and run it with Python, and then try to connect to the server with your editor. If you're still getting problems then the problem is with VS Code, try:
       - Check your detected your Python install, or set it manually.
       - For VS Code try reinstalling the VS Code Python extension.
@@ -120,6 +128,6 @@ Otherwise, if nothing works, don't hesitate to file an issue.
 
 # Notes
 
-<a id="f1" href="#n1">1.</a> Technically, the add-on will work with Python 2 as well since it doesn't use Python itself, just the ptvsd package, so it doesn't really matter whether you installed it with Python 2 or 3 because the package is compatible with both. On the VS Code side though, the Python extension does need to know where Python is (though not ptvsd), but it still will connect if it's using Python 2, just IntelliSense recommendations the will be wrong.
+<a id="f1" href="#n1">1.</a> Technically, the add-on will work with Python 2 as well since it doesn't use Python itself, just the ptvsd package, so it doesn't really matter whether you installed it with Python 2 or 3 because the package is compatible with both. On the VS Code side though, the Python extension does need to know where Python is (though not ptvsd), but it will still connect if it's using Python 2, just IntelliSense recommendations the will be wrong.
 
-<a id="f2" href="#n2">2.</a> The addon also detects python if PYTHONPATH is set (because Blender will add it to sys.path) or if you used the Python bundled with Blender to install ptvsd (but that's a bit of a pain because it doesn't have pip installed unless you want to install it manually).
+<a id="f2" href="#n2">2.</a> The addon also detects python if PYTHONPATH is set (because Blender will add it to sys.path) or if you used the Python bundled with Blender to install ptvsd (but that's a bit of a pain because it doesn't have pip installed, you would have to install it manually).
diff --git a/__init__.py b/__init__.py
@@ -21,7 +21,7 @@
 bl_info = {
    'name': 'Debugger for VS Code',
    'author': 'Alan North',
-   'version': (0, 1, 1),
+   'version': (0, 2, 0),
    'blender': (2, 79, 0),
    "description": "Starts debugging server for VS Code.",
    'location': 'In search (default shortcut:space) type "Debug"',
@@ -37,46 +37,38 @@
 import subprocess
 import re
 
-# check path for ptvsd
+# finds path to ptvsd if it exists
 def check_for_ptvsd():
-   #check for python with where/whereis
-   python_exe = None
-   try:
-      python_exe = subprocess.Popen(
-         ["whereis", "python"],
-         shell=False,
-         stdout=subprocess.PIPE,
-         stderr=subprocess.PIPE
-      )
-   except Exception: 
-      pass
-   if python_exe is None:
-      try: 
-         python_exe = subprocess.Popen(
-               ["where", "python"],
-               shell=False,
-               stdout=subprocess.PIPE,
-               stderr=subprocess.PIPE
-            )
-      except Exception: 
-         pass
-   if python_exe is None:
-      try: 
-         python_exe = subprocess.Popen(
-               ["which", "python"],
-               shell=False,
-               stdout=subprocess.PIPE,
-               stderr=subprocess.PIPE
-            )
+   #commands to check
+   checks = [
+      ["where", "python"],
+      ["whereis", "python"],
+      ["which", "python"],
+   ]
+   location = None
+   for command in checks:
+      try:
+         location = subprocess.Popen(
+            command,
+            shell=False,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE
+         )
       except Exception: 
-         pass
-   if python_exe is not None:
-      python_exe = str(python_exe.communicate()[0], "utf-8")
-      match = re.search(".*(\\\\|/)", python_exe).group() 
-      if os.path.exists(match+"lib\site-packages\ptvsd"):
-         return match+"lib\site-packages"
-
-   #check in our path
+         continue
+      if location is not None:
+         location = str(location.communicate()[0], "utf-8")
+         #normalize slashes
+         location = re.sub("\\\\", "/", location)
+         #extract path up to last slash
+         match = re.search(".*(/)", location)
+         if match is not None:
+            match = match.group() 
+            if os.path.exists(match+"lib/site-packages/ptvsd"):
+               match = match+"lib/site-packages"
+               return match
+
+   #check in path just in case PYTHONPATH happens to be set
    for path in sys.path:
       if os.path.exists(path+"\ptvsd"):
          return path
@@ -177,13 +169,9 @@ def execute(self, context):
       global ptvsd #so we can do check later
       import ptvsd
 
-      version = re.sub("\.", "", ptvsd.__version__)
-      if int(version) > 3000: 
-         print("Warning: PTVSD version " + ptvsd.__version__ + " is greater than 3.0.0, it will not work with VS Code.")
-
       # can only be attached once, no way to detach (at least not that I understand?)
       try:
-         ptvsd.enable_attach("my_secret", address = ("0.0.0.0", 3000))
+         ptvsd.enable_attach(("0.0.0.0", 3000), redirect_output=True)
       except:
          print("Server already running.")
 
