Pre-release

This release is a pre-release and may not be stable for production use.

sublime-text-stubs

PEP 561 typing stubs for the Sublime Text plugin API, covering the sublime, sublime_plugin and sublime_types modules.

The stubs carry the API documentation as docstrings, so hovering a symbol in an editor shows the same prose as the official API reference.

Sublime Text exposes these modules only inside its own embedded interpreter, so they cannot be imported or introspected from a normal Python environment. Installing this package as a dev dependency gives type checkers and editors something to resolve them against.

Installation

uv add --dev sublime-text-stubs
# or
pip install --upgrade sublime-text-stubs

Versioning

Versions follow the scheme 1.${st_build_version}.${patch}:

Version Sublime Text build Embedded Python
1.4200.* 4200 (stable) 3.8
1.4206.* 4206 (dev) 3.14

The leading 1 is the schema version of this package itself, the middle segment is the Sublime Text build the stubs describe, and the trailing segment is the patch level within that build. This is deliberately not semantic versioning.

Pin the build you target:

sublime-text-stubs = "==1.4200.*"

Sublime Text 4 also still ships a legacy Python 3.3 runtime. It is scheduled for removal and is not targeted by this package.

Notes for plugin authors

  • Commands do not declare run. Sublime Text invokes it with command-specific keyword arguments, so the stubs leave the signature to your subclass. Write def run(self, **kwargs), or def run(self, edit, **kwargs) for a TextCommand.
  • is_enabled, is_visible, is_checked and description receive their command arguments the same dynamic way, but they are declared without parameters, exactly as Sublime Text declares them. def is_enabled(self), def is_enabled(self, my_arg="") and def is_enabled(self, **kwargs) all type-check. A required parameter is rejected, and that rejection is correct: such an override also raises TypeError at runtime when the command is invoked without that argument.
  • TextChangeListener.buffer is sublime.Buffer, not Buffer | None. The plugin host attaches the listener immediately after constructing it, so no handler can observe the unattached state.
  • sublime_types.ModifierKeys exists only in these stubs, as the type of the modifier_keys entry of an Event. Import it inside an if TYPE_CHECKING: block, since the real module has no such name at runtime.

The stubs are validated by type-checking sample consumer code, not against the running editor, so divergences from the actual runtime API are possible. Please report any you find.

Contributing

See CONTRIBUTING.md for the project structure, how the stubs are generated and validated, and how to correct them.

License

Not yet chosen. See LICENSE.

Project links

Data verified by PyPI on Aug 2, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.4200.0b2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for FichteFoll from gravatar.com FichteFoll

Credits

Author: FichteFoll

GitHub Statistics

Data verified by PyPI on Aug 2, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python >=3.8

Tags

pep561 stubs sublime-text typing

Classifiers

Report project as malware

Download files

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

Source Distribution

sublime_text_stubs-1.4200.0b1.tar.gz (55.8 kB view details)

Uploaded Source

Built Distribution

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

sublime_text_stubs-1.4200.0b1-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file sublime_text_stubs-1.4200.0b1.tar.gz.

File metadata

  • Download URL: sublime_text_stubs-1.4200.0b1.tar.gz
  • Upload date:
  • Size: 55.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sublime_text_stubs-1.4200.0b1.tar.gz
Algorithm Hash digest
SHA256 79a84e1cfa373bcf0f822bd0b36db4c517abbe0729e50c50a77e839ba754103d
MD5 734dbac73485a7bc797fa291b6ed74bd
BLAKE2b-256 16d78db77b7bb6473a001cfffbc4ee340197801c256c5731ceee91f9a34a3b9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sublime_text_stubs-1.4200.0b1.tar.gz:

Publisher: release.yml on SublimeText/sublime-text-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 sublime_text_stubs-1.4200.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for sublime_text_stubs-1.4200.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 56965fd12d16284afa36df3eac06a495c1ca58a61f6f4052dc0bd44eeece355b
MD5 978268b7e9b19f41d47e697c3043e269
BLAKE2b-256 4ebfcf6637761e7527e52f68a3d7865a09b8678bfb11e0ab8ce6f633c2775fe1

See more details on using hashes here.

Provenance

The following attestation bundles were made for sublime_text_stubs-1.4200.0b1-py3-none-any.whl:

Publisher: release.yml on SublimeText/sublime-text-stubs

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

Release history Release notifications | RSS feed

Pre-release

1.4200.0b2

2 files

This release
Pre-release

1.4200.0b1 This release

2 files

Supported by

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