TheKevJames / coveralls-python / 29763296751

94%

master: 96%

Pull #755

github

refactor(config)!: model resolved configuration as a typed Config

resolve() now returns a typed Config dataclass instead of an untyped dict.
Config separates API payload fields from client-behaviour settings, exposes
to_payload() as the enforced payload boundary and request_timeout as the
resolved (connect, read) tuple, and validates the timeout family at
construction. api.py consumes Config by attribute and is now type-checked.

Unknown keys are handled the same way regardless of source -- config file or
Coveralls() keyword arguments -- dropped with a warning rather than crashing on
an unexpected kwarg. The boolean flags (parallel, skip_ssl_verify) are coerced
so a non-bool config value can't reach the API or a client toggle as a string.

changelog:
Resolved configuration is now a typed ``Config`` object. **Breaking (library
API):** ``Coveralls.config`` is a ``Config`` dataclass rather than a ``dict`` --
read values by attribute (``cover.config.service_name``) instead of by key
(``cover.config["service_name"]``). Unrecognised keys are now ignored with a
warning -- consistently whether they come from ``.coveralls.yml`` or a
``Coveralls()`` keyword argument -- instead of being silently accepted (config
file) or raising a ``TypeError`` (kwargs).

136 of 146 branches covered (93.15%)

Branch coverage included in aggregate %.

86 of 86 new or added lines in 2 files covered. (100.0%)

448 of 475 relevant lines covered (94.32%)

4.72 hits per line