Вложение IronPython, встроенная команда справки, объекты CLR

Я внедряю IronPython (2.6.1) в сборку С# и выставляю несколько объектов скриптам, которые выполняются с помощью PythonEngine.ExecuteFile. Я выставляю их либо с помощью

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

или

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

в зависимости от того, как скрипты используют их. Моя прикладная сборка добавляется к движку с помощью

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

Теперь script может выполнить help(SomeObject) и выгрузить симпатичную небольшую справочную информацию (*), однако она неполная. Ни одно из событий или свойств объекта (публичное, конечно) не появляется, и многие из "встроенных" членов также отсутствуют.

Здесь нечетная часть; Если я запустил ipy.exe и выполнил следующее:

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

Я получаю другую дамп, в комплекте со всеми отсутствующими членами!

Почему эти два отличаются?

Бонусный вопрос: Предполагая, что я правильно его работаю, возможно ли добавить описательный текст на мои объекты CLR на вывод справки()? Как вы можете из script, в ваших родных типах python? Мое первое предположение было DescriptionAttribute, но это не сработало.

(*) Очевидно, что последний, рабочий script не сделал бы этого, но он чрезвычайно полезен при написании/тестировании script.

Ответил

Вот полная консольная программа, которая иллюстрирует, как импортировать сайт, который заменяет ненужную внутреннюю справку() со стандартной помощью библиотеки 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;
    }
}

Ответ 1

Я предполагаю, что в вашем приложении вы не импортируете стандартную библиотеку. IronPython включает встроенную функцию справки, а стандартная библиотека включает в себя вспомогательную функцию, которая устанавливается на сайте site.py. Если вы убедитесь, что стандартная библиотека доступна, когда вы размещаете и затем импортируете site.py при создании движка, вам необходимо получить стандартную библиотечную помощь. Это, как говорится, вероятно, ошибка или отсутствует функция, что встроенная справка не документирует события и свойства.

Что касается документации - да, вам просто нужно использовать комментарии к С# doc и построить с помощью параметра /doc:MyAssemblyName.xml. Если файл XML находится в том же каталоге, что и IronPython, он прочитает строки документа и предоставит им атрибуты doc, которые help() затем читают.