Adds the ability to pass an amount to the range() method to control the length of the gap.

Author: sdispater

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Added `on()` and `at()` methods which replace `with_date()` and `with_time()`.
 - Added a `strict` keyword argument to `parse()` to get the type matching the parsed string.
+- Added the ability to pass an amount to the `range()` method to control the length of the gap.
 
 ### Changed
 

docs/_docs/period.rst

@@ -133,6 +133,19 @@ If you want to iterate over a period, you can use the ``range()`` method:
 
     If you just want a generator you can use the ``xrange()`` method.
 
+You can pass an amount for the passed unit to control the length of the gap:
+
+.. code-block:: python
+
+    for dt in period.range('days', 2):
+        print(dt)
+
+    '2000-01-01T00:00:00+00:00'
+    '2000-01-03T00:00:00+00:00'
+    '2000-01-05T00:00:00+00:00'
+    '2000-01-07T00:00:00+00:00'
+    '2000-01-09T00:00:00+00:00'
+
 You can also directly iterate over the ``Period`` instance, the unit will be ``days`` in this case:
 
 .. code-block:: python

pendulum/period.py

@@ -183,10 +183,10 @@ def in_words(self, locale=None, separator=' '):
             locale=locale, separator=separator, _periods=periods
         )
 
-    def range(self, unit):
-        return list(self.xrange(unit))
+    def range(self, unit, amount=1):
+        return list(self.xrange(unit, amount))
 
-    def xrange(self, unit):
+    def xrange(self, unit, amount=1):
         method = 'add'
         op = operator.le
         if not self._absolute and self.invert:
@@ -195,13 +195,13 @@ def xrange(self, unit):
 
         start, end = self.start, self.end
 
-        i = 1
+        i = amount
         while op(start, end):
             yield start
 
             start = getattr(self.start, method)(**{unit: i})
 
-            i += 1
+            i += amount
 
     def intersect(self, *periods):
         """

tests/period_tests/test_range.py

@@ -92,3 +92,16 @@ def test_range_with_dst(self):
         self.assertPendulum(r[0], 2016, 10, 14, 0, 0, 0)
         self.assertPendulum(r[2], 2016, 10, 16, 1, 0, 0)
         self.assertPendulum(r[-1], 2016, 10, 21, 0, 0, 0)
+
+    def test_range_amount(self):
+        dt1 = Pendulum(2016, 10, 14, tzinfo='America/Sao_Paulo')
+        dt2 = dt1.add(weeks=1)
+
+        p = Period(dt1, dt2)
+        r = p.range('days', 2)
+
+        self.assertEqual(len(r), 4)
+        self.assertPendulum(r[0], 2016, 10, 14, 0, 0, 0)
+        self.assertPendulum(r[1], 2016, 10, 16, 1, 0, 0)
+        self.assertPendulum(r[2], 2016, 10, 18, 0, 0, 0)
+        self.assertPendulum(r[3], 2016, 10, 20, 0, 0, 0)