aws-cdk: init python is not working

Describe the bug

I just generate a init python cdk template and run the commands from README, but it’s not working at all.

Expected Behavior

Synthesize the CloudFormation template from the init code from CDK

Current Behavior

Got this error message

Traceback (most recent call last):
  File "/project/aws-cdk/app.py", line 6, in <module>
    from aws_cdk.aws_cdk_stack import AwsCdkStack
  File "/project/aws-cdk/aws_cdk/aws_cdk_stack.py", line 1, in <module>
    from aws_cdk import (
ImportError: cannot import name 'Stack' from 'aws_cdk' (/project/aws-cdk/aws_cdk/__init__.py)

Subprocess exited with error 1

Reproduction Steps

1. Create a folder titled aws-cdk
2. Run cdk init --language python inside the aws-cdk
3. Run source .venv/bin/activate to go into virtual environment
4. Run pip install -r requirements.txt to install packages
5. Run cdk synth to generate Cloud formation, but this step got error like this

Possible Solution

The folder name is the same as the CDK python package naming. It makes python get the wrong folder. So I changed the folder name which CDK generates, then it was fixed. I think the cdk init should fix this.

Additional Information/Context

No response

CDK CLI Version

2.30.0

Framework Version

No response

Node.js Version

18.4.0

OS

macOS 12.4

Language

Python

Language Version

Python (3.10)

Other information

No response

[MrArnoldPalmer]

Yeah this is essentially a naming collision as the local python module being named the same as the aws_cdk package prevents you from correctly importing without aliasing the dependency to something else. I’m not sure if there is a simple workaround if you really wanted to name your python package aws_cdk (like aliasing the dependency to something else) but for now using a different directory/package name is the best solution.

ty @jashgala !

[jashgala]

I believe you are right, when I initialize the Python CDK inside a folder named “aws-cdk” it results in the same failure like the one that you mentioned. I’m think this might be an expected behavior and not a bug, as this problem happens due to the use of the name of aws-cdk module for a python project that internally references the same.

Nevertheless, I would allow someone who is more proficient in Python to confirm this. Meanwhile, you might want to update the steps to reproduce the issue accordingly:

Reproduction Steps* 0. Create a folder titled aws-cdk

1. Run cdk init --language python inside the aws-cdk
2. Run source .venv/bin/activate to go into virtual environment
3. Run pip install -r requirements.txt to install packages
4. Run cdk synth to generate Cloud formation, but this step got error like this