tfg.Tools package
Submodules
tfg.Tools.CalcTool module
- class tfg.Tools.CalcTool.CalculatorInput(**data)[source]
Bases:
BaseModel- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(**data)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- classmethod from_orm(obj)
- Return type:
Self
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – 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 (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'numbers': FieldInfo(annotation=List[float], required=True), 'operation': FieldInfo(annotation=str, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- numbers: List[float]
- operation: str
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- classmethod update_forward_refs(**localns)
- Return type:
None
- classmethod validate(value)
- Return type:
Self
- tfg.Tools.CalcTool.calculate(numbers, operation)[source]
Performs a calculation on a list of numbers.
- Parameters:
numbers (
List[float]) – List of numerical values.operation (
str) – Operation to perform (“mean”, “sum”, “min”, “max”).
- Returns:
Result of the calculation or error message.
- Return type:
str
tfg.Tools.CrossrefTool module
- class tfg.Tools.CrossrefTool.CrossrefInput(**data)[source]
Bases:
BaseModel- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(**data)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- classmethod from_orm(obj)
- Return type:
Self
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – 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 (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'subject': FieldInfo(annotation=str, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- subject: str
- classmethod update_forward_refs(**localns)
- Return type:
None
- classmethod validate(value)
- Return type:
Self
tfg.Tools.DBTool module
- class tfg.Tools.DBTool.InfluxDBQueryInput(**data)[source]
Bases:
BaseModelDefines the input parameters required for querying InfluxDB.
- metric
Sensor metric to query (e.g., temperature, humidity).
- Type:
str
- time_range
Relative time range (e.g., ‘24h’, ‘7d’). Ignored if start_time is provided.
- Type:
Optional[str]
- aggregation
Aggregation function to apply (e.g., ‘mean’, ‘max’).
- Type:
str
- start_time
Absolute start time in ISO 8601 format.
- Type:
Optional[str]
- end_time
Absolute end time in ISO 8601 format.
- Type:
Optional[str]
- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(**data)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- aggregation: str
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- end_time: str | None
- classmethod from_orm(obj)
- Return type:
Self
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- metric: str
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – 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 (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'aggregation': FieldInfo(annotation=str, required=True), 'end_time': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'metric': FieldInfo(annotation=str, required=True), 'start_time': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'time_range': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- start_time: str | None
- time_range: str | None
- classmethod update_forward_refs(**localns)
- Return type:
None
- classmethod validate(value)
- Return type:
Self
- tfg.Tools.DBTool._query_influxdb_internal(params)[source]
Constructs and executes a Flux query on InfluxDB from parameter dictionary.
- Parameters:
params (
dict) – Dictionary containing ‘metric’, ‘time_range’, and ‘aggregation’.- Returns:
Query results or an error message.
- Return type:
str
- tfg.Tools.DBTool.construct_flux_query(params)[source]
Constructs a Flux query based on extracted parameters.
- Parameters:
params (
dict) – Dictionary with keys ‘metric’, ‘aggregation’, and either ‘time_range’ or both ‘start_time’ and ‘end_time’.- Returns:
A formatted Flux query string.
- Return type:
str- Raises:
ValueError – If metric or aggregation is invalid, or required time parameters are missing.
- tfg.Tools.DBTool.extract_time_range(user_query)[source]
Extracts the time range from a user query.
- Parameters:
user_query (
str) – The input query from the user.- Returns:
A formatted time range for InfluxDB (e.g., “24h”, “7d”, “30d”).
- Return type:
str
- tfg.Tools.DBTool.query_influxdb(metric, aggregation, time_range=None, start_time=None, end_time=None)[source]
Queries InfluxDB using structured parameters. Accepts both relative and absolute time formats.
- Parameters:
metric (
str) – Metric name to query (e.g., “temperature”).aggregation (
str) – Aggregation function (e.g., “mean”, “max”).time_range (
Optional[str]) – Relative time range (e.g., “24h”, “7d”). Ignored if start_time and end_time are provided.start_time (
Optional[str]) – Absolute start time (e.g., “2024-11-01T00:00:00Z”).end_time (
Optional[str]) – Absolute end time (e.g., “2024-11-10T23:59:59Z”).
- Returns:
Resulting observation string or error message.
- Return type:
str
tfg.Tools.ElsevierTool module
- class tfg.Tools.ElsevierTool.ArticleInput(**data)[source]
Bases:
BaseModel- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(**data)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- classmethod from_orm(obj)
- Return type:
Self
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – 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 (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'title': FieldInfo(annotation=str, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- title: str
- classmethod update_forward_refs(**localns)
- Return type:
None
- classmethod validate(value)
- Return type:
Self
- tfg.Tools.ElsevierTool.get_article_content(title)[source]
Fetches the content of a specific article using Elsevier’s APIs based on its title.
- Parameters:
title (
str) – The title of the article to search for.- Returns:
- A string containing the content or abstract of the specified article.
If the article cannot be found or an error occurs, an appropriate error message is returned.
- Return type:
str
tfg.Tools.WeatherTool module
- class tfg.Tools.WeatherTool.WeatherInput(**data)[source]
Bases:
BaseModel- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(**data)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- end_date: str | None
- classmethod from_orm(obj)
- Return type:
Self
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- location: str
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – 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 (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'end_date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'location': FieldInfo(annotation=str, required=False, default='Madrid'), 'start_date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- start_date: str | None
- classmethod update_forward_refs(**localns)
- Return type:
None
- classmethod validate(value)
- Return type:
Self
- tfg.Tools.WeatherTool.get_weather_range(location='Madrid', start_date=None, end_date=None)[source]
Fetches weather data for a location over a date range using Open-Meteo API. If no end_date is provided, assumes a single-day query.
- Parameters:
location (
str) – Location name (e.g., “Madrid”)start_date (
Optional[str]) – ISO date (YYYY-MM-DD)end_date (
Optional[str]) – ISO date (YYYY-MM-DD)
- Returns:
Summary of temperatures per day and hourly breakdown.
- Return type:
str