Skip to content

refactor: rename OpentelemetryConfig → OpenTelemetryConfig; FreeBootstrapperConfig → FreeConfig#103

Merged
lesnik512 merged 1 commit into
mainfrom
refactor/low-7-naming
Jun 1, 2026
Merged

refactor: rename OpentelemetryConfig → OpenTelemetryConfig; FreeBootstrapperConfig → FreeConfig#103
lesnik512 merged 1 commit into
mainfrom
refactor/low-7-naming

Conversation

@lesnik512

@lesnik512 lesnik512 commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

The final PR of the deferred-refactors sequence. Two API-surface renames with silent backward-compatibility aliases:

  • OpentelemetryConfigOpenTelemetryConfig — matches the conventional OpenTelemetry capitalization and the OpenTelemetryServiceFieldsConfig mixin from PR6. Module-level alias preserves existing imports. Not exported from __init__.py (wasn't before).
  • FreeBootstrapperConfigFreeConfig — matches the sibling configs (FastAPIConfig, LitestarConfig, FastStreamConfig — none carry the Bootstrapper infix). Module-level alias plus FreeBootstrapperConfig re-export in __init__.py preserves existing public imports.

Internal references and tests updated to the new canonical names. Aliases are simple class assignments — same class object, so isinstance(x, OldName) and isinstance(x, NewName) are interchangeable. Old pickles continue to unpickle via the alias.

10 files modified, no behavior change. 129/129 tests pass.

Closes LOW-7 from an internal audit. Also closes the bonus Otel capitalization item surfaced during PR6's code review.

Test plan

  • just test — 129/129.
  • just lint — clean.
  • Aliases verified working (isinstance(x, OldName) is isinstance(x, NewName) for both renames).
  • Sanity grep confirms old names appear ONLY in alias contexts (4 matches: 2 alias lines + 2 in __init__.py).
  • Reviewer: confirm the aliases are simple class assignments (not subclasses), so isinstance behavior is fully preserved.

Why silent aliases

Locked decision in the sequencing spec: silent aliases (no warn-on-access). The library is small, and warn-on-access is overkill for two targeted renames where the new names are uncontroversially better.

🤖 Generated with Claude Code

…trapperConfig → FreeConfig

Two API-surface renames with silent backward-compatibility aliases.

OpentelemetryConfig → OpenTelemetryConfig: matches the conventional
OpenTelemetry capitalization and the OpenTelemetryServiceFieldsConfig
mixin introduced in PR6. Module-level alias `OpentelemetryConfig =
OpenTelemetryConfig` preserves existing imports. Not exported from
__init__.py (wasn't before either).

FreeBootstrapperConfig → FreeConfig: matches the sibling configs
(FastAPIConfig, LitestarConfig, FastStreamConfig — none carry the
"Bootstrapper" infix). Module-level alias plus `FreeBootstrapperConfig`
re-export in __init__.py preserves existing public imports.

Internal references and tests updated to the new canonical names.
Aliases are simple class assignments — same class object, so
isinstance(x, OldName) and isinstance(x, NewName) are interchangeable.
Old pickles continue to unpickle via the alias.

No behavior change. 129/129 tests pass.

Closes LOW-7 from the audit. Also closes the bonus Otel capitalization
item surfaced during PR6's code review.
@codecov

codecov Bot commented Jun 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
lite_bootstrap/__init__.py 100.00% <100.00%> (ø)
...te_bootstrap/bootstrappers/fastapi_bootstrapper.py 100.00% <100.00%> (ø)
...bootstrap/bootstrappers/faststream_bootstrapper.py 100.00% <100.00%> (ø)
lite_bootstrap/bootstrappers/free_bootstrapper.py 100.00% <100.00%> (ø)
...e_bootstrap/bootstrappers/litestar_bootstrapper.py 100.00% <100.00%> (ø)
..._bootstrap/instruments/opentelemetry_instrument.py 100.00% <100.00%> (ø)
tests/instruments/test_logging_instrument.py 100.00% <100.00%> (ø)
tests/instruments/test_opentelemetry_instrument.py 100.00% <ø> (ø)
tests/instruments/test_pyroscope_instrument.py 100.00% <100.00%> (ø)
tests/test_free_bootstrap.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@lesnik512 lesnik512 self-assigned this Jun 1, 2026
@lesnik512 lesnik512 merged commit d61827c into main Jun 1, 2026
8 checks passed
@lesnik512 lesnik512 deleted the refactor/low-7-naming branch June 1, 2026 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant