voxel51/fiftyone

[BUG] Datasets cannot have 'pk' fields

Open

#2,192 opened on 2022年10月24日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (4,021 stars) (400 forks)batch import
bugcoregood first issue

説明

Datasets cannot currently have a pk field:

import fiftyone as fo

sample = fo.Sample(filepath="image.jpg", pk=123)

dataset = fo.Dataset()
dataset.add_sample(sample)

dataset.set_values("foo", ["bar"])
# TypeError: id must be an instance of (bytes, str, ObjectId), not <class 'int'>

I believe pk should be a reserved keyword, IE these should be updated to raise errors:

sample = fo.Sample(filepath="image.jpg")
sample["pk"]  # ValueError: 'pk' is a reserved keyword

sample = fo.Sample(filepath="image.jpg", pk=123)    # ValueError: 'pk' is a reserved keyword

There may be other such keywords that need similar handling, btw.

I haven't investigated the source of the error. It might be possible to instead patch things so that pk is allowable.

コントリビューターガイド

技術スタック
python
領域
dataapi
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic PythonFamiliarity with FiftyOne
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
Investigate the Sample class (likely in fiftyone/core/sample.py) to find where field names are stored. Look for validation of reserved keywords like 'pk' and possibly 'id'. The issue suggests raising ValueError when 'pk' is used as a field name. Also check for other reserved keywords that might need similar handling. The existing error 'TypeError: id must be an instance of...' indicates that 'id' is already reserved, so follow that pattern.