Metadata-Version: 2.4
Name: types-python-snappy
Version: 0.7.3.0
Summary: PEP 561 type stubs for python-snappy
Author: Matthew Watkins
License: MIT
Keywords: compression,mypy,pyright,snappy,type stubs,typing
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Stubs Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# types-python-snappy

PEP 561 type stubs for [python-snappy](https://github.com/andrix/python-snappy).

## Installation

```bash
pip install types-python-snappy
# or
uv add --dev types-python-snappy
```

## Usage

Install alongside `python-snappy`. Type checkers (mypy, pyright) will pick up
the stubs automatically via PEP 561.

```python
import snappy

data: bytes = snappy.compress(b"hello world")
result: bytes = snappy.decompress(data)
```

## Versioning

Versions match the stubbed python-snappy release. `0.7.3.0` stubs
python-snappy 0.7.3.

## Coverage

- `compress` / `decompress` / `uncompress`
- `StreamCompressor` / `StreamDecompressor`
- `HadoopStreamCompressor` / `HadoopStreamDecompressor`
- `stream_compress` / `stream_decompress`
- `isValidCompressed` / `UncompressError`
- `snappy.snappy_formats` submodule

If python-snappy adds inline types (`py.typed`), this package will be deprecated.
