Improves Period class

Author: sdispater

docs/index.rst

@@ -1249,3 +1249,56 @@ you set the ``absolute`` keyword argument to ``True``:
 
     period.in_weekend_days()
     10
+
+Range
+-----
+
+If you want to iterate over a period, you can use the ``range()`` method:
+
+.. code-block:: python
+
+    import pendulum
+
+    start = pendulum.Pendulum(2000, 1, 1)
+    end = pendulum.Pendulum(2000, 1, 10)
+
+    period = pendulum.period(start, end)
+
+    for dt in period.range('days'):
+        print(dt)
+
+    '2000-01-01T00:00:00+00:00'
+    '2000-01-02T00:00:00+00:00'
+    '2000-01-03T00:00:00+00:00'
+    '2000-01-04T00:00:00+00:00'
+    '2000-01-05T00:00:00+00:00'
+    '2000-01-06T00:00:00+00:00'
+    '2000-01-07T00:00:00+00:00'
+    '2000-01-08T00:00:00+00:00'
+    '2000-01-09T00:00:00+00:00'
+    '2000-01-10T00:00:00+00:00'
+
+.. note::
+
+    Supported units for ``range()`` are: ``years``, ``months``, ``weeks``,
+    ``days``, ``hours``, ``minutes`` and ``seconds``
+
+.. note::
+
+    If you just want a generator you can use the ``xrange()`` method.
+
+You can also directly iterate over the ``Period`` instance, the unit will be ``days`` in this case:
+
+.. code-block:: python
+
+    for dt in period:
+        print(dt)
+
+You can check if a ``Pendulum`` instance is inside a period using the ``in`` keyword:
+
+.. code-block:: python
+
+    dt = Pendulum(2000, 1, 4)
+
+    dt in period
+    True

pendulum/period.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+import operator
 from .mixins.interval import WordableIntervalMixin
 from .interval import BaseInterval
 
@@ -86,4 +87,29 @@ def in_weekend_days(self):
 
         return days * (-1 if not self._absolute and self.invert else 1)
 
+    def range(self, unit):
+        return list(self.xrange(unit))
 
+    def xrange(self, unit):
+        method = 'add'
+        op = operator.le
+        if not self._absolute and self.invert:
+            method = 'subtract'
+            op = operator.ge
+
+        start, end = self.start, self.end
+        while op(start, end):
+            yield start
+
+            start = getattr(start, method)(**{unit: 1})
+
+    def __iter__(self):
+        return self.xrange('days')
+
+    def __contains__(self, item):
+        from .pendulum import Pendulum
+
+        if not isinstance(item, Pendulum):
+            item = Pendulum.instance(item)
+
+        return item.between(self.start, self.end)

tests/period_tests/test_range.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+from datetime import datetime
+from pendulum import Period, Pendulum
+
+from .. import AbstractTestCase
+
+
+class RangeTest(AbstractTestCase):
+
+    def test_range(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 12, 45, 37)
+
+        p = Period(dt1, dt2)
+        r = p.range('days')
+        self.assertEqual(31, len(r))
+        self.assertPendulum(r[0], 2000, 1, 1, 12, 45, 37)
+        self.assertPendulum(r[-1], 2000, 1, 31, 12, 45, 37)
+
+    def test_range_no_overflow(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 11, 45, 37)
+
+        p = Period(dt1, dt2)
+        r = p.range('days')
+        self.assertEqual(30, len(r))
+        self.assertPendulum(r[0], 2000, 1, 1, 12, 45, 37)
+        self.assertPendulum(r[-1], 2000, 1, 30, 12, 45, 37)
+
+    def test_range_inverted(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 12, 45, 37)
+
+        p = Period(dt2, dt1)
+        r = p.range('days')
+        self.assertEqual(31, len(r))
+        self.assertPendulum(r[-1], 2000, 1, 1, 12, 45, 37)
+        self.assertPendulum(r[0], 2000, 1, 31, 12, 45, 37)
+
+    def test_iter(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 12, 45, 37)
+
+        p = Period(dt1, dt2)
+        i = 0
+        for dt in p:
+            self.assertIsInstanceOfPendulum(dt)
+            i += 1
+
+        self.assertEqual(31, i)
+
+    def test_contains(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 12, 45, 37)
+
+        p = Period(dt1, dt2)
+        dt = Pendulum(2000, 1, 7)
+        self.assertTrue(dt in p)
+
+    def test_not_contains(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 12, 45, 37)
+
+        p = Period(dt1, dt2)
+        dt = Pendulum(2000, 1, 1, 11, 45, 37)
+        self.assertFalse(dt in p)
+
+    def test_contains_with_datetime(self):
+        dt1 = Pendulum(2000, 1, 1, 12, 45, 37)
+        dt2 = Pendulum(2000, 1, 31, 12, 45, 37)
+
+        p = Period(dt1, dt2)
+        dt = datetime(2000, 1, 7)
+        self.assertTrue(dt in p)