Skip to main content

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/

Metadata

Release files for oarepo-invenio-typing-stubs 0.1.46

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oarepo-invenio-typing-stubs 0.1.46
File Size Uploaded Provenance Actions
oarepo_invenio_typing_stubs-0.1.46.tar.gz 166.3 kB Without provenance Details for oarepo_invenio_typing_stubs-0.1.46.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oarepo-invenio-typing-stubs 0.1.46
File Interpreter ABI Platform Actions
oarepo_invenio_typing_stubs-0.1.46-py3-none-any.whl Python 3 none any Details for oarepo_invenio_typing_stubs-0.1.46-py3-none-any.whl

Total release size: 597.9 kB

Release files / oarepo_invenio_typing_stubs-0.1.46.tar.gz

Download URL oarepo_invenio_typing_stubs-0.1.46.tar.gz
Size 166.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c4e9af198ea91c9be772aeaf72f9eaf97c350f6ec0b9cec3972a19d5307dcb23
BLAKE2b-256 checksum
How to use checksums
de9975419378f38c527e0c7032b92440912e0fb6f81ec81ce2bdce3a3b446c3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / oarepo_invenio_typing_stubs-0.1.46-py3-none-any.whl

Download URL oarepo_invenio_typing_stubs-0.1.46-py3-none-any.whl
Size 431.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e3182ba9cda4a8a5f3b1d408222b74ff5e2a2a2ee9f7e275c595e870f51de92d
BLAKE2b-256 checksum
How to use checksums
846ec2c68937e9091689412615936566e480480b81e76f3285ceb4d02f706aba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for oarepo-invenio-typing-stubs 0.1.46

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.46 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page