Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving deque implementation to its own file #113

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions book/deques/deque.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
class Deque:
def __init__(self):
self._items = []

def is_empty(self):
return self._items == []

def add_front(self, item):
self._items.append(item)

def add_rear(self, item):
self._items.insert(0,item)
bharatagarwal marked this conversation as resolved.
Show resolved Hide resolved

def remove_front(self):
return self._items.pop()

def remove_rear(self):
return self._items.pop(0)

def size(self):
return len(self._items)
30 changes: 30 additions & 0 deletions book/deques/deque_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import unittest

from deque import Deque

cases = (
(lambda d: d.is_empty(), [], True),
(lambda d: d.add_rear(4), [4], None),
(lambda d: d.add_rear('dog'), ['dog', 4], None),
(lambda d: d.add_front('cat'), ['dog', 4, 'cat'], None),
(lambda d: d.add_front(True), ['dog', 4, 'cat', True], None),
(lambda d: d.size(), ['dog', 4, 'cat', True], 4),
(lambda d: d.is_empty(), ['dog', 4, 'cat', True], False),
(lambda d: d.add_rear(8.4), [8.4, 'dog', 4, 'cat', True], None),
(lambda d: d.remove_rear(), ['dog', 4, 'cat', True], 8.4),
(lambda d: d.remove_front(), ['dog', 4, 'cat'], True)
)


class TestCorrectness(unittest.TestCase):

def test_operates_correctly(self):
deque = Deque()
for operate, expected_state, expected_return in cases:
actual_return = operate(deque)
self.assertEqual(actual_return, expected_return)
self.assertEqual(deque._items, expected_state)
Comment on lines +5 to +26
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would you feel about something like this instead?

cases = (
    (Deque.is_empty, [], [], True),
    (Deque.add_rear, [4], [4], None),
    (Deque.add_rear, ['dog'], ['dog', 4], None),
    (Deque.add_front, ['cat'], ['dog', 4, 'cat'], None),
    (Deque.add_front, [True], ['dog', 4, 'cat', True], None),
    (Deque.size, [], ['dog', 4, 'cat', True], 4),
    (Deque.is_empty, [], ['dog', 4, 'cat', True], False),
    (Deque.add_rear, [8.4], [8.4, 'dog', 4, 'cat', True], None),
    (Deque.remove_rear, [], ['dog', 4, 'cat', True], 8.4),
    (Deque.remove_front, [], ['dog', 4, 'cat'], True)
)


class TestCorrectness(unittest.TestCase):

    def test_operates_correctly(self):
        deque = Deque()
        for method, args, expected_state, expected_return in cases:
            actual_return = method(deque, *args)
            self.assertEqual(actual_return, expected_return)
            self.assertEqual(deque._items, expected_state)



if __name__ == '__main__':
unittest.main()
24 changes: 1 addition & 23 deletions book/deques/implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,7 @@ position: 3

In practice, the most straightforward way to utilize a deque in Python will be to import `deque` from the `collections` module. For illustration purposes however, below we present a possible implementation of a deque using a Python list as the underlying concrete data type.

```python
class Deque(object):
def __init__(self):
self._items = []

def is_empty(self):
return self._items == []

def add_front(self, item):
self._items.append(item)

def add_rear(self, item):
self._items.insert(0,item)

def remove_front(self):
return self._items.pop()

def remove_rear(self):
return self._items.pop(0)

def size(self):
return len(self._items)
```
<!-- literate deques/deque.py -->

In `remove_front` we use the `pop` method to remove the last element from
the list. However, in `remove_rear`, the `pop(0)` method must remove the
Expand Down
2 changes: 1 addition & 1 deletion book/deques/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ Deque Operation | Deque Contents | Return Value
`d.is_empty()` | `['dog', 4, 'cat', True]` | `False`
`d.add_rear(8.4)` | `[8.4, 'dog', 4, 'cat',True]` |
`d.remove_rear()` | `['dog', 4, 'cat', True]` | `8.4`
`d.remove_front()` | `['dog', 4, 'cat'] | `True`
`d.remove_front()` | `['dog', 4, 'cat']` | `True`