airflow.hooks.subprocess

Module Contents

Classes

SubprocessHook

Hook for running processes with the subprocess module

Attributes

SubprocessResult

airflow.hooks.subprocess.SubprocessResult[source]
class airflow.hooks.subprocess.SubprocessHook[source]

Bases: airflow.hooks.base.BaseHook

Hook for running processes with the subprocess module

run_command(self, command, env=None, output_encoding='utf-8', cwd=None)[source]

Execute the command.

If cwd is None, execute the command in a temporary directory which will be cleaned afterwards. If env is not supplied, os.environ is passed

Parameters
  • command (List[str]) -- the command to run

  • env (Optional[Dict[str, str]]) -- Optional dict containing environment variables to be made available to the shell environment in which command will be executed. If omitted, os.environ will be used. Note, that in case you have Sentry configured, original variables from the environment will also be passed to the subprocess with SUBPROCESS_ prefix. See Error Tracking for details.

  • output_encoding (str) -- encoding to use for decoding stdout

  • cwd (Optional[str]) -- Working directory to run the command in. If None (default), the command is run in a temporary directory.

Returns

namedtuple containing exit_code and output, the last line from stderr or stdout

Return type

SubprocessResult

send_sigterm(self)[source]

Sends SIGTERM signal to self.sub_process if one exists.

Was this entry helpful?