apache_beam.runners.interactive.interactive_environment module

Module of the current Interactive Beam environment.

For internal use only; no backwards-compatibility guarantees. Provides interfaces to interact with existing Interactive Beam environment. External Interactive Beam users please use interactive_beam module in application code or notebook.

apache_beam.runners.interactive.interactive_environment.current_env(cache_manager=None)

Gets current Interactive Beam environment.

apache_beam.runners.interactive.interactive_environment.new_env(cache_manager=None)

Creates a new Interactive Beam environment to replace current one.

class apache_beam.runners.interactive.interactive_environment.InteractiveEnvironment(cache_manager=None)

Bases: object

An interactive environment with cache and pipeline variable metadata.

Interactive Beam will use the watched variable information to determine if a PCollection is assigned to a variable in user pipeline definition. When executing the pipeline, interactivity is applied with implicit cache mechanism for those PCollections if the pipeline is interactive. Users can also visualize and introspect those PCollections in user code since they have handles to the variables.

is_py_version_ready

If Python version is above the minimum requirement.

is_interactive_ready

If the [interactive] dependencies are installed.

is_in_ipython

If the runtime is within an IPython kernel.

is_in_notebook

If the kernel is connected to a notebook frontend.

If not, it could be that the user is using kernel in a terminal or a unit test.

cleanup()

watch(watchable)

Watches a watchable.

A watchable can be a dictionary of variable metadata such as locals(), a str name of a module, a module object or an instance of a class. The variable can come from any scope even local. Duplicated variable naming doesn’t matter since they are different instances. Duplicated variables are also allowed when watching.

watching()

Analyzes and returns a list of pair lists referring to variable names and values from watched scopes.

Each entry in the list represents the variable defined within a watched watchable. Currently, each entry holds a list of pairs. The format might change in the future to hold more metadata. Duplicated pairs are allowed. And multiple paris can have the same variable name as the “first” while having different variable values as the “second” since variables in different scopes can have the same name.

set_cache_manager(cache_manager)

Sets the cache manager held by current Interactive Environment.

cache_manager()

Gets the cache manager held by current Interactive Environment.

set_pipeline_result(pipeline, result)

Sets the pipeline run result. Adds one if absent. Otherwise, replace.

evict_pipeline_result(pipeline)

Evicts the tracking of given pipeline run. Noop if absent.

pipeline_result(pipeline)

Gets the pipeline run result. None if absent.

is_terminated(pipeline)

Queries if the most recent job (by executing the given pipeline) state is in a terminal state. True if absent.