kover 2.2.0__tar.gz → 2.3.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kover
-Version: 2.2.0
+Version: 2.3.0
 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
@@ -22,6 +22,10 @@ Requires-Python: >=3.10
 Requires-Dist: dnspython<3.0.0,>=1.16.0
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: typing-extensions>=4.12.2
+Provides-Extra: snappy
+Requires-Dist: python-snappy; extra == 'snappy'
+Provides-Extra: zstd
+Requires-Dist: zstd; extra == 'zstd'
 Description-Content-Type: text/markdown
 
 # kover

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

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-__version__ = "2.2.0"
+__version__ = "2.3.0"
 __author__ = "oMegaPB"
 __license__ = "MIT"
 __copyright__ = "Copyright (C) 2024-present megawattka"
@@ -59,7 +59,7 @@ from .network import AuthCredentials
 from .schema import Document, SchemaGenerator
 from .session import Session, Transaction
 from .typings import xJsonT
-from .utils import HasToDict, chain, filter_non_null, maybe_to_dict
+from .utils import chain, filter_non_null, maybe_to_dict
 
 __all__ = [
     "AuthCredentials",
@@ -73,7 +73,6 @@ __all__ = [
     "Database",
     "Delete",
     "Document",
-    "HasToDict",
     "HelloResult",
     "Index",
     "IndexDirection",

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

@@ -30,3 +30,6 @@ class ModelMixin(BaseModel):
     def to_dict(self) -> xJsonT:
         """Convert the model to a dictionary with camel case keys."""
         return self.model_dump(by_alias=True, exclude_none=True)
+
+    def __str__(self) -> str:
+        return self.__repr__()

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

@@ -17,60 +17,16 @@ if TYPE_CHECKING:
 
     from .models import ReplicaSetConfig
     from .network import AuthCredentials
-    from .typings import xJsonT
+    from .typings import COMPRESSION_T, xJsonT
 
 
 class Kover:
     """Kover client for interacting with a MongoDB server.
 
     Attributes:
-    ----------
-    socket : MongoSocket
-        The underlying socket connection to the MongoDB server.
-    signature : bytes | None
-        The authentication signature, if authenticated.
-
-    Methods:
-    -------
-    close() -> None
-        Close the underlying socket connection.
-    get_database(name: str) -> Database
-        Get a Database instance for the specified database name.
-    make_client(...)
-        Create and return a new Kover client instance.
-    refresh_sessions(sessions: list[Session]) -> None
-        Refresh the provided list of sessions.
-    end_sessions(sessions: list[Session]) -> None
-        End the provided list of sessions.
-    start_session() -> Session
-        Start a new session.
-    build_info() -> BuildInfo
-        Retrieve build information from the MongoDB server.
-    logout() -> None
-        Log out the current user session.
-    list_database_names() -> list[str]
-        Retrieve the names of all databases on the MongoDB server.
-    drop_database(name: str) -> None
-        Drop the specified database from the MongoDB server.
-    replica_set_initiate(config: xJsonT | None = None) -> None
-        Initiate a replica set with the provided configuration.
-    get_replica_set_status() -> xJsonT
-        Retrieve the status of the replica set.
-    shutdown(...)
-        Shut down the MongoDB server.
-    get_commandline() -> list[str]
-        Retrieve the command line arguments used to start the MongoDB server.
-    get_log(parameter: Literal["global", "startupWarnings"] = "startupWarnings") -> list[xJsonT]
-        Retrieve log entries from the MongoDB server.
-    rename_collection(...)
-        Rename a collection in the MongoDB server.
-    set_user_write_block_mode(param: bool) -> None
-        Set the user write block mode on the MongoDB server.
-    fsync(...)
-        Flush all pending writes to disk and optionally lock the database.
-    fsync_unlock(comment: str | None = None) -> None
-        Unlock the database after a previous fsync lock operation.
-    """  # noqa: E501
+        socket : The underlying socket connection to the MongoDB server.
+        signature : The authentication signature, if authenticated.
+    """
 
     def __init__(
         self,
@@ -95,8 +51,9 @@ class Kover:
     async def close(self) -> None:
         """Close the underlying socket connection.
 
-        This method closes the socket writer and waits until the connection is fully closed.
-        """  # noqa: E501
+        This method closes the socket writer
+        and waits until the connection is fully closed.
+        """
         self.socket.writer.close()
         await self.socket.writer.wait_closed()
 
@@ -104,13 +61,9 @@ class Kover:
         """Get a Database instance for the specified database name.
 
         Parameters:
-        ----------
-        name : str
-            The name of the database to retrieve.
+            name : The name of the database to retrieve.
 
         Returns:
-        -------
-        Database
             An instance of the Database class for the given name.
         """
         return Database(name=name, client=self)
@@ -125,41 +78,38 @@ class Kover:
         port: int = 27017,
         credentials: AuthCredentials | None = None,
         loop: asyncio.AbstractEventLoop | None = None,
+        compression: COMPRESSION_T | None = None,
     ) -> Kover:
         """Create and return a new Kover client instance.
 
         Parameters:
-        ----------
-        host : str, optional
-            The hostname of the MongoDB server, by default "127.0.0.1".
-        port : int, optional
-            The port number of the MongoDB server, by default 27017.
-        credentials : AuthCredentials or None, optional
-            Authentication credentials, if required.
-        loop : asyncio.AbstractEventLoop or None, optional
-            The event loop to use for asynchronous operations.
+            host : The hostname of the MongoDB server, by default "127.0.0.1".
+            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.
 
         Returns:
-        -------
-        Kover
             An instance of the Kover client.
         """
-        socket = await MongoSocket.make(host, port, loop=loop)
-        hello = await socket.hello(credentials=credentials)
+        socket = await MongoSocket.make(host=host, port=port, loop=loop)
+        hello = await socket.hello(
+            credentials=credentials,
+            compression=compression,
+        )
         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.
 
         Parameters:
-        ----------
-        sessions : list[Session]
-            A list of Session objects to be refreshed.
+            sessions : A list of Session objects to be refreshed.
         """
         documents: list[xJsonT] = [x.document for x in sessions]
         await self.socket.request({"refreshSessions": documents})
@@ -168,9 +118,7 @@ class Kover:
         """End the provided list of sessions.
 
         Parameters:
-        ----------
-        sessions : list[Session]
-            A list of Session objects to be ended.
+            sessions : A list of Session objects to be ended.
         """
         documents: list[xJsonT] = [x.document for x in sessions]
         await self.socket.request({"endSessions": documents})
@@ -179,8 +127,6 @@ class Kover:
         """Start a new session.
 
         Returns:
-        -------
-        Session
             An instance of the Session class representing the started session.
         """
         req = await self.socket.request({"startSession": 1.0})
@@ -190,36 +136,23 @@ class Kover:
         """Retrieve build information from the MongoDB server.
 
         Returns:
-        -------
-        BuildInfo
             An instance of BuildInfo containing server build details.
         """
         request = await self.socket.request({"buildInfo": 1.0})
-        return BuildInfo(
-            version=request["version"],
-            git_version=request["gitVersion"],
-            allocator=request["allocator"],
-            javascript_engine=request["javascriptEngine"],
-            version_array=request["versionArray"],
-            openssl=request["openssl"]["running"],
-            debug=request["debug"],
-            max_bson_object_size=request["maxBsonObjectSize"],
-            storage_engines=request["storageEngines"],
-        )
+        return BuildInfo.model_validate(request)
 
     async def logout(self) -> None:
         """Log out the current user session.
 
-        This method sends a logout request to the server to terminate the current authenticated session.
-        """  # noqa: E501
+        This method sends a logout request to the server
+        to terminate the current authenticated session.
+        """
         await self.socket.request({"logout": 1.0})
 
     async def list_database_names(self) -> list[str]:
         """Retrieve the names of all databases on the MongoDB server.
 
         Returns:
-        -------
-        list[str]
             A list containing the names of all databases.
         """
         command: xJsonT = {
@@ -233,9 +166,7 @@ class Kover:
         """Drop the specified database from the MongoDB server.
 
         Parameters:
-        ----------
-        name : str
-            The name of the database to drop.
+            name : The name of the database to drop.
         """
         await self.socket.request({"dropDatabase": 1.0}, db_name=name)
 
@@ -247,14 +178,8 @@ class Kover:
         """Initiate a replica set with the provided configuration.
 
         Parameters:
-        ----------
-        config : ReplicaSetConfig or None, optional
-            The configuration document for the replica set. If None,
-            default configuration is used.
-
-        Returns:
-        -------
-        None
+            config : The configuration document for the replica set. If None,
+                default configuration is used.
         """
         document = maybe_to_dict(config) or {}
         await self.socket.request({"replSetInitiate": document})
@@ -269,13 +194,7 @@ class Kover:
         """Perform Reconfiguration of a replica set.
 
         Parameters:
-        ----------
-        config : ReplicaSetConfig
-            The configuration document for the replica set.
-
-        Returns:
-        -------
-        None
+            config : The configuration document for the replica set.
         """
         document: xJsonT = filter_non_null({
             "replSetReconfig": maybe_to_dict(config) or {},
@@ -289,8 +208,6 @@ class Kover:
         """Retrieve the status of the replica set.
 
         Returns:
-        -------
-        xJsonT
             A JSON document containing the replica set status information.
         """
         return await self.socket.request({"replSetGetStatus": 1.0})
@@ -305,17 +222,9 @@ class Kover:
         """Shut down the MongoDB server.
 
         Parameters:
-        ----------
-        force : bool, optional
-            Whether to force the shutdown, by default False.
-        timeout : int or None, optional
-            Timeout in seconds before shutdown, by default None.
-        comment : str or None, optional
-            Optional comment for the shutdown command.
-
-        Returns:
-        -------
-        None
+            force : Whether to force the shutdown, by default False.
+            timeout : Timeout in seconds before shutdown, by default None.
+            comment : Optional comment for the shutdown command.
         """
         command = filter_non_null({
             "shutdown": 1.0,
@@ -330,8 +239,6 @@ class Kover:
         """Retrieve the command line args used to start the MongoDB server.
 
         Returns:
-        -------
-        list[str]
             A list of command line arguments.
         """
         r = await self.socket.request({"getCmdLineOpts": 1.0})
@@ -345,13 +252,10 @@ class Kover:
         """Retrieve log entries from the MongoDB server.
 
         Parameters:
-        ----------
-        parameter : Literal["global", "startupWarnings"], optional
-            The log type to retrieve, defaults to "startupWarnings".
+            parameter : The log type to retrieve,
+                defaults to "startupWarnings".
 
         Returns:
-        -------
-        list[xJsonT]
             A list of log entries as JSON objects.
         """
         r = await self.socket.request({"getLog": parameter})
@@ -370,20 +274,12 @@ class Kover:
         """Rename a collection in the MongoDB server.
 
         Parameters:
-        ----------
-        target : str
-            The full name of the source collection to rename.
-        new_name : str
-            The new name for the collection.
-        drop_target : bool, optional
-            Whether to drop the target collection if it exists, by default False.
-        comment : str or None, optional
-            Optional comment for the rename operation.
-
-        Returns:
-        -------
-        None
-        """  # noqa: E501
+            target : The full name of the source collection to rename.
+            new_name : The new name for the collection.
+            drop_target : Whether to drop the target collection if it exists,
+                by default False.
+            comment : Optional comment for the rename operation.
+        """
         command = filter_non_null({
             "renameCollection": target,
             "to": new_name,
@@ -397,14 +293,9 @@ class Kover:
         """Set the user write block mode on the MongoDB server.
 
         Parameters:
-        ----------
-        param : bool
-            Blocks writes on a cluster when set to true. To enable writes on a cluster, set global: false.
-
-        Returns:
-        -------
-        None
-        """  # noqa: E501
+            param : Blocks writes on a cluster when set to true.
+                To enable writes on a cluster, set global: false.
+        """
         await self.socket.request({
             "setUserWriteBlockMode": 1.0,
             "global": param,
@@ -420,18 +311,12 @@ class Kover:
         """Flush all pending writes to disk and optionally lock the database.
 
         Parameters:
-        ----------
-        timeout : int, optional
-            Timeout in milliseconds for acquiring the fsync lock, by default 90000.
-        lock : bool, optional
-            Whether to lock the database after flushing, by default True.
-        comment : str or None, optional
-            Optional comment for the fsync operation.
-
-        Returns:
-        -------
-        None
-        """  # noqa: E501
+            timeout : Timeout in milliseconds for acquiring the
+                fsync lock, by default 90000.
+            lock : Whether to lock the database after flushing,
+                by default True.
+            comment : Optional comment for the fsync operation.
+        """
         command = filter_non_null({
             "fsync": 1.0,
             "fsyncLockAcquisitionTimeoutMillis": timeout,
@@ -445,13 +330,7 @@ class Kover:
         """Unlock the database after a previous fsync lock operation.
 
         Parameters:
-        ----------
-        comment : str or None, optional
-            Optional comment for the fsync unlock operation.
-
-        Returns:
-        -------
-        None
+            comment : Optional comment for the fsync unlock operation.
         """
         command = filter_non_null({
             "fsyncUnlock": 1.0,