Allow downstream programs to supply additional rules

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

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
backend

調査の方向性

まず、BIDSValidator が現在の bids_validator ルールをどのように読み込み、適用しているかを追跡します。提案されている add_rules 設定と独立した validator の構築を確認し、そのうえで、デフォルトの検証を無効にすることなく、カスタムルールを後続のインスタンスから利用できることを対象とするテストを定義します。既存のフィルタリングを維持したまま、標準化前のサンプルファイルが受け入れられれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

PyBIDS uses the bids_validator Python library to filter files by default. It is not currently possible to augment this with additional rules to allow certain (pre-standard) new files without disabling the filter entirely.

Given that the current API is an object that each caller is likely to instantiate independently, some kind of configuration that would permit each new construction to incorporate the additional rules would be useful.

For example:

>>> import bids_validator
>>> validator = bids_validator.BIDSValidator()
>>> validator.is_bids('/models/model-001_smdl.json')
False

>>> bids_validator.add_rules('statsmodels', 'path/to/statsmodels.json')
>>> 
>>> validator = bids_validator.BIDSValidator()
>>> validator.is_bids('/models/model-001_smdl.json')
True

cc @tyarkoni

主要言語
Python
スター
10
フォーク
7
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

bids-standard/python-validator のほかの issue

bids-standard/python-validator の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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