pythonnet/src/runtime/exceptions.cs at master · ashsvis/pythonnet · 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

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

using System;

using System.Diagnostics;

using System.Reflection;

using System.Runtime.ExceptionServices;

using System.Runtime.InteropServices;

namespace Python.Runtime

{

/// <summary>

/// Base class for Python types that reflect managed exceptions based on

/// System.Exception

/// </summary>

/// <remarks>

/// The Python wrapper for managed exceptions LIES about its inheritance

/// tree. Although the real System.Exception is a subclass of

/// System.Object the Python type for System.Exception does NOT claim that

/// it subclasses System.Object. Instead TypeManager.CreateType() uses

/// Python's exception.Exception class as base class for System.Exception.

/// </remarks>

[Serializable]

internal class ExceptionClassObject : ClassObject

{

internal ExceptionClassObject(Type tp) : base(tp)

{

}

internal static Exception ToException(BorrowedReference ob)

{

var co = GetManagedObject(ob) as CLRObject;

return co?.inst as Exception;

}

/// <summary>

/// Exception __repr__ implementation

/// </summary>

public new static IntPtr tp_repr(IntPtr ob)

{

Exception e = ToException(new BorrowedReference(ob));

if (e == null)

{

return Exceptions.RaiseTypeError("invalid object");

}

string name = e.GetType().Name;

string message;

if (e.Message != String.Empty)

{

message = String.Format("{0}('{1}')", name, e.Message);

}

else

{

message = String.Format("{0}()", name);

}

return Runtime.PyUnicode_FromString(message);

}

/// <summary>

/// Exception __str__ implementation

/// </summary>

public new static IntPtr tp_str(IntPtr ob)

{

Exception e = ToException(new BorrowedReference(ob));

if (e == null)

{

return Exceptions.RaiseTypeError("invalid object");

}

string message = e.ToString();

string fullTypeName = e.GetType().FullName;

string prefix = fullTypeName + ": ";

if (message.StartsWith(prefix))

{

message = message.Substring(prefix.Length);

}

else if (message.StartsWith(fullTypeName))

{

message = message.Substring(fullTypeName.Length);

}

return Runtime.PyUnicode_FromString(message);

}

/// <summary>

/// Encapsulates the Python exception APIs.

/// </summary>

/// <remarks>

/// Readability of the Exceptions class improvements as we look toward version 2.7 ...

/// </remarks>

internal static class Exceptions

{

internal static PyModule warnings_module;

internal static PyModule exceptions_module;

/// <summary>

/// Initialization performed on startup of the Python runtime.

/// </summary>

internal static void Initialize()

{

string exceptionsModuleName = "builtins";

exceptions_module = PyModule.Import(exceptionsModuleName);

warnings_module = PyModule.Import("warnings");

Type type = typeof(Exceptions);

foreach (FieldInfo fi in type.GetFields(BindingFlags.Public | BindingFlags.Static))

{

IntPtr op = Runtime.PyObject_GetAttrString(exceptions_module.obj, fi.Name);

if (op != IntPtr.Zero)

{

fi.SetValue(type, op);

}

else

{

fi.SetValue(type, IntPtr.Zero);

DebugUtil.Print($"Unknown exception: {fi.Name}");

}

Runtime.PyErr_Clear();

}

/// <summary>

/// Cleanup resources upon shutdown of the Python runtime.

/// </summary>

internal static void Shutdown()

{

if (Runtime.Py_IsInitialized() == 0)

{

return;

}

Type type = typeof(Exceptions);

foreach (FieldInfo fi in type.GetFields(BindingFlags.Public | BindingFlags.Static))

{

var op = (IntPtr)fi.GetValue(type);

if (op == IntPtr.Zero)

{

continue;

}

Runtime.XDecref(op);

fi.SetValue(null, IntPtr.Zero);

}

exceptions_module.Dispose();

warnings_module.Dispose();

}

/// <summary>

/// Set the 'args' slot on a python exception object that wraps

/// a CLR exception. This is needed for pickling CLR exceptions as

/// BaseException_reduce will only check the slots, bypassing the

/// __getattr__ implementation, and thus dereferencing a NULL

/// pointer.

/// </summary>

internal static void SetArgsAndCause(BorrowedReference ob, Exception e)

{

IntPtr args;

if (!string.IsNullOrEmpty(e.Message))

{

args = Runtime.PyTuple_New(1);

IntPtr msg = Runtime.PyUnicode_FromString(e.Message);

Runtime.PyTuple_SetItem(args, 0, msg);

}

else

{

args = Runtime.PyTuple_New(0);

}

using var argsTuple = NewReference.DangerousFromPointer(args);

if (Runtime.PyObject_SetAttrString(ob, "args", argsTuple) != 0)

throw PythonException.ThrowLastAsClrException();

if (e.InnerException != null)

{

// Note: For an AggregateException, InnerException is only the first of the InnerExceptions.

using var cause = CLRObject.GetReference(e.InnerException);

Runtime.PyException_SetCause(ob, cause.Steal());

}

/// <summary>

/// Shortcut for (pointer == NULL) -> throw PythonException

/// </summary>

/// <param name="pointer">Pointer to a Python object</param>

internal static void ErrorCheck(BorrowedReference pointer)

{

if (pointer.IsNull)

{

throw PythonException.ThrowLastAsClrException();

}

internal static void ErrorCheck(IntPtr pointer) => ErrorCheck(new BorrowedReference(pointer));

/// <summary>

/// Shortcut for (pointer == NULL or ErrorOccurred()) -> throw PythonException

/// </summary>

internal static void ErrorOccurredCheck(IntPtr pointer)

{

if (pointer == IntPtr.Zero || ErrorOccurred())

{

throw PythonException.ThrowLastAsClrException();

}

internal static IntPtr ErrorCheckIfNull(IntPtr pointer)

{

if (pointer == IntPtr.Zero && ErrorOccurred())

{

throw PythonException.ThrowLastAsClrException();

}

return pointer;

}

/// <summary>

/// ExceptionMatches Method

/// </summary>

/// <remarks>

/// Returns true if the current Python exception matches the given

/// Python object. This is a wrapper for PyErr_ExceptionMatches.

/// </remarks>

public static bool ExceptionMatches(IntPtr ob)

{

return Runtime.PyErr_ExceptionMatches(ob) != 0;

}

/// <summary>

/// SetError Method

/// </summary>

/// <remarks>

/// Sets the current Python exception given a native string.

/// This is a wrapper for the Python PyErr_SetString call.

/// </remarks>

public static void SetError(IntPtr ob, string value)

{

Runtime.PyErr_SetString(ob, value);

}

/// <summary>

/// SetError Method

/// </summary>

/// <remarks>

/// Sets the current Python exception given a Python object.

/// This is a wrapper for the Python PyErr_SetObject call.

/// </remarks>

public static void SetError(IntPtr type, IntPtr exceptionObject)

{

Runtime.PyErr_SetObject(new BorrowedReference(type), new BorrowedReference(exceptionObject));

}

internal const string DispatchInfoAttribute = "__dispatch_info__";

/// <summary>

/// SetError Method

/// </summary>

/// <remarks>

/// Sets the current Python exception given a CLR exception

/// object. The CLR exception instance is wrapped as a Python

/// object, allowing it to be handled naturally from Python.

/// </remarks>

public static bool SetError(Exception e)

{

Debug.Assert(e is not null);

// Because delegates allow arbitrary nesting of Python calling

// managed calling Python calling... etc. it is possible that we

// might get a managed exception raised that is a wrapper for a

// Python exception. In that case we'd rather have the real thing.

var pe = e as PythonException;

if (pe != null)

{

pe.Restore();

return true;

}

using var instance = Converter.ToPythonReference(e);

if (instance.IsNull()) return false;

var exceptionInfo = ExceptionDispatchInfo.Capture(e);

using var pyInfo = Converter.ToPythonReference(exceptionInfo);

if (Runtime.PyObject_SetAttrString(instance, DispatchInfoAttribute, pyInfo) != 0)

return false;

Debug.Assert(Runtime.PyObject_TypeCheck(instance, new BorrowedReference(BaseException)));

var type = Runtime.PyObject_TYPE(instance);

Runtime.PyErr_SetObject(type, instance);

return true;

}

/// <summary>

/// When called after SetError, sets the cause of the error.

/// </summary>

/// <param name="cause">The cause of the current error</param>

public static void SetCause(Exception cause)

{

var currentException = PythonException.FetchCurrentRaw();

currentException.Normalize();

using var causeInstance = Converter.ToPythonReference(cause);

Runtime.PyException_SetCause(currentException.Value!.Reference, causeInstance.Steal());

currentException.Restore();

}

/// <summary>

/// ErrorOccurred Method

/// </summary>

/// <remarks>

/// Returns true if an exception occurred in the Python runtime.

/// This is a wrapper for the Python PyErr_Occurred call.

/// </remarks>

public static bool ErrorOccurred()

{

return Runtime.PyErr_Occurred() != null;

}

/// <summary>

/// Clear Method

/// </summary>

/// <remarks>

/// Clear any exception that has been set in the Python runtime.

/// </remarks>

public static void Clear()

{

Runtime.PyErr_Clear();

}

//====================================================================

// helper methods for raising warnings

//====================================================================

/// <summary>

/// Alias for Python's warnings.warn() function.

/// </summary>

public static void warn(string message, IntPtr exception, int stacklevel)

{

if (exception == IntPtr.Zero ||

(Runtime.PyObject_IsSubclass(new BorrowedReference(exception), new BorrowedReference(Exceptions.Warning)) != 1))

{

Exceptions.RaiseTypeError("Invalid exception");

}

IntPtr warn = Runtime.PyObject_GetAttrString(warnings_module.obj, "warn");

Exceptions.ErrorCheck(warn);

IntPtr args = Runtime.PyTuple_New(3);

IntPtr msg = Runtime.PyString_FromString(message);

Runtime.XIncref(exception); // PyTuple_SetItem steals a reference

IntPtr level = Runtime.PyInt_FromInt32(stacklevel);

Runtime.PyTuple_SetItem(args, 0, msg);

Runtime.PyTuple_SetItem(args, 1, exception);

Runtime.PyTuple_SetItem(args, 2, level);

IntPtr result = Runtime.PyObject_CallObject(warn, args);

Exceptions.ErrorCheck(result);

Runtime.XDecref(warn);

Runtime.XDecref(result);

Runtime.XDecref(args);

}

public static void warn(string message, IntPtr exception)

{

warn(message, exception, 1);

}

public static void deprecation(string message, int stacklevel)

{

warn(message, Exceptions.DeprecationWarning, stacklevel);

}

public static void deprecation(string message)

{

deprecation(message, 1);

}

//====================================================================

// Internal helper methods for common error handling scenarios.

//====================================================================

/// <summary>

/// Raises a TypeError exception and attaches any existing exception as its cause.

/// </summary>

/// <param name="message">The exception message</param>

/// <returns><c>IntPtr.Zero</c></returns>

internal static IntPtr RaiseTypeError(string message)

{

var cause = PythonException.FetchCurrentOrNullRaw();

cause?.Normalize();

Exceptions.SetError(Exceptions.TypeError, message);

if (cause is null) return IntPtr.Zero;

var typeError = PythonException.FetchCurrentRaw();

typeError.Normalize();

Runtime.PyException_SetCause(

typeError.Value!.Reference,

new NewReference(cause.Value!.Reference).Steal());

typeError.Restore();

return IntPtr.Zero;

}

// 2010-11-16: Arranged in python (2.6 & 2.7) source header file order

/* Predefined exceptions are

public static variables on the Exceptions class filled in from

the python class using reflection in Initialize() looked up by

name, not position. */

public static IntPtr BaseException;

public static IntPtr Exception;

public static IntPtr StopIteration;

public static IntPtr GeneratorExit;

public static IntPtr ArithmeticError;

public static IntPtr LookupError;

public static IntPtr AssertionError;

public static IntPtr AttributeError;

public static IntPtr EOFError;

public static IntPtr FloatingPointError;

public static IntPtr EnvironmentError;

public static IntPtr IOError;

public static IntPtr OSError;

public static IntPtr ImportError;

public static IntPtr IndexError;

public static IntPtr KeyError;

public static IntPtr KeyboardInterrupt;

public static IntPtr MemoryError;

public static IntPtr NameError;

public static IntPtr OverflowError;

public static IntPtr RuntimeError;

public static IntPtr NotImplementedError;

public static IntPtr SyntaxError;

public static IntPtr IndentationError;

public static IntPtr TabError;

public static IntPtr ReferenceError;

public static IntPtr SystemError;

public static IntPtr SystemExit;

public static IntPtr TypeError;

public static IntPtr UnboundLocalError;

public static IntPtr UnicodeError;

public static IntPtr UnicodeEncodeError;

public static IntPtr UnicodeDecodeError;

public static IntPtr UnicodeTranslateError;

public static IntPtr ValueError;

public static IntPtr ZeroDivisionError;

//#ifdef MS_WINDOWS

//public static IntPtr WindowsError;

//#endif

//#ifdef __VMS

//public static IntPtr VMSError;

//#endif

//PyAPI_DATA(PyObject *) PyExc_BufferError;

//PyAPI_DATA(PyObject *) PyExc_MemoryErrorInst;

//PyAPI_DATA(PyObject *) PyExc_RecursionErrorInst;

/* Predefined warning categories */

public static IntPtr Warning;

public static IntPtr UserWarning;

public static IntPtr DeprecationWarning;

public static IntPtr PendingDeprecationWarning;

public static IntPtr SyntaxWarning;

public static IntPtr RuntimeWarning;

public static IntPtr FutureWarning;

public static IntPtr ImportWarning;

public static IntPtr UnicodeWarning;

//PyAPI_DATA(PyObject *) PyExc_BytesWarning;

}

pythonnet/src/runtime/exceptions.cs at master · ashsvis/pythonnet · GitHub

Repository navigation

Expand file tree

Breadcrumbs

exceptions.cs

Latest commit

History

Breadcrumbs

exceptions.cs

File metadata and controls