python - Boto3, अजगर और त्रुटियों को कैसे संभालना है




amazon-web-services (4)

मैंने बस अपनी गो-टू स्क्रिप्टिंग भाषा के रूप में अजगर को उठाया और मैं यह समझने की कोशिश कर रहा हूं कि कैसे boto3 के साथ उचित त्रुटि से निपटने के लिए।

मैं IAM उपयोगकर्ता बनाने का प्रयास कर रहा हूं:

def create_user(username, iam_conn):
    try:
        user = iam_conn.create_user(UserName=username)
        return user
    except Exception as e:
        return e

जब create_user पर कॉल सफल होता है, तो मुझे एक नीट ऑब्जेक्ट मिलता है जिसमें API कॉल का http स्थिति कोड और नए बनाए गए उपयोगकर्ता का डेटा होता है।

उदाहरण:

{'ResponseMetadata': 
      {'HTTPStatusCode': 200, 
       'RequestId': 'omitted'
      },
 u'User': {u'Arn': 'arn:aws:iam::omitted:user/omitted',
           u'CreateDate': datetime.datetime(2015, 10, 11, 17, 13, 5, 882000, tzinfo=tzutc()),
           u'Path': '/',
           u'UserId': 'omitted',
           u'UserName': 'omitted'
          }
}

यह बहुत अच्छा काम करता है। लेकिन जब यह विफल हो जाता है (जैसे कि यदि उपयोगकर्ता पहले से मौजूद है), तो मुझे केवल यह बताने के लिए कि क्या गलत हुआ मुझे बताने के लिए केवल टेक्स्ट के साथ botocore.exception.ClientError प्रकार की एक वस्तु मिलती है।

उदाहरण: CreateEser ऑपरेशन को कॉल करते समय ClientError ('एक त्रुटि हुई (EntityAlreadyExists): नाम वाला उपयोगकर्ता पहले से मौजूद है।'),

यह (AFAIK) त्रुटि को बहुत कठिन बनाता है क्योंकि मैं परिणामी http स्थिति कोड (उपयोगकर्ता के लिए 409 पहले से ही IAM के लिए AWS एपीआई डॉक्स के अनुसार मौजूद है) पर स्विच नहीं कर सकता। इससे मुझे लगता है कि मुझे कुछ गलत करना चाहिए। इष्टतम तरीका यह होगा कि boto3 अपवादों को कभी न फेंकें, लेकिन juts हमेशा ऐसी वस्तु लौटाते हैं जो दर्शाती है कि API कॉल कैसे गया।

क्या कोई मुझे इस मुद्दे पर बता सकता है या सही दिशा में इशारा कर सकता है?

आपका बहुत बहुत धन्यवाद!


@Jarmod द्वारा इंगित की गई 'संसाधनों पर कोई अपवाद नहीं' समस्या के लिए बस एक अद्यतन (नीचे दिए गए लागू होने पर अपने जवाब को अपडेट करने के लिए स्वतंत्र महसूस करें)

मैंने नीचे दिए गए कोड का परीक्षण किया है और यह ठीक चलता है। यह चीजों को करने के लिए 'संसाधनों' का उपयोग करता है, लेकिन client.exceptions पकड़ता है - हालांकि यह 'कुछ गलत' लग रहा है ... यह अच्छा परीक्षण करता है, अपवाद वर्गों में अपवाद समय पर डिबगर का उपयोग करते समय दिखाए जाने वाले और मेल खाते हैं ...

यह सभी संसाधनों और ग्राहकों के लिए लागू नहीं हो सकता है, लेकिन डेटा फ़ोल्डर (उर्फ s3 बाल्टी) के लिए काम करता है।

lab_session = boto3.Session() 
c = lab_session.client('s3') #this client is only for exception catching

try:
    b = s3.Bucket(bucket)
    b.delete()
except c.exceptions.NoSuchBucket as e:
    #ignoring no such bucket exceptions
    logger.debug("Failed deleting bucket. Continuing. {}".format(e))
except Exception as e:
    #logging all the others as warning
    logger.warning("Failed deleting bucket. Continuing. {}".format(e))

उम्मीद है की यह मदद करेगा...


अपवाद के भीतर निहित प्रतिक्रिया का उपयोग करें। यहाँ एक उदाहरण है:

import boto3
from botocore.exceptions import ClientError

try:
    iam = boto3.client('iam')
    user = iam.create_user(UserName='fred')
    print("Created user: %s" % user)
