pythonnet/src/runtime/Types/ClassBase.cs at net8.0 · pythonnet/pythonnet

History

682 lines (595 loc) · 24.6 KB

Raw

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

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

using System;

using System.Collections;

using System.Collections.Generic;

using System.Diagnostics;

using System.Linq;

using System.Reflection;

using System.Runtime.InteropServices;

using System.Runtime.Serialization;

using Python.Runtime.Slots;

namespace Python.Runtime

{

/// <summary>

/// Base class for Python types that reflect managed types / classes.

/// Concrete subclasses include ClassObject and DelegateObject. This

/// class provides common attributes and common machinery for doing

/// class initialization (initialization of the class __dict__). The

/// concrete subclasses provide slot implementations appropriate for

/// each variety of reflected type.

/// </summary>

[Serializable]

internal class ClassBase : ManagedType, IDeserializationCallback

{

[NonSerialized]

internal List<string> dotNetMembers = new();

internal Indexer? indexer;

internal MethodBinder? del;

internal readonly Dictionary<int, MethodObject> richcompare = new();

internal MaybeType type;

internal ClassBase(Type tp)

{

if (tp is null) throw new ArgumentNullException(nameof(type));

indexer = null;

type = tp;

}

internal virtual bool CanSubclass()

{

return !type.Value.IsEnum;

}

public readonly static Dictionary<string, int> CilToPyOpMap = new()

{

["op_Equality"] = Runtime.Py_EQ,

["op_Inequality"] = Runtime.Py_NE,

["op_LessThanOrEqual"] = Runtime.Py_LE,

["op_GreaterThanOrEqual"] = Runtime.Py_GE,

["op_LessThan"] = Runtime.Py_LT,

["op_GreaterThan"] = Runtime.Py_GT,

};

/// <summary>

/// Default implementation of [] semantics for reflected types.

/// </summary>

public virtual NewReference type_subscript(BorrowedReference idx)

{

Type[]? types = Runtime.PythonArgsToTypeArray(idx);

if (types == null)

{

return Exceptions.RaiseTypeError("type(s) expected");

}

if (!type.Valid)

{

return Exceptions.RaiseTypeError(type.DeletedMessage);

}

Type? target = GenericUtil.GenericForType(type.Value, types.Length);

if (target != null)

{

Type t;

try

{

// MakeGenericType can throw ArgumentException

t = target.MakeGenericType(types);

}

catch (ArgumentException e)

{

return Exceptions.RaiseTypeError(e.Message);

}

var c = ClassManager.GetClass(t);

return new NewReference(c);

}

return Exceptions.RaiseTypeError($"{type.Value.Namespace}.{type.Name} does not accept {types.Length} generic parameters");

}

/// <summary>

/// Standard comparison implementation for instances of reflected types.

/// </summary>

public static NewReference tp_richcompare(BorrowedReference ob, BorrowedReference other, int op)

{

CLRObject co1;

CLRObject? co2;

BorrowedReference tp = Runtime.PyObject_TYPE(ob);

var cls = (ClassBase)GetManagedObject(tp)!;

// C# operator methods take precedence over IComparable.

// We first check if there's a comparison operator by looking up the richcompare table,

// otherwise fallback to checking if an IComparable interface is handled.

if (cls.richcompare.TryGetValue(op, out var methodObject))

{

// Wrap the `other` argument of a binary comparison operator in a PyTuple.

using var args = Runtime.PyTuple_New(1);

Runtime.PyTuple_SetItem(args.Borrow(), 0, other);

return methodObject.Invoke(ob, args.Borrow(), null);

}

switch (op)

{

case Runtime.Py_EQ:

case Runtime.Py_NE:

BorrowedReference pytrue = Runtime.PyTrue;

BorrowedReference pyfalse = Runtime.PyFalse;

// swap true and false for NE

if (op != Runtime.Py_EQ)

{

pytrue = Runtime.PyFalse;

pyfalse = Runtime.PyTrue;

}

if (ob == other)

{

return new NewReference(pytrue);

}

co1 = (CLRObject)GetManagedObject(ob)!;

co2 = GetManagedObject(other) as CLRObject;

if (null == co2)

{

return new NewReference(pyfalse);

}

object o1 = co1.inst;

object o2 = co2.inst;

if (Equals(o1, o2))

{

return new NewReference(pytrue);

}

return new NewReference(pyfalse);

case Runtime.Py_LT:

case Runtime.Py_LE:

case Runtime.Py_GT:

case Runtime.Py_GE:

co1 = (CLRObject)GetManagedObject(ob)!;

co2 = GetManagedObject(other) as CLRObject;

if (co1 == null || co2 == null)

{

return Exceptions.RaiseTypeError("Cannot get managed object");

}

if (co1.inst is not IComparable co1Comp)

{

Type co1Type = co1.GetType();

return Exceptions.RaiseTypeError($"Cannot convert object of type {co1Type} to IComparable");

}

try

{

int cmp = co1Comp.CompareTo(co2.inst);

BorrowedReference pyCmp;

if (cmp < 0)

{

if (op == Runtime.Py_LT || op == Runtime.Py_LE)

{

pyCmp = Runtime.PyTrue;

}

else

{

pyCmp = Runtime.PyFalse;

}

else if (cmp == 0)

{

if (op == Runtime.Py_LE || op == Runtime.Py_GE)

{

pyCmp = Runtime.PyTrue;

}

else

{

pyCmp = Runtime.PyFalse;

}

else

{

if (op == Runtime.Py_GE || op == Runtime.Py_GT)

{

pyCmp = Runtime.PyTrue;

}

else

{

pyCmp = Runtime.PyFalse;

}

return new NewReference(pyCmp);

}

catch (ArgumentException e)

{

return Exceptions.RaiseTypeError(e.Message);

}

default:

return new NewReference(Runtime.PyNotImplemented);

}

/// <summary>

/// Standard iteration support for instances of reflected types. This

/// allows natural iteration over objects that either are IEnumerable

/// or themselves support IEnumerator directly.

/// </summary>

static NewReference tp_iter_impl(BorrowedReference ob)

{

if (GetManagedObject(ob) is not CLRObject co)

{

return Exceptions.RaiseTypeError("invalid object");

}

IEnumerator? o;

if (co.inst is IEnumerable e)

{

o = e.GetEnumerator();

}

else

{

o = co.inst as IEnumerator;

if (o == null)

{

return Exceptions.RaiseTypeError("iteration over non-sequence");

}

var elemType = typeof(object);

var iterType = co.inst.GetType();

foreach (var ifc in iterType.GetInterfaces())

{

if (ifc.IsGenericType)

{

var genTypeDef = ifc.GetGenericTypeDefinition();

if (genTypeDef == typeof(IEnumerable<>) || genTypeDef == typeof(IEnumerator<>))

{

elemType = ifc.GetGenericArguments()[0];

break;

}

return new Iterator(o, elemType).Alloc();

}

/// <summary>

/// Standard __hash__ implementation for instances of reflected types.

/// </summary>

public static nint tp_hash(BorrowedReference ob)

{

if (GetManagedObject(ob) is CLRObject co)

{

return co.inst.GetHashCode();

}

else

{

Exceptions.RaiseTypeError("unhashable type");

return 0;

}

/// <summary>

/// Standard __str__ implementation for instances of reflected types.

/// </summary>

public static NewReference tp_str(BorrowedReference ob)

{

var co = GetManagedObject(ob) as CLRObject;

if (co == null)

{

return Exceptions.RaiseTypeError("invalid object");

}

try

{

return Runtime.PyString_FromString(co.inst.ToString());

}

catch (Exception e)

{

if (e.InnerException != null)

{

e = e.InnerException;

}

Exceptions.SetError(e);

return default;

}

public static NewReference tp_repr(BorrowedReference ob)

{

if (GetManagedObject(ob) is not CLRObject co)

{

return Exceptions.RaiseTypeError("invalid object");

}

try

{

//if __repr__ is defined, use it

var instType = co.inst.GetType();

var methodInfo = instType.GetMethod("__repr__");

if (methodInfo != null && methodInfo.IsPublic)

{

if (methodInfo.Invoke(co.inst, null) is string reprString)

{

return Runtime.PyString_FromString(reprString);

}

else

{

return new NewReference(Runtime.PyNone);

}

//otherwise use the standard object.__repr__(inst)

using var args = Runtime.PyTuple_New(1);

Runtime.PyTuple_SetItem(args.Borrow(), 0, ob);

using var reprFunc = Runtime.PyObject_GetAttr(Runtime.PyBaseObjectType, PyIdentifier.__repr__);

return Runtime.PyObject_Call(reprFunc.Borrow(), args.Borrow(), null);

}

catch (Exception e)

{

if (e.InnerException != null)

{

e = e.InnerException;

}

Exceptions.SetError(e);

return default;

}

/// <summary>

/// Standard dealloc implementation for instances of reflected types.

/// </summary>

public static void tp_dealloc(NewReference lastRef)

{

Runtime.PyObject_GC_UnTrack(lastRef.Borrow());

CallClear(lastRef.Borrow());

DecrefTypeAndFree(lastRef.Steal());

}

public static int tp_clear(BorrowedReference ob)

{

var weakrefs = Runtime.PyObject_GetWeakRefList(ob);

if (weakrefs != null)

{

Runtime.PyObject_ClearWeakRefs(ob);

}

if (TryFreeGCHandle(ob))

{

IntPtr addr = ob.DangerousGetAddress();

bool deleted = CLRObject.reflectedObjects.Remove(addr);

Debug.Assert(deleted);

}

int baseClearResult = BaseUnmanagedClear(ob);

if (baseClearResult != 0)

{

return baseClearResult;

}

ClearObjectDict(ob);

return 0;

}

internal static unsafe int BaseUnmanagedClear(BorrowedReference ob)

{

var type = Runtime.PyObject_TYPE(ob);

var unmanagedBase = GetUnmanagedBaseType(type);

var clearPtr = Util.ReadIntPtr(unmanagedBase, TypeOffset.tp_clear);

if (clearPtr == IntPtr.Zero)

{

return 0;

}

var clear = (delegate* unmanaged[Cdecl]<BorrowedReference, int>)clearPtr;

bool usesSubtypeClear = clearPtr == TypeManager.subtype_clear;

if (usesSubtypeClear)

{

// workaround for https://bugs.python.org/issue45266 (subtype_clear)

using var dict = Runtime.PyObject_GenericGetDict(ob);

if (Runtime.PyMapping_HasKey(dict.Borrow(), PyIdentifier.__clear_reentry_guard__) != 0)

return 0;

int res = Runtime.PyDict_SetItem(dict.Borrow(), PyIdentifier.__clear_reentry_guard__, Runtime.None);

if (res != 0) return res;

res = clear(ob);

Runtime.PyDict_DelItem(dict.Borrow(), PyIdentifier.__clear_reentry_guard__);

return res;

}

return clear(ob);

}

protected override Dictionary<string, object?> OnSave(BorrowedReference ob)

{

var context = base.OnSave(ob) ?? new();

context["impl"] = this;

return context;

}

protected override void OnLoad(BorrowedReference ob, Dictionary<string, object?>? context)

{

base.OnLoad(ob, context);

var gcHandle = GCHandle.Alloc(this);

SetGCHandle(ob, gcHandle);

}

/// <summary>

/// Implements __getitem__ for reflected classes and value types.

/// </summary>

static NewReference mp_subscript_impl(BorrowedReference ob, BorrowedReference idx)

{

BorrowedReference tp = Runtime.PyObject_TYPE(ob);

var cls = (ClassBase)GetManagedObject(tp)!;

if (cls.indexer == null || !cls.indexer.CanGet)

{

Exceptions.SetError(Exceptions.TypeError, "unindexable object");

return default;

}

// Arg may be a tuple in the case of an indexer with multiple

// parameters. If so, use it directly, else make a new tuple

// with the index arg (method binders expect arg tuples).

if (!Runtime.PyTuple_Check(idx))

{

using var argTuple = Runtime.PyTuple_New(1);

Runtime.PyTuple_SetItem(argTuple.Borrow(), 0, idx);

return cls.indexer.GetItem(ob, argTuple.Borrow());

}

else

{

return cls.indexer.GetItem(ob, idx);

}

/// <summary>

/// Implements __setitem__ for reflected classes and value types.

/// </summary>

static int mp_ass_subscript_impl(BorrowedReference ob, BorrowedReference idx, BorrowedReference v)

{

BorrowedReference tp = Runtime.PyObject_TYPE(ob);

var cls = (ClassBase)GetManagedObject(tp)!;

if (cls.indexer == null || !cls.indexer.CanSet)

{

Exceptions.SetError(Exceptions.TypeError, "object doesn't support item assignment");

return -1;

}

// Arg may be a tuple in the case of an indexer with multiple

// parameters. If so, use it directly, else make a new tuple

// with the index arg (method binders expect arg tuples).

NewReference argsTuple = default;

if (v.IsNull)

{

return DelImpl(ob, idx, cls);

}

if (!Runtime.PyTuple_Check(idx))

{

argsTuple = Runtime.PyTuple_New(1);

Runtime.PyTuple_SetItem(argsTuple.Borrow(), 0, idx);

idx = argsTuple.Borrow();

}

// Get the args passed in.

var i = Runtime.PyTuple_Size(idx);

using var defaultArgs = cls.indexer.GetDefaultArgs(idx);

var numOfDefaultArgs = Runtime.PyTuple_Size(defaultArgs.Borrow());

var temp = i + numOfDefaultArgs;

using var real = Runtime.PyTuple_New(temp + 1);

for (var n = 0; n < i; n++)

{

BorrowedReference item = Runtime.PyTuple_GetItem(idx, n);

Runtime.PyTuple_SetItem(real.Borrow(), n, item);

}

argsTuple.Dispose();

// Add Default Args if needed

for (var n = 0; n < numOfDefaultArgs; n++)

{

BorrowedReference item = Runtime.PyTuple_GetItem(defaultArgs.Borrow(), n);

Runtime.PyTuple_SetItem(real.Borrow(), n + i, item);

}

i = temp;

// Add value to argument list

Runtime.PyTuple_SetItem(real.Borrow(), i, v);

using var result = cls.indexer.SetItem(ob, real.Borrow());

return result.IsNull() ? -1 : 0;

}

/// Implements __delitem__ (del x[...]) for IList<T> and IDictionary<TKey, TValue>.

private static int DelImpl(BorrowedReference ob, BorrowedReference idx, ClassBase cls)

{

if (cls.del is null)

{

Exceptions.SetError(Exceptions.TypeError, "object does not support item deletion");

return -1;

}

if (Runtime.PyTuple_Check(idx))

{

Exceptions.SetError(Exceptions.TypeError, "multi-index deletion not supported");

return -1;

}

using var argsTuple = Runtime.PyTuple_New(1);

Runtime.PyTuple_SetItem(argsTuple.Borrow(), 0, idx);

using var result = cls.del.Invoke(ob, argsTuple.Borrow(), kw: null);

if (result.IsNull())

return -1;

if (Runtime.PyBool_CheckExact(result.Borrow()))

{

if (Runtime.PyObject_IsTrue(result.Borrow()) != 0)

return 0;

Exceptions.SetError(Exceptions.KeyError, "key not found");

return -1;

}

if (!result.IsNone())

{

Exceptions.warn("unsupported return type for __delitem__", Exceptions.TypeError);

}

return 0;

}

static NewReference tp_call_impl(BorrowedReference ob, BorrowedReference args, BorrowedReference kw)

{

BorrowedReference tp = Runtime.PyObject_TYPE(ob);

var self = (ClassBase)GetManagedObject(tp)!;

if (!self.type.Valid)

{

return Exceptions.RaiseTypeError(self.type.DeletedMessage);

}

Type type = self.type.Value;

var calls = GetCallImplementations(type).ToList();

Debug.Assert(calls.Count > 0);

var callBinder = new MethodBinder();

foreach (MethodInfo call in calls)

{

callBinder.AddMethod(call);

}

return callBinder.Invoke(ob, args, kw);

}

static NewReference DoConvert(BorrowedReference ob)

{