Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 15 additions & 73 deletions packages/smithy-aws-core/src/smithy_aws_core/config/__init__.py
Original file line number Diff line number Diff line change
@@ -1,76 +1,18 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

import os
from pathlib import Path

from smithy_aws_core.config.file_parser import (
FileType,
parse_config_file,
standardize,
)
from smithy_aws_core.config.merged_config import MergedConfig

_DEFAULT_CONFIG_FILE = "~/.aws/config"
_DEFAULT_CREDENTIALS_FILE = "~/.aws/credentials"
_CONFIG_FILE_ENV_VAR = "AWS_CONFIG_FILE"
_CREDENTIALS_FILE_ENV_VAR = "AWS_SHARED_CREDENTIALS_FILE"


def _resolve_config_paths(
config_file_path: Path | None = None,
credentials_file_path: Path | None = None,
) -> tuple[Path, Path]:
"""Resolve the final config and credentials file paths.

Resolution order for each path:
1. Explicit argument (if provided)
2. Environment variable (AWS_CONFIG_FILE / AWS_SHARED_CREDENTIALS_FILE)
3. Default (~/.aws/config / ~/.aws/credentials)

The ~ is expanded to the user's home directory.

:param config_file_path: Override path for config file.
:param credentials_file_path: Override path for credentials file.
:returns: Tuple of (resolved_config_path, resolved_credentials_path).
"""
config_path = (
config_file_path
or Path(os.environ.get(_CONFIG_FILE_ENV_VAR, _DEFAULT_CONFIG_FILE))
).expanduser()

credentials_path = (
credentials_file_path
or Path(os.environ.get(_CREDENTIALS_FILE_ENV_VAR, _DEFAULT_CREDENTIALS_FILE))
).expanduser()

return config_path, credentials_path


async def load_config(
config_file_path: Path | None = None,
credentials_file_path: Path | None = None,
) -> MergedConfig:
"""Load and merge AWS config and credentials files.

Parses both files, standardizes them, and returns a merged
MergedConfig ready for querying.

:param config_file_path: Override path for config file.
Defaults to AWS_CONFIG_FILE env var or ~/.aws/config.
:param credentials_file_path: Override path for credentials file.
Defaults to AWS_SHARED_CREDENTIALS_FILE env var or ~/.aws/credentials.
:returns: A MergedConfig with merged profiles from both files.
"""

config_path, credentials_path = _resolve_config_paths(
config_file_path, credentials_file_path
)

raw_config = await parse_config_file(str(config_path))
raw_credentials = await parse_config_file(str(credentials_path))

std_config = standardize(raw_config, FileType.CONFIG)
std_credentials = standardize(raw_credentials, FileType.CREDENTIALS)

return MergedConfig(std_config, std_credentials)
from .aws_config import AsyncAwsConfig
from .context import SharedConfigContext, load_config
from .filesystem import DefaultFileSystem, FileSystem
from .merged_config import MergedConfig
from .types import ConfigSource

__all__ = [
"AsyncAwsConfig",
"ConfigSource",
"DefaultFileSystem",
"FileSystem",
"MergedConfig",
"SharedConfigContext",
"load_config",
]
194 changes: 194 additions & 0 deletions packages/smithy-aws-core/src/smithy_aws_core/config/aws_config.py
Comment thread
ubaskota marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

from dataclasses import dataclass, field
from typing import Any, ClassVar, Self

from smithy_core.retries import RetryStrategyOptions

from .context import SharedConfigContext
from .exceptions import ConfigError, ConfigValidationError
from .filesystem import FileSystem
from .resolvers import (
resolve_max_attempts,
resolve_region,
resolve_retry_mode,
)
from .types import UNSET, ConfigSource, FieldSpec, Resolved
from .validators import (
validate_max_attempts,
validate_region,
validate_retry_mode,
)


@dataclass(kw_only=True)
class AsyncAwsConfig:
Comment thread
ubaskota marked this conversation as resolved.
"""Base configuration class for all AWS services.

Fields are resolved asynchronously from multiple sources (env vars,
config files, defaults) through the resolve() classmethod.

Do not instantiate directly — use:
config = await AsyncAwsConfig.resolve()
"""

region: str | None = None
retry_mode: str | None = None
max_attempts: int | None = None

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are promising to return int | None for max_attempts, however, this isn't true when a customer passes in a str. We cannot violate that contract.

>>> config = await AsyncAwsConfig.resolve(max_attempts="5")
>>> type(config.max_attempts)
<class 'str'>


_ctx: SharedConfigContext | None = field(default=None, repr=False, compare=False)
_sources: dict[str, ConfigSource] = field( # type: ignore[assignment]
default_factory=dict,
repr=False,
compare=False,
)

_FIELDS: ClassVar[dict[str, FieldSpec]] = {
"region": FieldSpec(
default=None,
resolver=resolve_region,
validator=validate_region,
),
"retry_mode": FieldSpec(
default=RetryStrategyOptions.retry_mode,
resolver=resolve_retry_mode,
validator=validate_retry_mode,
),
"max_attempts": FieldSpec(
default=RetryStrategyOptions.max_attempts,
resolver=resolve_max_attempts,
validator=validate_max_attempts,
),
}

def __post_init__(self) -> None:
"""Block direct construction. Use resolve() instead."""
raise ConfigError(
f"{type(self).__name__} cannot be constructed directly. "
f"Use `await {type(self).__name__}.resolve(...)` instead."
)

@classmethod
async def resolve(
cls,
*,
profile: str | None = None,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When a customer provides a profile value that doesn't actually exist, we throw a misleading error:

>>> c>>> config = await AsyncAwsConfig.resolve(profile="FOOBAR")  from smithy_aws_core.config import AsyncAwsConfig
>>> config = await AsyncAwsConfig.resolve(profile="FOOBAR")
Traceback (most recent call last):
  File "/Users/gytndd/.local/share/uv/python/cpython-3.12.13-macos-aarch64-none/lib/python3.12/concurrent/futures/_base.py", line 456, in result
    return self.__get_result()
           ^^^^^^^^^^^^^^^^^^^
  File "/Users/gytndd/.local/share/uv/python/cpython-3.12.13-macos-aarch64-none/lib/python3.12/concurrent/futures/_base.py", line 401, in __get_result
    raise self._exception
  File "<console>", line 1, in <module>
  File "/Users/gytndd/dev/GitHub/temp6/smithy-python/packages/smithy-aws-core/src/smithy_aws_core/config/aws_config.py", line 105, in resolve
    await instance._resolve_fields(overrides)
  File "/Users/gytndd/dev/GitHub/temp6/smithy-python/packages/smithy-aws-core/src/smithy_aws_core/config/aws_config.py", line 165, in _resolve_fields
    spec.validator(getattr(self, field_name))
  File "/Users/gytndd/dev/GitHub/temp6/smithy-python/packages/smithy-aws-core/src/smithy_aws_core/config/validators.py", line 24, in validate_region
    raise ConfigValidationError(
smithy_aws_core.config.exceptions.ConfigValidationError: Invalid value for 'region': None. Region is required and must be set.

A common case will be when customers make a type in the profile name. We should provide a more accurate/helpful error.

fs: FileSystem | None = None,
config_file_path: str | None = None,
credentials_file_path: str | None = None,
**overrides: Any,
) -> Self:
"""Resolve a config object from environment, config files, and defaults.

This is the only supported way to create a config instance.

:param profile: Override the active profile name.
:param fs: Override the filesystem abstraction.
:param config_file_path: Override path for config file.
:param credentials_file_path: Override path for credentials file.
:param overrides: Explicit field values that skip resolution.
:returns: A fully-resolved config instance.
"""
ctx = SharedConfigContext(
profile_name=profile,
fs=fs,
config_file_path=config_file_path,
credentials_file_path=credentials_file_path,
)

# Validate profile exists if explicitly requested
if profile is not None:
config_file = await ctx.parsed_profiles()
if profile not in config_file.profiles:
raise ConfigError(f"Profile '{profile}' not found in config file.")

# Create the instance bypassing __post_init__ check
instance = cls._create_instance()
instance._ctx = ctx

# Resolve each field
await instance._resolve_fields(overrides)

return instance

def source_of(self, field_name: str) -> ConfigSource | None:
"""Get the source that provided a field's value.

:param field_name: The config field name.
:returns: The ConfigSource, or None if not tracked.
"""
return self._sources.get(field_name)

def resolution_context(self) -> SharedConfigContext | None:
"""Get the resolution context used to create this config.

:returns: The SharedConfigContext, or None if not available.
"""
return self._ctx

@classmethod
def _create_instance(cls) -> Self:
"""Create an instance that bypasses construction blocking."""
instance = object.__new__(cls)
object.__setattr__(instance, "_sources", {})
object.__setattr__(instance, "_ctx", None)
for field_name in cls._FIELDS:
object.__setattr__(instance, field_name, UNSET)
return instance

async def _resolve_fields(self, overrides: dict[str, Any]) -> None:
"""Run the resolution pipeline for all fields."""
unknown = set(overrides) - set(self._FIELDS)
if unknown:
raise ConfigValidationError(
f"Unknown config field(s): {sorted(unknown)}. "
f"Valid fields are: {sorted(self._FIELDS)}"
)

for field_name, spec in self._FIELDS.items():
# check for overrides first
if field_name in overrides:
value = overrides[field_name]
setattr(self, field_name, value)
self._sources[field_name] = ConfigSource.OVERRIDE
# check in resolver
elif spec.resolver is not None:
result: Resolved[Any] = await spec.resolver(self._ctx)
if result.value is not UNSET:
setattr(self, field_name, result.value)
self._sources[field_name] = result.source
else:
# If resolver returned UNSET, fall back to default
self._apply_default(field_name, spec)

else:
# No resolver, use default directly
self._apply_default(field_name, spec)

# Run validator for all sources
if spec.validator is not None:
spec.validator(getattr(self, field_name))

def _apply_default(self, field_name: str, spec: FieldSpec) -> None:
"""Apply the default value for a field."""
if spec.default_factory is not None:
value = spec.default_factory()
else:
value = spec.default
setattr(self, field_name, value)
self._sources[field_name] = ConfigSource.DEFAULT

def __setattr__(self, name: str, value: Any) -> None:
"""Track provenance when fields are set with plugins after construction"""
# Mark as override only if the field is in _FIELDS and was already resolved
if (
name in self.__class__._FIELDS
and hasattr(self, "_sources")
and name in self._sources
):
spec = self.__class__._FIELDS[name]
if spec.validator is not None:
spec.validator(value)
self._sources[name] = ConfigSource.OVERRIDE
super().__setattr__(name, value)
Loading
Loading