タイプ コーデックによるデータのエンコード

デフォルトのタイプ コーデック

PyMongoには、任意で使用できるいくつかの組み込みコーデックが含まれています。これらの組み込みコーデックは一般的なデータ型を自動的に処理します。例、ドライバーは Python の decimal.Decimal 型をBSON Decimal128 値にエンコードおよびデコードできるようにする DecimalEncoder および DecimalDecoder クラスを提供します。

DecimalEncoderクラスはPython decimal.Decimal 値をBSON Decimal128 値に変換します。DecimalDecoderクラスはBSON Decimal128 値をPython decimal.Decimal 値に変換します。

次のコードでは、DecimalEncoderクラスを使用して小数の 1.0 をエンコードします。

opts = CodecOptions(type_registry=TypeRegistry([DecimalEncoder()]))
bson.encode({"d": decimal.Decimal('1.0')}, codec_options=opts)

次のコードでは、DecimalDecoderクラスを使用してBSONデータをデコードします。

opts = CodecOptions(type_registry=TypeRegistry([DecimalDecoder()]))
bson.decode(data, codec_options=opts)

タイプ コーデック クラスの定義

カスタム タイプをエンコードするには、まずタイプのコーデック を定義する必要があります。 タイプ コーデックは、カスタムタイプのインスタンスが、 bsonモジュールがすでにエンコードできるタイプに変換されたり、タイプから変換されたりする方法を示します。

型コーデックを定義する場合、クラスはcodec_optionsモジュール内の基本クラスの 1 つから継承する必要があります。 次の表では、これらの基本クラスと、それらを実装するタイミング、および方法について説明します。

例のEnumCodecカスタムタイプはstrインスタンスとの間で変換されるため、この型をエンコードおよびデコードする方法を定義する必要があります。 したがって、 Enum型のコーデック クラスはTypeCodec基本クラスから継承する必要があります。

from bson.codec_options import TypeCodec
class EnumCodec(TypeCodec):
    python_type = Status
    bson_type = str
    def transform_python(self, value):
        return value.value
    def transform_bson(self, value):
        try:
            return Status(value)
        except ValueError:
            return value

タイプ レジストリへのコーデックの追加

カスタム型コーデックを定義したら、それを PyMongo の型レジストリに追加する必要があります。これは、ドライバーがエンコードおよびデコードできる型のリストです。 そのためには、リスト内のタイプ コーデック クラスのインスタンスを渡して、 TypeRegistryクラスのインスタンスを作成します。 複数のカスタム コーデックを作成する場合は、それらすべてをTypeRegistryコンストラクターに渡すことができます。

次のコード例では、 EnumCodec型コーデックのインスタンスを型レジストリに追加します。

from bson.codec_options import TypeRegistry
enum_codec = EnumCodec()
type_registry = TypeRegistry([enum_codec])

コレクション参照の取得

最後に、 TypeRegistryオブジェクトをキーワード引数として渡して、 codec_options.CodecOptionsインスタンスを定義します。 CodecOptionsオブジェクトをget_collection()メソッドに渡して、カスタムタイプを使用できるコレクションを取得します。

from bson.codec_options import CodecOptions
codec_options = CodecOptions(type_registry=type_registry)
collection = database.get_collection("test", codec_options=codec_options)

次に、Statusクラスのインスタンスをエンコードおよびデコードできます。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

import pprint
collection.insert_one({"status": Status.ACTIVE})
my_doc = collection.find_one({"status": "active"})
pprint.pprint(my_doc)

{'_id': ObjectId('...'), 'status': <Status.ACTIVE: 'active'>}

import pprint
await collection.insert_one({"status": Status.ACTIVE})
my_doc = await collection.find_one({"status": "active"})
pprint.pprint(my_doc)

{'_id': ObjectId('...'), 'status': <Status.ACTIVE: 'active'>}

MongoDB がカスタム型のインスタンスを保存する方法を確認するには、カスタマイズされたコーデック オプションを使用せずに新しいコレクションオブジェクトを作成し、それを使用してカスタム型を含むドキュメントを検索します。次の例では、 PyMongo がStatusクラスのインスタンスを str 値として保存することを示しています。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

import pprint
new_collection = database.get_collection("test")
pprint.pprint(new_collection.find_one())

{'_id': ObjectId('...'), 'status': 'active'}

import pprint
new_collection = database.get_collection("test")
pprint.pprint(await new_collection.find_one())

{'_id': ObjectId('...'), 'status': 'active'}

不明な型のエンコード

フォールバック エンコードでは、エンコードする型を事前に宣言する必要がないため、 TypeEncoderが機能しない場合に使用できます。 たとえば、フォールバック エンコードを使用して任意のオブジェクトを MongoDB に保存できます。 次の任意のカスタム型について考えてみましょう。

class MyStringType(object):
    def __init__(self, value):
        self.__value = value
    def __repr__(self):
        return "MyStringType('%s')" % (self.__value,)
class MyNumberType(object):
    def __init__(self, value):
        self.__value = value
    def __repr__(self):
        return "MyNumberType(%s)" % (self.__value,)

列値インスタンスを string 値に変換して列挙インスタンスを処理するフォールバック エンコードを定義できます。または、ストレージ用に他のオブジェクトを選択します。次の例は、さまざまなタイプのカスタム オブジェクトの処理方法を示しています。

import pickle
from enum import Enum
def fallback_pickle_encoder(value):
    if isinstance(value, Enum):
        return value.value
    return pickle.dumps(value).decode('latin-1')
class PickledStringDecoder(TypeDecoder):
    bson_type = str
    def transform_bson(self, value):
        try:
            # Try to unpickle the string value
            return pickle.loads(value.encode('latin-1'))
        except:
            # If unpickling fails, return the original string
            return value

次に、型レジストリでフォールバック エンコードを使用してカスタム型をエンコードおよびデコードできます。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

from bson.codec_options import CodecOptions,TypeRegistry
codec_options = CodecOptions(
   type_registry=TypeRegistry(
      fallback_encoder=fallback_pickle_encoder
)
)
collection = db.get_collection("test", codec_options=codec_options)
collection.insert_one(
   {"_id": 1, "str": MyStringType("hello world"), "num": MyNumberType(2)}
)
my_doc = collection.find_one()
print(isinstance(my_doc["str"], MyStringType))
print(isinstance(my_doc["num"], MyNumberType))

True
True

from bson.codec_options import CodecOptions,TypeRegistry
codec_options = CodecOptions(
   type_registry=TypeRegistry(
      fallback_encoder=fallback_pickle_encoder
)
)
collection = db.get_collection("test", codec_options=codec_options)
await collection.insert_one(
   {"_id": 1, "str": MyStringType("hello world"), "num": MyNumberType(2)}
)
my_doc = await collection.find_one()
print(isinstance(my_doc["str"], MyStringType))
print(isinstance(my_doc["num"], MyNumberType))

True
True