except ClientError as e:
    if e.response['Error']['Code'] == 'EntityAlreadyExists':
        print("User already exists")
    else:
        print("Unexpected error: %s" % e)

अपवाद में लिखी गई प्रतिक्रिया में निम्नलिखित शामिल होंगे:

  • ['Error']['Code'] उदाहरण के लिए 'EntityAlreadyExists' या 'ValidationError'
  • ['ResponseMetadata']['HTTPStatusCode'] जैसे 400
  • ['ResponseMetadata']['RequestId'] जैसे 2 d2b06652-88d7-11e5-99d0-812348583a35’
  • ['Error']['Message'] उदाहरण के लिए "एक त्रुटि हुई (EntityAlreadyExists) ..."
  • ['Error']['Type'] जैसे 'प्रेषक'

अधिक जानकारी के लिए botocore.readthedocs.io/en/latest/… देखें।

[अपडेट किया गया: 2018-03-07]

एडब्ल्यूएस पायथन एसडीके ने clients (हालांकि resources पर नहीं) पर सेवा अपवादों को उजागर करना शुरू कर दिया है, जिसे आप स्पष्ट रूप से पकड़ सकते हैं, इसलिए अब उस कोड को इस तरह से लिखना संभव है:

import boto3
from botocore.exceptions import ClientError, ParamValidationError

try:
    iam = boto3.client('iam')
    user = iam.create_user(UserName='fred')
    print("Created user: %s" % user)
except iam.exceptions.EntityAlreadyExistsException:
    print("User already exists")
except ParamValidationError as e:
    print("Parameter validation error: %s" % e)
except ClientError as e:
    print("Unexpected error: %s" % e)

दुर्भाग्य से, इन अपवादों के लिए वर्तमान में कोई दस्तावेज नहीं है।


मुझे यह बहुत उपयोगी लगा, चूंकि अपवादों को इस पैकेज के लिए स्क्रीन पर सभी अपवादों को सूचीबद्ध करने के लिए प्रलेखित नहीं किया गया है। यहाँ वह कोड है जो मैं इसे करता था:

import botocore.exceptions
def listexns(mod):
    #module = __import__(mod)
    exns = []
    for name in botocore.exceptions.__dict__:
        if (isinstance(botocore.exceptions.__dict__[name], Exception) or
            name.endswith('Error')):
            exns.append(name)
    for name in exns:
        print('%s.%s is an exception type' % (str(mod), name))
    return

if __name__ == '__main__':
    import sys
    if len(sys.argv) <= 1:
        print('Give me a module name on the $PYTHONPATH!')
    print('Looking for exception types in module: %s' % sys.argv[1])
    listexns(sys.argv[1])

जिसके परिणामस्वरूप:

Looking for exception types in module: boto3
boto3.BotoCoreError is an exception type
boto3.DataNotFoundError is an exception type
boto3.UnknownServiceError is an exception type
boto3.ApiVersionNotFoundError is an exception type
boto3.HTTPClientError is an exception type
boto3.ConnectionError is an exception type
boto3.EndpointConnectionError is an exception type
boto3.SSLError is an exception type
boto3.ConnectionClosedError is an exception type
boto3.ReadTimeoutError is an exception type
boto3.ConnectTimeoutError is an exception type
boto3.ProxyConnectionError is an exception type
boto3.NoCredentialsError is an exception type
boto3.PartialCredentialsError is an exception type
boto3.CredentialRetrievalError is an exception type
boto3.UnknownSignatureVersionError is an exception type
boto3.ServiceNotInRegionError is an exception type
boto3.BaseEndpointResolverError is an exception type
boto3.NoRegionError is an exception type
boto3.UnknownEndpointError is an exception type
boto3.ConfigParseError is an exception type
boto3.MissingParametersError is an exception type
boto3.ValidationError is an exception type
boto3.ParamValidationError is an exception type
boto3.UnknownKeyError is an exception type
boto3.RangeError is an exception type
boto3.UnknownParameterError is an exception type
boto3.AliasConflictParameterError is an exception type
boto3.PaginationError is an exception type
boto3.OperationNotPageableError is an exception type
boto3.ChecksumError is an exception type
boto3.UnseekableStreamError is an exception type
boto3.WaiterError is an exception type
boto3.IncompleteReadError is an exception type
boto3.InvalidExpressionError is an exception type
boto3.UnknownCredentialError is an exception type
boto3.WaiterConfigError is an exception type
boto3.UnknownClientMethodError is an exception type
boto3.UnsupportedSignatureVersionError is an exception type
boto3.ClientError is an exception type
boto3.EventStreamError is an exception type
boto3.InvalidDNSNameError is an exception type
boto3.InvalidS3AddressingStyleError is an exception type
boto3.InvalidRetryConfigurationError is an exception type
boto3.InvalidMaxRetryAttemptsError is an exception type
boto3.StubResponseError is an exception type
boto3.StubAssertionError is an exception type
boto3.UnStubbedResponseError is an exception type
boto3.InvalidConfigError is an exception type
boto3.InfiniteLoopConfigError is an exception type
boto3.RefreshWithMFAUnsupportedError is an exception type
boto3.MD5UnavailableError is an exception type
boto3.MetadataRetrievalError is an exception type
boto3.UndefinedModelAttributeError is an exception type
boto3.MissingServiceIdError is an exception type

