Skip to content

Option to specify profile #1420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Option to specify profile #1420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 46 additions & 12 deletions S3/Config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,18 +261,19 @@ class Config(object):
max_retries = 5

## Creating a singleton
def __new__(self, configfile = None, access_key=None, secret_key=None, access_token=None):
def __new__(self, configfile = None, access_key=None, secret_key=None, access_token=None, profile=None):
if self._instance is None:
self._instance = object.__new__(self)
return self._instance

def __init__(self, configfile = None, access_key=None, secret_key=None, access_token=None):
def __init__(self, configfile = None, access_key=None, secret_key=None, access_token=None, profile=None):
if configfile:
debug("Config: Initializing with config file '%s', profile '%s'" % (configfile, profile))
Copy link
Contributor

@fviard fviard Oct 27, 2025

Choose a reason for hiding this comment

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

Except this one, you can probably get ride of the other debug logs that I don't think are necessary once you will have a working code.

try:
self.read_config_file(configfile)
self.read_config_file(configfile, profile)
except IOError:
if 'AWS_SHARED_CREDENTIALS_FILE' in os.environ or 'AWS_CREDENTIAL_FILE' in os.environ or 'AWS_PROFILE' in os.environ:
self.aws_credential_file()
self.aws_credential_file(profile)

# override these if passed on the command-line
# Allow blank secret_key
Expand Down Expand Up @@ -335,7 +336,7 @@ def role_config(self):
'%s=%s' % (k, s3_quote(v, unicode_output=True))
for k, v in params.items()
])
sts_endpoint = os.environ.get("AWS_STS_ENDPOINT", sts_endpoint)
sts_endpoint = os.environ.get("AWS_STS_ENDPOINT", sts_endpoint)
if os.environ.get("AWS_STS_REGIONAL_ENDPOINTS") == "regional":
# Check if the AWS_REGION variable is available to use as a region.
region = os.environ.get("AWS_REGION")
Expand Down Expand Up @@ -441,7 +442,7 @@ def role_refresh(self):
except Exception:
warning("Could not refresh role")

def aws_credential_file(self):
def aws_credential_file(self, profile=None):
try:
aws_credential_file = os.path.expanduser('~/.aws/credentials')
credential_file_from_env = os.environ.get('AWS_SHARED_CREDENTIALS_FILE') \
Expand All @@ -450,6 +451,7 @@ def aws_credential_file(self):
os.path.isfile(credential_file_from_env):
aws_credential_file = base_unicodise(credential_file_from_env)
elif not os.path.isfile(aws_credential_file):
debug("AWS credentials file not found at %s" % aws_credential_file)
return

config = PyConfigParser()
Expand Down Expand Up @@ -482,7 +484,12 @@ def aws_credential_file(self):
"Error reading aws_credential_file "
"(%s): %s" % (aws_credential_file, str(exc)))

profile = base_unicodise(os.environ.get('AWS_PROFILE', "default"))
# Determine which profile to use based on priority:
# 1. Command-line option (profile parameter)
# 2. Environment variable (AWS_PROFILE)
# 3. Default to 'default' if neither is specified
if profile is None:
profile = base_unicodise(os.environ.get('AWS_PROFILE', "default"))
debug("Using AWS profile '%s'" % (profile))

# get_key - helper function to read the aws profile credentials
Expand Down Expand Up @@ -559,8 +566,23 @@ def option_list(self):
retval.append(option)
return retval

def read_config_file(self, configfile):
cp = ConfigParser(configfile)
def read_config_file(self, configfile, profile=None):
# Determine which profile to use based on priority:
# 1. Command-line option (profile parameter)
# 2. Environment variable (AWS_PROFILE)
# 3. Default to 'default' if neither is specified
if profile is None:
profile = os.environ.get('AWS_PROFILE', 'default')

# Use the determined profile as the section name
sections = [profile]
cp = ConfigParser(configfile, sections)

# If the specified profile section doesn't exist,
# fall back to the default section
if not cp.cfg:
cp = ConfigParser(configfile, ["default"])

for option in self.option_list():
_option = cp.get(option)
if _option is not None:
Expand Down Expand Up @@ -655,20 +677,29 @@ def parse_file(self, file, sections = []):
debug("ConfigParser: Reading file '%s'" % file)
if type(sections) != type([]):
sections = [sections]
in_our_section = True

if sections:
debug("ConfigParser: Looking for sections: %s" % sections)
else:
debug("ConfigParser: Reading default section")

in_our_section = len(sections) == 0 # If no sections specified, read all
current_section = "default"
r_comment = re.compile(r'^\s*#.*')
r_empty = re.compile(r'^\s*$')
r_section = re.compile(r'^\[([^\]]+)\]')
r_data = re.compile(r'^\s*(?P<key>\w+)\s*=\s*(?P<value>.*)')
r_quotes = re.compile(r'^"(.*)"\s*$')

with io.open(file, "r", encoding=self.get('encoding', 'UTF-8')) as fp:
for line in fp:
if r_comment.match(line) or r_empty.match(line):
continue
is_section = r_section.match(line)
if is_section:
section = is_section.groups()[0]
in_our_section = (section in sections) or (len(sections) == 0)
current_section = is_section.groups()[0]
in_our_section = (current_section in sections) or (len(sections) == 0)
Copy link
Contributor

@fviard fviard Oct 27, 2025

Choose a reason for hiding this comment

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

I think that there is legacy code, but except if I'm missing something, you can probably do directly:
or not sections:
No need for the len.

debug("ConfigParser: Found section '%s', reading: %s" % (current_section, in_our_section))
continue
is_data = r_data.match(line)
if is_data and in_our_section:
Expand All @@ -682,6 +713,9 @@ def parse_file(self, file, sections = []):
print_value = data["value"]
debug("ConfigParser: %s->%s" % (data["key"], print_value))
continue
if is_data and not in_our_section:
# Skip data in sections we're not interested in
continue
warning("Ignoring invalid line in '%s': %s" % (file, line))

def __getitem__(self, name):
Expand Down
3 changes: 2 additions & 1 deletion s3cmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3158,6 +3158,7 @@ def main():
optparser.add_option( "--access_key", dest="access_key", help="AWS Access Key")
optparser.add_option( "--secret_key", dest="secret_key", help="AWS Secret Key")
optparser.add_option( "--access_token", dest="access_token", help="AWS Access Token")
optparser.add_option( "--profile", dest="profile", metavar="PROFILE", help="Profile to use from .s3cfg file")

optparser.add_option("-n", "--dry-run", dest="dry_run", action="store_true", help="Only show what should be uploaded or downloaded but don't actually do it. May still perform S3 requests to get bucket listings and other information though (only for file transfer commands)")

Expand Down Expand Up @@ -3316,7 +3317,7 @@ def main():
sys.exit(EX_CONFIG)

try:
cfg = Config(options.config, options.access_key, options.secret_key, options.access_token)
cfg = Config(options.config, options.access_key, options.secret_key, options.access_token, options.profile)
except ValueError as exc:
raise ParameterError(unicode(exc))
except IOError as e:
Expand Down