apache_beam.runners.interactive.utils module

Utilities to be used in Interactive Beam.

apache_beam.runners.interactive.utils.to_element_list(reader, coder, include_window_info, n=None, include_time_events=False)[source]

Returns an iterator that properly decodes the elements from the reader.

apache_beam.runners.interactive.utils.elements_to_df(elements, include_window_info=False, element_type=None)[source]

Parses the given elements into a Dataframe.

If the elements are a list of WindowedValues, then it will break out the elements into their own DataFrame and return it. If include_window_info is True, then it will concatenate the windowing information onto the elements DataFrame.


Adds the IPython handler to a dummy parent logger (named ‘apache_beam.runners.interactive’) of all interactive modules’ loggers so that if is_in_notebook, logging displays the logs as HTML in frontends.

class apache_beam.runners.interactive.utils.IPythonLogHandler(level=0)[source]

Bases: logging.Handler

A logging handler to display logs as HTML in IPython backed frontends.

Initializes the instance - basically setting the formatter to None and the filter list to empty.

log_template = '\n <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">\n <div class="alert alert-{level}">{msg}</div>'
logging_to_alert_level_map = {0: 'light', 10: 'dark', 20: 'info', 30: 'warning', 40: 'danger', 50: 'danger'}

Obfuscates any inputs into a hexadecimal string.

class apache_beam.runners.interactive.utils.ProgressIndicator(enter_text, exit_text)[source]

Bases: object

An indicator visualizing code execution in progress.

spinner_template = '\n <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">\n <div id="{id}">\n <div class="spinner-border text-info" role="status"></div>\n <span class="text-info">{text}</span>\n </div>\n '
spinner_removal_template = '\n $("#{id}").remove();'

A decorator using a unique progress indicator as a context manager to execute the given function within.


A decorator convert python objects returned by callables to json string.

The decorated function should always return an object parsable by json.dumps. If the object is not parsable, the str() of original object is returned instead.

apache_beam.runners.interactive.utils.pcoll_by_name() → Dict[str, apache_beam.pvalue.PCollection][source]

Finds all PCollections by their variable names defined in the notebook.

apache_beam.runners.interactive.utils.find_pcoll_name(pcoll: apache_beam.pvalue.PCollection) → str[source]

Finds the variable name of a PCollection defined by the user.

Returns None if not assigned to any variable.

apache_beam.runners.interactive.utils.cacheables() → Dict[apache_beam.runners.interactive.caching.cacheable.CacheKey, apache_beam.runners.interactive.caching.cacheable.Cacheable][source]

Finds all Cacheables with their CacheKeys.


Watches the unbounded sources in the pipeline.

Sources can output to a PCollection without a user variable reference. In this case the source is not cached. We still want to cache the data so we synthetically create a variable to the intermediate PCollection.


Checks if a given pipeline has recordable sources.


Returns a pipeline’s recordable sources.

apache_beam.runners.interactive.utils.create_var_in_main(name: str, value: Any, watch: bool = True) → Tuple[str, Any][source]

Declares a variable in the main module.

  • name – the variable name in the main module.
  • value – the value of the variable.
  • watch – whether to watch it in the interactive environment.

A 2-entry tuple of the variable name and value.


Asserts whether the specified GCS bucket with the name bucket_name exists.

Logs an error and raises a ValueError if the bucket does not exist.

Logs a warning if the bucket cannot be verified to exist.