Clarify runtime vs. complete_platforms for serverless. #18001
Conversation
A common pitfall is 1st using `runtime`, encountering issues, migrating to `complete_platforms` and still running into issue due to not deleting `runtime`. Hopefully this helps clarify you generally want to use these two fields as XOR.
| @@ -103,13 +103,13 @@ def generate_pex_arg_list(self) -> Iterator[str]: | |||
|
|
|||
|
|
|||
| @rule | |||
| async def digest_complete_platforms( | |||
| complete_platforms: PexCompletePlatformsField, | |||
| async def digest_complete_platform_addresses( | |||
There was a problem hiding this comment.
I threw up my hands with rule graph errors, unions and the like. This refactor works but its a bit clunky in that the subclassing backends each need to add a ~throwaway rule to link in.
Let me know if there is a better way to do all this. The basic chain is:
- I want to subclass a field to change its doc (PexCompletePlatformsField -> {PythonAwsLambdaCompletePlatforms, GoogleCloudFunctionCompletePlatforms})
- There is a pre-existing rule which turns a PexCompletePlatformsField into another thing and the engine does not allow subclasses; so ...
| @@ -246,6 +246,11 @@ class PythonAwsLambdaRuntime(StringField): | |||
| """ | |||
| The identifier of the AWS Lambda runtime to target (pythonX.Y). | |||
| See https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html. | |||
|
|
|||
| In general you'll want to define either a `runtime` or one `complete_platforms` but not | |||
There was a problem hiding this comment.
What happens today if you specify both? I assume we'd want to error? And wouldn't that error message be sufficient??
There was a problem hiding this comment.
Currently, like any other PEX, multiplatform is supported and all platforms and complete_platforms are additive. So you can make a PEX that can be deployed to >1 lambda runtime. A separate step could be the whole deprecation procedure to restrict this down to one, which would include transitioning to platform XOR complete_platforms and making complete_platforms singular.
A common pitfall is 1st using
runtime, encountering issues, migratingto
complete_platformsand still running into issues due to notdeleting
runtime. Hopefully this helps clarify you generally want touse these two fields as XOR.