pagination_helper.py

"""
For this exercise you will be strengthening your page-fu mastery. 
You will complete the PaginationHelper class, which is a utility class helpful for querying paging information related to an array.

The class is designed to take in an array of values and an integer indicating how many items will be allowed per each page. 
The types of values contained within the collection/array are not relevant.

The following are some examples of how this class is used:

helper = PaginationHelper(['a','b','c','d','e','f'], 4)
helper.page_count() # should == 2
helper.item_count() # should == 6
helper.page_item_count(0)  # should == 4
helper.page_item_count(1) # last page - should == 2
helper.page_item_count(2) # should == -1 since the page is invalid

# page_index takes an item index and returns the page that it belongs on
helper.page_index(5) # should == 1 (zero based index)
helper.page_index(2) # should == 0
helper.page_index(20) # should == -1
helper.page_index(-10) # should == -1 because negative indexes are invalid
"""

class PaginationHelper:

    # The constructor takes in an array of items and a integer indicating
    # how many items fit within a single page
    def __init__(self, collection, items_per_page):
        self.collection = collection
        self.items_per_page = items_per_page

    # returns the number of items within the entire collection
    def item_count(self):
        return len(self.collection)

    # returns the number of pages
    def page_count(self):
        return self.item_count() // self.items_per_page + min(
            1,
            self.item_count() % self.items_per_page)

    # returns the number of items on the current page. page_index is zero based
    # this method should return -1 for page_index values that are out of range
    def page_item_count(self, page_index):
        if page_index >= self.page_count():
            return -1
        else:
            return len(self.collection[self.items_per_page *
                            page_index:self.items_per_page * (page_index+1)])

    # determines what page an item is on. Zero based indexes.
    # this method should return -1 for item_index values that are out of range
    def page_index(self, item_index):
        if item_index >= self.item_count() or item_index < 0:
            return -1
        else:
            return item_index // self.items_per_page

def main():
    helper = PaginationHelper(['a','b','c','d','e','f'], 4)
    print(helper.page_count()) # should == 2
    print(helper.item_count()) # should == 6
    print(helper.page_item_count(0))  # should == 4
    print(helper.page_item_count(1)) # last page - should == 2
    print(helper.page_item_count(2))

    # page_index takes an item index and returns the page that it belongs on
    print(helper.page_index(5)) # should == 1 (zero based index)
    print(helper.page_index(0)) # should == 0
    print(helper.page_index(20)) # should == -1
    print(helper.page_index(-10)) # should == -1 because negative indexes are invalid

if __name__ == "__main__":
    main()