summaryrefslogtreecommitdiff
path: root/kafka/partitioner/base.py
blob: 0b1bb593c843257260c8035230b59e24b2f7cba0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

class Partitioner(object):
    """
    Base class for a partitioner
    """
    def __init__(self, partitions):
        """
        Initialize the partitioner

        Arguments:
            partitions: A list of available partitions (during startup)
        """
        self.partitions = partitions

    def partition(self, key, partitions):
        """
        Takes a string key and num_partitions as argument and returns
        a partition to be used for the message

        Arguments:
            partitions: The list of partitions is passed in every call. This
                may look like an overhead, but it will be useful
                (in future) when we handle cases like rebalancing
        """
        raise NotImplementedError('partition function has to be implemented')