Release 2.26.0 (2020-04-14)

--------------------
! BREAKING CHANGES !
--------------------
* The ``Query.filter`` method will return a clone/copy of itself. This will
  preserve the state of ``filters`` on the original Query object.
* The ``Query.all`` method will **not** clear the filters after returning.
* The ``Query.all`` method will return a ``TypeError`` if a type other than
  an ``int`` is passed to the ``limit`` argument.
* The ``Query.count`` method will **not** clear the filters after returning.
* see: #121

* The ``AgencyChain.agencies`` field will be returned as a list of Resource objects
* see: f34afd52

Author: marz619

HISTORY.rst

@@ -3,6 +3,42 @@
 History
 =======
 
+2.26.0 (2020-04-14)
+-------------------
+
+**Breaking Changes**
+
+* The ``Query.filter`` method will return a clone/copy of itself. This will
+  preserve the state of ``filters`` on the original Query object.
+* The ``Query.all`` method will **not** clear the filters after returning.
+* The ``Query.all`` method will return a ``TypeError`` if a type other than
+  an ``int`` is passed to the ``limit`` argument.
+* The ``Query.count`` method will **not** clear the filters after returning.
+* see: https://github.com/gadventures/gapipy/pull/121
+
+New behaviour with the ``Query.filter`` method
+
+.. code-block:: python
+
+    >>> from gapipy import Client
+    >>> api = Client(application_key='MY_SECRET_KEY')
+
+    # create a filter on the departures
+    >>> query = api.departures.filter(**{"tour_dossier.id": "24309"})
+    >>> query.count()
+    494
+
+    # we preserve the filter status of the current query
+    >>> query.filter(**{"availability.status": "AVAILABLE"}).count()
+    80
+
+    >>> query.count()
+    494
+
+* The ``AgencyChain.agencies`` field will be returned as a list of Resource objects
+* see: https://github.com/gadventures/gapipy/commit/f34afd52
+
+
 2.25.1 (2020-01-02)
 -------------------
 

README.rst

@@ -44,6 +44,11 @@ Quick Start
     >>> booking.external_id = 'def'
     >>> booking.save()
 
+
+Since `2.25.1 (2020-01-02)`_
+
+.. code-block:: python
+
     >>> # since 2.25.0 reference stubs that fail to fetch will return a
 
     >>> # subclass of requests.HTTPError (See: https://github.com/gadventures/gapipy/pull/119)
@@ -119,9 +124,16 @@ only supported for queries whose resources are listable.
     Generator over all resources in the current query. If ``limit`` is a
     positive integer ``n``, then only the first ``n`` results will be returned.
 
+    * A ``TypeError`` will be raised if limit is not ``None`` or ``int`` type
+    * A ``ValueError`` will be raised if ``limit <= 0``>
+
 ``filter(field1=value1, [field2=value2, ...])``
+``filter(**{"nested.field": "value", "field": "anothervalue"})``
+
     Filter resources on the provided fields and values. Calls to ``filter`` can
-    be chained.
+    be chained. The method will return a clone of the ``Query`` object and must
+    be stored in a separate variable in order to have access to **stacked**
+    filters.
 
 ``count()``
     Return the number of resources in the current query (by reading the

gapipy/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '2.25.1'
+__version__ = '2.26.0'
 __title__ = 'gapipy'
 
 from .client import Client  # NOQA