Incrustar IronPython, comando de ayuda integrado, mis objetos CLR

Question

Estoy integrando IronPython (2.6.1) en un ensamblado C# y exponiendo varios objetos a scripts que se ejecutan con PythonEngine.ExecuteFile. Expongo ellos, ya sea con

scope.SetVariable("SomeObject", new SomeObject()) 

o

engine.Execute("from MyNamespace import SomeObject", scope) 

dependiendo de cómo los guiones los utilizan. Mi conjunto de aplicación se añade al motor con

engine.Runtime.LoadAssembly(Assembly.GetExecutingAssembly()) 

Ahora un script puede ejecutar help(SomeObject) y volcar la pequeña información de ayuda (*), sin embargo es incompleta. Ninguno de los eventos o propiedades del objeto (público, por supuesto) aparece y muchos de los miembros 'incorporados' también faltan.

Aquí está la parte extraña; Si enciendo ipy.exe y ejecuto lo siguiente:

import sys 
sys.path.append('<location of my app>') 
import clr 
clr.AddReferenceToFile('myapp.exe') 
from MyNamespace import SomeObject 
help(SomeObject) 

¡Obtengo un volcado diferente, completo con todos los miembros que faltan!

¿Por qué las dos difieren?

Bono pregunta: Suponiendo que conseguir que funcione correctamente, es posible añadir un texto descriptivo en mis objetos CLR a la salida de la ayuda()? ¿Te gusta desde el script, en tus tipos nativos de python? Mi primera suposición fue la DescripciónAtributo, pero eso no funcionó.

(*) Obviamente, un script final y funcional no lo haría, pero es extremadamente útil al escribir/probar el script.

Respondido

Aquí es un programa de consola completa que ilustra la forma de importar el sitio que sustituye a la ayuda interna usless() con el estándar ayuda biblioteca de Python().

using System; 
using System.Collections.Generic; 
using System.Reflection; 
using IronPython.Hosting; 
using IronPython.Runtime; 
using Microsoft.Scripting.Hosting.Providers; 

namespace MyApp 
{ 
    class Program 
    { 
     static void Main(string[] args) 
     { 
      // Work around issue w/ pydoc - piping to more doesn't work so instead indicate that we're a dumb terminal 
      if (Environment.GetEnvironmentVariable("TERM") == null) 
       Environment.SetEnvironmentVariable("TERM", "dumb"); 

      var engine = Python.CreateEngine(); 

      // Add standard Python library path (is there a better way to do this??) 
      PythonContext context = HostingHelpers.GetLanguageContext(engine) as PythonContext; 
      ICollection<string> paths = context.GetSearchPaths(); 
      paths.Add(@"C:\Program Files (x86)\IronPython 2.6\Lib"); 
      context.SetSearchPaths(paths); 

      // Import site module 
      engine.ImportModule("site"); 

      engine.Runtime.LoadAssembly(Assembly.GetEntryAssembly()); 

      var scope = engine.CreateScope(); 
      scope.SetVariable("SomeObject", new SomeObject()); 
      engine.Execute("help(SomeObject)", scope); 
     } 
    } 

    /// <summary> 
    /// Description of SomeObject. 
    /// </summary> 
    public class SomeObject 
    { 
     /// <summary> 
     /// Description of SomeProperty. 
     /// </summary> 
     public int SomeProperty { get; set; } 
     /// <summary> 
     /// Description of SomeMethod. 
     /// </summary> 
     public void SomeMethod() { } 
     /// <summary> 
     /// Description of SomeEvent. 
     /// </summary> 
     public event EventHandler SomeEvent; 
    } 
} 

Answer 1

Supongo que en su aplicación no está importando la biblioteca estándar. IronPython incluye una función de ayuda incorporada y la biblioteca estándar incluye una función de ayuda que es instalada por site.py. Si se asegura de que la biblioteca estándar esté disponible cuando aloja e importa site.py cuando crea el motor, entonces debe obtener la ayuda de la biblioteca estándar. Dicho esto, es probable que sea un error o una característica que falta que la ayuda incorporada no documenta los eventos y las propiedades.

En cuanto a la documentación, sí, solo necesita usar los comentarios del doc de C# y compilar con la opción /doc:MyAssemblyName.xml. Si el archivo XML está en el mismo directorio que el ensamblado, IronPython leerá las cadenas de documentación y las proporcionará para los atributos doc que help() lee.