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.6.tar.gz (5.6 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.6-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dask_stubs-0.1.6.tar.gz
Algorithm Hash digest
SHA256 02c06e66b179ce7aa7a2976ef250cbefebbb170a09f97d626a32bec5d0728acf
MD5 e3ba192f67f25ddf3917db0f4d2856e9
BLAKE2b-256 73c70f8c8bc69a6a2912ac3d1e4b858b6f9118ed233b6dbbb6bd5145b860d793

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for dask_stubs-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 87a540bbbdea0a168efebf0534264ce9cd9bcc47a45ecc415f7d6a3eb008a02a
MD5 bb3ac23fa2d4f5c0d63d2c36b7c39a6f
BLAKE2b-256 10d1db78152e865efca2d9464e0f3490aa73da006d42dcf2e99da04f227846eb

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