Add the pyVmomi version in the user-agent request header

ddraganov · ddraganov · commit 5ad215f5f2af · 2024-01-29T10:57:20.000+02:00
This change adds a project wide variable to hold the current pyVmomi version - version_info. Based of https://docs.python.org/3/library/sys.html#sys.version_info Another variable holds a text version of version_info and extends the User-Agent header - version_info_str.
diff --git a/pyVmomi/SoapAdapter.py b/pyVmomi/SoapAdapter.py
@@ -1,5 +1,5 @@
 # **********************************************************
-# Copyright (c) 2005-2023 VMware, Inc.
+# Copyright (c) 2005-2024 VMware, Inc.  All rights reserved.
 # **********************************************************
 
 import base64
@@ -35,6 +35,7 @@
     IsChildVersion, ManagedMethod, UnknownManagedMethod, ManagedObject,
     Object, PropertyPath, Type, binary, versionIdMap, versionMap)
 from .Security import VerifyCertThumbprint
+from . import version_info_str
 from . import _legacyThumbprintException
 if _legacyThumbprintException:
     from .Security import ThumbprintMismatchException  # noqa: F401
@@ -1518,8 +1519,12 @@ def InvokeMethod(self, mo, info, args, outerStub=None):
             'Content-Type':
             'text/xml; charset={0}'.format(XML_ENCODING),
             'User-Agent':
-            'pyvmomi Python/{0} ({1}; {2}; {3})'.format(
-                PYTHON_VERSION, OS_NAME, OS_VERSION, OS_ARCH)
+            'pyvmomi {0} Python/{1} ({2}; {3}; {4})'.format(
+                version_info_str,
+                PYTHON_VERSION,
+                OS_NAME,
+                OS_VERSION,
+                OS_ARCH)
         }
         if self._customHeaders:
             headers.update(self._customHeaders)
diff --git a/pyVmomi/__init__.py b/pyVmomi/__init__.py
@@ -1,10 +1,20 @@
 # **********************************************************
-# Copyright (c) 2005-2023 VMware, Inc.
+# Copyright (c) 2005-2024 VMware, Inc.
 # **********************************************************
 
 import sys
 import importlib
 
+version_info = (
+    8,
+    0,
+    2,
+    0,
+    1,
+)
+
+version_info_str = ".".join(str(v) for v in version_info)
+
 if sys.version_info < (2, 7, 9):
     sys.stderr.write("pyVmomi requires Python 2.7.9 or newer")
     sys.exit(1)
diff --git a/setup.py b/setup.py
@@ -16,6 +16,7 @@
 import os
 
 from setuptools import setup
+from pyVmomi import version_info_str
 
 
 def read(fname):
@@ -30,7 +31,7 @@ def read(fname):
 
 setup(
     name='pyvmomi',
-    version='8.0.2.0.1',
+    version=version_info_str,
     description='VMware vSphere Python SDK',
     # NOTE: pypi prefers the use of RST to render docs
     long_description=read('README.rst'),
