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[source]
next_kwargs: dict[str, Any] | None[source]
timeout: datetime.timedelta | 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]

基类： airflow.sensors.base.BaseSensorOperator

等待文件或文件夹出现在文件系统中。

如果给定的路径是一个目录，则只有当其中存在任何文件（直接或在子目录中）时，此传感器才会返回 true

参数

  • fs_conn_id – 文件（路径）连接 ID 的引用

  • filepath – 文件或文件夹名称（相对于连接中设置的基本路径），可以是 glob。

  • recursive – 设置为 True 时，启用 glob filepath 参数中 ** 的递归目录匹配行为。默认为 False。

  • deferrable (bool) – 如果等待完成，是否将任务推迟到完成，默认值为 False。

  • start_from_trigger (bool) – 直接从触发器启动任务，而无需进入工作器。

  • trigger_kwargs (dict[str, Any] | None) – 当动态任务映射时，如果将 start_from_trigger 设置为 True，则传递给触发器的关键字参数。此参数在标准用法中不使用。

参见

有关如何使用此传感器的更多信息，请查看指南： FileSensor

template_fields: collections.abc.Sequence[str] = ('filepath',)[source]
ui_color = '#91818a'[source]
start_trigger_args[source]
start_from_trigger = False[source]
path()[source]
poke(context)[source]

在派生此类时覆盖。

execute(context)[source]

在创建操作符时派生。

上下文是与呈现 Jinja 模板时使用的字典相同的字典。

有关更多上下文，请参阅 get_template_context。

execute_complete(context, event=None)[source]

这个条目有用吗？