pythonnet/src/runtime/methodbinder.cs at master · RXDSolutions/pythonnet · GitHub

This repository was archived by the owner on Oct 14, 2026. It is now read-only.

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

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

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

using System;

using System.Collections;

using System.Reflection;

using System.Text;

using System.Collections.Generic;

using System.Linq;

namespace Python.Runtime

{

/// <summary>

/// A MethodBinder encapsulates information about a (possibly overloaded)

/// managed method, and is responsible for selecting the right method given

/// a set of Python arguments. This is also used as a base class for the

/// ConstructorBinder, a minor variation used to invoke constructors.

/// </summary>

internal class MethodBinder

{

public ArrayList list;

public MethodBase[] methods;

public bool init = false;

public bool allow_threads = true;

internal MethodBinder()

{

list = new ArrayList();

}

internal MethodBinder(MethodInfo mi)

{

list = new ArrayList { mi };

}

public int Count

{

get { return list.Count; }

}

internal void AddMethod(MethodBase m)

{

list.Add(m);

}

/// <summary>

/// Given a sequence of MethodInfo and a sequence of types, return the

/// MethodInfo that matches the signature represented by those types.

/// </summary>

internal static MethodInfo MatchSignature(MethodInfo[] mi, Type[] tp)

{

if (tp == null)

{

return null;

}

int count = tp.Length;

foreach (MethodInfo t in mi)

{

ParameterInfo[] pi = t.GetParameters();

if (pi.Length != count)

{

continue;

}

for (var n = 0; n < pi.Length; n++)

{

if (tp[n] != pi[n].ParameterType)

{

break;

}

if (n == pi.Length - 1)

{

return t;

}

return null;

}

/// <summary>

/// Given a sequence of MethodInfo and a sequence of type parameters,

/// return the MethodInfo that represents the matching closed generic.

/// </summary>

internal static MethodInfo MatchParameters(MethodInfo[] mi, Type[] tp)

{

if (tp == null)

{

return null;

}

int count = tp.Length;

foreach (MethodInfo t in mi)

{

if (!t.IsGenericMethodDefinition)

{

continue;

}

Type[] args = t.GetGenericArguments();

if (args.Length != count)

{

continue;

}

return t.MakeGenericMethod(tp);

}

return null;

}

/// <summary>

/// Given a sequence of MethodInfo and two sequences of type parameters,

/// return the MethodInfo that matches the signature and the closed generic.

/// </summary>

internal static MethodInfo MatchSignatureAndParameters(MethodInfo[] mi, Type[] genericTp, Type[] sigTp)

{

if (genericTp == null || sigTp == null)

{

return null;

}

int genericCount = genericTp.Length;

int signatureCount = sigTp.Length;

foreach (MethodInfo t in mi)

{

if (!t.IsGenericMethodDefinition)

{

continue;

}

Type[] genericArgs = t.GetGenericArguments();

if (genericArgs.Length != genericCount)

{

continue;

}

ParameterInfo[] pi = t.GetParameters();

if (pi.Length != signatureCount)

{

continue;

}

for (var n = 0; n < pi.Length; n++)

{

if (sigTp[n] != pi[n].ParameterType)

{

break;

}

if (n == pi.Length - 1)

{

MethodInfo match = t;

if (match.IsGenericMethodDefinition)

{

// FIXME: typeArgs not used

Type[] typeArgs = match.GetGenericArguments();

return match.MakeGenericMethod(genericTp);

}

return match;

}

return null;

}

/// <summary>

/// Return the array of MethodInfo for this method. The result array

/// is arranged in order of precedence (done lazily to avoid doing it

/// at all for methods that are never called).

/// </summary>

internal MethodBase[] GetMethods()

{

if (!init)

{

// I'm sure this could be made more efficient.

list.Sort(new MethodSorter());

methods = (MethodBase[])list.ToArray(typeof(MethodBase));

init = true;

}

return methods;

}

/// <summary>

/// Precedence algorithm largely lifted from Jython - the concerns are

/// generally the same so we'll start with this and tweak as necessary.

/// </summary>

/// <remarks>

/// Based from Jython `org.python.core.ReflectedArgs.precedence`

/// See: https://github.com/jythontools/jython/blob/master/src/org/python/core/ReflectedArgs.java#L192

/// </remarks>

internal static int GetPrecedence(MethodBase mi)

{

ParameterInfo[] pi = mi.GetParameters();

int val = mi.IsStatic ? 3000 : 0;

int num = pi.Length;

val += mi.IsGenericMethod ? 1 : 0;

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

{

val += ArgPrecedence(pi[i].ParameterType);

}

return val;

}

/// <summary>

/// Return a precedence value for a particular Type object.

/// </summary>

internal static int ArgPrecedence(Type t)

{

Type objectType = typeof(object);

if (t == objectType)

{

return 3000;

}

TypeCode tc = Type.GetTypeCode(t);

// TODO: Clean up

switch (tc)

{

case TypeCode.Object:

return 1;

case TypeCode.UInt64:

return 10;

case TypeCode.UInt32:

return 11;

case TypeCode.UInt16:

return 12;

case TypeCode.Int64:

return 13;

case TypeCode.Int32:

return 14;

case TypeCode.Int16:

return 15;

case TypeCode.Char:

return 16;

case TypeCode.SByte:

return 17;

case TypeCode.Byte:

return 18;

case TypeCode.Single:

return 20;

case TypeCode.Double:

return 21;

case TypeCode.String:

return 30;

case TypeCode.Boolean:

return 40;

}

if (t.IsArray)

{

Type e = t.GetElementType();

if (e == objectType)

{

return 2500;

}

return 100 + ArgPrecedence(e);

}

return 2000;

}

/// <summary>

/// Bind the given Python instance and arguments to a particular method

/// overload and return a structure that contains the converted Python

/// instance, converted arguments and the correct method to call.

/// </summary>

internal Binding Bind(IntPtr inst, IntPtr args, IntPtr kw)

{

return Bind(inst, args, kw, null, null);

}

internal Binding Bind(IntPtr inst, IntPtr args, IntPtr kw, MethodBase info)

{

return Bind(inst, args, kw, info, null);

}

internal Binding Bind(IntPtr inst, IntPtr args, IntPtr kw, MethodBase info, MethodInfo[] methodinfo)

{

// loop to find match, return invoker w/ or /wo error

MethodBase[] _methods = null;

var kwargDict = new Dictionary<string, IntPtr>();

if (kw != IntPtr.Zero)

{

var pynkwargs = (int)Runtime.PyDict_Size(kw);

IntPtr keylist = Runtime.PyDict_Keys(kw);

IntPtr valueList = Runtime.PyDict_Values(kw);

for (int i = 0; i < pynkwargs; ++i)

{

var keyStr = Runtime.GetManagedString(Runtime.PyList_GetItem(keylist, i));

kwargDict[keyStr] = Runtime.PyList_GetItem(valueList, i).DangerousGetAddress();

}

Runtime.XDecref(keylist);

Runtime.XDecref(valueList);

}

var pynargs = (int)Runtime.PyTuple_Size(args);

var isGeneric = false;

if (info != null)

{

_methods = new MethodBase[1];

_methods.SetValue(info, 0);

}

else

{

_methods = GetMethods();

}

// TODO: Clean up

foreach (MethodBase mi in _methods)

{

if (mi.IsGenericMethod)

{

isGeneric = true;

}

ParameterInfo[] pi = mi.GetParameters();

ArrayList defaultArgList;

bool paramsArray;

if (!MatchesArgumentCount(pynargs, pi, kwargDict, out paramsArray, out defaultArgList))

{

continue;

}

var outs = 0;

var margs = TryConvertArguments(pi, paramsArray, args, pynargs, kwargDict, defaultArgList,

needsResolution: _methods.Length > 1,

outs: out outs);

if (margs == null)

{

continue;

}

object target = null;

if (!mi.IsStatic && inst != IntPtr.Zero)

{

//CLRObject co = (CLRObject)ManagedType.GetManagedObject(inst);

// InvalidCastException: Unable to cast object of type

// 'Python.Runtime.ClassObject' to type 'Python.Runtime.CLRObject'

var co = ManagedType.GetManagedObject(inst) as CLRObject;

// Sanity check: this ensures a graceful exit if someone does

// something intentionally wrong like call a non-static method

// on the class rather than on an instance of the class.

// XXX maybe better to do this before all the other rigmarole.

if (co == null)

{

return null;

}

target = co.inst;

}

return new Binding(mi, target, margs, outs);

}

// We weren't able to find a matching method but at least one

// is a generic method and info is null. That happens when a generic

// method was not called using the [] syntax. Let's introspect the

// type of the arguments and use it to construct the correct method.

if (isGeneric && info == null && methodinfo != null)

{

Type[] types = Runtime.PythonArgsToTypeArray(args, true);

MethodInfo mi = MatchParameters(methodinfo, types);

return Bind(inst, args, kw, mi, null);

}

return null;

}

/// <summary>

/// Attempts to convert Python positional argument tuple and keyword argument table

/// into an array of managed objects, that can be passed to a method.

/// </summary>

/// <param name="pi">Information about expected parameters</param>

/// <param name="paramsArray"><c>true</c>, if the last parameter is a params array.</param>

/// <param name="args">A pointer to the Python argument tuple</param>

/// <param name="pyArgCount">Number of arguments, passed by Python</param>

/// <param name="kwargDict">Dictionary of keyword argument name to python object pointer</param>

/// <param name="defaultArgList">A list of default values for omitted parameters</param>

/// <param name="needsResolution"><c>true</c>, if overloading resolution is required</param>

/// <param name="outs">Returns number of output parameters</param>

/// <returns>An array of .NET arguments, that can be passed to a method.</returns>

static object[] TryConvertArguments(ParameterInfo[] pi, bool paramsArray,

IntPtr args, int pyArgCount,

Dictionary<string, IntPtr> kwargDict,

ArrayList defaultArgList,

bool needsResolution,

out int outs)

{

outs = 0;

var margs = new object[pi.Length];

int arrayStart = paramsArray ? pi.Length - 1 : -1;

for (int paramIndex = 0; paramIndex < pi.Length; paramIndex++)

{

var parameter = pi[paramIndex];

bool hasNamedParam = kwargDict.ContainsKey(parameter.Name);

if (paramIndex >= pyArgCount && !hasNamedParam)

{

if (defaultArgList != null)

{

margs[paramIndex] = defaultArgList[paramIndex - pyArgCount];

}

continue;

}

IntPtr op;

if (hasNamedParam)

{

op = kwargDict[parameter.Name];

}

else

{

op = (arrayStart == paramIndex)

// map remaining Python arguments to a tuple since

// the managed function accepts it - hopefully :]

? Runtime.PyTuple_GetSlice(args, arrayStart, pyArgCount)

: Runtime.PyTuple_GetItem(args, paramIndex);

}

bool isOut;

if (!TryConvertArgument(op, parameter.ParameterType, needsResolution, out margs[paramIndex], out isOut))

{

return null;

}

if (arrayStart == paramIndex)

{

// TODO: is this a bug? Should this happen even if the conversion fails?

// GetSlice() creates a new reference but GetItem()

// returns only a borrow reference.

Runtime.XDecref(op);

}

if (parameter.IsOut || isOut)

{

outs++;

}

return margs;

}

static bool TryConvertArgument(IntPtr op, Type parameterType, bool needsResolution,

out object arg, out bool isOut)

{

arg = null;

isOut = false;

var clrtype = TryComputeClrArgumentType(parameterType, op, needsResolution: needsResolution);

if (clrtype == null)

{

return false;

}

if (!Converter.ToManaged(op, clrtype, out arg, false))

{

Exceptions.Clear();

return false;

}

isOut = clrtype.IsByRef;

return true;

}

static Type TryComputeClrArgumentType(Type parameterType, IntPtr argument, bool needsResolution)

{

// this logic below handles cases when multiple overloading methods

// are ambiguous, hence comparison between Python and CLR types

// is necessary

Type clrtype = null;

IntPtr pyoptype;

if (needsResolution)

{

// HACK: each overload should be weighted in some way instead

pyoptype = Runtime.PyObject_Type(argument);

Exceptions.Clear();

if (pyoptype != IntPtr.Zero)

{

clrtype = Converter.GetTypeByAlias(pyoptype);

}

Runtime.XDecref(pyoptype);

}

if (clrtype != null)

{

var typematch = false;

if ((parameterType != typeof(object)) && (parameterType != clrtype))

{

IntPtr pytype = Converter.GetPythonTypeByAlias(parameterType);

pyoptype = Runtime.PyObject_Type(argument);

Exceptions.Clear();

if (pyoptype != IntPtr.Zero)

{

if (pytype != pyoptype)

{

typematch = false;

}

else

{

typematch = true;

clrtype = parameterType;

}

if (!typematch)

{

// this takes care of enum values

TypeCode argtypecode = Type.GetTypeCode(parameterType);

TypeCode paramtypecode = Type.GetTypeCode(clrtype);

if (argtypecode == paramtypecode)

{

typematch = true;

clrtype = parameterType;

}

Runtime.XDecref(pyoptype);

if (!typematch)

{

return null;

}

else

{

typematch = true;

clrtype = parameterType;

}

else

{

clrtype = parameterType;

}

return clrtype;

}

static bool MatchesArgumentCount(int positionalArgumentCount, ParameterInfo[] parameters,

Dictionary<string, IntPtr> kwargDict,

out bool paramsArray,

out ArrayList defaultArgList)

{

defaultArgList = null;

var match = false;

paramsArray = false;

if (positionalArgumentCount == parameters.Length)

{

match = true;

}

else if (positionalArgumentCount < parameters.Length)

{

// every parameter past 'positionalArgumentCount' must have either

// a corresponding keyword argument or a default parameter

match = true;

defaultArgList = new ArrayList();

for (var v = positionalArgumentCount; v < parameters.Length; v++)

{

if (kwargDict.ContainsKey(parameters[v].Name))

{

// we have a keyword argument for this parameter,

// no need to check for a default parameter, but put a null

// placeholder in defaultArgList

defaultArgList.Add(null);

}

else if (parameters[v].IsOptional)

{

// IsOptional will be true if the parameter has a default value,

// or if the parameter has the [Optional] attribute specified.

// The GetDefaultValue() extension method will return the value

// to be passed in as the parameter value

defaultArgList.Add(parameters[v].GetDefaultValue());

}

else

{

match = false;

}

else if (positionalArgumentCount > parameters.Length && parameters.Length > 0 &&

Attribute.IsDefined(parameters[parameters.Length - 1], typeof(ParamArrayAttribute)))

{

// This is a `foo(params object[] bar)` style method

match = true;

paramsArray = true;

}

return match;

}

internal virtual IntPtr Invoke(IntPtr inst, IntPtr args, IntPtr kw)

{

return Invoke(inst, args, kw, null, null);

}

internal virtual IntPtr Invoke(IntPtr inst, IntPtr args, IntPtr kw, MethodBase info)

{

return Invoke(inst, args, kw, info, null);

}

internal virtual IntPtr Invoke(IntPtr inst, IntPtr args, IntPtr kw, MethodBase info, MethodInfo[] methodinfo)

{

Binding binding = Bind(inst, args, kw, info, methodinfo);

object result;

IntPtr ts = IntPtr.Zero;

if (binding == null)

{

var value = new StringBuilder("No method matches given arguments");

if (methodinfo != null && methodinfo.Length > 0)

{

value.Append($" for {methodinfo[0].Name}");

}

long argCount = Runtime.PyTuple_Size(args);

value.Append(": (");

for(long argIndex = 0; argIndex < argCount; argIndex++) {

var arg = Runtime.PyTuple_GetItem(args, argIndex);

if (arg != IntPtr.Zero) {

var type = Runtime.PyObject_Type(arg);

if (type != IntPtr.Zero) {

try {

var description = Runtime.PyObject_Unicode(type);

if (description != IntPtr.Zero) {

value.Append(Runtime.GetManagedString(description));

Runtime.XDecref(description);

}

} finally {

Runtime.XDecref(type);

}

if (argIndex + 1 < argCount)

value.Append(", ");

}

value.Append(')');

Exceptions.SetError(Exceptions.TypeError, value.ToString());

return IntPtr.Zero;

}

if (allow_threads)

{

ts = PythonEngine.BeginAllowThreads();

}

try

{

result = binding.info.Invoke(binding.inst, BindingFlags.Default, null, binding.args, null);

}

catch (Exception e)

{

if (e.InnerException != null)

{

e = e.InnerException;

}

if (allow_threads)

{

PythonEngine.EndAllowThreads(ts);

}

Exceptions.SetError(e);

return IntPtr.Zero;

}

if (allow_threads)

{

PythonEngine.EndAllowThreads(ts);

}

// If there are out parameters, we return a tuple containing

// the result followed by the out parameters. If there is only

// one out parameter and the return type of the method is void,

// we return the out parameter as the result to Python (for

// code compatibility with ironpython).

var mi = (MethodInfo)binding.info;

if (binding.outs == 1 && mi.ReturnType == typeof(void))

{

}

if (binding.outs > 0)

{

ParameterInfo[] pi = mi.GetParameters();

int c = pi.Length;

var n = 0;

IntPtr t = Runtime.PyTuple_New(binding.outs + 1);

IntPtr v = Converter.ToPython(result, mi.ReturnType);

Runtime.PyTuple_SetItem(t, n, v);

n++;

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

{

Type pt = pi[i].ParameterType;

if (pi[i].IsOut || pt.IsByRef)

{

v = Converter.ToPython(binding.args[i], pt);

Runtime.PyTuple_SetItem(t, n, v);

n++;

}

if (binding.outs == 1 && mi.ReturnType == typeof(void))

{

v = Runtime.PyTuple_GetItem(t, 1);

Runtime.XIncref(v);

Runtime.XDecref(t);

return v;

}

return t;

}

return Converter.ToPython(result, mi.ReturnType);

}

/// <summary>

/// Utility class to sort method info by parameter type precedence.

/// </summary>

internal class MethodSorter : IComparer

{

int IComparer.Compare(object m1, object m2)

{

var me1 = (MethodBase)m1;

var me2 = (MethodBase)m2;

if (me1.DeclaringType != me2.DeclaringType)

{

// m2's type derives from m1's type, favor m2

if (me1.DeclaringType.IsAssignableFrom(me2.DeclaringType))

return 1;

// m1's type derives from m2's type, favor m1

if (me2.DeclaringType.IsAssignableFrom(me1.DeclaringType))

return -1;

}

int p1 = MethodBinder.GetPrecedence((MethodBase)m1);

int p2 = MethodBinder.GetPrecedence((MethodBase)m2);

if (p1 < p2)

{

return -1;

}

if (p1 > p2)

{

return 1;

}

return 0;

}

/// <summary>

/// A Binding is a utility instance that bundles together a MethodInfo

/// representing a method to call, a (possibly null) target instance for

/// the call, and the arguments for the call (all as managed values).

/// </summary>

internal class Binding

{

public MethodBase info;

public object[] args;

public object inst;

public int outs;

internal Binding(MethodBase info, object inst, object[] args, int outs)

{

this.info = info;

this.inst = inst;

this.args = args;

this.outs = outs;

}

static internal class ParameterInfoExtensions

{

public static object GetDefaultValue(this ParameterInfo parameterInfo)

{

// parameterInfo.HasDefaultValue is preferable but doesn't exist in .NET 4.0

bool hasDefaultValue = (parameterInfo.Attributes & ParameterAttributes.HasDefault) ==

ParameterAttributes.HasDefault;

if (hasDefaultValue)

{

return parameterInfo.DefaultValue;

}

else

{

// [OptionalAttribute] was specified for the parameter.

// See https://stackoverflow.com/questions/3416216/optionalattribute-parameters-default-value

// for rules on determining the value to pass to the parameter

var type = parameterInfo.ParameterType;

if (type == typeof(object))

return Type.Missing;

else if (type.IsValueType)

return Activator.CreateInstance(type);

else

return null;

}

pythonnet/src/runtime/methodbinder.cs at master · RXDSolutions/pythonnet · GitHub

Repository navigation

Expand file tree

Breadcrumbs

methodbinder.cs

Latest commit

History

Breadcrumbs

methodbinder.cs

File metadata and controls