Merge pull request #3 from zabbix/release/1.0.2

aiantsen · web-flow · commit a591e06f18cd · 2023-12-15T13:51:03.000+02:00
Release/1.0.2
diff --git a/.github/scripts/additional_api_tests.py b/.github/scripts/additional_api_tests.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import base64
 import unittest
diff --git a/.github/scripts/check_new_zabbx_release.py b/.github/scripts/check_new_zabbx_release.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import os
 import sys
 import requests
diff --git a/.github/scripts/compatibility_api_test_5.py b/.github/scripts/compatibility_api_test_5.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import time
 import unittest
diff --git a/.github/scripts/compatibility_api_test_6.py b/.github/scripts/compatibility_api_test_6.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import time
 import unittest
diff --git a/.github/scripts/compatibility_api_test_latest.py b/.github/scripts/compatibility_api_test_latest.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import time
 import unittest
diff --git a/.github/scripts/integration_api_test.py b/.github/scripts/integration_api_test.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import unittest
 
@@ -61,7 +66,17 @@ def test_user_get(self):
             users = self.zapi.user.get(
                 output=['userid', 'name']
             )
-        self.assertEqual(type(users), list, "Request user.getter was going wrong")
+        self.assertEqual(type(users), list, "Request user.get was going wrong")
+
+    def test_host_get(self):
+        """Tests getting hosts info works properly using suffix"""
+
+        hosts = None
+        if self.zapi:
+            hosts = self.zapi.host_.get_(
+                output=['hostid', 'host']
+            )
+        self.assertEqual(type(hosts), list, "Request host.get was going wrong")
 
 
 if __name__ == '__main__':
diff --git a/.github/scripts/integration_get_test.py b/.github/scripts/integration_get_test.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import json
 import unittest
diff --git a/.github/scripts/integration_sender_test.py b/.github/scripts/integration_sender_test.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import unittest
 
diff --git a/.github/scripts/telegram_msg.py b/.github/scripts/telegram_msg.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python3
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import requests
 import sys
 import os
diff --git a/.github/scripts/wait_instance_zabbix.py b/.github/scripts/wait_instance_zabbix.py
@@ -1,4 +1,9 @@
 #!/usr/bin/env python
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import time
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## [1.0.2](https://github.com/zabbix/python-zabbix-utils/compare/v1.0.1...v1.0.2) (2023-12-15)
+
+### Bug fixes:
+
+- added trailing underscores as workaround to use Python keywords as names of API object or method
+- changed TypeError to ValueError for the exception during version parsing.
+- fixed compression support for Sender and Getter.
+- made refactoring of some parts of the code.
+- fixed small bugs and flaws.
+
 ## [1.0.1](https://github.com/zabbix/python-zabbix-utils/compare/v1.0.0...v1.0.1) (2023-11-27)
 
 ### Bug fixes:
diff --git a/README.md b/README.md
@@ -27,8 +27,8 @@ Supported versions:
 
 Tested on:
 
-* Zabbix 4.0, 5.0, 6.0, 6.4 and 7.0alpha7
-* Python 3.7, 3.8, 3.9, 3.10 and 3.11
+* Zabbix 5.0, 6.0, 6.4 and 7.0.0 alpha 7
+* Python 3.8, 3.9, 3.10 and 3.11
 
 ## Documentation
 
