vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

chore: add docstring for get_docs

Browse source
This commit is contained in:
Shrihari Mahabal 2026-03-09 12:39:56 +05:30
parent e2fef24a08
commit 16efc5fa45
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
frappe/model/document.py
View file

@ -169,9 +169,17 @@ def get_docs(
) -> list["Document"] | Generator[list["Document"]]:
"""Fetch fully instantiated Document objects from the database.
Returns a list of Documents by default. Pass ``as_generator=True`` to get
a chunked generator that yields a list of Documents per chunk to reduce
peak memory usage.
Returns a list of Documents by default. Pass `as_generator=True` to get
a chunked generator that yields a list of Documents per chunk to reduce memory usage.
:param doctype: DocType of the records to fetch.
:param filters: Dict or list of filters to apply.
:param chunk_size: Number of records to yield per chunk if using `as_generator`. Default 1000.
:param limit: Maximum total number of records to fetch.
:param limit_start: Start results at record #. Default 0.
:param order_by: Order By string, e.g. `creation desc`.
:param as_generator: If True, returns a generator yielding lists of Documents.
:param for_update: If True, locks the fetched rows for update.
"""
if is_virtual_doctype(doctype):
frappe.throw(_("Virtual DocType {0} cannot be fetched in bulk.").format(doctype))