invenio-typing-stubs
This is a package that provides typing support for the InvenioRDM source base. It is intended as a temporary solution until InvenioRDM itself provides typing support.
As such, it is a collection of type stubs for the InvenioRDM source base, as well as some utility functions to help with typing.
It must not contain any runtime code, it is intended to be used only for type checking.
Warning
These stubs were generated mostly automatically and only some have been manually checked. They will surely contain some errors. Please report any issues you find.
Usage
Please install the package directly from github:
pip install git+https://github.com/oarepo/invenio-typing-stubs.git
If you add the dependency to your pyproject.toml built with hatchling, do it like:
[project.optional-dependencies]
dev = [
"invenio-typing-stubs @ git+https://github.com/oarepo/invenio-typing-stubs.git",
]
How it was generated
Automatic generation
Copilot with GPT-5 was used to generate the stubs. The following prompt was used:
There is a agent_helper command that will give you work. Please call the command as
`.venv/bin/python agent_helper.py invenio_communities`.
The output of the command are the instructions that you should do.
Read them carefully and execute them.
After that, continue calling the agent and processing the instructions
until it will tell you that all work has been done.
Manual checks
Some manual checks were done to ensure the stubs are correct. Systemfields were patched manually to ensure correct typing.
Problems
Typing for SQL Alchemy mostly does not work with invenio_db.
Final checks
Checked with
mypy --check-untyped-defs --ignore-missing-imports invenio_records_resources-stubs/
1 maintainer
Metadata
1 maintainer
Release files for oarepo-invenio-typing-stubs 0.1.42
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| oarepo_invenio_typing_stubs-0.1.42.tar.gz | 165.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| oarepo_invenio_typing_stubs-0.1.42-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 595.9 kB
Release files / oarepo_invenio_typing_stubs-0.1.42.tar.gz
| Download URL | oarepo_invenio_typing_stubs-0.1.42.tar.gz |
|---|---|
| Size | 165.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b15a72ccc73807b4198b18601a7dc8b9d24d344115aaeb72bf237b20d90ac5b4
|
|
BLAKE2b-256 checksum How to use checksums |
b217378942f9cee743a53dd154da0ef3d146cfe534b38097cc1dd8bbb0cc9c5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / oarepo_invenio_typing_stubs-0.1.42-py3-none-any.whl
| Download URL | oarepo_invenio_typing_stubs-0.1.42-py3-none-any.whl |
|---|---|
| Size | 430.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
945f1c9a2bbefbe309ead3e087d4495bad9da5fee8c7a04e00ed12afd03e59c3
|
|
BLAKE2b-256 checksum How to use checksums |
3de00c096473979ad362ee5e02f905a3568f2f79be79518851a3599fd3c03878
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
