Skip to main content

Use typing.assert_type() to test runtime behavior

Project description

pytest-assert-type

Type-check and runtime-validate your interfaces with typing.assert_type()

Each assertion is ran in a subtest, so you get report for all of them regardless of failure.

📦 Installation

uv add --optional dev pytest pytest_assert_type

🎼 Usage

cat library.py

from dataclasses import dataclass
from typing import Callable, Generic, Literal, Protocol, TypeVar, overload
from typing_extensions import TypedDict

T = TypeVar("T")
U = TypeVar("U")

@dataclass(frozen=True)
class Box(Generic[T]):
    value: T

    def map(self, f: Callable[[T], U]) -> "Box[U]":
        return Box(f(self.value))

@overload
def parse_number(text: str, *, base10: Literal[True] = True) -> int: ...
@overload
def parse_number(text: str, *, base10: Literal[False]) -> float: ...
def parse_number(text: str, *, base10: bool = True) -> int | float:
    return int(text) if base10 else float(text)

class SupportsLen(Protocol):
    def __len__(self) -> int: ...

def size(x: SupportsLen) -> int:
    return len(x)

def first(xs: list[T]) -> T:
    return xs[0]

class User(TypedDict):
    id: int
    name: str
    history: list[tuple[int, str]]

def make_user(user_id: int, name: str) -> User:
    history: list[tuple[int, str]] = [(user_id, name)]
    return {"id": user_id, "name": name, "history": history}

cat test_typehints.py

from __future__ import annotations

import pytest
import pytest_assert_type 
from typing_extensions import assert_type

from library import Box, User, first, make_user, parse_number, size

def test_generics_and_map() -> None:
    b = Box(21)
    b2 = b.map(lambda n: n * 2.0)
    assert_type(b, Box[int])
    assert_type(b2, Box[float])
    assert_type(b2.value, float)

@pytest_assert_type.check
def test_overloads() -> None:
    i = parse_number("123", base10=True)
    f = parse_number("1.5", base10=False)
    assert_type(i, int)
    assert_type(f, float)

@pytest_assert_type.check
def test_protocol_structural() -> None:
    class V:
        def __len__(self) -> int:
            return 3

    s = size("abc")
    v = size(V())
    assert_type(s, int)
    assert_type(v, int)

@pytest_assert_type.check
def test_generic_binding() -> None:
    xs = [1, 2, 3]
    head = first(xs)
    assert_type(xs, list[int])
    assert_type(head, int)

@pytest_assert_type.check
def test_deep_containers() -> None:
    u = make_user(7, "Ada")
    assert_type(u, User)
    # Reach inside the structure to show deep shape validation:
    assert_type(u["id"], int)
    assert_type(u["name"], str)
    assert_type(u["history"], list[tuple[int, str]])
    assert_type(u["history"][0], tuple[int, str])
    assert_type(u["history"][0][0], int)
    assert_type(u["history"][0][1], str)

mypy test_typehints.py

Success: no issues found in 1 source file

pytest -v test_typehints.py

==================================== test session starts ====================================
platform darwin -- Python 3.14.0, pytest-8.4.2, pluggy-1.6.0 -- .venv/bin/python3
collected 5 items                                                                           

test_library.py::test_generics_and_map PASSED                                         [ 20%]
test_library.py::test_overloads 
test_library.py::test_overloads[i] [subtest] SUBPASS                                  [ 40%]
test_library.py::test_overloads[f] [subtest] SUBPASS                                  [ 60%]
test_library.py::test_overloads PASSED                                                [ 80%]
test_library.py::test_protocol_structural 
test_library.py::test_protocol_structural[s] [subtest] SUBPASS                        [100%]
test_library.py::test_protocol_structural[v] [subtest] SUBPASS                        [120%]
test_library.py::test_protocol_structural PASSED                                      [140%]
test_library.py::test_generic_binding 
test_library.py::test_generic_binding[xs] [subtest] SUBPASS                           [160%]
test_library.py::test_generic_binding[head] [subtest] SUBPASS                         [180%]
test_library.py::test_generic_binding PASSED                                          [200%]
test_library.py::test_deep_containers 
test_library.py::test_deep_containers[u] [subtest] SUBPASS                            [220%]
test_library.py::test_deep_containers[u['id']] [subtest] SUBPASS                      [240%]
test_library.py::test_deep_containers[u['name']] [subtest] SUBPASS                    [260%]
test_library.py::test_deep_containers[u['history']] [subtest] SUBPASS                 [280%]
test_library.py::test_deep_containers[u['history'][0]] [subtest] SUBPASS              [300%]
test_library.py::test_deep_containers[u['history'][0][0]] [subtest] SUBPASS           [320%]
test_library.py::test_deep_containers[u['history'][0][1]] [subtest] SUBPASS           [340%]
test_library.py::test_deep_containers PASSED                                          [360%]

=========================== 5 passed, 13 subtests passed in 0.09s ===========================

🚧 Development

  • brew install go-task or other options
  • task -l
    - task: Available tasks for this project:
    * add:             Add optional dependency: `task add -- test pytest-cov`
    * clear:           Clear __pycache__
    * default:         Run all checks: `task`
    * format:          Format
    * htmlcov:         Run tests and open htmlcov in browser
    * lint:            Lint
    * remove:          Add optional dependency: `task add -- test pytest-cov`
    * setup:           Install dependencies
    * test:            Run tests
    * typecheck:       Typecheck
    
  • Before push: task

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

pytest_assert_type-0.1.1.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

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

pytest_assert_type-0.1.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file pytest_assert_type-0.1.1.tar.gz.

File metadata

  • Download URL: pytest_assert_type-0.1.1.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pytest_assert_type-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c88c0fc09dfde03f8eb30ff8bcef6fcf9eb00d5bc398de96feda9af6886f8e25
MD5 7d8325d99bc46ca65efe9b7fed93eed6
BLAKE2b-256 a8e41a8e353931978c3603c53c6da83cb0498e020a32d59f8559b538950f7121

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_assert_type-0.1.1.tar.gz:

Publisher: publish.yaml on Bobronium/pytest-assert-type

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytest_assert_type-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_assert_type-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 229b163139b40ca5bc86636c1a06f358bb8ebe5b8d78df60b3dcfaad657aaf37
MD5 4b5221ed0be3a3d77d56c8d15d148d1e
BLAKE2b-256 e6d91bcfe3e7c94a4454eb71582ecd880d7fa38cc0eb8d0d266e4d43de26ac72

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_assert_type-0.1.1-py3-none-any.whl:

Publisher: publish.yaml on Bobronium/pytest-assert-type

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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