c# - 如何在 python 中调试 win32com 调用

Question

为了收集日志脚本的输出，我想使用 onepy将信息添加到 OneNote 2013 笔记本。不幸的是，onepy 提供的方法 update_page_content() 对我不起作用。为了更深入地了解这个问题，我切换到 C#，其中存在许多 OneNote API 的在线示例，并且在一些 trouble 之后我设法使以下简约 C# 示例起作用:

using System;
using OneNote = Microsoft.Office.Interop.OneNote;

class Program
{
    static void Main(string[] args)
    {
        OneNote.Application onenoteApp = new OneNote.Application();
        string xml = "<one:Page xmlns:one=\"http://schemas.microsoft.com/office/onenote/2013/onenote\" ...> ... </one:Page>";
        onenoteApp.UpdatePageContent(xml, DateTime.MinValue);
    }
}

字符串 xml 是通过修改 XML 文档获得的，该文档是使用 GetPageContent 方法从 OneNote 中检索到的，如我链接的上一个问题中所述。 xml 的精确内容对于这个问题来说并不重要，唯一重要的是上面的程序一次又一次地运行没有问题，并且对现有 OneNote 页面的更改总是成功执行。

现在转向 Python，我尝试在不进行实质性更改的情况下翻译我的简约程序。我的结果如下所示:

import win32com
import pytz
import datetime

onenote_app = win32com.client.Dispatch('OneNote.Application.15')
xml = "<one:Page xmlns:one=\"http://schemas.microsoft.com/office/onenote/2013/onenote\" ...> ... </one:Page>"
date = pytz.utc.localize(datetime.datetime.fromordinal(1))
onenote_app.UpdatePageContent(xml, date)

我试着非常小心地为两个变量使用相同的值。当然，这两个字符串 xml 的内容是相同的(复制和粘贴)。此外，根据 VS2015 调试器，DateTime.MinValue 和 date 指的是同一日期。然而，当我执行 python 程序时，我收到了这个非常无用的错误。

    135         def UpdatePageContent(self, bstrPageChangesXmlIn=defaultNamedNotOptArg, dateExpectedLastModified=(1899, 12, 30, 0, 0, 0, 5, 364, 0), xsSchema=2, force=False):
    136         return self._oleobj_.InvokeTypes(1610743816, LCID, 1, (24, 0), ((8, 1), (7, 49), (3, 49), (11, 49)),bstrPageChangesXmlIn
--> 137             , dateExpectedLastModified, xsSchema, force)
    138 
    139     _prop_map_get_ = {

com_error: (-2147352567, 'Exception occurred.', (0, None, None, None, 0, -2147213296), None)

据我了解，C# 和 Python 实际上都使用相同的库来执行它们的调用(都称为 Microsoft OneNote 15.0 Object Library)。所以原则上这两个程序应该都能正常工作。如果我在这一点上没有弄错的话，我会因此假设 Python 在调用库时做了一些不同的事情。我怎样才能进一步追踪这里的实际问题是什么？有没有办法使用 Visual Studio 2015 的内置 Python 支持来更好地理解 C# 和 Python 代码之间的区别？

Answer 1

正如 jayongg 已经在他的 answer 中指出的那样，我的问题是日期作为参数传递给 UpdatePageContent() 调用。但是，他建议将零作为最后修改日期并禁用日期检查，详见 documentation并不像看起来那么简单。在我的回答中，我将详细说明我遇到的所有陷阱。

第一个问题显示在this中。问题。例如，如果尝试将 datetime 对象或普通整数传递给 UpdatePageContent()，则会引发如下错误。

    135         def UpdatePageContent(self, bstrPageChangesXmlIn=defaultNamedNotOptArg, dateExpectedLastModified=(1899, 12, 30, 0, 0, 0, 5, 364, 0), xsSchema=2, force=False):
    136         return self._oleobj_.InvokeTypes(1610743816, LCID, 1, (24, 0), ((8, 1), (7, 49), (3, 49), (11, 49)),bstrPageChangesXmlIn
--> 137             , dateExpectedLastModified, xsSchema, force)
    138 
    139     _prop_map_get_ = {

ValueError: astimezone() cannot be applied to a naive datetime

特别是，将日期参数留空并使用默认值不会按预期工作:

    135         def UpdatePageContent(self, bstrPageChangesXmlIn=defaultNamedNotOptArg, dateExpectedLastModified=(1899, 12, 30, 0, 0, 0, 5, 364, 0), xsSchema=2, force=False):
    136         return self._oleobj_.InvokeTypes(1610743816, LCID, 1, (24, 0), ((8, 1), (7, 49), (3, 49), (11, 49)),bstrPageChangesXmlIn
--> 137             , dateExpectedLastModified, xsSchema, force)
    138 
    139     _prop_map_get_ = {

TypeError: must be a pywintypes time object (got tuple)

显然，python API 调用的一些内部机制被搞乱了。如果按照 onepy project page 上的说明进行操作并使用 makepy 预先生成 API 包装器，然后可以检查负责这些调用的源文件，但至少对我来说这不是很有指导意义。我怀疑 InvokeTypes 方法试图将传递的日期放入 API 可以理解的格式，但 Python 包装器本身并未实现必要的要求。

幸运的是，有一个非常简单的解决方法。诀窍是使传递的 datetime 对象具有时区意识。为此，必须先将其本地化。例如，这可以使用 pytz 模块来完成。

import datetime
import pytz

date = pytz.utc.localize(datetime.datetime.fromordinal(1))

有了这些知识，API 调用就可以工作，但是我的问题中出现了 COM 错误。这就是 jayongg 的答案所在:我必须将零作为上次修改日期传递(或者我需要知道最后一次修改发生的日期，这也应该有效)。现在棘手的问题是:什么是零？

在我的 C# 代码中，此日期由 DateTime.MinValue 给出，根据 Visual Studio 2015 等于 0001-01-01 00:00:00。 Python 中的相同日期是 datetime.datetime.fromordinal(1)，但它仍然无法调用。我不得不怀疑 Visual Studio 提供的信息是错误的，或者两者之间发生了某种魔法，可能是类型转换 VSDate -> Int -> APIDate。

那么我如何找出要传递的正确零日期？事实证明答案已经存在，只需要知道去哪里寻找。如果在 Python API 包装器中进行检查，则会为相关参数提供默认值:

dateExpectedLastModified=(1899, 12, 30, 0, 0, 0, 5, 364, 0)

同样可以通过以下代码片段获得。

>> date = pytz.utc.localize(datetime.datetime(year=1899, month=12, day=30))
>> print(tuple(date.timetuple()))
(1899, 12, 30, 0, 0, 0, 5, 364, 0)

瞧，将变量日期传递给调用就可以了。

>> onenote_app.UpdatePageContent(xml, date)
>>

很有道理，对吧？我的意思是，除了 1899 年 12 月 30 日，你还会选择哪个日期？其实还是有些道理的。这一天是Dublin Julian Date零点前一天.根据德国Wikipedia article这一天被 Excel 用作日期的零点，因此 OneNote 做同样的事情听起来很合理。

为什么会有一天的差异？显然，1900 年被误认为是闰年，但事实并非如此。因此 1899-12-31 被转移到 1899-12-30，这是 API 想要的。叹。为什么关于如何存储日期有这么多不同的协议(protocol)？哦，只是提一下。 Office for Mac 使用 1904 作为零点。是的，当然。