airflow.providers.standard.sensors.filesystem¶

类¶

`StartTriggerArgs`	从触发器启动任务执行所需的参数。
`FileSensor`	等待文件或文件夹到达文件系统。

模块内容¶

class airflow.providers.standard.sensors.filesystem.StartTriggerArgs[source]¶

从触发器启动任务执行所需的参数。

trigger_cls: str[source]¶

next_method: str[source]¶

trigger_kwargs: dict[str, Any] | None = None[source]¶

next_kwargs: dict[str, Any] | None = None[source]¶

timeout: datetime.timedelta | None = None[source]¶

class airflow.providers.standard.sensors.filesystem.FileSensor(*, filepath, fs_conn_id='fs_default', recursive=False, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), start_from_trigger=False, trigger_kwargs=None, **kwargs)[source]¶

Bases: airflow.sensors.base.BaseSensorOperator

等待文件或文件夹到达文件系统。

如果给定的路径是目录，则此 sensor 仅当目录内存在任何文件（直接或子目录内）时返回 true。

参数:

fs_conn_id – 文件（路径）连接 ID 的引用
filepath – 文件或文件夹名称（相对于连接中设置的基础路径），可以是 glob 表达式。
recursive – 设置为 True 时，启用 glob filepath 参数中 ** 的递归目录匹配行为。默认为 False。
deferrable (bool) – 如果等待完成，是否将任务延迟执行直到完成，默认为 False。
start_from_trigger (bool) – 直接从触发器启动任务，无需进入 worker。
trigger_kwargs (dict[str, Any] | None) – 在动态任务映射期间，当 start_from_trigger 设置为 True 时传递给触发器的关键字参数。此参数在标准用法中未使用。

另请参阅

有关如何使用此 sensor 的更多信息，请参阅指南: FileSensor

template_fields: collections.abc.Sequence[str] = ('filepath',)[source]¶

ui_color = '#91818a'[source]¶

start_trigger_args[source]¶

start_from_trigger = False[source]¶

filepath[source]¶

fs_conn_id = 'fs_default'[source]¶

recursive = False[source]¶

deferrable = True[source]¶

property path: str[source]¶

poke(context)[source]¶

派生此类时重写此方法。

execute(context)[source]¶

创建 operator 时派生此方法。

执行任务的主要方法。context 与渲染 jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

execute_complete(context, event=None)[source]¶