AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu
Docs Home
/ /
PyMongo
Docs Home
/
クライアント ライブラリ
/
Python
/
PyMongo
Docs Home
/
クライアント ライブラリ
/
Python
/
PyMongo

PyMongo のバージョンをアップグレードする

Overview

このページでは、PyMongo の新しいバージョンにアップグレードするときにアプリケーションに加える必要がある変更について説明します。

重要

このガイドには、v 以降のPyMongoバージョンのみに対する重大な変更が含まれています。4.0 PyMongo v2 または v3 からアップグレードする場合は、「 PyMongo4 移行ガイド 」を参照してください。

アップグレードする前に、次のアクションを実行してください。

  • 新しいPyMongoバージョンが、アプリケーションが接続するMongoDB Serverのバージョンおよびアプリケーションを実行するPythonバージョンと互換性があることを確認します。バージョンの互換性情報については、互換性ページを参照してください。

  • アプリケーションが使用しているドライバー バージョンとアップグレード予定のバージョンとの間の重大な変更については、重大な変更セクションを参照してください。

Tip

将来ドライバーのバージョンをアップグレードする際にアプリケーションに必要な変更数を最小限に抑えるには、 Stable API を使用します。

非推奨警告の表示

非推奨の PyMongo 機能を使用する場合、ドライバーはDeprecationWarningを発生させます。 デフォルトでは、Python インタープリタはこれらの警告を無視します。 これらをstderrに出力するには、 -Wdオプションを使用して Python を起動します。

次の例では、非推奨の メソッドを呼び出す Python アプリケーションであるinsert.pyを実行します。 Python が-Wdオプションで開始されていたため、インタプリタはDeprecationWarningを表示します。

$ python3 -Wd insert.py
insert.py:4: DeprecationWarning: insert is deprecated. Use insert_one or insert_many instead.
  client.test.test.insert({})

DeprecationWarningメッセージを例外として扱うには、次の例に示すように、代わりに-Weオプションを使用して Python を起動します。

$ python3 -We insert.py
Traceback (most recent call last):
  File "insert.py", line 4, in <module>
    client.test.test.insert({})
  File "/home/durin/work/mongo-python-driver/pymongo/collection.py", line 2906, in insert
    "instead.", DeprecationWarning, stacklevel=2)
DeprecationWarning: insert is deprecated. Use insert_one or insert_many instead.

Tip

インタープリタ警告と-Wオプションの詳細については、次の Python ドキュメントを参照してください。

重大な変更

重大な変更とは、ドライバーの特定のバージョン以降の規則または動作の変更です。 このタイプの変更では、ドライバーをアップグレードする前に対処しないと、アプリケーションが正常に動作しなくなる可能性があります。

このセクションの重大な変更は、それを導入したドライバーのバージョンによって分類されます。 ドライバーのバージョンをアップグレードするときは、現在のバージョンとアップグレードのバージョン間のすべての重大な変更に対処してください。

例

バージョン4.0からのアップグレード

PyMongo を v 4.0から v 4.7にアップグレードする場合は、バージョン4.1から4.7にリストされているすべての重大な変更に対処します。

バージョン4.18 重大な変更

  • MongoDB Server v4.2 のサポートを削除します。 サポートされるMongoDB Server の最小バージョンは v4.4 になりました。

  • 集計ヘルパーメソッドでは、aggregate または pipeline のキーワード引数を渡すと pymongo.errors.ConfigurationError が発生します。以前は、これらのキーは、生成された aggregate コマンドのターゲット名前空間とパイプラインを暗黙的に置き換えました。この変更は、同期クラスと非同期クラスの両方の次のメソッドに影響します。

    • Collection.aggregate()

    • Collection.aggregate_raw_batches()

    • Database.aggregate()

    • Collection.list_search_indexes()

  • 1 つの論理操作のコマンド モニタリング イベントとコマンドログメッセージは、その操作のすべての再試行で 1 つの安定版 operation_id を共有します。その結果、これらの操作では、operation_id は試行回数 request_id と等しなくなりました。

  • 4 KB 以上で、不変バッファから bson.raw_bson.RawBSONDocument オブジェクトにデコードされるドキュメントとサブドキュメントは、bytes コピーではなく読み取り専用の memoryview スライスとして表示されます。 bytearray などの可変バッファからデコードされたドキュメントは、常に bytes のコピーであります。

  • bson.get_data_and_view() メソッドは、bytes または bytearray 以外のバッファ プロトコル入力のプライベート bytes コピーのビューを返します。

  • v7.1 より前の mongos バージョンに対して exhaust カーソル（CursorType.EXHAUST）を使用すると、ドライバーは find() メソッドではなく、カーソルの最初の反復で pymongo.errors.InvalidOperation エラーを発生させます。次の理由で、ドライバーは、使用されている接続に対して要件をチェックします。 limit と CursorType.EXHAUST を組み合わせた非同期カーソルでは、最初の反復ではなく find() メソッドからエラーが発生します。これは同期APIに一致します。

