MethodConfigGroup

pydantic model fitrequest.method_config_group.MethodConfigGroup

Bases: BaseModel

Describes the configuration of a set of methods

Fields:

• auth (fitrequest.auth.Auth | None)

• base_url (fitrequest.fit_var.FitVar | dict | str | None)

• client_name (str)

• family_name_templates (fitrequest.method_config_family.FamilyTemplates | None)

• method_config_list (list[fitrequest.method_config.MethodConfig | fitrequest.method_config_family.MethodConfigFamily])

• method_decorators (list[collections.abc.Callable | str])

• method_docstring (str)

• version (str)

field auth: Auth | None = None

Authentication object used by generated methods.

field base_url: Annotated[FitVar | dict | str | None, FieldInfo(annotation=NoneType, required=True, validate_default=True), BeforeValidator(func=validate_init_value, json_schema_input_type=PydanticUndefined)] = None

Default base URL for the generated method.

field client_name: str [Required]

Name of the client.

field family_name_templates: FamilyTemplates | None = None

These name templates are used to generate family names. Be cautious when overriding these default values with custom templates, as doing so - especially if the custom templates do not utilize all the requested variables for naming - could lead to unexpected errors.

Override these templates with care.

field method_config_list: list[MethodConfig | MethodConfigFamily] [Optional]

List of MethodConfig and MethodConfigFamily objects representing the methods to be generated.

field method_decorators: list[~types.Annotated[~collections.abc.Callable | str, ~pydantic.functional_validators.BeforeValidator(func=~fitrequest.method_decorator.validate_init_value, json_schema_input_type=PydanticUndefined), ~pydantic.functional_serializers.PlainSerializer(func=~fitrequest.method_decorator.<lambda>, return_type=str, when_used=always)]] [Optional]

Default decorators applied to the generated method.

field method_docstring: str = ''

Default Jinja template for the generated method. The default variable declaration {{my_var}} is replaced by {my_var}. See: https://jinja.palletsprojects.com/en/stable/

field version: str = ''

Version of the client. If not provided FitRequest tries to retrieve the version from the python package.