make FieldInfo a protocol

[tlambert03]

📒 Description

This makes a modification to #848 to make the dataclass.compat.FieldInfo type a bit more accurate. In #848, the return type was changed to a NamedTuple, but that named tuple wasn't actually used anywhere, instead, a regular dataclasses.Field is returned (as it was before) but it's just cast to the FieldInfo to satisfy type checkers. This means that all downstream users now get a typing error unless they also import your FieldInfo object and use a cast as well, even though they technically are returning the same Field object that you are returning internally.

🔗 What I've Done

I used a Protocol that matches the subset of dataclasses.Field that you are using, rather than the combination of NamedTuple and yield from cast(List[FieldInfo], fields(obj))

💬 Comments

A place to write any comments to the reviewer.

🛫 Checklist

• Updated docs
• Added unit-tests
• Sample tests pass
• W3C tests pass

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cf3aa92) 99.97% compared to head (3b308d4) 99.97%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #949   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files         109      109           
  Lines        8762     8763    +1     
  Branches     2075     2075           
=======================================
+ Hits         8760     8761    +1     
  Misses          1        1           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud