Added support for Python 3.12 and removed support for insecure versions of Python

* Added Python 3.12 to test suite
* Removed support for Python 3.7. Per Python maintainers, 3.7 is EOL and no longer receiving security updates
* Excluded additional files that need not trigger tests.
* Optimized error checking and introduced common.py enabling method extractions for common code.
* Minor import optimizations
* Minor linting fixes
* Fixed missing NETWORK_DELETE_RETRY_WAIT_TIME argument in meraki/__init__.py
* Minor syntactical improvements for README.md

Author: TKIPisalegacycipher

.github/workflows/test-library.yml

@@ -8,10 +8,24 @@ on:
       - 'main'
       - 'release'
     paths-ignore:
-      - '.github/workflows/**'
+      - '.github/**'
+      - 'examples/**'
+      - 'meraki/aio/**'
+      - 'notebooks/**'
+      - 'README.md'
+      - 'LICENSE'
+      - 'setup.py'
   pull_request:
     branches:
       - 'main'
+    paths-ignore:
+      - '.github/**'
+      - 'examples/**'
+      - 'meraki/aio/**'
+      - 'notebooks/**'
+      - 'README.md'
+      - 'LICENSE'
+      - 'setup.py'
   workflow_dispatch:
 
 
@@ -22,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3
@@ -44,3 +58,4 @@ jobs:
     - name: Test with pytest
       run: |
         pytest --apikey ${{ secrets.TEST_ORG_API_KEY }} --o ${{ secrets.TEST_ORG_ID }}
+

README.md

@@ -1,6 +1,6 @@
 # Meraki Dashboard API Python Library
 
-The Meraki Dashboard API Python library provides all current Meraki [dashboard API](https://developer.cisco.com/meraki/api-v1/) calls to interface with the Cisco Meraki cloud-managed platform. Meraki generates the library based on dashboard API's OpenAPI spec to keep it up to date with the latest API releases, and provides the full source code for the library including the tools used to generate the library, if you are participating in the Early Access program or would like to contribute to the development of the library. Meraki welcomes constructive pull requests that maintain backwards compatibility with prior versions. The library requires Python 3.7+, receives support from the community, and you can install it via [PyPI](https://pypi.org/project/meraki/):
+The Meraki Dashboard API Python library provides all current Meraki [dashboard API](https://developer.cisco.com/meraki/api-v1/) calls to interface with the Cisco Meraki cloud-managed platform. Meraki generates the library based on dashboard API's OpenAPI spec to keep it up to date with the latest API releases, and provides the full source code for the library including the tools used to generate the library, if you are participating in the Early Access program or would like to contribute to the development of the library. Meraki welcomes constructive pull requests that maintain backwards compatibility with prior versions. The library requires Python 3.8+, receives support from the community, and you can install it via [PyPI](https://pypi.org/project/meraki/):
 
     pip install --upgrade meraki
 
@@ -41,7 +41,7 @@ While you can make direct HTTP requests to dashboard API in any programming lang
 1. Export your API key as an [environment variable](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html), for example:
 
     ```shell
-    export MERAKI_DASHBOARD_API_KEY=093b24e85df15a3e66f1fc359f4c48493eaa1b73
+    export MERAKI_DASHBOARD_API_KEY=YOUR_KEY_HERE
     ```
 
 2. Alternatively, define your API key as a variable in your source code; this method is not recommended due to its inherent insecurity.
@@ -79,7 +79,7 @@ The usage is similiar to the sequential version above. However it has has some d
 1. Export your API key as an [environment variable](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html), for example:
 
     ```shell
-    export MERAKI_DASHBOARD_API_KEY=093b24e85df15a3e66f1fc359f4c48493eaa1b73
+    export MERAKI_DASHBOARD_API_KEY=YOUR_KEY_HERE
     ```
 
 2. Alternatively, define your API key as a variable in your source code; this method is not recommended due to its inherent insecurity.
@@ -107,11 +107,8 @@ The usage is similiar to the sequential version above. However it has has some d
 import asyncio
 
 if __name__ == "__main__":
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(my_async_entry_point())
-    
-    # if you are using Python 3.7+ you can also simply 
-    # use the following line instead of the two lines above
+
+    # replace my_async_entry_point with the name of your entry point method
     asyncio.run(my_async_entry_point())
 ```
 

meraki/__init__.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 import logging
 import os
 
@@ -30,6 +29,7 @@
     WAIT_ON_RATE_LIMIT,
     NGINX_429_RETRY_WAIT_TIME,
     ACTION_BATCH_RETRY_WAIT_TIME,
+    NETWORK_DELETE_RETRY_WAIT_TIME,
     RETRY_4XX_ERROR,
     RETRY_4XX_ERROR_WAIT_TIME,
     MAXIMUM_RETRIES,

meraki/aio/rest_session.py

@@ -1,20 +1,17 @@
-import logging
-import sys
-from datetime import datetime
-import json
-import platform
 import random
-import urllib.parse
+import time
 import asyncio
+import json
+import sys
 import ssl
-import time
-
 
+import urllib.parse
+from datetime import datetime
 import aiohttp
 
 from meraki.__init__ import __version__
+from meraki.common import *
 from meraki.config import *
-from meraki.exceptions import *
 from meraki.rest_session import user_agent_extended
 
 
@@ -66,18 +63,7 @@ def __init__(
         self.use_iterator_for_get_pages = use_iterator_for_get_pages
 
         # Check minimum Python version
-        version_warning_string = f'This library requires Python 3.7 at minimum. Python versions 3.6 and below ' \
-                                 f'are end of life and end of support per the Python maintainers, and your ' \
-                                 f'interpreter version details are: \n' \
-                                 f'platform.python_version_tuple()[0] = {platform.python_version_tuple()[0]}\n' \
-                                 f'platform.python_version_tuple()[1] = {platform.python_version_tuple()[1]}\n' \
-                                 f'platform.python_version is {platform.python_version()}\n' \
-                                 f'Please consult the readme at your convenience: ' \
-                                 f'https://github.com/meraki/dashboard-api-python'
-        if int(platform.python_version_tuple()[0]) != 3:
-            sys.exit(version_warning_string)
-        elif int(platform.python_version_tuple()[1]) < 7:
-            sys.exit(version_warning_string)
+        check_python_version()
 
         # Check base URL
         if "v0" in self._base_url:

meraki/common.py

@@ -0,0 +1,19 @@
+import platform
+from meraki.exceptions import *
+
+
+def check_python_version():
+    # Check minimum Python version
+
+    if not (int(platform.python_version_tuple()[0]) == 3 and int(platform.python_version_tuple()[1]) >= 8):
+        message = (
+            f"This library requires Python 3.8 at minimum. Python versions 3.7 and below "
+            f"no longer receive security updates since reaching end of life and of support "
+            f"per the Python maintainers. Your interpreter version is: {platform.python_version()}. "
+            f"Please consult the readme at your convenience: https://github.com/meraki/dashboard-api-python "
+            f"Additional details: "
+            f"python_version_tuple()[0] = {platform.python_version_tuple()[0]}; "
+            f"python_version_tuple()[1] = {platform.python_version_tuple()[1]} "
+        )
+
+        raise PythonVersionError(message)

meraki/exceptions.py

@@ -13,13 +13,17 @@ class APIResponseError(Exception):
     Exception class raised from HTTP class methods. Used as a single catch-all error for any possible
     requests exception error that might happen during communication with Meraki API to simplify caller coding.
     """
+
     def __init__(self, obj_name, status_code, error_msg):
         self.obj_name = obj_name
         self.status_code = status_code
         self.reason = error_msg
 
     def exc_message(self):
-        return f'HTTP call within object "{self.obj_name}" failed. Status code is "{self.status_code}". Error message is: "{self.reason}".'
+        return (
+            f'HTTP call within object "{self.obj_name}" failed. Status code is "{self.status_code}". '
+            f'Error message is: "{self.reason}".'
+        )
 
     def json(self):
         return dict(error=self.reason, status_code=self.status_code)
@@ -94,3 +98,13 @@ def __init__(self, metadata, response, message):
 
     def __repr__(self):
         return f"{self.tag}, {self.operation} - {self.status} {self.reason}, {self.message}"
+
+
+class PythonVersionError(Exception):
+    """Exception raised for unsupported Python versions."""
+
+    def __init__(self, message):
+
+        self.message = message
+
+        super().__init__(self.message)

meraki/rest_session.py

@@ -1,16 +1,15 @@
-import sys
-from datetime import datetime
-import json
-import platform
 import random
-import urllib.parse
 import time
-
 import requests
+import json
+import sys
+
+import urllib.parse
+from datetime import datetime
 
-from meraki.config import *
-from meraki.exceptions import *
 from meraki.__init__ import __version__
+from meraki.common import *
+from meraki.config import *
 
 
 def user_agent_extended(be_geo_id, caller):
@@ -55,22 +54,6 @@ def user_agent_extended(be_geo_id, caller):
 
 
 # Main module interface
-def check_python_version():
-    # Check minimum Python version
-    version_warning_string = f'This library requires Python 3.7 at minimum. Python versions 3.6 and below ' \
-                             f'are end of life and end of support per the Python maintainers, and your ' \
-                             f'interpreter version details are: \n' \
-                             f'platform.python_version_tuple()[0] = {platform.python_version_tuple()[0]}\n' \
-                             f'platform.python_version_tuple()[1] = {platform.python_version_tuple()[1]}\n' \
-                             f'platform.python_version is {platform.python_version()}\n' \
-                             f'Please consult the readme at your convenience: ' \
-                             f'https://github.com/meraki/dashboard-api-python'
-    if int(platform.python_version_tuple()[0]) != 3:
-        sys.exit(version_warning_string)
-    elif int(platform.python_version_tuple()[1]) < 7:
-        sys.exit(version_warning_string)
-
-
 class RestSession(object):
     def __init__(
         self,
@@ -207,7 +190,8 @@ def request(self, metadata, method, url, **kwargs):
                     retries -= 1
                     if retries == 0:
                         if e.response and e.response.status_code:
-                            raise APIError(metadata, APIResponseError(e.__class__.__name__, e.response.status_code, str(e)))
+                            raise APIError(metadata, APIResponseError(e.__class__.__name__,
+                                                                      e.response.status_code, str(e)))
                         else:
                             raise APIError(metadata, APIResponseError(e.__class__.__name__, 503, str(e)))
                     else: