compass.Step.update_streams_at_runtime

Step.update_streams_at_runtime(package, streams, template_replacements, out_name=None)[source]

Update the streams files during the run phase of this step using the given template and replacements. This may be useful for updating streams based on config options that a user may have changed before running the step.

Parameters:
  • package (Package) – The package name or module object that contains the streams file

  • streams (str) – The name of a Jinja2 template to be rendered with replacements

  • template_replacements (dict) – A dictionary of replacements

  • out_name (str, optional) – The name of the streams file to write out, streams.<core> by default