[](https://badge.fury.io/py/types-wxpython)
# Typing stubs for wxPython
Version: wxPython 4.2.0
This package contains typing stubs for [wxPython](https://pypi.org/project/wxPython/).
This package is not maintained by the wxPython maintainers. It is maintained by users of wxPython.
Any help is always appreciated.
## How it works
The base for the stubs is generated from [docs.wxpython.org](https://docs.wxpython.org/). It crawls the documentation looking for Python classes, functions, and literals. This means that changes in the documentation are automatically reflected in the stubs when they are regenerated.
We do not manually update anything in the `wx-stubs' folder. Everything is generated by the generator.
Run `run.bat`/`run.sh` to generate the stubs.
### Overrides
Because we generated things based on online information, sometimes we have to resort to guessing, or sometimes the online documentation does not contain certain information. To fix these problems, we can override the typing.
You can find the overrides in [`generator/overrides.py`](https://github.com/AlexionSoftware/types-wxpython/blob/main/generator/overrides.py).
In this file you can override any parameter by specifying the key and the parameter you want to override. You can change the typing of any class, function, or literal. These are applied after the typing is retrieved from the online documentation.
To update the stubs run: `run.bat`. This will result in newly updated stubs in the `wx-stubs` folder.
### Missing
The online documentation may be incomplete, or sometimes we just can't understand the page. In these cases, we can add typing to the stubs.
You can find this file in [`generator/extras.py`](https://github.com/AlexionSoftware/types-wxpython/blob/main/generator/extras.py).
Here you can add any missing typing.
To update the stubs run: `run.bat`. This will result in newly updated stubs in the `wx-stubs` folder.
## Help is appreciated
We started this project because we use wxPython ourselves and code typing is really helpful for finding bugs.
But there is so much in wxPython. We fixed problems in the stubs as they came up in our code. This can cause things to not work for your code.
We have decided to open source the work we have put into creating the best wxPython typing there is.
We want you to help. You can create an issue if you find problems with the typing. Or create a pull request if you have fixed something.
### Guidelines
* You don't need to commit newly generated stubs to your PR. We will generate them when we release a new version of the stubs.
Raw data
{
"_id": null,
"home_page": "https://github.com/AlexionSoftware/types-wxpython",
"name": "types-wxpython",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "wxPython,typing,stubs,wx",
"author": "Alexion Software",
"author_email": "info@alexion.nl",
"download_url": "https://files.pythonhosted.org/packages/e7/46/68d32c278fe545e8301c17adf255055a377ab7144bee19be6343f2a21224/types_wxpython-0.9.6.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/types-wxpython)\n\n\n\n\n\n# Typing stubs for wxPython\nVersion: wxPython 4.2.0\n\nThis package contains typing stubs for [wxPython](https://pypi.org/project/wxPython/).\n\nThis package is not maintained by the wxPython maintainers. It is maintained by users of wxPython.\n\nAny help is always appreciated.\n\n## How it works\nThe base for the stubs is generated from [docs.wxpython.org](https://docs.wxpython.org/). It crawls the documentation looking for Python classes, functions, and literals. This means that changes in the documentation are automatically reflected in the stubs when they are regenerated.\n\nWe do not manually update anything in the `wx-stubs' folder. Everything is generated by the generator.\n\nRun `run.bat`/`run.sh` to generate the stubs.\n\n### Overrides\nBecause we generated things based on online information, sometimes we have to resort to guessing, or sometimes the online documentation does not contain certain information. To fix these problems, we can override the typing.\n\nYou can find the overrides in [`generator/overrides.py`](https://github.com/AlexionSoftware/types-wxpython/blob/main/generator/overrides.py).\n\nIn this file you can override any parameter by specifying the key and the parameter you want to override. You can change the typing of any class, function, or literal. These are applied after the typing is retrieved from the online documentation.\n\nTo update the stubs run: `run.bat`. This will result in newly updated stubs in the `wx-stubs` folder.\n\n### Missing\nThe online documentation may be incomplete, or sometimes we just can't understand the page. In these cases, we can add typing to the stubs.\n\nYou can find this file in [`generator/extras.py`](https://github.com/AlexionSoftware/types-wxpython/blob/main/generator/extras.py).\n\nHere you can add any missing typing.\n\nTo update the stubs run: `run.bat`. This will result in newly updated stubs in the `wx-stubs` folder.\n\n## Help is appreciated\nWe started this project because we use wxPython ourselves and code typing is really helpful for finding bugs.\nBut there is so much in wxPython. We fixed problems in the stubs as they came up in our code. This can cause things to not work for your code.\n\nWe have decided to open source the work we have put into creating the best wxPython typing there is.\nWe want you to help. You can create an issue if you find problems with the typing. Or create a pull request if you have fixed something.\n\n### Guidelines\n* You don't need to commit newly generated stubs to your PR. We will generate them when we release a new version of the stubs.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Typing stubs for wxPython",
"version": "0.9.6",
"project_urls": {
"Homepage": "https://github.com/AlexionSoftware/types-wxpython",
"Repository": "https://github.com/AlexionSoftware/types-wxpython"
},
"split_keywords": [
"wxpython",
"typing",
"stubs",
"wx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7a6a02601425ff37657edd255b54d9568ad88a851c2c4789a600e02ca8df4f6",
"md5": "f9973aeb2b699726701851c45ec36f0c",
"sha256": "7cef433e6a6926a57bb6f059aec8e4e503953eadd9e4cdc0692c336fd30d0378"
},
"downloads": -1,
"filename": "types_wxpython-0.9.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9973aeb2b699726701851c45ec36f0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 531352,
"upload_time": "2024-01-26T13:54:56",
"upload_time_iso_8601": "2024-01-26T13:54:56.603823Z",
"url": "https://files.pythonhosted.org/packages/f7/a6/a02601425ff37657edd255b54d9568ad88a851c2c4789a600e02ca8df4f6/types_wxpython-0.9.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e74668d32c278fe545e8301c17adf255055a377ab7144bee19be6343f2a21224",
"md5": "c6f7beef2d77f10005e4565532574e85",
"sha256": "0ca49a7249234160f45194a2d12254d11a13049550a52022d5c80248b4415f66"
},
"downloads": -1,
"filename": "types_wxpython-0.9.6.tar.gz",
"has_sig": false,
"md5_digest": "c6f7beef2d77f10005e4565532574e85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 495210,
"upload_time": "2024-01-26T13:54:58",
"upload_time_iso_8601": "2024-01-26T13:54:58.607398Z",
"url": "https://files.pythonhosted.org/packages/e7/46/68d32c278fe545e8301c17adf255055a377ab7144bee19be6343f2a21224/types_wxpython-0.9.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 13:54:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AlexionSoftware",
"github_project": "types-wxpython",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "types-wxpython"
}
JSON
