Skip to content

Modernize type hints #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
deathaxe wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Modernize type hints #184

deathaxe wants to merge 6 commits into from

Conversation

@deathaxe
Copy link
Member

@deathaxe deathaxe commented Jan 11, 2026 •
edited
Loading

This PR...

  1. updates stubs from ST4202, primarily to be able to run mypy.
  2. updates typehints to a more modern format (AFAIK python 3.9+ format), which is possible due to type hints being excluded from runtime evaluation and type checkers likely running on more modern python.

There are some mypy errors, which may require further investigation about how to fix...

Example:

sublime_lib\view_stream.py:39: error: Self argument missing for a non-static method (or an invalid type for self)  [misc]

@deathaxe
Update stubs
564e4c0 
Update sublime API stubs from ST4202.
@deathaxe
Modernize type hints
4093705 
This commit sorts some imports and modernizes type hints.
FichteFoll
FichteFoll requested changes Jan 11, 2026
View reviewed changes
Copy link
Member

@FichteFoll FichteFoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these the official stubs from the ST distribution?

@deathaxe
Copy link
Member Author

deathaxe commented Jan 11, 2026

Took original sublime.py and sublime_types.py, modified type hints to more modern format and added additional hints to satisfy mypy. Existing sublime_plugin.pyi was extended by missing classes and methods from official sublime_plugin.py

@deathaxe
Use sublime.Value in SettingsDict
8763c59 
This commit re-uses ST4's `Value` type instead of defining its own duplicate.

Note: adjusts missed import sort order
@deathaxe
Fix YamlScalar type alias definition
bfd9d07
@deathaxe
Use sublime_types.Value
eb95b42 
satisfy mypy as sublime does not export Value, explicitly.
FichteFoll
FichteFoll reviewed Jan 11, 2026
View reviewed changes
@FichteFoll
Copy link
Member

FichteFoll commented Jan 11, 2026

Perhaps we should add a mypy job to our PR lint workflow.

@deathaxe
Can't use sublime_types
156bd14 
It is not supported by ST4107
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@FichteFoll FichteFoll FichteFoll requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@deathaxe @FichteFoll