config_wrangler.utils module

class config_wrangler.utils.TZFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Bases: Formatter

__init__(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Initialize the formatter with specified format strings.

Initialize the formatter either with the specified format string, or a default as described above. Allow for specialized date formatting with the optional datefmt argument. If datefmt is omitted, you get an ISO8601-like (or RFC 3339-like) format.

Use a style parameter of ‘%’, ‘{’ or ‘$’ to specify that you want to use one of %-formatting, str.format() ({}) formatting or string.Template formatting in your format string.

Changed in version 3.2: Added the style parameter.

converter()

localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,

tm_sec,tm_wday,tm_yday,tm_isdst)

Convert seconds since the Epoch to a time tuple expressing local time. When ‘seconds’ is not passed in, convert the current time instead.

default_msec_format = '%s,%03d'

default_time_format = '%Y-%m-%d %H:%M:%S'

format(record)

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

formatException(ei)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

formatMessage(record)

formatStack(stack_info)

This method is provided as an extension point for specialized formatting of stack information.

The input data is a string as returned from a call to traceback.print_stack(), but with the last trailing newline removed.

The base implementation just returns the value passed in.

formatTime(record, datefmt=None)

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the ‘converter’ attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the ‘converter’ attribute in the Formatter class.

local_timezone = datetime.timezone(datetime.timedelta(days=-1, seconds=72000), 'Eastern Daylight Time')

static tz_aware_converter(timestamp) → datetime

usesTime()

Check if the format uses the creation time of the record.

config_wrangler.utils.build_referenced_objects(field_name: str, field_info: FieldInfo, parents: List[str], parent_container: MutableMapping, root_config_data: MutableMapping, list_of_sections: Sequence[str], inner_type: type[BaseModel]) → Dict[str, BaseModel]

config_wrangler.utils.find_referenced_section(field_name: str, field_info: FieldInfo, parents: List[str], section_name: str | MutableMapping, current_dict: MutableMapping, root_dict: MutableMapping) → MutableMapping

config_wrangler.utils.full_name(parents: List[str], field_name: str)

config_wrangler.utils.get_inner_type(cls: Any)

config_wrangler.utils.has_sub_fields(inner_type: Type)

config_wrangler.utils.inherit_fill(parent_config, child_config)

config_wrangler.utils.interpolate_values(container: MutableMapping, root_config_data: MutableMapping) → List[Tuple[str, str]]

config_wrangler.utils.lenient_issubclass(cls: Any, class_or_tuple: Type[Any] | Tuple[Type[Any], ...] | Set[Type[Any]] | None) → bool

config_wrangler.utils.match_config_data_to_field(field_name: str, field_info: FieldInfo, field_value: object, parent_container: MutableMapping, root_config_data: MutableMapping, parents: List[str])

config_wrangler.utils.match_config_data_to_field_or_submodel(field_name: str, field_info: FieldInfo, parent_container: MutableMapping, root_config_data: MutableMapping = None, parents=None)

config_wrangler.utils.match_config_data_to_model(model: BaseModel, config_data: MutableMapping, root_config_data: MutableMapping = None, parents=None)

config_wrangler.utils.merge_configs(child: MutableMapping, parent: MutableMapping) → None

config_wrangler.utils.parse_as_literal_or_json(value: str) → Any

config_wrangler.utils.parse_delimited_list(field_name: str, field_info: FieldInfo, field_value: str) → Sequence

config_wrangler.utils.resolve_variable(root_config_data: MutableMapping, variable_name: str, part_delimiter=':') → Any

config_wrangler.utils.walk_model(model: BaseModel, parents=None)