Improved recipe initialization UX #9158
Conversation
✅ Deploy Preview for prefect-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| @@ -230,6 +233,7 @@ def initialize_project(name: str = None, recipe: str = None) -> List[str]: | |||
| elif recipe is None: | |||
| recipe = "local" | |||
|
|
|||
| formatting_kwargs.update(inputs or {}) | |||
There was a problem hiding this comment.
probably a dumb python q - why not set inputs: dict = {} as a default arg?
There was a problem hiding this comment.
@parkedwards not a dumb question at all, it's a common python gotcha actually; because function definitions are run only once per-import, all default values are set and bound once and only once. This means that if a default is a mutable object, it can begin to leak state between calls of the function. Easy to inspect example:
def f(item, x: list = []):
x.append(item)
return x
f(1) # returns [1]
f(2) # returns [1, 2]So to get around that, the best practice is to use None as the default for mutable inputs, and initialize an empty version of the object once per-call (you'll often see things like inputs = inputs or {} at the top of functions for this reason).
There was a problem hiding this comment.
iiiinteresting, good to know. thanks chris
Co-authored-by: Bill Palombi <bill@prefect.io>
Co-authored-by: Bill Palombi <bill@prefect.io>
This PR introduces a new interactive experience for recipes - all recipes now ship with
required_inputsthat, if not provided, are prompted for whenever initializing that recipe. These interactive prompts can be avoided by passing the required fields with the new--fieldflag onproject init. Documentation has also been updated to reflect this.Example
produces:Checklist
<link to issue>"fix,feature,enhancement,docs.