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.3.tar.gz (4.8 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.3-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dask_stubs-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0dc75e81e3d561efc360edb2811dcf5ee77d734eaa2427d1be3ac8d6fed4f85c
MD5 ee8d6b120bba367f84d7c3f06c5ecba7
BLAKE2b-256 10d41062cf8baf43aaac35387b97fd9442cf66593ec6e53072c9e2cfb2df1bed

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for dask_stubs-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f81f58e18cf99ed77fbda0a65cda9d95385f2991325b0e34faaa2c179ef3b612
MD5 d3faa7519a56c5c234af335d4747452d
BLAKE2b-256 30d609d63bc252152ecda11c510d9ec56d96ed6730b83a85e5e2be1d78839d74

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