Config

Config#

class Settings(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: DotenvType | None = PosixPath('.'), _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_implicit_flags: bool | None = None, _secrets_dir: PathType | None = None, *, prescient_endpoint_url: str, prescient_aws_region: str, prescient_aws_role: Annotated[str, MinLen(min_length=20)], prescient_upload_role: Annotated[str, MinLen(min_length=20)], prescient_upload_bucket: str, prescient_tenant_id: str, prescient_client_id: str, prescient_auth_url: str, prescient_auth_token_path: str)[source]#

Default configuration for the Prescient SDK.

Configuration is handled using [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)

Order of precedence for configuration values:

  1. Environment variables are always highest precedence and will override any other configuration values

  2. config.env file: if a config.env file is present in the root of the project, it will be used

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[SettingsConfigDict] = {'arbitrary_types_allowed': True, 'case_sensitive': False, 'cli_avoid_json': False, 'cli_enforce_required': False, 'cli_exit_on_error': True, 'cli_hide_none_type': False, 'cli_implicit_flags': False, 'cli_parse_args': None, 'cli_parse_none_str': None, 'cli_prefix': '', 'cli_prog_name': None, 'cli_settings_source': None, 'cli_use_class_docs_for_groups': False, 'env_file': 'config.env', 'env_file_encoding': 'utf-8', 'env_ignore_empty': False, 'env_nested_delimiter': None, 'env_parse_enums': None, 'env_parse_none_str': None, 'env_prefix': '', 'extra': 'forbid', 'json_file': None, 'json_file_encoding': None, 'nested_model_default_partial_update': False, 'protected_namespaces': ('model_', 'settings_'), 'secrets_dir': None, 'toml_file': None, 'validate_default': True, 'yaml_file': None, 'yaml_file_encoding': None}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'prescient_auth_token_path': FieldInfo(annotation=str, required=True), 'prescient_auth_url': FieldInfo(annotation=str, required=True), 'prescient_aws_region': FieldInfo(annotation=str, required=True), 'prescient_aws_role': FieldInfo(annotation=str, required=True, metadata=[MinLen(min_length=20)]), 'prescient_client_id': FieldInfo(annotation=str, required=True), 'prescient_endpoint_url': FieldInfo(annotation=str, required=True), 'prescient_tenant_id': FieldInfo(annotation=str, required=True), 'prescient_upload_bucket': FieldInfo(annotation=str, required=True, description='AWS S3 upload bucket name'), 'prescient_upload_role': FieldInfo(annotation=str, required=True, description='AWS ARN role upload bucket', metadata=[MinLen(min_length=20)])}#

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.

Contents