1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# librt: mypyc runtime library
This library contains basic functionality that is useful in code compiled
using mypyc, and efficient C implementations of various Python standard library
classes and functions. Mypyc can produce faster extensions when you use `librt` in
the code you compile. `librt` also contains some internal library features used by mypy.
This repository is only used to build and publish the mypyc runtime library. Development
happens in the [mypy repository](https://github.com/python/mypy). Code is then perodically
synced from the `mypyc/lib-rt`
[subdirectory in the mypy repository](https://github.com/python/mypy/tree/master/mypyc/lib-rt).
Report any issues in the [mypyc issue tracker](https://github.com/mypyc/mypyc/issues).
## Developer notes
Since this repo should be kept in sync with `mypy`, it has an unusual directory structure.
If you want to install from sources, it is recommended to use `sdist` wheel. If you want to
install directly form the repo, you will need to execute `cp -r lib-rt/* .` before install.
See [issue #17](https://github.com/mypyc/librt/issues/17) for discussion.
Unfortunatelly PyPy is not supported. If you develop a library that supports PyPy and you need
`librt` only as a `mypy` dependency, you can skip PyPy in your CI matrix when type checking
(since results of type checking will be identical on e.g. CPython 3.11 and PyPy 3.11).
See [issue #16](https://github.com/mypyc/librt/issues/16) for discussion.
## Making a release
1. As a prerequisite, there generally will be some changes in the mypy repository under `mypyc/lib-rt`
that you want to release.
2. Run the `sync-mypy.py` script in this repository to sync changes from the mypy repository.
3. Bump the version number in `pyproject.toml` in this repository.
4. Update `smoke_tests.py` (optional but recommended for new features). Here's how to run tests:
* Activate a dedicated virtualenv (don't reuse your mypy virtualenv).
* `pip install -U ./lib-rt`
* `pip install pytest mypy-extensions`
* `pytest smoke_tests.py`
5. Commit and push (pushing directly to master is fine).
6. Wait until all [builds](https://github.com/mypyc/librt/actions) complete successfully
(no release is triggered yet).
7. Once builds are complete, tag the release (`git tag vX.Y.Z`; `git push origin vX.Y.Z`).
8. Go to the ["Actions" tab](https://github.com/mypyc/librt/actions) and click "Build wheels"
on the left.
9. Click "Run workflow" and pick the newly created tag from the drop-down list. This will build
*and upload* the wheels.
10. After the workflow completes, verify that `pip install -U librt` installs the new version from PyPI.
11. Create a PR to update the `librt` version in `mypy-requirements.txt`, `test-requirements.txt` and
`pyproject.toml` (`dependencies`, and `requires` under `build-system`) in the mypy repository.
The process should take about 20 minutes.
|
