kover 2.3.0__tar.gz → 2.6.2__tar.gz

{kover-2.3.0 → kover-2.6.2}/.gitignore

@@ -8,4 +8,6 @@ badges.txt
 dist
 .ruff_cache
 .python-version
-.token
+.token
+uv.lock
+kover/bulk

{kover-2.3.0 → kover-2.6.2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: kover
-Version: 2.3.0
+Version: 2.6.2
 Summary: Fully async mongodb driver for mongod and replica sets.
 Project-URL: Repository, https://github.com/megawattka/kover
 Project-URL: Documentation, https://github.com/megawattka/kover
 Author-email: megawattka <gunter56741@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
-Keywords: Kover API mongo,Mongo Kover,async driver,kover,kover mongodb,megawattka,mongo async,mongo kover,mongod driver,mongodb
+Keywords: Kover API mongo,Mongo Kover,async driver,kover,kover mongodb,mongo async,mongo kover,mongod driver,mongodb
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -19,7 +19,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: dnspython<3.0.0,>=1.16.0
+Requires-Dist: dnspython>=2.7.0
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: typing-extensions>=4.12.2
 Provides-Extra: snappy
@@ -37,8 +37,8 @@ Description-Content-Type: text/markdown
 ![Last Commit](https://img.shields.io/github/last-commit/megawattka/kover)
 ![MongoDB](https://img.shields.io/badge/MongoDB-6.0+-green)
 
-**Kover** is a model-orientied strict typed mongodb driver supporting local mongod and replica sets. Battle tests are still required*<br>
-this library was inspired by <a href=https://github.com/sakal/aiomongo>this project</a> i like it very much. Though its 8 years old.
+**Kover** is a model-orientied strictly typed mongodb driver supporting local mongod, replica sets and remote atlases.<br>
+this library was inspired by <a href=https://github.com/sakal/aiomongo>this project</a> i like it very much. Though its 9 years old.
 Kover is linted by Ruff and supports pyright strict type checking mode.
 
 ```py
@@ -66,19 +66,20 @@ The main reason why i created this project is that Motor - official async wrappe
 
 # Status
 it still missing features. <br>
-e.g: **bulk write API** and **Compression**<br>
+e.g: **bulk write API** and **Encryption**
 but its already very cool! <br>
 
 # Dependencies
 - All platforms.
-- python 3.10
+- python 3.10+
 - MongoDB 6.0+ (not sure about older versions)
 - pydantic 2.10.6 or later
+- dnspython 2.7.0 or later
 
 # Features
 Almost all features from pymongo. All auth types are supported. Integration with Pydantic supported.
 this lib was built for new mongod versions. All features that were marked as DEPRECATED in docs
-were NOT added. See docs for references. The kover.bson package was entirely copied from pymongo source code. Also pymongo.saslprep was copied for internal purposes, i do not own these files.
+were NOT added. See docs for references. The kover.bson package was entirely copied from pymongo source code. I do not own these files.
 
 ### Cursors
 if you just need list:
@@ -346,4 +347,4 @@ if __name__ == "__main__":
 
 ```
 
-# If you found a bug, go ahead and open an issue, or even better a pull request, thx ❤️
+# If you found a bug, open an issue, or even better create a pull request, thx ❤️

{kover-2.3.0 → kover-2.6.2}/README.md

@@ -7,8 +7,8 @@
 ![Last Commit](https://img.shields.io/github/last-commit/megawattka/kover)
 ![MongoDB](https://img.shields.io/badge/MongoDB-6.0+-green)
 
-**Kover** is a model-orientied strict typed mongodb driver supporting local mongod and replica sets. Battle tests are still required*<br>
-this library was inspired by <a href=https://github.com/sakal/aiomongo>this project</a> i like it very much. Though its 8 years old.
+**Kover** is a model-orientied strictly typed mongodb driver supporting local mongod, replica sets and remote atlases.<br>
+this library was inspired by <a href=https://github.com/sakal/aiomongo>this project</a> i like it very much. Though its 9 years old.
 Kover is linted by Ruff and supports pyright strict type checking mode.
 
 ```py
@@ -36,19 +36,20 @@ The main reason why i created this project is that Motor - official async wrappe
 
 # Status
 it still missing features. <br>
-e.g: **bulk write API** and **Compression**<br>
+e.g: **bulk write API** and **Encryption**
 but its already very cool! <br>
 
 # Dependencies
 - All platforms.
-- python 3.10
+- python 3.10+
 - MongoDB 6.0+ (not sure about older versions)
 - pydantic 2.10.6 or later
+- dnspython 2.7.0 or later
 
 # Features
 Almost all features from pymongo. All auth types are supported. Integration with Pydantic supported.
 this lib was built for new mongod versions. All features that were marked as DEPRECATED in docs
-were NOT added. See docs for references. The kover.bson package was entirely copied from pymongo source code. Also pymongo.saslprep was copied for internal purposes, i do not own these files.
+were NOT added. See docs for references. The kover.bson package was entirely copied from pymongo source code. I do not own these files.
 
 ### Cursors
 if you just need list:
@@ -316,4 +317,4 @@ if __name__ == "__main__":
 
 ```
 
-# If you found a bug, go ahead and open an issue, or even better a pull request, thx ❤️
+# If you found a bug, open an issue, or even better create a pull request, thx ❤️

{kover-2.3.0 → kover-2.6.2}/kover/__init__.py

@@ -20,8 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-__version__ = "2.3.0"
-__author__ = "oMegaPB"
+__version__ = "2.6.2"
+__author__ = "megawattka"
 __license__ = "MIT"
 __copyright__ = "Copyright (C) 2024-present megawattka"
 
@@ -41,6 +41,7 @@ from .exceptions import (
     OperationFailure,
     SchemaGenerationException,
 )
+from .helpers import chain, filter_non_null, maybe_to_dict
 from .models import (
     BuildInfo,
     Collation,
@@ -55,13 +56,13 @@ from .models import (
     User,
     WriteConcern,
 )
-from .network import AuthCredentials
+from .network import AuthCredentials, MongoTransport, SrvResolver
 from .schema import Document, SchemaGenerator
-from .session import Session, Transaction
+from .session import Session
+from .transaction import Transaction
 from .typings import xJsonT
-from .utils import chain, filter_non_null, maybe_to_dict
 
-__all__ = [
+__all__ = (
     "AuthCredentials",
     "BuildInfo",
     "Collation",
@@ -78,6 +79,7 @@ __all__ = [
     "IndexDirection",
     "IndexType",
     "Kover",
+    "MongoTransport",
     "OperationFailure",
     "ReadConcern",
     "ReplicaSetConfig",
@@ -86,6 +88,7 @@ __all__ = [
     "SchemaGenerationException",
     "SchemaGenerator",
     "Session",
+    "SrvResolver",
     "Transaction",
     "Update",
     "User",
@@ -95,4 +98,4 @@ __all__ = [
     "filter_non_null",
     "maybe_to_dict",
     "xJsonT",
-]
+)

kover-2.6.2/kover/_internals/__init__.py

@@ -0,0 +1,7 @@
+from ._mixins import EmptyReprMixin
+from ._serializers import value_to_json_schema
+
+__all__ = (
+    "EmptyReprMixin",
+    "value_to_json_schema",
+)

{kover-2.3.0 → kover-2.6.2}/kover/_internals/_mixins.py

@@ -9,7 +9,7 @@ if TYPE_CHECKING:
     from ..typings import xJsonT
 
 
-class ReprMixin:
+class EmptyReprMixin:
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}()"
 

{kover-2.3.0 → kover-2.6.2}/kover/_internals/_serializers.py

@@ -8,11 +8,14 @@ from typing import (
     Literal,
     get_origin,
 )
+from typing import is_typeddict as t_is_typeddict
 from uuid import UUID
 
+from typing_extensions import is_typeddict as te_is_typeddict
+
 from ..bson import Binary, Int64, ObjectId, Timestamp
-from ..exceptions import UnsupportedAnnotation
-from ..utils import chain
+from ..exceptions import SchemaGenerationException, UnsupportedAnnotation
+from ..helpers import chain
 
 if TYPE_CHECKING:
     from types import UnionType
@@ -60,20 +63,27 @@ def _serialize_literal(
     }
 
 
+def _is_typeddict_ex(attr_t: type[object]) -> bool:
+    return t_is_typeddict(attr_t) or te_is_typeddict(attr_t)
+
+
 # passing type data to dict unsupported and ignored
 # use Document for that
 # in that case it just creates AnyDict
 # accepting any data passed to it. e.g custom metadata
-# TODO @megawattka: probably add something here?
+# TODO @megawattka: TypedDict support
 def _serialize_dict(
-    attr_t: type[object],  # noqa: ARG001
+    attr_t: type[object],
     /,
     *,
     is_optional: bool = False,
 ) -> xJsonT:
-    return {
-        "bsonType": ["object"] + (["null"] if is_optional else []),
-    }
+    if not _is_typeddict_ex(attr_t):
+        return {
+            "bsonType": ["object"] + (["null"] if is_optional else []),
+        }
+    comment = "TypedDict currently not supported. Use Document."
+    raise SchemaGenerationException(comment)
 
 
 def _serialize_enum(
@@ -105,12 +115,15 @@ def _serialize_simple_type(
 
 
 def value_to_json_schema(
-    attr_t: object,
+    attr_t: type[object],
     /,
     *,
     is_optional: bool = False,
 ) -> xJsonT | None:
     origin = get_origin(attr_t)
+    if origin is None and _is_typeddict_ex(attr_t):
+        origin = dict
+
     func = None
     origin_map: dict[Any, Any] = {
         Literal: _serialize_literal,
@@ -119,12 +132,11 @@ def value_to_json_schema(
     if origin in origin_map:
         func = origin_map[origin]  # type: ignore
 
-    elif isinstance(attr_t, type) and issubclass(attr_t, Enum):
+    elif isinstance(attr_t, type) and issubclass(attr_t, Enum):  # type: ignore
         func = _serialize_enum
 
     elif attr_t in _TYPE_MAP:
         func = _serialize_simple_type
-
     if func is not None:
         return func(attr_t, is_optional=is_optional)  # type: ignore
 

{kover-2.3.0 → kover-2.6.2}/kover/client.py

@@ -1,16 +1,16 @@
 from __future__ import annotations
 
 import json
-import random
 from typing import TYPE_CHECKING, Literal
 
 from typing_extensions import Self
 
 from .database import Database
-from .models import BuildInfo
-from .network import Auth, MongoSocket
+from .helpers import classrepr, filter_non_null, maybe_to_dict
+from .models import BuildInfo, WriteConcern
+from .network import MongoTransport, SrvResolver
 from .session import Session
-from .utils import filter_non_null, maybe_to_dict
+from .uri_parser import parse_uri
 
 if TYPE_CHECKING:
     import asyncio
@@ -20,21 +20,30 @@ if TYPE_CHECKING:
     from .typings import COMPRESSION_T, xJsonT
 
 
+@classrepr("signature", "transport", "is_primary")
 class Kover:
     """Kover client for interacting with a MongoDB server.
 
     Attributes:
-        socket : The underlying socket connection to the MongoDB server.
+        transport : The underlying transport to the MongoDB server.
         signature : The authentication signature, if authenticated.
+        default_database : The name of the default database.
+        is_primary : The flag that tells us whether that
+            this is primary or secondary instance
     """
 
     def __init__(
         self,
-        socket: MongoSocket,
+        transport: MongoTransport,
         signature: bytes | None,
+        *,
+        is_primary: bool = False,
+        w: str | int = "majority",
     ) -> None:
-        self.socket: MongoSocket = socket
+        self.transport = transport
         self.signature = signature
+        self._is_primary = is_primary
+        self._write_concern = WriteConcern(w=w)
 
     async def __aenter__(self) -> Self:
         return self
@@ -45,17 +54,19 @@ class Kover:
         await self.close()
         return True
 
-    def __repr__(self) -> str:
-        return f"<Kover signature={self.signature} socket={self.socket}>"
+    @property
+    def is_primary(self) -> bool:
+        """Whether this instance is a primary or not."""
+        return self._is_primary
 
     async def close(self) -> None:
-        """Close the underlying socket connection.
+        """Close the underlying transport connection.
 
-        This method closes the socket writer
+        This method closes the transport writer
         and waits until the connection is fully closed.
         """
-        self.socket.writer.close()
-        await self.socket.writer.wait_closed()
+        self.transport.writer.close()
+        await self.transport.writer.wait_closed()
 
     def get_database(self, name: str) -> Database:
         """Get a Database instance for the specified database name.
@@ -71,14 +82,74 @@ class Kover:
     def __getattr__(self, name: str) -> Database:
         return self.get_database(name=name)
 
+    def set_write_concern(
+        self,
+        /,
+        *,
+        w: str | int,
+        j: bool | None = None,
+        wtimeout: int = 0,
+    ) -> Self:
+        """This sets a WriteConcern for all requests."""
+        self._write_concern = WriteConcern(w=w, j=j, wtimeout=wtimeout)
+        return self
+
+    @classmethod
+    async def from_uri(
+        cls,
+        uri: str,
+        loop: asyncio.AbstractEventLoop | None = None,
+    ) -> Kover:
+        """Create an instance of Kover client by passing a uri."""
+        parsed = parse_uri(uri)
+
+        resolver = SrvResolver()
+        nodes = await resolver.get_nodes(parsed.hostname)
+        assert nodes, "Node resolution failed."
+
+        transport = await MongoTransport.make(
+            nodes[0], port=parsed.port, tls=parsed.tls, loop=loop)
+
+        hello = await transport.hello(
+            parsed.compressors, parsed.credentials, parsed.application)
+
+        if not hello.is_primary:
+            assert hello.primary_node, "Primary node resolution failed."
+
+            host, _ = hello.primary_node.split(":")
+            return await cls.make_client(
+                host=host,
+                port=parsed.port,
+                credentials=parsed.credentials,
+                loop=loop,
+                compression=parsed.compressors,
+                tls=parsed.tls,
+                application=parsed.application,
+                write_concern=parsed.write_concern,
+            )
+
+        mechanism = hello.get_auth_mechanism()
+        signature = await transport.authorize(mechanism, parsed.credentials)
+
+        return cls(
+            transport=transport,
+            signature=signature,
+            is_primary=hello.is_primary,
+            w=parsed.write_concern,
+        )
+
     @classmethod
     async def make_client(
         cls,
         host: str = "127.0.0.1",
         port: int = 27017,
+        *,
         credentials: AuthCredentials | None = None,
         loop: asyncio.AbstractEventLoop | None = None,
         compression: COMPRESSION_T | None = None,
+        tls: bool = False,
+        application: xJsonT | None = None,
+        write_concern: str | int = "majority",
     ) -> Kover:
         """Create and return a new Kover client instance.
 
@@ -87,23 +158,34 @@ class Kover:
             port : The port number of the MongoDB server, by default 27017.
             credentials : Authentication credentials, if required.
             loop : The event loop to use for asynchronous operations.
+            compression : List of compression options.
+            default_database : the name of a database that will be returned
+                by Kover.get_default_database().
+            tls : the boolean value that indicated whether to use tls or no.
+            application : document that will be included in hello payload
+                under the "application" field.
+            write_concern : the value of default write concern used.
 
         Returns:
             An instance of the Kover client.
         """
-        socket = await MongoSocket.make(host=host, port=port, loop=loop)
-        hello = await socket.hello(
+        transport = await MongoTransport.make(
+            host=host, port=port, loop=loop, tls=tls)
+
+        hello = await transport.hello(
             credentials=credentials,
             compression=compression,
+            application=application,
+        )
+        mechanism = hello.get_auth_mechanism()
+        signature = await transport.authorize(mechanism, credentials)
+
+        return cls(
+            transport,
+            signature,
+            is_primary=hello.is_primary,
+            w=write_concern,
         )
-        if hello.requires_auth and credentials:
-            mechanism = random.choice(hello.sasl_supported_mechs or [])  # noqa: S311
-            signature = await Auth(socket).create(mechanism, credentials)
-        else:
-            signature = None
-        if hello.compression:
-            socket.set_compressor(hello.compression[0])
-        return cls(socket, signature)
 
     async def refresh_sessions(self, sessions: list[Session]) -> None:
         """Refresh the provided list of sessions.
@@ -112,7 +194,7 @@ class Kover:
             sessions : A list of Session objects to be refreshed.
         """
         documents: list[xJsonT] = [x.document for x in sessions]
-        await self.socket.request({"refreshSessions": documents})
+        await self.transport.request({"refreshSessions": documents})
 
     async def end_sessions(self, sessions: list[Session]) -> None:
         """End the provided list of sessions.
@@ -121,7 +203,7 @@ class Kover:
             sessions : A list of Session objects to be ended.
         """
         documents: list[xJsonT] = [x.document for x in sessions]
-        await self.socket.request({"endSessions": documents})
+        await self.transport.request({"endSessions": documents})
 
     async def start_session(self) -> Session:
         """Start a new session.
@@ -129,8 +211,8 @@ class Kover:
         Returns:
             An instance of the Session class representing the started session.
         """
-        req = await self.socket.request({"startSession": 1.0})
-        return Session(document=req["id"], socket=self.socket)
+        req = await self.transport.request({"startSession": 1.0})
+        return Session(document=req["id"], transport=self.transport)
 
     async def build_info(self) -> BuildInfo:
         """Retrieve build information from the MongoDB server.
@@ -138,7 +220,7 @@ class Kover:
         Returns:
             An instance of BuildInfo containing server build details.
         """
-        request = await self.socket.request({"buildInfo": 1.0})
+        request = await self.transport.request({"buildInfo": 1.0})
         return BuildInfo.model_validate(request)
 
     async def logout(self) -> None:
@@ -147,7 +229,7 @@ class Kover:
         This method sends a logout request to the server
         to terminate the current authenticated session.
         """
-        await self.socket.request({"logout": 1.0})
+        await self.transport.request({"logout": 1.0})
 
     async def list_database_names(self) -> list[str]:
         """Retrieve the names of all databases on the MongoDB server.
@@ -159,7 +241,7 @@ class Kover:
             "listDatabases": 1.0,
             "nameOnly": True  # noqa: COM812
         }
-        request = await self.socket.request(command)
+        request = await self.transport.request(command)
         return [x["name"] for x in request["databases"]]
 
     async def drop_database(self, name: str) -> None:
@@ -168,7 +250,7 @@ class Kover:
         Parameters:
             name : The name of the database to drop.
         """
-        await self.socket.request({"dropDatabase": 1.0}, db_name=name)
+        await self.transport.request({"dropDatabase": 1.0}, db_name=name)
 
     # https://www.mongodb.com/docs/manual/reference/command/replSetInitiate/
     async def replica_set_initiate(
@@ -182,12 +264,13 @@ class Kover:
                 default configuration is used.
         """
         document = maybe_to_dict(config) or {}
-        await self.socket.request({"replSetInitiate": document})
+        await self.transport.request({"replSetInitiate": document})
 
     # https://www.mongodb.com/docs/manual/reference/command/replSetReconfig/
     async def replica_set_reconfig(
         self,
         config: ReplicaSetConfig,
+        *,
         force: bool = False,
         max_time_ms: int | None = None,
     ) -> None:
@@ -201,7 +284,7 @@ class Kover:
             "force": force,
             "maxTimeMS": max_time_ms,
         })
-        await self.socket.request(document)
+        await self.transport.request(document)
 
     # https://www.mongodb.com/docs/manual/reference/command/replSetGetStatus/
     async def get_replica_set_status(self) -> xJsonT:
@@ -210,11 +293,12 @@ class Kover:
         Returns:
             A JSON document containing the replica set status information.
         """
-        return await self.socket.request({"replSetGetStatus": 1.0})
+        return await self.transport.request({"replSetGetStatus": 1.0})
 
     # https://www.mongodb.com/docs/manual/reference/command/shutdown/
     async def shutdown(
         self,
+        *,
         force: bool = False,
         timeout: int | None = None,
         comment: str | None = None,
@@ -232,7 +316,7 @@ class Kover:
             "timeoutSecs": timeout,
             "comment": comment,
         })
-        await self.socket.request(command, wait_response=False)
+        await self.transport.request(command, wait_response=False)
 
     # https://www.mongodb.com/docs/manual/reference/command/getCmdLineOpts/
     async def get_commandline(self) -> list[str]:
@@ -241,7 +325,7 @@ class Kover:
         Returns:
             A list of command line arguments.
         """
-        r = await self.socket.request({"getCmdLineOpts": 1.0})
+        r = await self.transport.request({"getCmdLineOpts": 1.0})
         return r["argv"]
 
     # https://www.mongodb.com/docs/manual/reference/command/getLog/#getlog
@@ -258,7 +342,7 @@ class Kover:
         Returns:
             A list of log entries as JSON objects.
         """
-        r = await self.socket.request({"getLog": parameter})
+        r = await self.transport.request({"getLog": parameter})
         return [
             json.loads(info) for info in r["log"]
         ]
@@ -267,6 +351,7 @@ class Kover:
     async def rename_collection(
         self,
         target: str,
+        *,
         new_name: str,
         drop_target: bool = False,
         comment: str | None = None,
@@ -286,17 +371,17 @@ class Kover:
             "dropTarget": drop_target,
             "comment": comment,
         })
-        await self.socket.request(command)
+        await self.transport.request(command)
 
     # https://www.mongodb.com/docs/manual/reference/command/setUserWriteBlockMode/
-    async def set_user_write_block_mode(self, param: bool) -> None:
+    async def set_user_write_block_mode(self, *, param: bool) -> None:
         """Set the user write block mode on the MongoDB server.
 
         Parameters:
             param : Blocks writes on a cluster when set to true.
                 To enable writes on a cluster, set global: false.
         """
-        await self.socket.request({
+        await self.transport.request({
             "setUserWriteBlockMode": 1.0,
             "global": param,
         })
@@ -304,6 +389,7 @@ class Kover:
     # https://www.mongodb.com/docs/manual/reference/command/fsync/
     async def fsync(
         self,
+        *,
         timeout: int = 90000,
         lock: bool = True,
         comment: str | None = None,
@@ -323,7 +409,7 @@ class Kover:
             "lock": lock,
             "comment": comment,
         })
-        await self.socket.request(command)
+        await self.transport.request(command)
 
     # https://www.mongodb.com/docs/manual/reference/command/fsyncUnlock/
     async def fsync_unlock(self, comment: str | None = None) -> None:
@@ -336,4 +422,4 @@ class Kover:
             "fsyncUnlock": 1.0,
             "comment": comment,
         })
-        await self.socket.request(command)
+        await self.transport.request(command)

{kover-2.3.0 → kover-2.6.2}/kover/codes.py

@@ -424,6 +424,7 @@ _codes_to_exc_name: dict[str, str] = {
     "457": "ReplayClientInternalError",
     "458": "ReplayClientSessionSchedulerError",
     "459": "ReplayClientSessionSimulationError",
+    "8000": "AtlasError",
     "9001": "SocketException",
     "10003": "CannotGrowDocumentInCappedNamespace",
     "10058": "LegacyNotPrimary",