pytest-dev / pluggy

A minimalist production ready plugin system
https://pluggy.readthedocs.io/en/latest/
MIT License
1.24k stars 121 forks source link

Export our typing #428

Closed bluetech closed 1 year ago

bluetech commented 1 year ago

This is an audit of pluggy's public API, from the perspective of typing. The idea is that every type which is reachable transitively through the public API should be exported from pluggy and have a clean documented interface (and without _ prefixes), with possible exceptions.

Note: this is different from the goal of making hook calls themselves typed. That would be great, but is a separate enhancement.

Other tasks are:

RonnyPfannschmidt commented 1 year ago

id like to recommend deprecating the current tracing/tagtracing and trying to get rid of them

my understanding is that the api in there was a initial attempt at observability from >15 years ago and missmatches any type of current best practice

i believe pytest is the only place where its used in the internals to do debug tracing

if we export it wed have to keep it, and i would like to strongly avoid that

that being said opentracing completely fails to provide performant and simple local apis while eliot lacks any way of deeper integration

bluetech commented 1 year ago

@RonnyPfannschmidt OK, I'll not document the tracing types for now, though it's already documented here.