U d @sVdZddlmZddlmZmZmZGdddZGdddZdd d d d d Z dS)a Support for MongoDB Stable API. .. _versioned-api-ref: MongoDB Stable API ===================== Starting in MongoDB 5.0, applications can specify the server API version to use when creating a :class:`~pymongo.mongo_client.MongoClient`. Doing so ensures that the driver behaves in a manner compatible with that server API version, regardless of the server's actual release version. Declaring an API Version ```````````````````````` .. attention:: Stable API requires MongoDB >=5.0. To configure MongoDB Stable API, pass the ``server_api`` keyword option to :class:`~pymongo.mongo_client.MongoClient`:: >>> from pymongo.mongo_client import MongoClient >>> from pymongo.server_api import ServerApi >>> >>> # Declare API version "1" for MongoClient "client" >>> server_api = ServerApi('1') >>> client = MongoClient(server_api=server_api) The declared API version is applied to all commands run through ``client``, including those sent through the generic :meth:`~pymongo.database.Database.command` helper. .. note:: Declaring an API version on the :class:`~pymongo.mongo_client.MongoClient` **and** specifying stable API options in :meth:`~pymongo.database.Database.command` command document is not supported and will lead to undefined behaviour. To run any command without declaring a server API version or using a different API version, create a separate :class:`~pymongo.mongo_client.MongoClient` instance. Strict Mode ``````````` Configuring ``strict`` mode will cause the MongoDB server to reject all commands that are not part of the declared :attr:`ServerApi.version`. This includes command options and aggregation pipeline stages. For example:: >>> server_api = ServerApi('1', strict=True) >>> client = MongoClient(server_api=server_api) >>> client.test.command('count', 'test') Traceback (most recent call last): ... pymongo.errors.OperationFailure: Provided apiStrict:true, but the command count is not in API Version 1, full error: {'ok': 0.0, 'errmsg': 'Provided apiStrict:true, but the command count is not in API Version 1', 'code': 323, 'codeName': 'APIStrictError' Detecting API Deprecations `````````````````````````` The ``deprecationErrors`` option can be used to enable command failures when using functionality that is deprecated from the configured :attr:`ServerApi.version`. For example:: >>> server_api = ServerApi('1', deprecation_errors=True) >>> client = MongoClient(server_api=server_api) Note that at the time of this writing, no deprecated APIs exist. Classes ======= ) annotations)AnyMutableMappingOptionalc@seZdZdZdZdS)ServerApiVersionz[An enum that defines values for :attr:`ServerApi.version`. .. versionadded:: 3.12 1N)__name__ __module__ __qualname____doc__V1r r 6/tmp/pip-unpacked-wheel-oblwsawz/pymongo/server_api.pyr[src@sZeZdZdZdddddddZeddd d Zeddd d Zeddd dZdS) ServerApizMongoDB Stable API.NstrzOptional[bool]versionstrictdeprecation_errorscCsv|tjkrtd||dk r|sdS|j|d<|jdk r&|j|d<|jdk r:|j|d<dS)zInternal helper which adds API versioning options to a command. :Parameters: - `cmd`: The command. - `server_api` (optional): A :class:`ServerApi` or ``None``. NZ apiVersionZ apiStrictZapiDeprecationErrorsr)r$r%r r r_add_to_commands    r&N) r __future__rtypingrrrrrr&r r r rs G  =