airflow_pydantic.PythonOperatorArgs

pydantic model airflow_pydantic.PythonOperatorArgs[source]

Bases: _TaskSpecificArgs

Show JSON schema
{
   "title": "PythonOperatorArgs",
   "type": "object",
   "properties": {
      "python_callable": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "python_callable",
         "title": "Python Callable"
      },
      "op_args": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "a list of positional arguments that will get unpacked when calling your callable",
         "title": "Op Args"
      },
      "op_kwargs": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "a dictionary of keyword arguments that will get unpacked in your function",
         "title": "Op Kwargs"
      },
      "templates_dict": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "a dictionary where the values are templates that will get templated by the Airflow engine sometime between __init__ and execute takes place and are made available in your callable\u2019s context after the template has been applied. (templated)",
         "title": "Templates Dict"
      },
      "templates_exts": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "a list of file extensions to resolve while processing templated fields, for examples ['.sql', '.hql']",
         "title": "Templates Exts"
      },
      "show_return_value_in_logs": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "a bool value whether to show return_value logs. Defaults to True, which allows return value log output. It can be set to False",
         "title": "Show Return Value In Logs"
      }
   },
   "additionalProperties": true
}

Fields:
  • op_args (List[object] | None)

  • op_kwargs (Dict[str, object] | None)

  • python_callable (object | None)

  • show_return_value_in_logs (bool | None)

  • templates_dict (Dict[str, object] | None)

  • templates_exts (List[str] | None)

field python_callable: Annotated[object, BeforeValidator(func=get_import_path, json_schema_input_type=PydanticUndefined)] | None = None

python_callable

field op_args: List[object] | None = None

a list of positional arguments that will get unpacked when calling your callable

field op_kwargs: Dict[str, object] | None = None

a dictionary of keyword arguments that will get unpacked in your function

field templates_dict: Dict[str, object] | None = None

a dictionary where the values are templates that will get templated by the Airflow engine sometime between __init__ and execute takes place and are made available in your callable’s context after the template has been applied. (templated)

field templates_exts: List[str] | None = None

a list of file extensions to resolve while processing templated fields, for examples [‘.sql’, ‘.hql’]

field show_return_value_in_logs: bool | None = None

a bool value whether to show return_value logs. Defaults to True, which allows return value log output. It can be set to False