langtest.utils.custom_types.sample.SpeedTestSample#

class SpeedTestSample(*, category: str = 'performance', test_type: str = 'speed', expected_results: Result = None, actual_results: Result = None)#

Bases: BaseModel

A class representing a sample for speed test.

transform_time#

The transform times for different operations.

Type:: Dict[str, Union[int, float]]

run_time#

The run times for different operations.

Type:: Dict[str, Union[int, float]]

total#

The total times for different operations.

Type:: Dict[str, Union[int, float]]

__init__(**data)#: Constructor method

Methods

`__init__`(**data)	Constructor method
`construct`([_fields_set])	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
`convert_ns_to_unit`(time[, unit])	Converts time from nanoseconds to the specified unit.
`copy`(*[, include, exclude, update, deep])	Duplicate a model, optionally choose which fields to include, exclude and change.
`dict`(*[, include, exclude, by_alias, ...])	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
`from_orm`(obj)
`is_pass`()	Checks if the sample passes based on the maximum score.
`json`(*[, include, exclude, by_alias, ...])	Generate a JSON representation of the model, include and exclude arguments as per dict().
`parse_file`(path, *[, content_type, ...])
`parse_obj`(obj)
`parse_raw`(b, *[, content_type, encoding, ...])
`schema`([by_alias, ref_template])
`schema_json`(*[, by_alias, ref_template])
`to_dict`()	Converts the SpeedTestSample object to a dictionary.
`total_time`(time_ns, tokens)	Calculates the total time for each operation.
`update_forward_refs`(**localns)	Try to update ForwardRefs on fields based on this Model, globalns and localns.
`validate`(value)

Attributes

`category`
`test_type`
`expected_results`
`actual_results`

classmethod construct(_fields_set: SetStr | None = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

convert_ns_to_unit(time: int | float, unit: str = 'ms')#

Converts time from nanoseconds to the specified unit.

Parameters:

time (Union[int, float]) – The time value to convert.
unit (str, optional) – The unit of time to convert to (default: ‘ms’).

Returns:

The converted time value.

Return type:

Union[int, float]

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns:

new model instance

dict(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

is_pass()#: Checks if the sample passes based on the maximum score.

json(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Callable[[Any], Any] | None = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode#

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

to_dict() → Dict[str, Any]#

Converts the SpeedTestSample object to a dictionary.

Returns:: A dictionary representation of the SpeedTestSample object.
Return type:: Dict[str, Any]

total_time(time_ns, tokens)#

Calculates the total time for each operation.

Parameters:: unit (str, optional) – The unit of time to convert to (default: ‘ms’).
Returns:: A dictionary containing the total times for each operation.
Return type:: Dict[str, Union[int, float]]

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.