Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(glue): PythonRayExecutableProps has innaccurate properties #28625

Merged
merged 4 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions packages/@aws-cdk/aws-glue-alpha/lib/job-executable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,22 @@ interface PythonExecutableProps {
readonly extraPythonFiles?: Code[];
}

interface RayExecutableProps {
/**
* The Python version to use.
*/
readonly pythonVersion: PythonVersion;

/**
* Additional Python modules that AWS Glue adds to the Python path before executing your script.
*
* @default - no extra python files and argument is not set
*
* @see `--s3-py-modules` in https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html
*/
readonly s3PythonModules?: Code[];
}

interface SharedJobExecutableProps {
/**
* Runtime. It is required for Ray jobs.
Expand Down Expand Up @@ -253,7 +269,7 @@ export interface PythonShellExecutableProps extends SharedJobExecutableProps, Py
/**
* Props for creating a Python Ray job executable
*/
export interface PythonRayExecutableProps extends SharedJobExecutableProps, PythonExecutableProps {}
export interface PythonRayExecutableProps extends SharedJobExecutableProps, RayExecutableProps {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens to PythonExecutableProps? a) is it used elsewhere and b) we are not dropping support for any properties right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we are dropping support for properties (as the attached issue suggests) it should have been called out in PR description as a BREAKING CHANGE.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a) is it used elsewhere
Yes. There are three job types; Spark, Python shell, and Ray. PythonExecutableProps is used for the first two.

b) we are not dropping support for any properties right?
Right. We are not dropping any or working properties.
Only the property we are dropping is extraPythonFiles which was not working for Ray job. This is not breaking change.


/**
* The executable properties related to the Glue job's GlueVersion, JobType and code
Expand Down Expand Up @@ -377,14 +393,17 @@ export class JobExecutable {
if (JobLanguage.PYTHON !== config.language && config.extraPythonFiles) {
throw new Error('extraPythonFiles is not supported for languages other than JobLanguage.PYTHON');
}
if (config.extraPythonFiles && type === JobType.RAY.name) {
throw new Error('extraPythonFiles is not supported for Ray jobs');
}
if (config.pythonVersion === PythonVersion.THREE_NINE && type !== JobType.PYTHON_SHELL.name && type !== JobType.RAY.name) {
throw new Error('Specified PythonVersion PythonVersion.THREE_NINE is only supported for JobType Python Shell and Ray');
}
if (config.pythonVersion === PythonVersion.THREE && type === JobType.RAY.name) {
throw new Error('Specified PythonVersion PythonVersion.THREE is not supported for Ray');
}
if (config.runtime === undefined && type === JobType.RAY.name) {
throw new Error('Runtime is required for Ray jobs.');
throw new Error('Runtime is required for Ray jobs');
}
this.config = config;
}
Expand Down Expand Up @@ -466,6 +485,15 @@ export interface JobExecutableConfig {
*/
readonly extraPythonFiles?: Code[];

/**
* Additional Python modules that AWS Glue adds to the Python path before executing your script.
*
* @default - no extra python files specified.
*
* @see `--s3-py-modules` in https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@see expects a url after the tag, and nothing else

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

*/
readonly s3PythonModules?: Code[];

/**
* Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.
*
Expand Down
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-glue-alpha/lib/job.ts
Original file line number Diff line number Diff line change
Expand Up @@ -801,6 +801,9 @@ export class Job extends JobBase {
if (config.extraPythonFiles && config.extraPythonFiles.length > 0) {
args['--extra-py-files'] = config.extraPythonFiles.map(code => this.codeS3ObjectUrl(code)).join(',');
}
if (config.s3PythonModules && config.s3PythonModules.length > 0) {
args['--s3-py-modules'] = config.s3PythonModules.map(code => this.codeS3ObjectUrl(code)).join(',');
}
if (config.extraFiles && config.extraFiles.length > 0) {
args['--extra-files'] = config.extraFiles.map(code => this.codeS3ObjectUrl(code)).join(',');
}
Expand Down
Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading