add a version info getter

Author: mmomtchev

.vscode/c_cpp_properties.json

@@ -1,4 +1,15 @@
 {
+  "env": {
+    "projectDefines": [
+      "NAPI_EXPERIMENTAL",
+      "NODE_ADDON_API_DISABLE_DEPRECATED",
+      "NAPI_VERSION=6",
+      "PYMPORT_VERSION_MAJOR=1",
+      "PYMPORT_VERSION_MINOR=0",
+      "PYMPORT_VERSION_PATCH=0",
+      "PYMPORT_VERSION_SUFFIX=git"
+    ]
+  },
   "configurations": [
     {
       "name": "Linux",
@@ -7,6 +18,9 @@
         "${workspaceFolder}/node_modules/node-addon-api",
         "/usr/include/python3.8"
       ],
+      "defines": [
+        "${projectDefines}"
+      ],
       "compilerPath": "/usr/bin/g++",
       "cStandard": "c17",
       "cppStandard": "c++14"
@@ -18,6 +32,9 @@
         "C:/Program Files/Python310/include",
         "~/AppData/Local/node-gyp/Cache/16.10.0/include/node"
       ],
+      "defines": [
+        "${projectDefines}"
+      ],
       "compilerPath": "cl.exe",
       "cStandard": "c17",
       "cppStandard": "c++14"

binding.gyp

@@ -20,9 +20,13 @@
         "<!@(node -p \"require('node-addon-api').include\")"
       ],
       'defines': [
-        'NAPI_EXPERIMENTAL'
+        'NAPI_EXPERIMENTAL',
         'NODE_ADDON_API_DISABLE_DEPRECATED',
-        'NAPI_VERSION=6'
+        'NAPI_VERSION=6',
+        'PYMPORT_VERSION_MAJOR=<!(node -e "console.log(require(\'./package.json\').version.split(\'.\')[0])")',
+        'PYMPORT_VERSION_MINOR=<!(node -e "console.log(require(\'./package.json\').version.split(\'.\')[1])")',
+        'PYMPORT_VERSION_PATCH=<!(node -e "console.log(require(\'./package.json\').version.split(\'-\')[0].split(\'.\')[2])")',
+        'PYMPORT_VERSION_SUFFIX=<!(node -e "console.log(require(\'./package.json\').version.split(\'-\')[1])")'
       ],
       'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
       'conditions': [

lib/index.d.ts

@@ -161,3 +161,24 @@ export function pyval(
   globals?: PyObject | Record<string, any>,
   locals?: PyObject | Record<string, any>
 ): PyObject;
+
+export const version: {
+  pymport: { major: number, minor: number, patch: number, suffix: string; },
+  pythonLibrary: {
+    builtin: boolean;
+    major: number;
+    minor: number;
+    micro: number;
+    release: number;
+    serial: number;
+    /**
+     * Hex number
+     */
+    version: string;
+  };
+  /**
+   * Supported only on Python 3.11+
+   */
+  pythonRuntime: null | string;
+  pythonPath: string;
+};

src/main.cc

@@ -1,22 +1,72 @@
 #include <locale>
 #include <codecvt>
 #include <string>
+#include <iomanip>
 
 #include "pymport.h"
 #include "values.h"
 
 using namespace Napi;
 using namespace pymport;
 
+#define STR(s) __STR(s)
+#define __STR(x) #x
+
 size_t pymport::active_environments = 0;
 std::wstring builtin_python_path;
 
+std::string to_hex(long number) {
+  std::stringstream r;
+  r << std::hex << number;
+  return r.str();
+}
+
+Value Version(const CallbackInfo &info) {
+  Env env = info.Env();
+  Object versionInfo = Object::New(env);
+
+  Object pymportVersion = Object::New(env);
+  versionInfo.Set("pymport", pymportVersion);
+  pymportVersion.Set("major", Number::New(env, PYMPORT_VERSION_MAJOR));
+  pymportVersion.Set("minor", Number::New(env, PYMPORT_VERSION_MINOR));
+  pymportVersion.Set("patch", Number::New(env, PYMPORT_VERSION_PATCH));
+  pymportVersion.Set("suffix", String::New(env, STR(PYMPORT_VERSION_SUFFIX)));
+
+#ifdef BUILTIN_PYTHON_PATH
+  bool builtin = true;
+#else
+  bool builtin = false;
+#endif
+  Object pythonLibrary = Object::New(env);
+  versionInfo.Set("pythonLibrary", pythonLibrary);
+  pythonLibrary.Set("builtin", Boolean::New(env, builtin));
+  pythonLibrary.Set("major", Number::New(env, PY_MAJOR_VERSION));
+  pythonLibrary.Set("minor", Number::New(env, PY_MINOR_VERSION));
+  pythonLibrary.Set("micro", Number::New(env, PY_MICRO_VERSION));
+  pythonLibrary.Set("release", Number::New(env, PY_RELEASE_LEVEL));
+  pythonLibrary.Set("serial", Number::New(env, PY_RELEASE_SERIAL));
+  pythonLibrary.Set("version", String::New(env, to_hex(PY_VERSION_HEX)));
+
+#if PY_MAJOR_VERSION > 3 || (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 11)
+  versionInfo.Set("pythonRuntime", String::New(env, to_hex(Py_Version())));
+#else
+  versionInfo.Set("pythonRuntime", env.Null());
+#endif
+
+  std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>> converter;
+  std::string pyHome = converter.to_bytes(Py_GetPythonHome());
+  versionInfo.Set("pythonPath", String::New(env, pyHome.c_str()));
+
+  return versionInfo;
+}
+
 Napi::Object Init(Env env, Object exports) {
   Function pyObjCons = PyObjectWrap::GetClass(env);
 
   exports.Set("PyObject", pyObjCons);
   exports.Set("pymport", Function::New(env, PyObjectWrap::Import));
   exports.Set("pyval", Function::New(env, PyObjectWrap::Eval));
+  exports.DefineProperty(PropertyDescriptor::Accessor<Version>("version", napi_enumerable));
 
   auto context = new EnvContext();
   context->pyObj = new FunctionReference();

test/pymport.test.ts

@@ -1,9 +1,25 @@
-import { pymport } from 'pymport';
+import { pymport, version } from 'pymport';
 import { assert } from 'chai';
 
+import pkg from '../package.json';
+
 describe('pymport', () => {
   afterEach('gc', global.gc);
 
+  it('version', () => {
+    assert.strictEqual(version.pymport.major, +pkg.version.split('.')[0]);
+    assert.strictEqual(version.pymport.minor, +pkg.version.split('.')[1]);
+    assert.strictEqual(version.pymport.patch, +pkg.version.split('-')[0].split('.')[2]);
+    assert.isBoolean(version.pythonLibrary.builtin);
+    assert.isNumber(version.pythonLibrary.major);
+    assert.isNumber(version.pythonLibrary.minor);
+    assert.isNumber(version.pythonLibrary.micro);
+    assert.isNumber(version.pythonLibrary.release);
+    assert.isNumber(version.pythonLibrary.serial);
+    assert.isString(version.pythonLibrary.version);
+    assert.isString(version.pythonPath);
+  });
+
   describe('numpy', () => {
     it('basic pyimport', () => {
       const np = pymport('numpy');

test/tsconfig.test.json

@@ -4,6 +4,7 @@
     "strict": true,
     "strictNullChecks": true,
     "baseUrl": ".",
+    "resolveJsonModule": true,
     "paths": {
       "@mapbox/node-pre-gyp": [
         "./mapbox-node-pre-gyp"

tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "esModuleInterop": true,
     "moduleResolution": "node",
+    "resolveJsonModule": true,
     "paths": {
       "pymport": [
         "."