Add version-agnostic trait detection

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

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

評価

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

調査の方向性

生成された trait IDs と trait-set の所属がどのように表現されているかを追跡することから始め、次に issue で言及されている TraitsData と specification の trait-set のクエリパスを確認します。まず、単一 ID を対象とする最小限のバージョン非依存クエリを定義します。コンテナ向けの利便性クエリは、既存の設計がそれらをサポートしている場合にのみ検討し、opaque な trait IDs が引き続き使用可能であることを検証します。

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

説明

What

Support queries to detect whether a trait ID matches a trait, ignoring version.

Why

The work in https://github.com/OpenAssetIO/OpenAssetIO-MediaCreation/issues/64 developed a strategy for versioning of traits. This works by changing the unique ID of a trait to include a version number. This means that detecting if a trait set contains a trait, where the version is not important, means testing every version of the trait until one matches.

Hosts/managers are likely to want to branch at a high level based on traits, and not initially care what version they are.

There is a danger hosts/managers will work around this by abusing the format of the trait ID, i.e. to strip off the version tag. However, the trait ID should be viewed as opaque by consumers.

So at minimum we need a way to test if a single string ID is a given trait, ignoring version.

Notes

As an extension, version-agnostic trait set/data container queries could be added for convenience. Changes to TraitsData might be needed to do this efficiently.

A useful knock-on effect of this could allow specification trait sets to be version agnostic (though constructing a trait via a Specification view class would of course still need to choose a version).

主要言語
Python
スター
7
フォーク
7
平均マージ
1時間 7分
マージ済み PR(30日)
1

環境構築

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

はじめの一歩

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

OpenAssetIO/OpenAssetIO-TraitGen のほかの issue

OpenAssetIO/OpenAssetIO-TraitGen の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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