python: more informative error #1269

refack · 2017-08-20T03:20:13Z

Checklist

npm install && npm test passes
tests are included
commit message follows commit guidelines

Description of change

more informative error when failing to find a suitable python:

gyp info it worked if it ends with ok
gyp verb cli [ 'C:\\bin\\dev\\node\\node4.exe',
gyp verb cli   'D:\\code\\4node\\node-gyp\\bin\\node-gyp.js',
gyp verb cli   'configure',
gyp verb cli   '--loglevel=verbose' ]
gyp info using node-gyp@4.0.0
gyp info using node@4.8.2 | win32 | x64
gyp verb command configure []
gyp verb check python checking for Python executable "python2" in the PATH
gyp verb `which` failed Error: not found: python2
gyp verb `which` failed     at getNotFoundError (D:\code\4node\node-gyp\node_modules\which\which.js:13:12)
gyp verb `which` failed     at F (D:\code\4node\node-gyp\node_modules\which\which.js:68:19)
gyp verb `which` failed     at E (D:\code\4node\node-gyp\node_modules\which\which.js:80:29)
gyp verb `which` failed     at D:\code\4node\node-gyp\node_modules\which\which.js:89:16
gyp verb `which` failed     at D:\code\4node\node-gyp\node_modules\isexe\index.js:42:5
gyp verb `which` failed     at D:\code\4node\node-gyp\node_modules\isexe\windows.js:36:5
gyp verb `which` failed     at FSReqWrap.oncomplete (fs.js:82:15)
gyp verb `which` failed  python2 { [Error: not found: python2]
gyp verb `which` failed   stack: 'Error: not found: python2\n    at getNotFoundError (D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:13:12)\n    at F (D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:68:19)\n    at E (D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:80:29)\n    at D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:89:16\n    at D:\\code\\4node\\node-gyp\\node_modules\\isexe\\index.js:42:5\n    at D:\\code\\4node\\node-gyp\\node_modules\\isexe\\windows.js:36:5\n    at FSReqWrap.oncomplete (fs.js:82:15)',
gyp verb `which` failed   code: 'ENOENT' }
gyp verb check python checking for Python executable "python" in the PATH
gyp verb `which` failed Error: not found: python
gyp verb `which` failed     at getNotFoundError (D:\code\4node\node-gyp\node_modules\which\which.js:13:12)
gyp verb `which` failed     at F (D:\code\4node\node-gyp\node_modules\which\which.js:68:19)
gyp verb `which` failed     at E (D:\code\4node\node-gyp\node_modules\which\which.js:80:29)
gyp verb `which` failed     at D:\code\4node\node-gyp\node_modules\which\which.js:89:16
gyp verb `which` failed     at D:\code\4node\node-gyp\node_modules\isexe\index.js:42:5
gyp verb `which` failed     at D:\code\4node\node-gyp\node_modules\isexe\windows.js:36:5
gyp verb `which` failed     at FSReqWrap.oncomplete (fs.js:82:15)
gyp verb `which` failed  python { [Error: not found: python]
gyp verb `which` failed   stack: 'Error: not found: python\n    at getNotFoundError (D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:13:12)\n    at F (D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:68:19)\n    at E (D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:80:29)\n    at D:\\code\\4node\\node-gyp\\node_modules\\which\\which.js:89:16\n    at D:\\code\\4node\\node-gyp\\node_modules\\isexe\\index.js:42:5\n    at D:\\code\\4node\\node-gyp\\node_modules\\isexe\\windows.js:36:5\n    at FSReqWrap.oncomplete (fs.js:82:15)',
gyp verb `which` failed   code: 'ENOENT' }
gyp verb could not find "python". checking python launcher 
gyp verb could not find "python". guessing location 
gyp verb ensuring that file exists: C:\Python27\python.exe
gyp ERR! configure error 
gyp ERR! 
******************************************************************
node-gyp can't use "python",
It is recommended that you install python 2.7, set the PYTHON env,
or use the --python switch to point to a Python >= v2.6.0 & < 3.0.0.
For more information consult the documentation at:
https://github.com/nodejs/node-gyp#installation
*********************************************************************** 
gyp ERR! not ok

refack · 2017-08-20T03:23:21Z

CI: https://ci.nodejs.org/view/All/job/nodegyp-test-pull-request/33/

richardlau · 2017-08-20T03:25:44Z

lib/configure.js

-    this.callback(new Error(errmsg))
+    const err = new Error(
+      '\n******************************************************************\n' +
+      `node-gyp can't use "${this.python}",\n` +


Did you mean to change the wording from "can't find" to "can't use"?

Yes because this error is printed both when python can't be found, and on windows when it's a bad version.
In #1268 the error outputed was:

stack Error: Can't find Python executable "C:\Program Files\Python35\python.EXE", you can set the PYTHON env variable.

which makes less sense.

Is it possible to distinguish between "can't be found" and bad version? In the example output in the PR description (i.e. the not found case), I think the message is now worse.

node-gyp can't use "python",

It's quite convoluted code...
I'll give it another look in the morning but I can't promise I can find an elegant solution. This code comes after several rounds of geusses so it difficult to know what was found but deemed unsuitable or if nothing was found at all.

Didn't notice this PR before doing my own fix. Solves the above issue and detects if there is a wrong version + a possible infinite loop fix. See #1325

jeanru · 2017-09-07T12:47:39Z

+1, I have similar issue, and the error info is as following:

C:\Program Files (x86)\Microsoft Visual Studio 11.0>npm config set python "D:/Python27/python.exe"

C:\Program Files (x86)\Microsoft Visual Studio 11.0>node-gyp rebuild
gyp info it worked if it ends with ok
gyp info using node-gyp@3.6.2
gyp info using node@8.0.0 | win32 | x64
gyp ERR! configure error
gyp ERR! stack Error: Can't find Python executable "python", you can set the PYTHON env variable.
gyp ERR! stack     at PythonFinder.failNoPython (C:\Users\leon\AppData\Roaming\npm\node_modules\node-gyp\lib\configure.js:483:19)
gyp ERR! stack     at PythonFinder.<anonymous> (C:\Users\leon\AppData\Roaming\npm\node_modules\node-gyp\lib\configure.js:508:16)
gyp ERR! stack     at C:\Users\leon\AppData\Roaming\npm\node_modules\node-gyp\node_modules\graceful-fs\polyfills.js:284:29
gyp ERR! stack     at FSReqWrap.oncomplete (fs.js:152:21)
gyp ERR! System Windows_NT 10.0.15063
gyp ERR! command "D:\\Program Files\\nodejs\\node.exe" "C:\\Users\\leon\\AppData\\Roaming\\npm\\node_modules\\node-gyp\\bin\\node-gyp.js" "rebuild"
gyp ERR! cwd C:\Program Files (x86)\Microsoft Visual Studio 11.0
gyp ERR! node -v v8.0.0
gyp ERR! node-gyp -v v3.6.2
gyp ERR! not ok

ncannasse · 2018-04-08T09:08:43Z

This should be definitely merged, the error message is vastly misleading. I just spent one hour figuring that I had the wrong python version installed.

David-OConnor · 2018-06-01T03:45:22Z

Same

Bertware · 2018-07-12T07:41:25Z

@bnoordhuis can someone please take a look at these python related PR's?

cclauss · 2018-07-23T12:47:27Z

lib/configure.js

@@ -461,7 +461,7 @@ PythonFinder.prototype = {
        this.log.silly('stripping "rc" identifier from version')
        version = version.replace(/rc(.*)$/ig, '')
      }
-      var range = semver.Range('>=2.5.0 <3.0.0')
+      var range = semver.Range('>=2.6.0 <3.0.0')


Should this be 2.7.0 instead of 2.6.0 at this point? Python 2.6 has been EOL for 5 years.

cclauss · 2018-07-23T12:49:42Z

lib/configure.js

+      '\n******************************************************************\n' +
+      `node-gyp can't use "${this.python}",\n` +
+      'It is recommended that you install python 2.7, set the PYTHON env,\n' +
+      'or use the --python switch to point to a Python >= v2.6.0 & < 3.0.0.\n' +


Should this be 2.7.0 instead of 2.6.0 at this point? Python 2.6 has been EOL for 5 years.

cclauss · 2018-07-23T12:49:53Z

lib/configure.js

+      `Python executable "${this.python}" is v${badVersion}\n` +
+      'this version is not supported by GYP and hence by node-gyp.\n' +
+      'It is recommended that you install python 2.7, set the PYTHON env,\n' +
+      'or use the --python switch to point to a Python >= v2.6.0 & < 3.0.0.\n' +


Should this be 2.7.0 instead of 2.6.0 at this point? Python 2.6 has been EOL for 5 years.

rvagg · 2018-08-09T00:43:37Z

@refack I'm going to have to defer to you on the status of this and its suitability for merging, can you review and see if it's ready or not?

Ref: nodejs#1269

joaocgreis

Included this commit as part of #1582, so the two PRs should land simultaneously. LGTM in case you want to go ahead with this independently.

PR-URL: #1269 Refs: #1582 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: João Reis <reis@janeasystems.com>

joaocgreis · 2018-11-13T02:20:07Z

Landed in 6b7c8e6

PR-URL: #1269 Refs: #1582 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: João Reis <reis@janeasystems.com>

python: more informative error

c6e155f

refack added the User Friendly label Aug 20, 2017

refack mentioned this pull request Aug 20, 2017

gyp can't find Python, despite Python running when you type "python" #1268

Closed

richardlau reviewed Aug 20, 2017

View reviewed changes

mvidmar mentioned this pull request Nov 5, 2017

Fixed handling of missing python on Windows. #1325

Closed

4 tasks

cclauss reviewed Jul 23, 2018

View reviewed changes

richardlau mentioned this pull request Aug 30, 2018

Python executable not found #1536

Closed

joaocgreis pushed a commit to JaneaSystems/node-gyp that referenced this pull request Oct 25, 2018

python: more informative error

33ccb1f

Ref: nodejs#1269

joaocgreis mentioned this pull request Oct 26, 2018

Clean-up python detection #1582

Closed

3 tasks

joaocgreis approved these changes Oct 26, 2018

View reviewed changes

joaocgreis pushed a commit that referenced this pull request Nov 13, 2018

python: more informative error

6b7c8e6

PR-URL: #1269 Refs: #1582 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: João Reis <reis@janeasystems.com>

joaocgreis closed this Nov 13, 2018

rvagg pushed a commit that referenced this pull request Apr 24, 2019

python: more informative error

49ab79d

PR-URL: #1269 Refs: #1582 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: João Reis <reis@janeasystems.com>

rvagg mentioned this pull request Apr 24, 2019

v5.0.0 proposal #1723

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

python: more informative error #1269

python: more informative error #1269

refack commented Aug 20, 2017

refack commented Aug 20, 2017

richardlau Aug 20, 2017

refack Aug 20, 2017

richardlau Aug 20, 2017

refack Aug 20, 2017

mvidmar Nov 5, 2017

jeanru commented Sep 7, 2017 •

edited by refack

ncannasse commented Apr 8, 2018

David-OConnor commented Jun 1, 2018

Bertware commented Jul 12, 2018

cclauss Jul 23, 2018

cclauss Jul 23, 2018

cclauss Jul 23, 2018

rvagg commented Aug 9, 2018

joaocgreis left a comment

joaocgreis commented Nov 13, 2018

python: more informative error #1269

python: more informative error #1269

Conversation

refack commented Aug 20, 2017

Checklist

Description of change

refack commented Aug 20, 2017

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

jeanru commented Sep 7, 2017 • edited by refack

ncannasse commented Apr 8, 2018

David-OConnor commented Jun 1, 2018

Bertware commented Jul 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvagg commented Aug 9, 2018

joaocgreis left a comment

Choose a reason for hiding this comment

joaocgreis commented Nov 13, 2018

jeanru commented Sep 7, 2017 •

edited by refack