pay.collections.payable

Module Contents

Classes

PayableCollection

Provides a collection of all payable models. This collection is

Attributes

_P

pay.collections.payable._P

class pay.collections.payable.PayableCollection(session: sqlalchemy.orm.Session, cls: type[_P], page: int = 0)

class pay.collections.payable.PayableCollection(session: sqlalchemy.orm.Session, cls: Literal[*] = '*', page: int = 0)

Bases: onegov.core.collection.Pagination[_P]

Provides a collection of all payable models. This collection is meant to be read-only, so there’s no add/delete methods.

To add payments to payable models just use the payment property and directly assign a new or an existing payment.

property classes: tuple[type[onegov.core.orm.Base], Ellipsis]

property page_index: int

Returns the current page index (starting at 0).

page: int

query() → QueryChain[_P]

__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.

subset() → QueryChain[_P]

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

page_by_index(index: int) → typing_extensions.Self

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