@@ -76,10 +76,10 @@ users = api.user.get(
 
 for user in users:
     print(user['name'])
-
-api.logout()
 ```
 
+When token is used, calling `api.logout()` is not necessary.
+
 It is possible to specify authentication fields by the following environment variables:
 `ZABBIX_URL`, `ZABBIX_TOKEN`, `ZABBIX_USER`, `ZABBIX_PASSWORD`
 
@@ -115,6 +115,27 @@ print(ver.is_lts()) # True
 api.logout()
 ```
 
+In case the API object or method name matches one of Python keywords, you can use the suffix `_` in their name to execute correctly:
+```python
+from zabbix_utils import ZabbixAPI
+
+api = ZabbixAPI(url="127.0.0.1")
+api.login(token="xxxxxxxx")
+
+template_source = ''
+with open('template_example.xml', mode='r', encoding='utf-8') as f:
+    template_source = f.read()
+
+response = api.configuration.import_(
+    source=template_source,
+    format="xml",
+    rules={...}
+)
+
+if response:
+    print("Template imported successfully")
+```
+
 > Please, refer to the [Zabbix API Documentation](https://www.zabbix.com/documentation/current/manual/api/reference) and the [using examples](https://github.com/zabbix/python-zabbix-utils/tree/main/examples/api) for more information.
 
 ##### To work via Zabbix sender protocol
diff --git a/examples/api/auth_by_token.py b/examples/api/auth_by_token.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # Use an authentication token generated via the web interface or
diff --git a/examples/api/check_auth_state.py b/examples/api/check_auth_state.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # Zabbix server details and authentication credentials
diff --git a/examples/api/disabling_validate_certs.py b/examples/api/disabling_validate_certs.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # SSL certificate verification will be ignored.
diff --git a/examples/api/export_templates.py b/examples/api/export_templates.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # Zabbix server details and authentication credentials
diff --git a/examples/api/token_auth_if_supported.py b/examples/api/token_auth_if_supported.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # Zabbix server details and authentication credentials
diff --git a/examples/api/use_context_manager.py b/examples/api/use_context_manager.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # Zabbix server details and authentication credentials
@@ -7,7 +12,7 @@
 
 # Use a context manager for automatic logout upon completion of the request.
 # Each time it's created it performs "login" and "apiinfo.version".
-# Highly recommended to use it many times in a single script.
+# Highly recommended not to use it many times in a single script.
 with ZabbixAPI(url=ZABBIX_SERVER) as api:
     # Authenticate with the Zabbix API using the provided user credentials
     api.login(user=ZABBIX_USER, password=ZABBIX_PASSWORD)
diff --git a/examples/api/using_http_auth.py b/examples/api/using_http_auth.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ZabbixAPI
 
 # Create an instance of the ZabbixAPI class with the Zabbix server URL
diff --git a/examples/get/custom_source_ip.py b/examples/get/custom_source_ip.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import Getter
 
 # Create a Getter instance with specified parameters
diff --git a/examples/get/getting_value.py b/examples/get/getting_value.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import sys
 import json
 from zabbix_utils import Getter
diff --git a/examples/get/psk_wrapper.py b/examples/get/psk_wrapper.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import ssl
 from zabbix_utils import Getter
 
diff --git a/examples/sender/agent_config_using.py b/examples/sender/agent_config_using.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import Sender
 
 # Toy can create an instance of Sender using the default configuration file path
diff --git a/examples/sender/bulk_sending.py b/examples/sender/bulk_sending.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import ItemValue, Sender
 
 # List of ItemValue instances representing items to be sent
diff --git a/examples/sender/custom_source_ip.py b/examples/sender/custom_source_ip.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import Sender
 
 # Create an instance of the Sender class with specified parameters
diff --git a/examples/sender/psk_wrapper.py b/examples/sender/psk_wrapper.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import ssl
 from zabbix_utils import Sender
 
diff --git a/examples/sender/psk_wrapper_from_config.py b/examples/sender/psk_wrapper_from_config.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import ssl
 from zabbix_utils import Sender
 
diff --git a/examples/sender/single_sending.py b/examples/sender/single_sending.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 from zabbix_utils import Sender
 
 # Zabbix server/proxy details for Sender
diff --git a/examples/sender/tls_cert_wrapper.py b/examples/sender/tls_cert_wrapper.py
@@ -1,3 +1,8 @@
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Zabbix SIA licenses this file to you under the MIT License.
+# See the LICENSE file in the project root for more information.
+
 import ssl
 from zabbix_utils import Sender
 
diff --git a/setup.py b/setup.py
@@ -1,3 +1,27 @@
+# zabbix_utils
+#
+# Copyright (C) 2001-2023 Zabbix SIA
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without restriction,
+# including without limitation the rights to use, copy, modify,
+# merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software
+# is furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
 import re
 import setuptools
 from zabbix_utils.version import __version__
diff --git a/tests/test_zabbix_api.py b/tests/test_zabbix_api.py
diff --git a/tests/test_zabbix_get.py b/tests/test_zabbix_get.py
diff --git a/tests/test_zabbix_sender.py b/tests/test_zabbix_sender.py
diff --git a/zabbix_utils/api.py b/zabbix_utils/api.py
diff --git a/zabbix_utils/common.py b/zabbix_utils/common.py
diff --git a/zabbix_utils/getter.py b/zabbix_utils/getter.py
diff --git a/zabbix_utils/sender.py b/zabbix_utils/sender.py
diff --git a/zabbix_utils/version.py b/zabbix_utils/version.py
