>|h&dZddlZddlZddlZddlmZddlmZddlm Z ddl Z ddl m Z ddlmZGd d Zd ZGd d ZGdde j&ZdedZGddZy)akPagination feature Two pagination modes are supported: - Pagination inside the resource: the resource function is responsible for selecting requested range of items and setting total number of items. - Post-pagination: the resource returns an iterator (typically a DB cursor) and a pager is provided to paginate the data and get the total number of items. N)deepcopy)wraps)request) FlaskParser)unpack_tuple_responsec<eZdZdZdZedZedZdZy)PaginationParameterszeHolds pagination arguments :param int page: Page number :param int page_size: Page size c.||_||_d|_yN)page page_size item_count)selfr rs W/var/www/html/test/engine/venv/lib/python3.12/site-packages/flask_smorest/pagination.py__init__zPaginationParameters.__init__!s "c:|jdz |jzS)zReturn first item numberr)r rrs r first_itemzPaginationParameters.first_item&s A //rc:|j|jzdz S)zReturn last item numberr)rrrs r last_itemzPaginationParameters.last_item+s/!33rch|jjd|jd|jdS)Nz(page=z ,page_size=)) __class____name__r rrs r__repr__zPaginationParameters.__repr__0s5~~&&'TYYMT^^,>a A rN) r __module__ __qualname____doc__rpropertyrrrrrr r s9  0044 rr cFGfddtj}|S)z%Generate a PaginationParametersSchemac.eZdZdZGddZej jWejjdZ ej jWejjdWZ ejdZ y ) I_pagination_parameters_schema_factory..PaginationParametersSchemaz8Deserializes pagination params into PaginationParametersc(eZdZdZej Zy)N_pagination_parameters_schema_factory..PaginationParametersSchema.MetaTN)rrrorderedmaEXCLUDEunknownr"rrMetar'=sGjjGrr,r)min) load_defaultvalidate)r-maxctdi|S)Nr")r )rdatakwargss rmake_paginatorzX_pagination_parameters_schema_factory..PaginationParametersSchema.make_paginatorIs'/$/ /rN)rrrr r,r)fieldsIntegerr/Ranger r post_loadr4)def_max_page_sizedef_page def_page_sizesrPaginationParametersSchemar%:sF ! !yy  !BKK,=,=!,=,D! II%%&[[&&12C&D&  0  0rr<)r)Schema)r:r;r9r<s``` r%_pagination_parameters_schema_factoryr>7s 00RYY0& &%rc<eZdZdZdZedZedZdZy)PagezpPager for simple types such as lists. Can be subclassed to provide a pager for a specific data object. cV||_||_|j|j_y)zCreate a Page instance :param sequence collection: Collection of items to page through :page PaginationParameters page_params: Pagination parameters N) collection page_paramsr)rrBrCs rrz Page.__init__Vs% %&&*oo#rct|j|jj|jjdzS)Nr)listrBrCrrrs ritemsz Page.items`s= OO  ++d.>.>.H.H1.L   rc,t|jSr )lenrBrs rrzPage.item_counths4??##rch|jjd|jd|jdS)Nz (collection=z ,page_params=r)rrrBrCrs rrz Page.__repr__ls8~~&&'4??-]4;K;K:Na Q rN) rrrr rr!rFrrr"rrr@r@Ps9 6  $$ rr@ceZdZdZej j Zej j Zej j Z ej j Z ej j Z ej j Z ej j Z GddZy)PaginationMetadataSchemazPagination metadata schema Used to serialize pagination metadata. Its main purpose is to document the pagination metadata. ceZdZdZy)PaginationMetadataSchema.MetaTN)rrrr(r"rrr,rMsrr,N)rrrr r)r5Inttotal total_pages first_page last_pager previous_page next_pager,r"rrrKrKss| IIMMOE))--/KJ I 99==?DIIMMOM IrrKzPagination metadata) descriptionschemacbeZdZdZeZdZddddZd dddddZe d Z d Z d Z d Z y)PaginationMixinz*Extend Blueprint to add Pagination featurez X-Paginationr d)r r max_page_sizeNc|jd}|jd}|jd}t|||ddjjfd}|S)a Decorator adding pagination to the endpoint :param type[Page] pager: Page class used to paginate response data :param int page: Default requested page number (default: 1) :param int page_size: Default requested page size (default: 10) :param int max_page_size: Maximum page size (default: 100) If a :class:`Page ` class is provided, it is used to paginate the data returned by the view function, typically a lazy database cursor. Otherwise, pagination is handled in the view function. The decorated function may return a tuple including status and/or headers, like a typical flask view function. It may not return a ``Response`` object. See :doc:`Pagination `. r rr[query)inrVctfd}tt|di|_t j j id|jd<|S)Ncf jjtd}||d<t|i|\}}}||j} j L|j *tjdtjddn j|||\}}|||fS) Nr])locationpagination_parameters)rCzitem_count not set in endpoint .) stacklevel) PAGINATION_ARGUMENTS_PARSERparserrrFPAGINATION_HEADER_NAMErwarningswarnendpoint_set_pagination_metadata) argsr3rCresultstatusheadersfuncpage_params_schemapagerrs rwrapperz.decorator..wrappers">>DD&'E =6AF23+@d@Uf@U*V'$"6{CIIF..:"--5 =g>N>N=OqQ'( +/*G*G'+vw..r_apidoc) parametersresponse pagination)rrgetattrruhttp HTTPStatusname)rqrterror_status_coderrrsrvrs` r decoratorz+PaginationMixin.paginate..decoratorsd 4[ / />'ww 2'FGGO(%t7H'I'N'N-GOOL )Nr)DEFAULT_PAGINATION_PARAMETERSr>rfDEFAULT_VALIDATION_STATUS) rrsr rr[r~r}rrrvs `` @@@rpaginatezPaginationMixin.paginates& <55f=D  ::;GI   >>OMB )]  ( !<<VV) ) Vrci}||d<|dk(rd|d<nB|dz |zdz}d}|}||d<||d<||d<||kr||d<||kDr|dz |d<||kr|dz|d <tj|S) zBuild pagination metadata from page, page size and item count Override this to use another pagination metadata structure rOrrPrrQrRr rSrT)rKdump)r rr page_metadata page_countrQrRs r_make_pagination_metadataz)PaginationMixin._make_pagination_metadatas  !+ g ?+,M- (&>i71?  rr )rrrr rrfrhrr staticmethodrrlrrr"rrrXrXs[4"--,./RRU$V!O44tOb>>4    rrX)r rzrricopyr functoolsrflaskr marshmallowr)webargs.flaskparserrutilsrr r>r@r=rKrrXr"rrrsm  +(  :&2   Fryy()& ``r