Skip to main content

Type stubs for FontForge's Python modules

Project description

fontforge-stubs

This package provides PEP 561 type stubs and docstrings for FontForge's Python modules:

  • fontforge
  • psMat

The stubs and docstrings were created by referencing the official FontForge Python Module documentation and -- when necessary -- the FontForge Python extension source code.

Motivation

FontForge provides powerful Python C extension modules. By nature, they do not contain typing information. Combined with inconsistent naming conventions and at times ambiguous documentation, FontForge Python scripting is unnecessarily arduous.

Perhaps you can relate to:

  • Never remembering if it's glyph.name, glyph.glyphName, or glyph.glyph_name
  • Reading the docs and still not knowing whether width is an int or a float
  • Parsing and re-parsing the documentation to figure out the structure of a feature-script-lang tuple

With type stubs, editors can provide autocompletion, and type checkers can identify errors previously only discovered when running your script with FontForge. Built-in documentation removes the need to constantly switch between your editor and external documentation -- further increasing productivity.

Installation

Install the package in your development environment:

pip install fontforge-stubs

Your editor/type-checker should automatically pick up the stubs.

Versioning and Compatibility

This project uses YYYY.MM.DD calendar versioning.

It aims to be compatible with FontForge 20230101 and later. Legacy and deprecated FontForge Python APIs are not officially supported.

Updates to the FontForge Python APIs since the latest offical release (currently 20251009) are kept in the fontforge-next branch until the next upstream release. If you are using a newer build, you may want to install from fontforge-next:

pip install git+https://github.com/chanicpanic/fontforge-stubs@fontforge-next

Contributing

If you find any issues with the type stubs, please open an issue and/or pull request.

License

This project is under the MIT License.

The stubs and docstrings in this project were closely derived from the FontForge source. In particular, fontforge.rst, psMat.rst, and python.c. See NOTICE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fontforge_stubs-2026.1.2.tar.gz (60.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fontforge_stubs-2026.1.2-py3-none-any.whl (62.5 kB view details)

Uploaded Python 3

File details

Details for the file fontforge_stubs-2026.1.2.tar.gz.

File metadata

  • Download URL: fontforge_stubs-2026.1.2.tar.gz
  • Upload date:
  • Size: 60.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fontforge_stubs-2026.1.2.tar.gz
Algorithm Hash digest
SHA256 fac4b98d2fd0aa650d1cbe13e9c32b13ca8cce04055d2a5dda5e51355c37f3f0
MD5 1118179e2c44fefe3cc5ac757ee69329
BLAKE2b-256 ad929171c93852072c680f8c693ee607a08fb8d05323d6d4385cf2d8ae118db2

See more details on using hashes here.

Provenance

The following attestation bundles were made for fontforge_stubs-2026.1.2.tar.gz:

Publisher: publish.yaml on chanicpanic/fontforge-stubs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fontforge_stubs-2026.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for fontforge_stubs-2026.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 80633b56411387012bb33fced0352c5046aa8320acca7fc88eafda06660ffc0e
MD5 adf2fa99819c07f739ce17758a7d0e6d
BLAKE2b-256 9d5c48cf5ead39bdd8ea86b0fc203291e3915a44156ec0237324ff0055ad2230

See more details on using hashes here.

Provenance

The following attestation bundles were made for fontforge_stubs-2026.1.2-py3-none-any.whl:

Publisher: publish.yaml on chanicpanic/fontforge-stubs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page