pydwshape
A per-lookup OpenType shaping tracer for BabelMap's OpenType test framework — the DirectWrite analogue of its HarfBuzz/HarfRust engines.
Two engines:
backend="dwcore"(default on Windows) — shapes entirely with Microsoft DWriteCore (app-local, version-pinned); returns the babelsoft/api/opentype/shaperesult dict including the per-lookup glyph-mutation trace. No systemdwrite.dll/TextShaping.dllis loaded and no subprocess is spawned — the Rust engine runs in-process via this PyO3 abi3 extension.backend="winedwrite"(cross-platform) — the bundled Wine DWrite port (tools/wine_dwrite), loaded in-process via ctypes; no DWriteCore.
The Wine backend makes the package usable on Linux/macOS too (see the "Cross-platform Wine backend" section below).
Requires
- Windows 10 1809+ (x64) for
backend="dwcore"(native DWriteCore) - any OS for
backend="winedwrite"(bundled Wine DWrite port) - CPython 3.9+ (any 3.9+ interpreter; wheel tags
cp39-abi3-*)
The package imports on any OS; backend="dwcore" raises on non-Windows (it
needs the native DWriteCore engine). Use backend="winedwrite" elsewhere.
Install
pip install pydwshape
Usage
from pydwshape import shape_with_dwrite
font = open("font.otf", "rb").read()
res = shape_with_dwrite(font, "ᠰᠠᠢᠬᠠᠨ") # script omitted -> auto-detected
res = shape_with_dwrite(font, "ᠰᠠᠢᠬᠠᠨ", script="mong") # explicit
# res = {upem, glyph_count, stages:[{m,glyphs,depth,effective}], final, messages, engine}
script may be omitted (auto/empty behave the same): the script number is
auto-detected from the text using DWriteCore's own Unicode script data
(Common/Inherited/combining marks inherit from context).
features is a {tag: bool} map (same convention as the HarfBuzz/harfrust
engines): optional features toggle ({"smcp": True}, {"liga": False} …);
script-required features (Mongolian/Arabic init/medi/fina/rclt …) are fixed
by DWriteCore and cannot be disabled.
Constraints
- Single-threaded by design: the per-lookup trace comes from a process-local hook that is installed per call and restored afterwards (the GIL serialises calls from Python, so repeated calls are safe).
- The hook is signature-locked to the bundled DWriteCore build (2.1.1.2605) with automatic relocation by prologue scan for newer builds.
Provenance / licensing
- Our Rust/Python code: MIT (see the source repository).
- Bundled
DWriteCore.dllis Microsoft software from the Windows App SDK (Microsoft.WindowsAppSDK.DWrite), redistributed under Microsoft's license terms for that component; the DLL is Microsoft-signed and unmodified.
Build (maintainers, Windows)
# stage the MS-signed DWriteCore.dll (from build/dwc_poc or the Windows App SDK NuGet)
Copy-Item build\dwc_poc\DWriteCore.dll python\pydwshape-wheel\python\pydwshape\DWriteCore.dll
cd python\pydwshape-wheel
python -m pip install maturin
python -m maturin build --release --interpreter <python> -o dist
Cross-platform Wine backend (v0.2.0+)
Since 0.2.0 the wheel also bundles the Wine DWrite port
(tools/wine_dwrite) as a second, cross-platform engine:
res = shape_with_dwrite(font, text, backend="dwcore") # default, Windows: native DWriteCore
res = shape_with_dwrite(font, text, backend="winedwrite") # Wine DWrite port, cross-platform
backend="dwcore"is unchanged (Windows x64 only, bundled DWriteCore.dll).backend="winedwrite"loads the bundled Wine DWrite port shared library (winedwrite.dll/libwinedwrite.so/libwinedwrite.dylib) in-process via ctypes — no DWriteCore, no system DirectWrite. Script is auto-detected from the text; the per-lookup trace is genuine; Mongolian converges byte-identically to DWriteCore on the hudum corpus.- On non-Windows the package imports fine; only
backend="dwcore"raises (it needs the Windows DWriteCore native engine). SetWDWRITE_LIBto point at an existing build to override the bundled library.
Building the wheel
Windows (builds the Wine port, bundles winedwrite.dll + DWriteCore.dll,
then maturin):
powershell -NoProfile -ExecutionPolicy Bypass -File build.ps1
Linux / macOS (builds the Wine port as a shared lib, bundles it, then maturin; the dwcore backend is not included on these platforms):
bash build.sh # requires cc + make + maturin
License note: the bundled Wine DWrite port is LGPL-2.1-or-later; see
python/pydwshape/NOTICE.md in the wheel.
Metadata
Release files for pydwshape 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pydwshape-0.4.0-cp39-abi3-win_amd64.whl | CPython 3.9 | abi3 | Windows x86-64 | Details for pydwshape-0.4.0-cp39-abi3-win_amd64.whl |
Release files / pydwshape-0.4.0-cp39-abi3-win_amd64.whl
| Download URL | pydwshape-0.4.0-cp39-abi3-win_amd64.whl |
|---|---|
| Size | 1.8 MB |
| Tags | CPython 3.9 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
2ab16250329d651a28d7805c842ce579b40459cafa67f623867a60e33c92f8f2
|
|
BLAKE2b-256 checksum How to use checksums |
9f10482eccf850b3c985eab8766baf850d29a698bd4f971b0167bc7981516114
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency logSecurity for pydwshape 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
1 file in this release has been uploaded with provenance metadata.
Attestation for pydwshape-0.4.0-cp39-abi3-win_amd64.whl
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.