Recently I have been doing a lot of lambda coding in AWS. After doing a lot of web services, I was really missing the ability to debug my code line by line in my local environment. I use PyCharm CE a lot, and to have PyCharm debug my lambda code, was to me, an awesome idea. Regardless, using the following way, we can set up the code in VS Code also. I could not find the proper tutorial on the internet. All the topics were around using SAM CLI, which I didn’t want to use. Prerequisites We must have the AWS credentials available in the home See this link to . The full project is . ~/.aws/credentials . configure AWS CLI here Let’s start… Here is my sample lambda function. A sample lambda function with 2 triggers, one from S3-Put and another from SQS receive message. This function also has some environment variables. The function also has a layer. Here is the code for the layer # dummy_layer.py : def call_dummy () return "Hello from dummy layer" To properly set it up in PyCharm we will use this structure. project Things to note 1. The events folder will have all the events which will invoke my lambda function locally. 2. The folder and all the components inside it are the layer codes. We can add any number of layers here. python 3. file will have all the environment variables for the lambda .env 4. is the actual function code. We can just copy the function from AWS console and put it here. lambda_function.py 5. is the file that will run the lambda function after loading the proper event. run.py Setup We will copy the lambda code from AWS, if available already, or will write the code, debug it and then deploy it. We will create the environment where the lambda function will run and use the real event to trigger the call. AWS resources can also be referenced like shown in the code. The client will use the file to create a connection with AWS, so the CLI configuration is a must. boto3 ~/.aws/credentials We will add any third-party layer code also. 1. Copy the lambda code from AWS console to the lambda_function.py file. In our case, we have: json boto3 dummy_layer call_dummy

s3 = boto3.client( ) print(call_dummy())
    print(s3.list_buckets()) { : , : json.dumps( )
    } import import from import "s3" : def lambda_handler (event, context) return 'statusCode' 200 'body' 'Hello from Lambda!' 2. Add the layer code as source set. We need to add the lambda layer code as the python source set so that we can import them into the lambda function. 3. Where to get the events We can get sample events from the test configuration in the lambda code console: The cloudwatch logs, will be actual events invoking the function. The AWS Toolkit plugin in PyCharm: 4. Code the run.py file Let’s load the s3 put file to simulate a put event and invoke the function. json lambda_function lambda_handler self.invoked_function_arn = arn __name__ == :
    event = {} open( , ) f:
        event = json.load(f)
        lambda_handler(event, Context( )) import from import : class Context : def __init__ (self, arn: str) if "__main__" with "events/s3-put.json" 'r' as "Sample ARN" 5. Configure .env file Install the .env file support plugin from jetbrains marketplace. Add all the environment configuration in the .env file for local debugging. This is simulating the environment variable configuration in the AWS lambda console. 6. Create run configuration. Finally, create a python run configuration for the file with the file setup. This is how we simulate the environment variable, just like in AWS console: run.py .env That’s it … We are done. Now just run the run configuration and debug away. Also published on Medium's subdomain behind a paywall .

How to Debug AWS Lambda Code with PyCharm

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

An Intro to Rio: A Lightweight Job Scheduler in Go

Exploring AWS CLI v2 with AWS Single Sign-on

How to Handle EC2 Credentials: Best Practices and Common Mistakes

Simplifying Amazon S3: A Must-Read for AWS Associate Certification

10 Things in Engineering We Don't Spend Enough Time On

254 Stories To Learn About Amazon

An Intro to Rio: A Lightweight Job Scheduler in Go

Exploring AWS CLI v2 with AWS Single Sign-on

How to Handle EC2 Credentials: Best Practices and Common Mistakes

Simplifying Amazon S3: A Must-Read for AWS Associate Certification

10 Things in Engineering We Don't Spend Enough Time On

254 Stories To Learn About Amazon

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps