aws / aws/aws-cdk

aws_s3_assets: wrong signature for try_bundle()

Open Beginner friendly
#38,321 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

@aws-cdk/aws-s3-assets documentation effort/medium p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 1h
Merged PRs (30d)
74

Description

Describe the issue

NOTE: this issue is Python specific.

$ cdk --version
2.1131.0 (build 1e9a1e1)
$ pip list --format freeze
attrs==26.1.0
aws-cdk.asset-awscli-v1==2.2.282
aws-cdk.asset-node-proxy-agent-v6==2.1.2
aws-cdk.cloud-assembly-schema==54.10.0
aws-cdk-lib==2.261.0
cattrs==26.1.0
constructs==10.6.0
jsii==1.138.0
pip==24.0
publication==0.0.3
python-dateutil==2.9.0.post0
repro-zipfile==0.4.1
six==1.17.0
typeguard==2.13.3
typing_extensions==4.16.0

The local bundling provider example here shows an incorrect signature for try_bundle():

import aws_cdk as cdk


@jsii.implements(cdk.ILocalBundling)
class MyBundle:
    def try_bundle(self, output_dir, *, image, entrypoint=None, command=None, volumes=None, volumesFrom=None, environment=None, workingDirectory=None, user=None, local=None, outputType=None, securityOpt=None, network=None, bundlingFileAccess=None, platform=None):

AFAICT, the actual signature is:

import aws_cdk as cdk


def try_bundle(self, output_dir: str, bundling_options: cdk.BundlingOptions, /) -> bool:
Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_s3_assets/README.html#asset-bundling

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the AWS S3 assets README's asset-bundling section linked in the issue and compare its local bundling provider example with the actual try_bundle(output_dir, bundling_options) signature shown in the report. Update the example so it reflects the current Python API, then verify the rendered documentation no longer shows the outdated signature.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.