aws / aws/jsii

Generated python modules are too large for some IDEs to support

Open
#3,365 2 comments 1 reaction 0 assignees View on GitHub
effort/large feature-request language/python p1
Dominant language
TypeScript
Stars
2.9k
Forks
267
Avg merge
1d 25m
Merged PRs (30d)
14

Description

The generated code for Python modules can be large enough to have IDEs refuse to process them (e.g: for IntelliSense support) unless the user tweaks some advanced parameters of their IDE.

In particular, we have [reports](https://github.com/aws/aws-cdk/issues/18711) of JetBrains IDEs (PyCharm, etc...) require tweaking `idea.max.intellisense.filesize` in order to enjoy code completion from the IDE with the `aws_cdk.aws_ec2` module, as it is larger than the `2500` bytes limit that is the default.

In order to address this, the modules should be broken down into smaller files.

While this is certainly possible, doing so requires care, as it could lead to causing import cycles.

Contributor guide

Open the contributing guide

Research direction

No source file or test is named. Start by locating the generator entry point that produces the Python modules, then inspect the generated aws_cdk.aws_ec2 module and its imports. Done means the generated modules are below the cited IDE size limit without introducing import cycles.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.