📝 clarify async build config sink-kind semantics

This commit is contained in:
Nanaloveyuki
2026-06-14 09:04:38 +08:00
parent 54e695942f
commit 4dd1e5a33d
2 changed files with 10 additions and 0 deletions
+5
View File
@@ -43,6 +43,7 @@ Detailed rules explaining key parameters and behaviors
- The constructor does not normalize or reinterpret either embedded config beyond those defaults; any normalization has already happened inside the `LoggerConfig` or `AsyncLoggerConfig` values passed in.
- When passed to `build_async_logger(...)`, the `logger` portion is built first through the normal synchronous config path before the outer async queue layer is applied.
- When passed to `build_async_text_logger(...)`, the same `logger` portion is consumed more narrowly: `text_formatter`, `min_level`, `target`, and `timestamp` are used directly to build a text console sink, while `LoggerConfig.queue` is not applied.
- On that text-specific path, `logger.sink.kind` also does not decide the runtime sink shape. `build_async_text_logger(...)` still constructs `FormattedConsoleSink` from `logger.sink.text_formatter` even if the config says `Console`, `JsonConsole`, or `File`.
- This helper is the main code-side counterpart to `parse_async_logger_build_config_text(...)`.
### How to Use
@@ -63,6 +64,8 @@ In this example, the builder input keeps both configuration layers in one typed
And later code can still decide whether that shared config should flow into the full sync-first builder or the narrower text-console builder.
And if later code chooses `build_async_text_logger(...)`, that builder choice still matters more than `logger.sink.kind` because only the formatter-backed text path is consumed there.
#### When Need Defaulted Async Build Settings
When code only wants the standard combined config shape with few overrides:
@@ -81,6 +84,8 @@ e.g.:
- If callers expect every field inside `LoggerConfig` to affect every async builder equally, that assumption is too broad: `build_async_text_logger(...)` intentionally skips the optional sync queue layer.
- In particular, carrying `logger.sink.kind=File` inside this config does not force the later text-specific builder path to create a file-backed async logger; only `build_async_logger(...)` branches on sink kind.
### Notes
1. Use this helper when async builder APIs should receive one combined config object.