Reference track

What BenchPress is made of, rather than how to use it or how to run it.

Who this is for. Somebody who calls the API from another program, changes
the code, or has to answer a question the other two tracks do not cover.

Before you start. The user track and the
operator track describe the same system as tasks. This track
assumes you have watched one deploy run. Read
Deploy from a template first if you have not.

Pick a page by the question you have

What this track is counted against

The numbers below are the size of the surface each page documents. Every page
accounts for its whole set. A page that omits a member says which one and why.

Two rules that explain most of the code

Both are repository conventions, and both are enforced.

1. Query with frappe.qb, never frappe.db.sql. A raw string query is a
   lint failure.
2. Every whitelisted function checks permissions itself. The decorator only
   publishes the function. It grants nothing. See
   How an endpoint is guarded.

Behavior also lives in hooks.py, not only in the file you are reading. Check
it before you assume a save does the plain thing.

Where the code lives

Related

• Architecture — the map to read first.
• Operator track — the same system, from the host side.
• Settings reference — every field on the two settings documents.