यदि आप Python3 का उपयोग करके sign_up API (AWS Cognito) कॉल कर रहे हैं, तो आप निम्न कोड का उपयोग कर सकते हैं।

def registerUser(userObj):
    ''' Registers the user to AWS Cognito.
    '''

    # Mobile number is not a mandatory field. 
    if(len(userObj['user_mob_no']) == 0):
        mobilenumber = ''
    else:
        mobilenumber = userObj['user_country_code']+userObj['user_mob_no']

    secretKey = bytes(settings.SOCIAL_AUTH_COGNITO_SECRET, 'latin-1')
    clientId = settings.SOCIAL_AUTH_COGNITO_KEY 

    digest = hmac.new(secretKey,
                msg=(userObj['user_name'] + clientId).encode('utf-8'),
                digestmod=hashlib.sha256
                ).digest()
    signature = base64.b64encode(digest).decode()

    client = boto3.client('cognito-idp', region_name='eu-west-1' ) 

    try:
        response = client.sign_up(
                    ClientId=clientId,
                    Username=userObj['user_name'],
                    Password=userObj['password1'],
                    SecretHash=signature,
                    UserAttributes=[
                        {
                            'Name': 'given_name',
                            'Value': userObj['given_name']
                        },
                        {
                            'Name': 'family_name',
                            'Value': userObj['family_name']
                        },
                        {
                            'Name': 'email',
                            'Value': userObj['user_email']
                        },
                        {
                            'Name': 'phone_number',
                            'Value': mobilenumber
                        }
                    ],
                    ValidationData=[
                        {
                            'Name': 'email',
                            'Value': userObj['user_email']
                        },
                    ]
                    ,
                    AnalyticsMetadata={
                        'AnalyticsEndpointId': 'string'
                    },
                    UserContextData={
                        'EncodedData': 'string'
                    }
                )
    except ClientError as error:
        return {"errorcode": error.response['Error']['Code'],
            "errormessage" : error.response['Error']['Message'] }
    except Exception as e:
        return {"errorcode": "Something went wrong. Try later or contact the admin" }
    return {"success": "User registered successfully. "}

error.response ['Error'] [] Code ’] InvalidPasswordException, UsernameExistsException आदि होगा। इसलिए मुख्य फ़ंक्शन में या जहाँ आप फ़ंक्शन को कॉल कर रहे हैं, आप उपयोगकर्ता को एक सार्थक संदेश प्रदान करने के लिए तर्क लिख सकते हैं।

प्रतिक्रिया के लिए एक उदाहरण (error.response):

{
  "Error": {
    "Message": "Password did not conform with policy: Password must have symbol characters",
    "Code": "InvalidPasswordException"
  },
  "ResponseMetadata": {
    "RequestId": "c8a591d5-8c51-4af9-8fad-b38b270c3ca2",
    "HTTPStatusCode": 400,
    "HTTPHeaders": {
      "date": "Wed, 17 Jul 2019 09:38:32 GMT",
      "content-type": "application/x-amz-json-1.1",
      "content-length": "124",
      "connection": "keep-alive",
      "x-amzn-requestid": "c8a591d5-8c51-4af9-8fad-b38b270c3ca2",
      "x-amzn-errortype": "InvalidPasswordException:",
      "x-amzn-errormessage": "Password did not conform with policy: Password must have symbol characters"
    },
    "RetryAttempts": 0
  }
}

अधिक संदर्भ के लिए: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html#CognitoIdentityProvider.Client.sign_up





boto3