Merge pull request #283 from aadityasinha-dotcom/context_manager

Turned SDK APIs into context manager

CHANGELOG.md

@@ -64,6 +64,7 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil
 - Added method to load profile properties from environment variables [#136](https://github.com/zowe/zowe-client-python-sdk/issues/136)
 - Added validation of zowe.config.json file matching the schema [#192](https://github.com/zowe/zowe-client-python-sdk/issues/192)
 - Added Secrets SDK for storing client secrets in OS keyring [#208](https://github.com/zowe/zowe-client-python-sdk/issues/208)
+- Turned SDK APIs into context manager [#145](https://github.com/zowe/zowe-client-python-sdk/issues/145)
 
 ### Bug Fixes
 

src/core/zowe/core_for_zowe_sdk/request_handler.py

@@ -41,6 +41,7 @@ def __init__(self, session_arguments, logger_name=__name__):
         logger_name
             The logger name of the modules calling request handler
         """
+        self.session = requests.Session()
         self.session_arguments = session_arguments
         self.valid_methods = ["GET", "POST", "PUT", "DELETE"]
         self.__handle_ssl_warnings()
@@ -97,11 +98,15 @@ def __validate_method(self):
 
     def __send_request(self, stream=False):
         """Build a custom session object, prepare it with a custom request and send it."""
-        session = requests.Session()
+        session = self.session
         request_object = requests.Request(method=self.method, **self.request_arguments)
         prepared = session.prepare_request(request_object)
         self.response = session.send(prepared, stream=stream, **self.session_arguments)
 
+    def __del__(self):
+        """Clean up the REST session object once it is no longer needed anymore"""
+        self.session.close()
+
     def __validate_response(self):
         """Validate if request response is acceptable based on expected code list.
 

src/core/zowe/core_for_zowe_sdk/sdk_api.py

@@ -55,6 +55,12 @@ def __init__(self, profile, default_url, logger_name = __name__):
             self.default_headers["Authorization"] = f"Bearer {self.session.tokenValue}"
         elif self.session.type == session_constants.AUTH_TYPE_TOKEN:
             self.default_headers["Cookie"] = f"{self.session.tokenType}={self.session.tokenValue}"
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exception, traceback):
+        del self.request_handler
 
     def _create_custom_request_arguments(self):
         """Create a copy of the default request arguments dictionary.

src/zos_console/README.md

@@ -13,7 +13,7 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_console_for_zowe_sdk import Console
 
 profile = ProfileManager().load(profile_name="zosmf")
-console_info = Console(profile)
 
-print(console_info.issue_command(command="D IPLINFO", console="EMCS"))
+with Console(profile) as console_info:
+    print(console_info.issue_command(command="D IPLINFO", console="EMCS"))
 ```

src/zos_files/README.md

@@ -30,7 +30,7 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_files_for_zowe_sdk import Files
 
 profile = ProfileManager().load(profile_name="zosmf")
-files_info = Files(profile)
 
-print(files_info.delete_data_set(dataset_name="ZOWEUSER.PUBLIC.MY.DATASET.JCL", member_name="MEMBER"))
+with Files(profile) as files_info:
+    print(files_info.delete_data_set(dataset_name="ZOWEUSER.PUBLIC.MY.DATASET.JCL", member_name="MEMBER"))
 ```

src/zos_jobs/README.md

@@ -25,9 +25,9 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_jobs_for_zowe_sdk import Jobs
 
 profile = ProfileManager().load(profile_name="zosmf")
-jobs_info = Jobs(profile)
 
-print(jobs_info.delete_job("JOBNAME", "JOBID"))
+with Jobs(profile) as jobs_info:
+    print(jobs_info.delete_job("JOBNAME", "JOBID"))
 ```
 
 <strong>Get jobs by owner</strong>   
@@ -37,10 +37,10 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_jobs_for_zowe_sdk import Jobs
 
 profile = ProfileManager().load(profile_name="zosmf")
-jobs_info = Jobs(profile)
 
-job_owner = "USERNAME"
-print(jobs_info.list_jobs(job_owner))
+with Jobs(profile) as jobs_info:
+    job_owner = "USERNAME"
+    print(jobs_info.list_jobs(job_owner))
 ```
 
 <strong>Submit a job from mainframe</strong>  
@@ -50,7 +50,7 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_jobs_for_zowe_sdk import Jobs
 
 profile = ProfileManager().load(profile_name="zosmf")
-jobs_info = Jobs(profile)
 
-print(jobs_info.submit_from_mainframe(jcl_path="ZOWEUSER.PUBLIC.MY.DATASET.JCL(MEMBER)"))
+with Jobs(profile) as jobs_info:
+    print(jobs_info.submit_from_mainframe(jcl_path="ZOWEUSER.PUBLIC.MY.DATASET.JCL(MEMBER)"))
 ```

src/zos_tso/README.md

@@ -13,12 +13,12 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_tso_for_zowe_sdk import Tso
 
 profile = ProfileManager().load(profile_name="zosmf")
-tso_info = Tso(profile)
 
-started_tso_session = tso_info.start_tso_session()
+with Tso(profile) as tso_info:
+    started_tso_session = tso_info.start_tso_session()
 
-issue_command = tso_info.send_tso_message(started_tso_session, message="status")
-print(issue_command)
+    issue_command = tso_info.send_tso_message(started_tso_session, message="status")
+    print(issue_command)
 ```
 
 <strong>Demonstrate starting, pinging, and stopping a TSO address space</strong>  
@@ -28,12 +28,12 @@ from zowe.core_for_zowe_sdk import ProfileManager
 from zowe.zos_tso_for_zowe_sdk import Tso
 
 profile = ProfileManager().load(profile_name="zosmf")
-tso_info = Tso(profile)
 
-started_tso_session = tso_info.start_tso_session()
-print(started_tso_session)
+with Tso(profile) as tso_info:
+    started_tso_session = tso_info.start_tso_session()
+    print(started_tso_session)
 
-print(tso_info.ping_tso_session(started_tso_session))
+    print(tso_info.ping_tso_session(started_tso_session))
 
-print(tso_info.end_tso_session(started_tso_session))
+    print(tso_info.end_tso_session(started_tso_session))
 ```