python-gvm 25.1.1__tar.gz → 26.1.0__tar.gz

{python_gvm-25.1.1 → python_gvm-26.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-gvm
-Version: 25.1.1
+Version: 26.1.0
 Summary: Library to communicate with remote servers over GMP or OSP
 License: GPL-3.0-or-later
 Author: Greenbone AG
@@ -64,9 +64,12 @@ Please always take a look at the documentation for further details. This
 
 ### Version
 
-Please consider to always use the **newest** version of `gvm-tools` and `python-gvm`.
-We frequently update this projects to add features and keep them free from bugs.
-This is why installing `python-gvm` using pip is recommended.
+`python-gvm` uses [semantic versioning](https://semver.org/).
+
+Versions prior to 26.0.0 used [calendar versioning](https://calver.org/).
+
+Please consider to always use the **newest** releases of `gvm-tools` and `python-gvm`.
+We frequently update these projects to add features and keep them free from bugs.
 
 > [!IMPORTANT]
 > To use `python-gvm` with GMP version of 7, 8 or 9 you must use a release version
@@ -87,20 +90,22 @@ Python 3.9 and later is supported.
 You can install the latest stable release of python-gvm from the Python Package
 Index using [pip](https://pip.pypa.io/):
 
-    python3 -m pip install --user python-gvm
+```shell
+python3 -m pip install --user python-gvm
+```
 
 ## Example
 
 ```python3
 from gvm.connections import UnixSocketConnection
-from gvm.protocols.gmp import Gmp
+from gvm.protocols.gmp import GMP
 from gvm.transforms import EtreeTransform
 from gvm.xml import pretty_print
 
 connection = UnixSocketConnection()
 transform = EtreeTransform()
 
-with Gmp(connection, transform=transform) as gmp:
+with GMP(connection, transform=transform) as gmp:
     # Retrieve GMP version supported by the remote daemon
     version = gmp.get_version()
 
@@ -159,12 +164,14 @@ The python-gvm repository uses [autohooks](https://github.com/greenbone/autohook
 to apply linting and auto formatting via git hooks. Please ensure the git hooks
 are active.
 
-    $ poetry install
-    $ poetry run autohooks activate --force
+```shell
+poetry install
+poetry run autohooks activate --force
+```
 
 ## License
 
-Copyright (C) 2017-2024 [Greenbone AG](https://www.greenbone.net/)
+Copyright (C) 2017-2025 [Greenbone AG](https://www.greenbone.net/)
 
 Licensed under the [GNU General Public License v3.0 or later](LICENSE).
 

{python_gvm-25.1.1 → python_gvm-26.1.0}/README.md

@@ -37,9 +37,12 @@ Please always take a look at the documentation for further details. This
 
 ### Version
 
-Please consider to always use the **newest** version of `gvm-tools` and `python-gvm`.
-We frequently update this projects to add features and keep them free from bugs.
-This is why installing `python-gvm` using pip is recommended.
+`python-gvm` uses [semantic versioning](https://semver.org/).
+
+Versions prior to 26.0.0 used [calendar versioning](https://calver.org/).
+
+Please consider to always use the **newest** releases of `gvm-tools` and `python-gvm`.
+We frequently update these projects to add features and keep them free from bugs.
 
 > [!IMPORTANT]
 > To use `python-gvm` with GMP version of 7, 8 or 9 you must use a release version
@@ -60,20 +63,22 @@ Python 3.9 and later is supported.
 You can install the latest stable release of python-gvm from the Python Package
 Index using [pip](https://pip.pypa.io/):
 
-    python3 -m pip install --user python-gvm
+```shell
+python3 -m pip install --user python-gvm
+```
 
 ## Example
 
 ```python3
 from gvm.connections import UnixSocketConnection
-from gvm.protocols.gmp import Gmp
+from gvm.protocols.gmp import GMP
 from gvm.transforms import EtreeTransform
 from gvm.xml import pretty_print
 
 connection = UnixSocketConnection()
 transform = EtreeTransform()
 
-with Gmp(connection, transform=transform) as gmp:
+with GMP(connection, transform=transform) as gmp:
     # Retrieve GMP version supported by the remote daemon
     version = gmp.get_version()
 
@@ -132,11 +137,13 @@ The python-gvm repository uses [autohooks](https://github.com/greenbone/autohook
 to apply linting and auto formatting via git hooks. Please ensure the git hooks
 are active.
 
-    $ poetry install
-    $ poetry run autohooks activate --force
+```shell
+poetry install
+poetry run autohooks activate --force
+```
 
 ## License
 
-Copyright (C) 2017-2024 [Greenbone AG](https://www.greenbone.net/)
+Copyright (C) 2017-2025 [Greenbone AG](https://www.greenbone.net/)
 
 Licensed under the [GNU General Public License v3.0 or later](LICENSE).

{python_gvm-25.1.1 → python_gvm-26.1.0}/gvm/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "25.1.1"
+__version__ = "26.1.0"

{python_gvm-25.1.1 → python_gvm-26.1.0}/gvm/protocols/_protocol.py

@@ -112,16 +112,22 @@ class GvmProtocol(Generic[T]):
         string
         """
         return bytes(
-            self._send_command(cmd.encode("utf-8", errors="ignore"))  # type: ignore[arg-type] # it seems mypy on Python < 3.11 can't handle bytes here
+            self._send_request(cmd.encode("utf-8", errors="ignore"))  # type: ignore[arg-type] # it seems mypy on Python < 3.11 can't handle bytes here
         ).decode("utf-8", errors="ignore")
 
     def _transform(self, response: Response) -> T:
         transform = self._transform_callable
         return transform(response)
 
-    def _send_command(self, cmd: Request) -> Response:
+    def _send_request(self, request: Request) -> Response:
+        """
+        Send a request to the remote daemon and return the response
+
+        Args:
+            request: The request to be send.
+        """
         try:
-            send_data = self._protocol.send(cmd)
+            send_data = self._protocol.send(request)
             self._send(send_data)
             response: Optional[Response] = None
             while not response:
@@ -132,5 +138,11 @@ class GvmProtocol(Generic[T]):
             self.disconnect()
             raise e
 
-    def _send_and_transform_command(self, cmd: Request) -> T:
-        return self._transform(self._send_command(cmd))
+    def _send_request_and_transform_response(self, request: Request) -> T:
+        """
+        Send a request and transform its response using the transform callable.
+
+        Args:
+            request: The request to be send.
+        """
+        return self._transform(self._send_request(request))

{python_gvm-25.1.1 → python_gvm-26.1.0}/gvm/protocols/core/_connection.py

@@ -184,7 +184,7 @@ class Connection:
 
         Raises:
             An InvalidStateError if no data can be received currently. For
-            example if not request is send yet.
+            example if no request is send yet.
         """
         return self._state.receive_data(data)
 

{python_gvm-25.1.1 → python_gvm-26.1.0}/gvm/protocols/gmp/__init__.py

@@ -19,6 +19,7 @@ If you need to use a specific GMP version, you can use the :class:`GMPv224` or
 from ._gmp import GMP
 from ._gmp224 import GMPv224
 from ._gmp225 import GMPv225
+from ._gmp226 import GMPv226
 
 Gmp = GMP  # for backwards compatibility
 
@@ -27,4 +28,5 @@ __all__ = (
     "Gmp",
     "GMPv224",
     "GMPv225",
+    "GMPv226",
 )

{python_gvm-25.1.1 → python_gvm-26.1.0}/gvm/protocols/gmp/_gmp.py

@@ -2,9 +2,11 @@
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
+import warnings
 from types import TracebackType
 from typing import Callable, Optional, Type, Union
 
+from gvm.__version__ import __version__
 from gvm.connections import GvmConnection
 from gvm.errors import GvmError
 from gvm.protocols.core import Response
@@ -12,9 +14,11 @@ from gvm.protocols.core import Response
 from .._protocol import GvmProtocol, T, str_transform
 from ._gmp224 import GMPv224
 from ._gmp225 import GMPv225
+from ._gmp226 import GMPv226
 from .requests import Version
 
-SUPPORTED_GMP_VERSIONS = Union[GMPv224[T], GMPv225[T]]
+SUPPORTED_GMP_VERSIONS = Union[GMPv224[T], GMPv225[T], GMPv226[T]]
+_SUPPORTED_GMP_VERSION_STRINGS = ["22.4", "22.5", "22.6"]
 
 
 class GMP(GvmProtocol[T]):
@@ -30,9 +34,11 @@ class GMP(GvmProtocol[T]):
             from gvm.protocols.gmp import GMP
 
             with GMP(connection) as gmp:
-                # gmp can be an instance of gvm.protocols.gmp.GMPv224 or
-                # gvm.protocols.gmp.GMPv225 depending
-                # on the supported GMP version of the remote manager daemon
+                # gmp can be an instance of
+                # gvm.protocols.gmp.GMPv224,
+                # gvm.protocols.gmp.GMPv225
+                # or gvm.protocols.gmp.GMPv226
+                # depending on the supported GMP version of the remote manager daemon
                 resp = gmp.get_tasks()
 
     """
@@ -65,7 +71,7 @@ class GMP(GvmProtocol[T]):
     def determine_remote_gmp_version(self) -> str:
         """Determine the supported GMP version of the remote daemon"""
         self.connect()
-        resp = self._send_command(Version.get_version())
+        resp = self._send_request(Version.get_version())
         self.disconnect()
 
         version_el = resp.xml().find("version")
@@ -88,10 +94,21 @@ class GMP(GvmProtocol[T]):
             gmp_class = GMPv224
         elif major_version == 22 and minor_version == 5:
             gmp_class = GMPv225
+        elif major_version == 22 and minor_version >= 6:
+            gmp_class = GMPv226
+            if minor_version > 6:
+                warnings.warn(
+                    "Remote manager daemon uses a newer GMP version then "
+                    f"supported by python-gvm {__version__}. Please update to "
+                    "a newer release of python-gvm if possible. "
+                    f"Remote GMP version is {major_version}.{minor_version}. "
+                    f"Supported GMP versions are {', '.join(_SUPPORTED_GMP_VERSION_STRINGS)}."
+                )
         else:
             raise GvmError(
                 "Remote manager daemon uses an unsupported version of GMP. "
                 f"The GMP version was {major_version}.{minor_version}"
+                f"Supported GMP versions are {', '.join(_SUPPORTED_GMP_VERSION_STRINGS)}."
             )
 
         return gmp_class(self._connection, transform=self._transform_callable)  # type: ignore[arg-type]