Skip to main content

Typing stubs for the Dask ecosystem.

Project description

dask-stubs

dask-stubs provides third-party typing information for the Dask project. The goal is to fill the gaps left by the runtime package so that type checkers such as Mypy and Pyright can reason about typical Dask usage with confidence.

Project layout

The repository separates runtime helpers from the stub definitions:

  • src/dask-stubs/ holds .pyi files that mirror the public Dask API.
  • tests/typecheck/samples/ provides runtime-free Python snippets that mypy validates to guard the stubs.
  • noxfile.py defines automation for linting, type checking, and stub sanity checks.

Quick start

  1. Install development dependencies with uv (Python 3.12+):

    uv sync --group dev
    
  2. Run the default automation via uv:

    uv run nox
    

    This runs Ruff, Mypy against the stubs, and the sample type-check tests.

Contribution guidelines

  1. Prefer working against small slices of the API. It is easier to review and iterate on focused modules.
  2. Each new stub should be paired with a usage example under tests/typecheck/samples/ (tested via mypy).
  3. Keep the stubs faithful to the runtime signatures. Where the runtime is dynamic, fall back to Any but leave a TODO for future improvement.
  4. Run the full uv run nox suite before sending a pull request.

See CONTRIBUTING.md for more detail on project conventions and coding standards.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dask_stubs-0.1.5.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dask_stubs-0.1.5-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file dask_stubs-0.1.5.tar.gz.

File metadata

  • Download URL: dask_stubs-0.1.5.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.5

File hashes

Hashes for dask_stubs-0.1.5.tar.gz
Algorithm Hash digest
SHA256 c8468cf6f6bd9d1309d690e3ca3ada46c4f55f273254410c738d6957130a6e8c
MD5 0bbe1406acbd8f256307258470be7bf4
BLAKE2b-256 2295e461bc3155b520d3964d2796529c97ba552207bbe8b1e7b9a28086d65255

See more details on using hashes here.

File details

Details for the file dask_stubs-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: dask_stubs-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.5

File hashes

Hashes for dask_stubs-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7d42604b34ee77fa9eddf648080aee6a1c5263f27eaf4f10d7de07de1c962d20
MD5 6c95fbab875ccf1d12fa303d0ef78f50
BLAKE2b-256 c79a875e8779ecbb7577a37a834395eb195e64c94d44c1bf9387fa8859de1553

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page