airflow.secrets.local_filesystem

Objects relating to retrieving connections and variables from local file.

Attributes

`log`
`FILE_PARSERS`

Classes

LocalFilesystemBackend

Retrieves Connection objects and Variables from local files.

Functions

`get_connection_parameter_names`()	Return `airflow.models.connection.Connection` constructor parameters.
`load_variables`(file_path)	Load variables from a text file.
`load_connections_dict`(file_path)	Load connection from text file.
`load_configs_dict`(file_path)	Load configs from a text file.

Module Contents

airflow.secrets.local_filesystem.log[source]

airflow.secrets.local_filesystem.get_connection_parameter_names()[source]

Return airflow.models.connection.Connection constructor parameters.

airflow.secrets.local_filesystem.FILE_PARSERS[source]

airflow.secrets.local_filesystem.load_variables(file_path)[source]

Load variables from a text file.

JSON, YAML and .env files are supported.

Parameters:: file_path (str) – The location of the file that will be processed.

airflow.secrets.local_filesystem.load_connections_dict(file_path)[source]

Load connection from text file.

JSON, YAML and .env files are supported.

Returns:: A dictionary where the key contains a connection ID and the value contains the connection.
Return type:: dict[str, Any]

airflow.secrets.local_filesystem.load_configs_dict(file_path)[source]

Load configs from a text file.

JSON, YAML and .env files are supported.

Parameters:: file_path (str) – The location of the file that will be processed.
Returns:: A dictionary where the key contains a config name and the value contains the config value.
Return type:: dict[str, str]

class airflow.secrets.local_filesystem.LocalFilesystemBackend(variables_file_path=None, connections_file_path=None, configs_file_path=None)[source]

Bases: airflow.secrets.base_secrets.BaseSecretsBackend, airflow.utils.log.logging_mixin.LoggingMixin

Retrieves Connection objects and Variables from local files.

JSON, YAML and .env files are supported.

Parameters:

variables_file_path (str | None) – File location with variables data.
connections_file_path (str | None) – File location with connection data.

variables_file = None[source]

connections_file = None[source]

configs_file = None[source]

get_connection(conn_id)[source]

Return connection object with a given conn_id.

Parameters:: conn_id (str) – connection id
Returns:: Connection object or None
Return type:: airflow.models.connection.Connection | None

get_variable(key)[source]

Return value for Airflow Variable.

Parameters:: key (str) – Variable Key
Returns:: Variable Value
Return type:: str | None

get_config(key)[source]

Return value for Airflow Config Key.

Parameters:: key (str) – Config Key
Returns:: Config Value
Return type:: str | None