"On demand" formulas

オープン
#207 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@jqnatividad がすでに取り組んでいます。

2025年5月29日 から。

評価

この issue はまだ評価されていません。

説明

DP+ DRUF currently supports two formula types:

  • formula (aka "direct formulas")
    the Jinja2 expression is evaluated at package creation/update and "directly" stored into the designated package/resource field.
  • suggestion_formula
    the Jinja2 expression is evaluated at package creation/update, and is stored in the dpp_suggestions package field (as a JSON object). The dpp_suggestions package field is used to power the Bootstrap-powered Suggestion UI popover

We should create a third formula type - On demand, which is a variant of suggestion_formula.

It is indicated by a new scheming keyword - ondemand_formula.

As the name implies, an ondemand formula is calculated on demand, i.e. while entering metadata in CKAN.

When an ondemand_formula is used, the Suggestion UI will have an "Recalculate" button in addition to "Apply Suggestion" button.

To enable this, DP+ will have a new Action API endpoint - dpp_ondemand_formula:

def dpp_ondemand_formula(context, data_dict):
'''
Evaluate the on_demand formula for the given package/resource field

:param formula: the Jinja2 expression to evaluate.
:param track_invocation: track the formula/result pair with a timestamp (default: false)
'''

When the "Recalculate" button is pressed, the Suggestion UI calls the dpp_ondemand_formula API for the associated field.

Ondemand formulas will be initially used for AI-powered formulas - as they often need repeated invocations while entering metadata.
We offer the ability to "track_invocation", so the user can possibly use/consult previous invocations.

Eventually, ondemand formulas can be also used to have "formula presets", similar to scheming's "presets".
"Formula presets" are traditional jinja2 templates that can render a custom UI for an associated formula that may require additional form controls beyond the generic Suggestion UI (e.g. a field picker to select which fields to use in a formula during data entry).

cc @minhajuddin2510 @samibaig @wardi

主要言語
Python
スター
47
フォーク
33
平均マージ
2時間 28分
マージ済み PR(30日)
10

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

dathere/datapusher-plus のほかの issue

dathere/datapusher-plus の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。