agency.collections.agencies
===========================

.. py:module:: agency.collections.agencies


Classes
-------

.. autoapisummary::

   agency.collections.agencies.FilterParams
   agency.collections.agencies.ExtendedAgencyCollection
   agency.collections.agencies.PaginatedAgencyCollection


Module Contents
---------------

.. py:class:: FilterParams

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: title
      :type:  str | None


   .. py:attribute:: updated_gt
      :type:  str | None


   .. py:attribute:: updated_ge
      :type:  str | None


   .. py:attribute:: updated_eq
      :type:  str | None


   .. py:attribute:: updated_le
      :type:  str | None


   .. py:attribute:: updated_lt
      :type:  str | None


.. py:class:: ExtendedAgencyCollection(session: sqlalchemy.orm.Session, root_pdf_modified: str | None = None, browse: str | None = None)

   Bases: :py:obj:`onegov.core.orm.abstract.AdjacencyListCollection`\ [\ :py:obj:`onegov.agency.models.ExtendedAgency`\ ]


   A base class for collections working with :class:`AdjacencyList`. 


   .. py:attribute:: __listclass__

      The list class this collection handles. Must inherit from
      :class:`AdjacencyList`.




   .. py:attribute:: root_pdf_modified
      :value: None



   .. py:attribute:: browse
      :value: None



.. py:class:: PaginatedAgencyCollection(session: sqlalchemy.orm.Session, page: int = 0, parent: str | Literal[False] | None = None, exclude_hidden: bool = True, joinedload: collections.abc.Collection[str] | None = None, title: str | None = None, updated_gt: str | None = None, updated_ge: str | None = None, updated_eq: str | None = None, updated_le: str | None = None, updated_lt: str | None = None, undefer: collections.abc.Collection[str] | None = None)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`onegov.agency.models.ExtendedAgency`\ ], :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`onegov.agency.models.ExtendedAgency`\ ]


   Abstract base class for generic types.

   A generic type is typically declared by inheriting from
   this class parameterized with one or more type variables.
   For example, a generic mapping type might be defined as::

     class Mapping(Generic[KT, VT]):
         def __getitem__(self, key: KT) -> VT:
             ...
         # Etc.

   This class can then be used as follows::

     def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
         try:
             return mapping[key]
         except KeyError:
             return default


   .. py:attribute:: page
      :value: 0



   .. py:attribute:: parent
      :value: None



   .. py:attribute:: title
      :value: None



   .. py:attribute:: updated_gt
      :value: None



   .. py:attribute:: updated_ge
      :value: None



   .. py:attribute:: updated_eq
      :value: None



   .. py:attribute:: updated_le
      :value: None



   .. py:attribute:: updated_lt
      :value: None



   .. py:attribute:: exclude_hidden
      :value: True



   .. py:attribute:: joinedload
      :value: []



   .. py:attribute:: undefer
      :value: []



   .. py:property:: model_class
      :type: type[onegov.agency.models.ExtendedAgency]



   .. py:method:: __eq__(other: object) -> bool

      Returns True if the current and the other Pagination instance
      are equal. Used to find the current page in a list of pages.




   .. py:method:: subset() -> sqlalchemy.orm.Query[onegov.agency.models.ExtendedAgency]

      Returns an SQLAlchemy query containing all records that should
      be considered for pagination.




   .. py:property:: page_index
      :type: int


      Returns the current page index (starting at 0). 



   .. py:method:: page_by_index(index: int) -> Self

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.




   .. py:method:: for_filter(**kwargs: typing_extensions.Unpack[FilterParams]) -> Self


   .. py:method:: query() -> sqlalchemy.orm.Query[onegov.agency.models.ExtendedAgency]