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

[pipes] update PipesContext variable name: context -> pipes #17173

Conversation

yuhan
Copy link
Contributor

@yuhan yuhan commented Oct 12, 2023

Summary & Motivation

instead of context, we name PipesContext variables pipes. this PR also updates some docs copy to eliminate the mention of the "context" name.

pipes.report_x feels great.

but a few places where pipes feel odd:

  • when it's accessing a property through "the context made available to pipes process", e.g. pipes.asset_keys, pipes.partition_key, pipes.log.info. the apis are the same as e.x. context.log.info in asset body but the variable naming convention make it feel different.
  • pipes = PipesContext.get() imo context feels more natural in this line. but this might be minor?

How I Tested These Changes

@yuhan yuhan requested a review from erinkcochran87 as a code owner October 12, 2023 15:43
@yuhan
Copy link
Contributor Author

yuhan commented Oct 12, 2023

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@yuhan yuhan force-pushed the 10-12-_pipes_update_PipesContext_variable_name_context_-_pipes branch from ab1746f to 6a882d8 Compare October 12, 2023 15:46
Copy link
Member

@schrockn schrockn left a comment

Choose a reason for hiding this comment

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

We could rename PipesContext to just Pipes

@yuhan
Copy link
Contributor Author

yuhan commented Oct 12, 2023

closing as this variable rename is a no-go per slack convo

@yuhan yuhan closed this Oct 12, 2023
@yuhan yuhan deleted the 10-12-_pipes_update_PipesContext_variable_name_context_-_pipes branch October 12, 2023 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants