Creating custom operators in Apache Airflow - Why You Should Know This

The Big Idea

What if you could write a task once and use it everywhere without copying code?

The Scenario

Imagine you have many workflows in Airflow that need to perform similar but slightly different tasks, like sending emails with different formats or processing data from various sources.

Doing this manually means copying and pasting similar code everywhere and changing small parts each time.

The Problem

This manual approach is slow because you repeat the same work over and over.

It is error-prone since a small change in one place might not be updated everywhere.

Maintaining and updating these workflows becomes a headache as the number of tasks grows.

The Solution

Creating custom operators lets you write the task logic once and reuse it everywhere.

You can customize behavior by passing parameters without rewriting code.

This makes your workflows cleaner, easier to maintain, and less error-prone.

Before vs After

✗ Before

def send_email_task():
    # code to send email with format A

def send_email_task_v2():
    # similar code with slight changes for format B

✓ After

from airflow.models import BaseOperator

class CustomEmailOperator(BaseOperator):
    def __init__(self, email_format, **kwargs):
        super().__init__(**kwargs)
        self.email_format = email_format
    def execute(self, context):
        # send email using self.email_format
        pass

What It Enables

You can build flexible, reusable, and maintainable workflows that adapt easily to changing needs.

Real Life Example

A data team creates a custom operator to load data from different databases by just changing connection details, instead of writing new code for each database.

Key Takeaways

Manual repetition causes slow and error-prone workflows.

Custom operators let you write reusable task logic once.

This improves maintainability and flexibility in Airflow pipelines.

Practice

1. What is the main purpose of creating a custom operator in Airflow?

easy

A. To install new Airflow plugins automatically

B. To change the Airflow webserver UI appearance

C. To configure the Airflow scheduler settings

D. To define reusable tasks with custom logic inside the execute method

Solution

1. Step 1: Understand what custom operators do

   Custom operators let you create tasks that run your own code inside Airflow workflows.

2. Step 2: Identify where custom logic is placed

   This logic is placed inside the execute method of the operator class.

3. Final Answer:

   To define reusable tasks with custom logic inside the execute method -> Option D

4. Quick Check:

   Custom operator = reusable task logic [OK]

Hint: Custom operators run your code in the execute() method [OK]

Common Mistakes:

• Confusing UI or scheduler settings with operators
• Thinking operators install plugins
• Believing custom operators change Airflow core behavior

2. Which of the following is the correct way to start defining a custom operator class in Airflow?

easy

A. operator MyOperator extends BaseOperator:

B. class MyOperator(BaseOperator):

C. class MyOperator():

D. def MyOperator():

Solution

1. Step 1: Recall Python class syntax for inheritance

   In Python, to inherit from a class, use class ClassName(BaseClass):.

2. Step 2: Match Airflow custom operator syntax

   Airflow custom operators inherit from BaseOperator, so the correct syntax is class MyOperator(BaseOperator):.

3. Final Answer:

   class MyOperator(BaseOperator): -> Option B

4. Quick Check:

   Python class inheritance = class MyOperator(BaseOperator): [OK]

Hint: Custom operators inherit BaseOperator with class syntax [OK]

Common Mistakes:

• Using function definition instead of class
• Omitting BaseOperator inheritance
• Using incorrect syntax like 'operator' keyword

3. Given this custom operator code snippet, what will be printed when the task runs?

from airflow.models import BaseOperator
from airflow.utils.decorators import apply_defaults

class PrintOperator(BaseOperator):
    @apply_defaults
    def __init__(self, message: str, **kwargs):
        super().__init__(**kwargs)
        self.message = message

    def execute(self, context):
        print(f"Message: {self.message}")

# Task instance runs with message='Hello Airflow'

medium

A. Message: Hello Airflow

B. Hello Airflow

C. Message: message

D. Error: missing execute method

Solution

1. Step 1: Understand the execute method output

   The execute method prints the string with prefix "Message:" followed by the message attribute.

2. Step 2: Substitute the message value

   The task runs with message='Hello Airflow', so the print outputs "Message: Hello Airflow".

3. Final Answer:

   Message: Hello Airflow -> Option A

4. Quick Check:

   execute prints 'Message: ' + message [OK]

Hint: execute() prints 'Message: ' plus the message string [OK]

Common Mistakes:

• Forgetting the 'Message:' prefix in print
• Confusing attribute name with string literal
• Assuming execute method is missing

4. What is wrong with this custom operator code?

from airflow.models import BaseOperator

class BadOperator(BaseOperator):
    def __init__(self, param):
        self.param = param

    def execute(self, context):
        print(self.param)

medium

A. param should be a class variable, not instance variable

B. execute method should not have context parameter

C. Missing call to super().__init__() in __init__ method

D. BaseOperator cannot be inherited

Solution

1. Step 1: Check __init__ method for BaseOperator inheritance

   When inheriting BaseOperator, you must call super().__init__(**kwargs) to initialize the base class properly.

2. Step 2: Identify missing super() call

   The code does not call super().__init__()</>, so Airflow internal setup will fail.

3. Final Answer:

   Missing call to super().__init__() in __init__ method -> Option C

4. Quick Check:

   Always call super().__init__() in custom operator init [OK]

Hint: Always call super().__init__() in __init__ [OK]

Common Mistakes:

• Omitting super().__init__() call
• Removing context parameter from execute
• Misunderstanding inheritance rules

5. You want to create a custom operator that accepts a list of filenames and prints each filename during execution. Which code snippet correctly implements this behavior?

hard

A. class FilePrinterOperator(BaseOperator):
@apply_defaults
def __init__(self, files: list, **kwargs):
super().__init__(**kwargs)
self.files = files
def execute(self, context):
for f in self.files:
print(f)

B. class FilePrinterOperator(BaseOperator):
def __init__(self, files):
self.files = files
def execute(self):
for f in files:
print(f)

C. class FilePrinterOperator(BaseOperator):
@apply_defaults
def __init__(self, files: str, **kwargs):
super().__init__(**kwargs)
self.files = files
def execute(self, context):
print(self.files)

D. class FilePrinterOperator(BaseOperator):
@apply_defaults
def __init__(self, files: list, **kwargs):
super().__init__(**kwargs)
self.files = files
def execute(self, context):
print(files)

Solution

1. Step 1: Check constructor and inheritance

   class FilePrinterOperator(BaseOperator): @apply_defaults def __init__(self, files: list, **kwargs): super().__init__(**kwargs) self.files = files def execute(self, context): for f in self.files: print(f) correctly uses @apply_defaults, calls super().__init__(**kwargs), and stores the list in self.files.

2. Step 2: Verify execute method logic

   class FilePrinterOperator(BaseOperator): @apply_defaults def __init__(self, files: list, **kwargs): super().__init__(**kwargs) self.files = files def execute(self, context): for f in self.files: print(f) loops over self.files and prints each filename, matching the requirement.

3. Final Answer:

   Option A correctly implements the custom operator to print each filename -> Option A

4. Quick Check:

   Use self.files list and loop in execute() [OK]

Hint: Use self.files list and loop inside execute() [OK]

Common Mistakes:

• Not calling super().__init__()
• Using wrong parameter types
• Referencing variables without self.
• Missing context parameter in execute