Skip to content

README.md

Latest commit

 

History

History
47 lines (36 loc) · 1.41 KB

README.md

File metadata and controls

47 lines (36 loc) · 1.41 KB
Raw

Generate Python bindings from a custom WinMD

This sample is a reusable template for metadata shipped outside the Windows SDK, including a private component, a vendor SDK, or an individual Windows App SDK package.

It demonstrates:

  • passing an explicit WinMD and reference set to dynwinrt-codegen;
  • generating a typed Python package with .pyi files and py.typed;
  • importing every generated module; and
  • inspecting public generated types and documentation.

Generate

.\generate.ps1 `
  -Winmd C:\path\to\Contoso.Component.winmd `
  -Namespace Contoso.Component `
  -RefList C:\path\to\references.txt `
  -Codegen ..\..\..\target\release\dynwinrt-codegen.exe

Limit generation to selected runtime classes when the namespace is large:

.\generate.ps1 `
  -Winmd C:\path\to\Contoso.Component.winmd `
  -Namespace Contoso.Component `
  -ClassName "Widget,WidgetOptions" `
  -RefList C:\path\to\references.txt

Each non-empty line in references.txt is an additional WinMD used for type resolution but not emitted.

Inspect

.\run.ps1 -Python C:\path\to\python.exe
.\run.ps1 -Python C:\path\to\python.exe -Symbol Widget

The default command imports every generated module and prints the first public symbols. Activation and method calls require the component that implements the WinMD to be installed, registered, or bootstrapped according to that component's deployment model.