aws_cloudwatch, aws_secretsmanager: SyntaxWarning: invalid escape sequence '\|'

[garysassano]

Describe the bug

❯ pj deploy
👾 deploy | cdk deploy
/home/user/github/cdk-aws-app/.venv/lib/python3.12/site-packages/aws_cdk/aws_cloudwatch/__init__.py:1: SyntaxWarning: invalid escape sequence '\|'
  '''
/home/user/github/cdk-aws-app/.venv/lib/python3.12/site-packages/aws_cdk/aws_secretsmanager/__init__.py:1: SyntaxWarning: invalid escape sequence '\`'
  '''

Expected Behavior

No warnings displayed when using cdk deploy.

Current Behavior

Warnings are displayed for the aws_cloudwatch and aws_secretsmanager packages.

Reproduction Steps

cdk deploy

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.127.0

Framework Version

No response

Node.js Version

20.11.1

OS

Ubuntu 22.04.3 LTS

Language

Python

Language Version

3.12.1

Other information

No response

[tim-finnigan]

Thanks for reaching out. This looks like a duplicate of aws/jsii#4532. I think this comment may have identified the underlying issue:

This seems to be caused by the generated code that puts the documentation at the top of the module (so maybe this is really a jsii issue?). The fix seems to be as simple as putting an r at the top before the ''', i.e. make it a raw string, so that way Python doesn't try to interpret the backslashes as escape characters.

This needs further review but I think we should continue tracking in aws/jsii#4532 going forward to consolidate the investigation and discussion.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.