87 lines
3.4 KiB
Plaintext
87 lines
3.4 KiB
Plaintext
Metadata-Version: 2.4
|
|
Name: micropython-stdlib-stubs
|
|
Version: 1.26.0.post3
|
|
Summary: Micropython stdlib is a reduced and augmented copy of typeshed's stdlib for use by MicroPython stub packages
|
|
Project-URL: homepage, https://github.com/josverl/micropython-stubs#micropython-stubs
|
|
Project-URL: documentation, https://micropython-stubs.readthedocs.io/
|
|
Project-URL: repository, https://github.com/josverl/micropython-stubs
|
|
Author-email: Jos Verlinde <josverl@users.noreply.github.com>
|
|
License-Expression: MIT
|
|
License-File: LICENSE.md
|
|
License-File: LICENSE_typeshed
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
Classifier: Programming Language :: Python :: Implementation :: MicroPython
|
|
Classifier: Topic :: Software Development :: Build Tools
|
|
Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
|
|
Classifier: Typing :: Stubs Only
|
|
Requires-Python: >=3.7
|
|
Description-Content-Type: text/markdown
|
|
|
|
# micropython-stdlib-stubs
|
|
A limited size copy of typesheds stdlib directory.
|
|
https://github.com/python/typeshed/tree/main/stdlib
|
|
|
|
This is used as a dependency in the micropython-*-stub packages to allow overriding of some of the stdlib modules with MicroPython specific implementations.
|
|
|
|
MicroPython specific updates to:
|
|
- collections
|
|
|
|
If you have suggestions or find any issues with the stubs, please report them in the [MicroPython-stubs Discussions](https://github.com/Josverl/micropython-stubs/discussions)
|
|
|
|
For an overview of Micropython Stubs please see: https://micropython-stubs.readthedocs.io/en/main/
|
|
* List of all stubs : https://micropython-stubs.readthedocs.io/en/main/firmware_grp.html
|
|
|
|
## Building
|
|
|
|
This is a short description of the steps taken to create or update the stubs for the micropython-stdlib-stubs distribution.
|
|
this package is built using `uv build` and published using `uv publish`.
|
|
|
|
## There are two possible reasons to rebuild
|
|
1. Rebuild in order to update from the reference-stubs or ducument-stubs. This will use the same typeshed stubs, and infuse or enrich them with new information from MicroPython.
|
|
2. Rebuild in order to update to a newer version of theof the typeshedrepo.for this you will need to manually advance the typeset repo to a newer version. Perhaps the newest versionand then rerun the update script it might be that due to the changes in the base 5 stubs that you'll need to make updates to the updatescript in order to accommodate for that.
|
|
|
|
*Steps*
|
|
- clone the typeshed repository
|
|
```bash
|
|
cd repos
|
|
git clone https://github.com/python/typeshed.git
|
|
cd typeshed
|
|
git checkout <commit-hash>
|
|
```
|
|
- update the version in pyproject toml to the new version ( .postnn)
|
|
|
|
- from the publish/micropython-stdlib-stubs directory
|
|
- run `python build.py`
|
|
|
|
- update and publish the micropython-stdlib-stubs package
|
|
```bash
|
|
uv publish
|
|
```
|
|
|
|
- commit the changes to the micropython-stdlib-stubs repository
|
|
|
|
## asyncio notes
|
|
## asyncio
|
|
- no _asyncio.pyi stubs to avoid conflict with stdlib re-use
|
|
|
|
- Generators
|
|
are not values - but are always callables, or coroutines
|
|
so rewrite
|
|
`open_connection: Generator ## = <generator>`
|
|
to
|
|
`async def open_connection () -> Callable[..., Awaitable[Tuple[StreamReader, StreamWriter]]]`
|
|
or similar
|
|
|
|
|
|
## Publish to PyPi
|
|
|
|
Publish using `uv publish`.
|
|
|
|
|
|
|
|
|