バージョン4.14 重大な変更

  • MongoDB Server v4.0 のサポートを削除します。 サポートされるMongoDB Server の最小バージョンは v4.2 になりました。

  • bson.binary.BinaryVectorオブジェクトをエンコードする場合、paddingメタデータフィールドの値は次の条件を満たす必要があります。

    • バイナリ サブタイプが PACKED_BIT の場合、値は 0 から 7 まで（この値を含む）の範囲でなくてはなりません。

    • それ以外の場合、値は 0 である必要があります。

    上記の条件が満たされていない場合、 PyMongo はValueError を発生させます。

  • uri_parser.parse_uri() メソッドの options パラメータのタイプは dict です。以前のバージョンでは、このパラメータは _CaseInsensitiveDictionary 型でした。

バージョン4.11 重大な変更

  • MongoDB Server v3.6 のサポートを削除します。 サポートされるMongoDB Server の最小バージョンは v4.0 になりました。

  • MongoDB Server v4.04 のサポートを廃止します。 MongoDBソフトウェア ライフサイクル スケジュール に従って、 PyMongoの次のマイナー バージョンでは、 MongoDB Server の最小バージョンが.0 4から.2 に引き上げられます。

  • Python v3.8 のサポートを削除します。 サポートされる最小Pythonバージョンは v3.9 になりました。

  • PyPy v3.9 のサポートを削除します。 サポートされる PyPy の最小バージョンは v3.10 になりました。

  • MONGODB-CR認証メカニズムのサポートを廃止します。 認証の詳細については、 認証メカニズム のガイドを参照してください。

バージョン4.9 重大な変更

バージョン 4.8 重大な変更

  • PyMongo v 4.8のため バックエンド ビルド システムとしてhatchを使用している場合、 setup.pyファイルを使用してドライバーをビルドすることはできなくなりました。 代わりに、 pip を使用して PyMongo をインストールする必要があります。 編集可能なインストールの場合は、 pip v 21.3以降を使用する必要があります。

バージョン 4.7 の重大な変更

  • すべての内部クラスとコマンドでのSONコレクション タイプのすべての発生がdictに変更されました。

  • options.pool_options.metadataプロパティは、 SON dictのタイプになりました。 次のコード例は、これらの形式でのデータ保存方法の違いを示しています。

# Before (SON)
>>> from pymongo import MongoClient
>>> client = MongoClient()
>>> client.options.pool_options.metadata
SON([('driver', SON([('name', 'PyMongo'), ('version', '4.7.0.dev0')])), ('os', SON([('type', 'Darwin'), ('name', 'Darwin'), ('architecture', 'arm64'), ('version', '14.3')])), ('platform', 'CPython 3.11.6.final.0')])
# After (dict)
>>> client.options.pool_options.metadata
{'driver': {'name': 'PyMongo', 'version': '4.7.0.dev0'}, 'os': {'type': 'Darwin', 'name': 'Darwin', 'architecture': 'arm64', 'version': '14.3'}, 'platform': 'CPython 3.11.6.final.0'}

単一レイヤーのdictオブジェクトをSONオブジェクトに変換するには、次の例に示すように、 dictオブジェクトをSONコンストラクターに渡します。

>>> data_as_dict = client.options.pool_options.metadata
>>> SON(data_as_dict)
SON([('driver', {'name': 'PyMongo', 'version': '4.7.0.dev0'}), ('os', {'type': 'Darwin', 'name': 'Darwin', 'architecture': 'arm64', 'version': '14.3'}), ('platform', 'CPython 3.11.6.final.0')])

dictオブジェクトに複数のレイヤーがある場合は、次の例に示すように、値を一度に 1 つずつ変換する必要があります。

>>> def dict_to_SON(data_as_dict: dict[Any, Any]):
...     data_as_SON = SON()
...     for key, value in data_as_dict.items():
...         data_as_SON[key] = dict_to_SON(value) if isinstance(value, dict) else value
...     return data_as_SON
>>>
>>> dict_to_SON(data_as_dict)
SON([('driver', SON([('name', 'PyMongo'), ('version', '4.7.0.dev0')])), ('os', SON([('type', 'Darwin'), ('name', 'Darwin'), ('architecture', 'arm64'), ('version', '14.3')])), ('platform', 'CPython 3.11.6.final.0')])

バージョン 4.2 の重大な変更

  • Py right ツールのサポートを改善するため、ClientSession クラスはジェネリック型を使用しなくなりました。

  • クライアント側フィールドレベル暗号化（CSFLE）には、pymongocrypt v 1.3.0以降が必要です。

  • BSON 、 PyMongo 、 Grifs パッケージでは、公開 API を宣言するために __all__ 変数が使用されるようになりました。 アプリケーションにfrom bson import *ステートメントが含まれている場合は、必要な API が引き続きインポートされていることを確認してください。

  • estimated_document_count()メソッドは常に count コマンドを使用します。 このコマンドは MongoDB バージョン5.0.0の Stable API では使用できません。 から5.0.8まで。 Stable API でestimated_document_count()メソッドを使用する場合は、 MongoDB Server v 5.0にアップグレードする 必要があります。 9以降の または 、 pymongo.server_api.ServerApi.strictオプションをFalseに設定します。

戻る
リリースノート
次へ
PyMongo Async への移行
このページを評価

項目一覧