WhichPython/src/PythonEnvironment.cs at master · losttech/WhichPython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

namespace LostTech.WhichPython {

using System;

using System.Collections.Generic;

using System.Diagnostics;

using System.Globalization;

using System.IO;

using System.Linq;

using System.Runtime.InteropServices;

using System.Text.RegularExpressions;

using System.Threading;

using Microsoft.Win32;

using static System.FormattableString;

/// <summary>

/// Provides information about a Python environment

/// </summary>

public class PythonEnvironment {

/// <summary>

/// Path to Python executable.

/// Usually <c>python.exe</c> on Windows and <c>pythonX.X</c> on Linux

/// </summary>

public FileSystemInfo? InterpreterPath { get; }

/// <summary>

/// The value of interpreter's PYTHONHOME

/// </summary>

public FileSystemInfo? Home { get; }

/// <summary>

/// Path to the Python dynamic library (useful for embedding). E.g. <c>python36.dll</c> on Windows.

/// </summary>

public FileSystemInfo? DynamicLibraryPath { get; }

/// <summary>

/// Python language version.

/// </summary>

public Version? LanguageVersion { get; }

/// <summary>

/// Interpreter architecture.

/// </summary>

public Architecture? Architecture { get; }

/// <summary>

/// Creates new instance of <see cref="PythonEnvironment"/>

/// </summary>

/// <param name="interpreterPath">Path to Python executable.

/// Usually <c>python.exe</c> on Windows and <c>pythonX.X</c> on Linux.</param>

/// <param name="home">The value of interpreter's PYTHONHOME. Optional.</param>

/// <param name="dll">Path to the Python dynamic library (useful for embedding). Optional.</param>

/// <param name="languageVersion">Python language version. Optional.</param>

/// <param name="architecture">Interpreter architecture</param>

public PythonEnvironment(FileSystemInfo? interpreterPath, FileSystemInfo? home, FileSystemInfo? dll, Version? languageVersion, Architecture? architecture) {

this.InterpreterPath = interpreterPath;

this.Home = home;

this.DynamicLibraryPath = dll;

this.LanguageVersion = languageVersion;

this.Architecture = architecture;

}

/// <summary>

/// Enumerate Python interpreters, installed for current user (including system-wide ones).

/// <para>SECURITY: this invokes any files matching <c>python*</c> mask in PATH to determine if they are a Python interpreter.</para>

/// </summary>

public static IEnumerable<PythonEnvironment> EnumerateEnvironments(CancellationToken cancellation = default) {

var found = new SortedSet<string?>();

if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) {

foreach (var environment in EnumerateRegistryEnvironments(found, cancellation))

yield return environment;

}

foreach (var environment in EnumeratePathEnvironments(found, cancellation))

yield return environment;

}

/// <summary>

/// Enumerate Conda environments of the current user.

/// </summary>

[Obsolete("Use CondaEnvironment.EnumerateCondaEnvironments")]

public static IEnumerable<PythonEnvironment> EnumerateCondaEnvironments(CancellationToken cancellation = default)

=> CondaEnvironment.EnumerateCondaEnvironments(cancellation);

/// <summary>

/// Enumerate Python interpreters in the specified directories.

/// Does not go into subdirectories.

/// <para>SECURITY: this invokes any files matching the mask to determine if they are a Python interpreter.</para>

/// </summary>

/// <param name="paths">Directories to search for interpreters.</param>

/// <param name="interpreterFileNameMask">What an interpreter file name is expected to look like.</param>

/// <param name="cancellation">Optional cancellation token.</param>

public static IEnumerable<PythonEnvironment> EnumeratePathEnvironments(

IEnumerable<DirectoryInfo> paths,

string interpreterFileNameMask = "python*",

CancellationToken cancellation = default){

if (paths == null) throw new ArgumentNullException(nameof(paths));

if (interpreterFileNameMask == null) throw new ArgumentNullException(nameof(interpreterFileNameMask));

return Impl();

IEnumerable<PythonEnvironment> Impl() {

foreach (var directory in paths) {

if (!directory.Exists)

continue;

foreach (FileInfo potentialInterpreter in directory.EnumerateFiles(searchPattern: interpreterFileNameMask)) {

cancellation.ThrowIfCancellationRequested();

var env = TryDetectEnvironmentFromInterpreter(potentialInterpreter, cancellation);

if (env != null)

yield return env;

}

public static PythonEnvironment FromInterpreterChecked(FileInfo interpreter) {

if (interpreter is null) throw new ArgumentNullException(nameof(interpreter));

if (!interpreter.Exists)

throw new FileNotFoundException("Interpreter file not found", interpreter.FullName);

var version = TryGetVersion(interpreter);

if (version is null)

throw new NotSupportedException("Unable to get interpreter version");

DirectoryInfo? home = null;

string? dllPath = null;

if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) {

home = new DirectoryInfo(interpreter.DirectoryName);

dllPath = GetDll(home, version);

if (dllPath != null && !File.Exists(dllPath))

throw new NotSupportedException("Unable to find dynamic library");

}

if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)

|| RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) {

dllPath = LocateSo(interpreter);

if (dllPath != null) {

home = TryGuessUnixHome(interpreter, version, dllPath: dllPath);

}

return new PythonEnvironment(interpreter, home,

dll: dllPath is null ? null : new FileInfo(dllPath),

languageVersion: version,

architecture: null);

}

/// <summary>

/// Enumerate Python environments, listed in the PATH environment variable.

/// </summary>

static IEnumerable<PythonEnvironment> EnumeratePathEnvironments(ISet<string?> enumerated, CancellationToken cancellation) {

bool windows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);

char pathSeparator = windows ? ';' : ':';

DirectoryInfo[]? paths = Environment.GetEnvironmentVariable("PATH")

?.Split(new[] { pathSeparator }, StringSplitOptions.RemoveEmptyEntries)

.Select(dirPath => new DirectoryInfo(dirPath))

.ToArray();

if (paths == null)

yield break;

string[] interpreterFileNameMasks = windows

? new[] { "python.exe" }

: new[] { "python?.?", "python" };

foreach (var env in interpreterFileNameMasks.SelectMany(

mask => EnumeratePathEnvironments(paths, mask, cancellation))) {

if (enumerated.Add(env.DynamicLibraryPath?.FullName))

yield return env;

}

static IEnumerable<PythonEnvironment> EnumerateRegistryEnvironments(ISet<string?> enumerated, CancellationToken cancellation) {

foreach (var environment in EnumerateRegistryEnvironments(Registry.CurrentUser, enumerated, cancellation))

yield return environment;

foreach (var environment in EnumerateRegistryEnvironments(Registry.LocalMachine, enumerated, cancellation))

yield return environment;

}

static IEnumerable<PythonEnvironment> EnumerateRegistryEnvironments(RegistryKey hive, ISet<string?> enumerated, CancellationToken cancellation) {

using var registryEnvironments = hive.OpenSubKey(@"SOFTWARE\Python\PythonCore");

if (registryEnvironments == null) yield break;

var abi = RuntimeInformation.ProcessArchitecture;

foreach (var environment in EnumerateRegistryEnvironments(enumerated, registryEnvironments, abi, cancellation))

yield return environment;

}

static IEnumerable<PythonEnvironment> EnumerateRegistryEnvironments(ISet<string?> enumerated, RegistryKey registryKey, Architecture abi, CancellationToken cancellation) {

foreach (string majorVersion in registryKey.GetSubKeyNames()) {

cancellation.ThrowIfCancellationRequested();

using var installPath = registryKey.OpenSubKey(majorVersion + @"\InstallPath");

if (installPath == null)

continue;

if (!(installPath.GetValue("") is string homePath)) continue;

var home = new DirectoryInfo(homePath);

string interpreterPath = Path.Combine(homePath, "python.exe");

if (!File.Exists(interpreterPath)) continue;

if (!enumerated.Add(homePath)) continue;

bool hasVer = Version.TryParse(majorVersion, out var version);

string? dllPath = hasVer ? GetDll(home, version) : null;

var dll = dllPath == null || !File.Exists(dllPath)

? null

: new FileInfo(dllPath);

yield return new PythonEnvironment(

interpreterPath: new FileInfo(interpreterPath),

home: home,

dll: dll,

version, abi);

}

static string WindowsGetDll(DirectoryInfo home, Version version)

=> Path.Combine(home.FullName, Invariant($"python{version.Major}{version.Minor}.dll"));

static string UnixGetDll(DirectoryInfo home, Version version) {

string mVersion = Path.Combine(home.FullName, "lib",

Invariant($"libpython{version.Major}.{version.Minor}m{DynamicLibraryExtension}"));

if (File.Exists(mVersion)) return mVersion;

return Path.Combine(home.FullName, "lib",

Invariant($"libpython{version.Major}.{version.Minor}{DynamicLibraryExtension}"));

}

internal static string GetDll(DirectoryInfo home, Version version)

=> RuntimeInformation.IsOSPlatform(OSPlatform.Windows)

? WindowsGetDll(home, version)

: UnixGetDll(home, version);

static readonly string DynamicLibraryExtension =

RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? ".dll"

: RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? ".dylib"

: ".so";

static Version? WindowsGetVersion(DirectoryInfo home, CancellationToken cancellation) {

return home.EnumerateFiles(searchPattern: "python??.dll")

.Concat(home.EnumerateFiles(searchPattern: "python???.dll"))

.Select(file => {

string name = Path.GetFileNameWithoutExtension(file.Name);

string verString = name.Substring("python".Length);

int major = verString[0] - '0';

if (major <= 0 || major >= 10) return null;

return int.TryParse(verString.Substring(1), NumberStyles.None, CultureInfo.InvariantCulture, out int minor)

? new Version(major, minor)

: null;

}).WithCancellation(cancellation).Min();

}

static readonly Regex LibPythonVersionRegex = new Regex(@"^libpython(?<major>[0-9])\.(?<minor>[0-9]+)");

static Version? UnixGetVersion(DirectoryInfo home, CancellationToken cancellation) {

if (home is null) throw new ArgumentNullException(nameof(home));

string lib = Path.Combine(home.FullName, "lib");

string extension = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? ".dylib" : ".so";

return Directory.EnumerateFiles(lib, searchPattern: "libpython?.*" + extension)

.Select(name => {

name = Path.GetFileNameWithoutExtension(name);

var match = LibPythonVersionRegex.Match(name);

if (!match.Success) return null;

int major = int.Parse(match.Groups["major"].Value, NumberStyles.None, CultureInfo.InvariantCulture);

int minor = int.Parse(match.Groups["minor"].Value, NumberStyles.None, CultureInfo.InvariantCulture);

return new Version(major, minor);

}).WithCancellation(cancellation).Min();

}

internal static Version? TryGetVersion(DirectoryInfo home, CancellationToken cancellation)

=> RuntimeInformation.IsOSPlatform(OSPlatform.Windows)

? WindowsGetVersion(home, cancellation)

: UnixGetVersion(home, cancellation);

static readonly Regex FileNameVersionRegex = new Regex(@"[a-zA-Z]+(?<ver>\d\.\d)(\.exe)?");

static PythonEnvironment? TryDetectEnvironmentFromInterpreter(FileInfo potentialInterpreter, CancellationToken cancellation = default) {

if (potentialInterpreter is null) throw new ArgumentNullException(nameof(potentialInterpreter));

if (!potentialInterpreter.Exists) return null;

cancellation.ThrowIfCancellationRequested();

var version = TryGetVersion(potentialInterpreter);

if (version is null) return null;

DirectoryInfo? home = null;

string? dllPath = null;

if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)){

home = new DirectoryInfo(potentialInterpreter.DirectoryName);

dllPath = GetDll(home, version);

if (dllPath != null && !File.Exists(dllPath))

dllPath = null;

}

if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)

|| RuntimeInformation.IsOSPlatform(OSPlatform.OSX)){

dllPath = TryLocateSo(potentialInterpreter);

if (dllPath != null)

home = TryGuessUnixHome(potentialInterpreter, version, dllPath: dllPath);

}

