pygmt.clib.Session.destroy¶

Session.destroy()[source]¶

Destroy the currently open GMT API session.

Warning

Usage of pygmt.clib.Session as a context manager in a with block is preferred over calling pygmt.clib.Session.create and pygmt.clib.Session.destroy manually.

Calls GMT_Destroy_Session to terminate and free the memory of a registered GMTAPI_CTRL session (the pointer for this struct is stored in the session_pointer attribute).

Always use this method after you are done using a C API session. The session needs to be destroyed before creating a new one. Otherwise, some of the configuration files might be left behind and can influence subsequent API calls.

Sets the session_pointer attribute to None.