Skip to content

Add typing stubs

Tor Solli-Nowlan requested to merge 140-more-typing into 140-converter-refactor

Description

cyvcf2 is untyped cython. This stub adds type annotation for the most commonly used functionality, namely Reader, Writer and Variant.

Stubs are placed default VS Code directory ./typings. devcontainer.json has been updated with MYPYPATH so mypy also knows where the stubs live.

Related issues

Notes to review (code/docs/QA)

Tests

General

  • Tests have been added that prove my fix is effective or that my feature works
  • Related tests have been modified/removed

Hypothesis testing:

  • Soak testing has been done
  • Distribution between positive / negative cases has been checked

Database

  • Includes changes to database schema
  • Includes necessary database migrations

Configuration

  • Includes changes to configuration
  • Includes configuration migration instructions in documentation

Merge checklist

  • Self-review of code has been performed.
  • Feature review and validation against specification has been performed (if applicable). Apply label: QAdone
  • Need for documentation has been evaluated and, if necessary, updated. Apply label: docsdone
  • Code and implementation has been reviewed by other core developer (including any changes based on initial review). Apply label: code reviewdone
Edited by Morten C. Eike

Merge request reports