return home != null || dllPath != null

? new PythonEnvironment(interpreterPath: potentialInterpreter,

home: home,

dll: dllPath is null ? null : new FileInfo(dllPath),

languageVersion: version, architecture: null)

: null;

}

static Version? TryGetVersion(FileInfo interpreter) {

string? versionString = TryGetVersionString(interpreter);

if (versionString is null) return null;

return Version.TryParse(versionString, out var version) ? version : null;

}

static string? TryGetVersionString(FileInfo interpreter) {

var match = FileNameVersionRegex.Match(interpreter.Name);

if (match.Success)

return match.Groups["ver"].Value;

if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows) && interpreter.Name == "python"

|| RuntimeInformation.IsOSPlatform(OSPlatform.Windows) && interpreter.Name == "python.exe")

return TryRunScript(interpreter, PrintVersionScript);

return null;

}

static string? TryRunScript(FileInfo interpreter, string script, int timeoutMilliseconds = 5000) {

var startInfo = new ProcessStartInfo(interpreter.FullName, $"-c \"{script}\"") {

CreateNoWindow = true,

RedirectStandardOutput = true,

UseShellExecute = false,

};

try {

var process = Process.Start(startInfo);

if (!process.WaitForExit(timeoutMilliseconds)) {

process.Kill();

return null;

}

return process.StandardOutput.ReadToEnd();

} catch (PlatformNotSupportedException) {

return null;

} catch (System.ComponentModel.Win32Exception notFound) when (notFound.NativeErrorCode == 2) {

return null;

}

static string LocateSo(FileInfo interpreterPath) {

string? libPathsOutput = TryGetLibPaths(interpreterPath);

if (libPathsOutput is null)

throw new NotSupportedException("Unable to get lib paths");

string? so = TryGetDllFromGetLibPathsOutput(libPathsOutput);

return so ?? throw new NotImplementedException("Unable to find DLL in lib paths: " + libPathsOutput);

}

static string? TryLocateSo(FileInfo interpreterPath) {

string? libPathsOutput = TryGetLibPaths(interpreterPath);

if (libPathsOutput is null) return null;

return TryGetDllFromGetLibPathsOutput(libPathsOutput);

}

static string? TryGetLibPaths(FileInfo interpreterPath) {

if (interpreterPath is null) throw new ArgumentNullException(nameof(interpreterPath));

string getLibPathsScript = RuntimeInformation.IsOSPlatform(OSPlatform.Linux)

? LinuxGetLibPathsScript

: MacGetLibPathsScript;

return TryRunScript(interpreterPath, getLibPathsScript);

}

static string? TryGetDllFromGetLibPathsOutput(string stdout) {

string[] paths = stdout

.Split(new[] {Environment.NewLine}, StringSplitOptions.RemoveEmptyEntries)

.ToArray();

return paths.Select(libPath => Path.ChangeExtension(libPath, DynamicLibraryExtension))

.Concat(paths)

.Where(libPath => Path.GetExtension(libPath) != ".a")

.FirstOrDefault(File.Exists);

}

static DirectoryInfo? TryGuessUnixHome(FileInfo interpreterPath, Version version, string dllPath) {

var candidate = interpreterPath.Directory;

var dllDir = new FileInfo(dllPath).Directory;

if (IsSubDirectoryOrSame(parent: candidate, child: dllDir))

return candidate;

if (candidate.Name == "bin" && candidate.Parent != null) {

candidate = candidate.Parent;

if (IsSubDirectoryOrSame(candidate, child: dllDir))

return candidate;

}

string? sysPaths = TryRunScript(interpreterPath, PrintSysPathScript);

if (sysPaths != null) {

var paths = sysPaths

.Split(new[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries)

.Select(path => new DirectoryInfo(path))

.ToArray();

var home = paths.FirstOrDefault(path =>

path.Name == Invariant($"python{version.Major}.{version.Minor}")

&& path.Parent != null && path.Parent.Name == "lib")?.Parent?.Parent;

if (home != null && IsSubDirectoryOrSame(home, child: interpreterPath.Directory))

return home;

}

return null;

}

static bool IsSubDirectoryOrSame(DirectoryInfo parent, DirectoryInfo child) {

if (child.FullName.Length < parent.FullName.Length) return false;

if ((child.FullName + Path.DirectorySeparatorChar).StartsWith(parent.FullName + Path.DirectorySeparatorChar, StringComparison.Ordinal))

return true;

return !(child.Parent is null) && IsSubDirectoryOrSame(parent, child.Parent);

}

const string PrintVersionScript = "import sys; print(str(sys.version_info[0]) + '.' + str(sys.version_info[1])+ '.' + str(sys.version_info[2]))";

const string PrintSysPathScript = @"import sys; print('\n'.join(sys.path))";

const string LinuxGetLibPathsScript = "from distutils import sysconfig; import os.path as op; v = sysconfig.get_config_vars(); fpaths = [op.join(v[pv], v['LDLIBRARY']) for pv in ('LIBDIR', 'LIBPL')]; print(list(filter(op.exists, fpaths))[0])";

const string MacGetLibPathsScript = "from distutils import sysconfig; import os.path as op; v = sysconfig.get_config_vars(); fpaths = [op.join(v[pv], fname) for pv in ('LIBDIR', 'LIBPL') for fname in (op.splitext(v['LIBRARY'])[0] + '.dylib', v['LIBRARY'])]; print(list(filter(op.exists, fpaths))[0])";

}

WhichPython/src/PythonEnvironment.cs at master · losttech/WhichPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

PythonEnvironment.cs

Latest commit

History

Breadcrumbs

PythonEnvironment.cs

File metadata and controls