MambuPy 2.1.0__tar.gz → 2.1.1__tar.gz

{mambupy-2.1.0 → mambupy-2.1.1}/MambuPy/__init__.py

@@ -39,7 +39,7 @@ import sys
 from importlib.abc import MetaPathFinder
 from importlib.util import spec_from_file_location
 
-__version__ = "2.1.0"
+__version__ = "2.1.1"
 """The version of this module."""
 
 

{mambupy-2.1.0/mambupy → mambupy-2.1.1/MambuPy}/api/connector/rest.py

@@ -36,12 +36,82 @@ from MambuPy.mambuutil import (
     apiurl,
     apiuser,
     setup_logging,
+    activate_request_session_objects,
 )
 
 
 logger = setup_logging(__name__)
 
 
+def _configure_retry_strategy(session, retries=5):
+    """Configure retry strategy for a session.
+
+    Args:
+        session (requests.Session): The session to configure
+        retries (int, optional): Number of retries. Defaults to 5.
+    """
+    retry_strategy = Retry(
+        total=retries,
+        status_forcelist=[429, 500, 502, 503, 504],
+        backoff_factor=1,
+        allowed_methods=[
+            "HEAD",
+            "GET",
+            "OPTIONS",
+            "POST",
+            "PUT",
+            "DELETE",
+            "TRACE",
+            "PATCH",
+        ],
+    )
+    adapter = HTTPAdapter(max_retries=retry_strategy)
+    session.mount("https://", adapter)
+    session.mount("http://", adapter)
+
+
+class SessionSingleton:
+    """Singleton class to manage HTTP sessions for MambuPy.
+
+    This class ensures that only one requests.Session object is created and reused
+    across all requests to the Mambu API. This helps improve performance by reusing
+    TCP connections.
+
+    Example:
+        >>> session = SessionSingleton()
+        >>> session.get_session()  # Returns a requests.Session object
+        >>> session2 = SessionSingleton()
+        >>> session2.get_session()  # Returns the same requests.Session object
+    """
+
+    __instance = None
+    __session = None
+    _RETRIES = 5
+
+    def __new__(cls):
+        """Create a new instance of SessionSingleton if one doesn't exist.
+
+        Returns:
+            SessionSingleton: The singleton instance.
+        """
+        if cls.__instance is None:
+            cls.__instance = super(SessionSingleton, cls).__new__(cls)
+        return cls.__instance
+
+    def get_session(self):
+        """Get the requests.Session object.
+
+        If no session exists, create a new one. Otherwise, return the existing one.
+
+        Returns:
+            requests.Session: The session object to use for HTTP requests.
+        """
+        if self.__session is None:
+            self.__session = requests.Session()
+            _configure_retry_strategy(self.__session, self._RETRIES)
+        return self.__session
+
+
 class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWriter):
     """A connector for Mambu REST API"""
 
@@ -55,6 +125,9 @@ class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWri
         }
         self.__set_authorization_header(user, pwd)
         self.__set_url(url)
+        self._session = None
+        if activate_request_session_objects.lower() == "true":
+            self._session = SessionSingleton().get_session()
 
     def __set_authorization_header(self, user, pwd):
         self._headers["Authorization"] = "Basic {}".format(
@@ -108,26 +181,6 @@ class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWri
         params = self.__request_params(params)
         data = self.__request_data(data)
 
-        retry_strategy = Retry(
-            total=self._RETRIES,
-            status_forcelist=[429, 500, 502, 503, 504],
-            backoff_factor=1,
-            allowed_methods=[
-                "HEAD",
-                "GET",
-                "OPTIONS",
-                "POST",
-                "PUT",
-                "DELETE",
-                "TRACE",
-                "PATCH",
-            ],
-        )
-        adapter = HTTPAdapter(max_retries=retry_strategy)
-        http = requests.Session()
-        http.mount("https://", adapter)
-        http.mount("http://", adapter)
-
         resp = ""
         try:
             logger.debug(
@@ -139,10 +192,15 @@ url %s, params %s, data %s, headers %s",
                 data,
                 [(k, v) for k, v in headers.items() if k != "Authorization"],
             )
-            resp = http.request(method, url, params=params, data=data, headers=headers)
+            if self._session:
+                resp = self._session.request(method, url, params=params, data=data, headers=headers)
+            else:
+                http = requests.Session()
+                _configure_retry_strategy(http, self._RETRIES)
+                resp = http.request(method, url, params=params, data=data, headers=headers)
             resp.raise_for_status()
         except requests.exceptions.HTTPError as httperr:
-            logger.error(
+            logger.warning(
                 "%s on %s request: params %s, data %s, headers %s",
                 str(httperr),
                 method,
@@ -151,7 +209,7 @@ url %s, params %s, data %s, headers %s",
                 [(k, v) for k, v in headers.items() if k != "Authorization"],
             )
             if hasattr(resp, "content"):  # pragma: no cover
-                logger.error("HTTPError, resp content: %s", resp.content)
+                logger.warning("HTTPError, resp content: %s", resp.content)
             try:
                 content = json.loads(resp.content.decode())
             except ValueError:

{mambupy-2.1.0/mambupy → mambupy-2.1.1/MambuPy}/mambuconfig.py

@@ -24,6 +24,7 @@ RC files must have the following format:
     apiuser=API_user
     apipwd=API_password
     apipagination=API_pagination_limit
+    activate_request_session_objects=API_persistent_session
     [DB]
     dbname=Database_name
     dbuser=Database_user
@@ -75,6 +76,10 @@ user on your Mambu instance
 
 The db* configs refer to Database configurations which hold a backup of
 your Mambu Database on some server.
+
+The activate_request_session_objects config enables or disables HTTP persistent sessions
+for API requests. When enabled, it will reuse the same TCP connection for
+multiple requests, improving performance. Default is False.
 """
 
 default_configs = {
@@ -83,6 +88,7 @@ default_configs = {
     "apiuser": "mambu_api_user",
     "apipwd": "mambu_api_password",
     "apipagination": "50",
+    "activate_request_session_objects": "False",
     # Mambu DB configurations
     "dbname": "mambu_db",
     "dbuser": "mambu_db_user",
@@ -123,6 +129,7 @@ argparser.add_argument("--mambupy_apiurl")
 argparser.add_argument("--mambupy_apiuser")
 argparser.add_argument("--mambupy_apipwd")
 argparser.add_argument("--mambupy_apipagination")
+argparser.add_argument("--mambupy_activate_request_session_objects")
 argparser.add_argument("--mambupy_dbname")
 argparser.add_argument("--mambupy_dbuser")
 argparser.add_argument("--mambupy_dbpwd")
@@ -184,6 +191,8 @@ apipwd = get_conf(config, "API", "apipwd")
 """Password to access Mambu API"""
 apipagination = get_conf(config, "API", "apipagination")
 """Pagination default limit for requests to Mambu API"""
+activate_request_session_objects = get_conf(config, "API", "activate_request_session_objects")
+"""Whether to use persistent HTTP sessions for API requests"""
 dbname = get_conf(config, "DB", "dbname")
 """Name of the DB with a backup of Mambu's DB"""
 dbuser = get_conf(config, "DB", "dbuser")

{mambupy-2.1.0/mambupy → mambupy-2.1.1/MambuPy}/mambuutil.py

@@ -28,7 +28,7 @@ from codecs import open as copen
 
 import yaml
 
-from .mambuconfig import apipagination, apipwd, apiurl, apiuser, loggingconf
+from .mambuconfig import apipagination, apipwd, apiurl, apiuser, loggingconf, activate_request_session_objects
 from .mambugeturl import getmambuurl
 
 try:
@@ -258,7 +258,7 @@ def strip_consecutive_repeated_char(s, ch):
 
 if sys.version_info >= (3, 0):
     # python3
-    from future.moves.urllib import parse as urlparse
+    from urllib import parse as urlparse
 else:  # pragma: no cover
     # python2
     import urlparse

{mambupy-2.1.0 → mambupy-2.1.1}/MambuPy/rest/mambuclient.py

@@ -13,7 +13,7 @@ Uses mambugeturl.getclienturl as default urlfunc
 """
 
 
-from builtins import str as unicode
+unicode = str
 
 from ..mambugeturl import getclientcustominformationurl, getclienturl
 from ..mambuutil import strip_consecutive_repeated_char as scrc

{mambupy-2.1.0 → mambupy-2.1.1}/MambuPy/rest/mamburestutils.py

@@ -1,5 +1,3 @@
-from future.utils import implements_iterator
-
 from ..mambuutil import MambuError
 
 
@@ -30,7 +28,6 @@ class RequestsCounter(object):
         cls.requests = []
 
 
-@implements_iterator
 class MambuStructIterator:
     """Enables iteration for some Mambu objects that may want to have iterators.
 

{mambupy-2.1.0/mambupy → mambupy-2.1.1/MambuPy}/rest/mambustruct.py

@@ -31,7 +31,7 @@ Some basic definitions:
   relational database but the term table is preferred in this case.
 """
 import json
-from builtins import str as unicode
+unicode = str
 from datetime import datetime
 
 import requests

{mambupy-2.1.0 → mambupy-2.1.1}/MambuPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: MambuPy
-Version: 2.1.0
+Version: 2.1.1
 Summary: A python library for using Mambu APIs.
 Author-email: "Javier Novoa C." <jstitch@gmail.com>
 License: LICENSE
@@ -694,14 +694,13 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 or later (G
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: requests==2.31.0
 Requires-Dist: requests_toolbelt==1.0.0
 Requires-Dist: dateutils==0.6.12
-Requires-Dist: future==0.18.3
 Provides-Extra: full
 Requires-Dist: SQLAlchemy==1.3.6; extra == "full"
 Requires-Dist: mysqlclient==2.1.0; extra == "full"
@@ -722,6 +721,8 @@ Requires-Dist: twine; extra == "deploy"
 Provides-Extra: devtools
 Requires-Dist: ipython; extra == "devtools"
 Requires-Dist: ipdb; extra == "devtools"
+Requires-Dist: devpi-client>=7.2.0; extra == "devtools"
+Dynamic: license-file
 
 MambuPy
 =======

{mambupy-2.1.0 → mambupy-2.1.1}/MambuPy.egg-info/requires.txt

@@ -2,7 +2,6 @@ PyYAML==6.0.1
 requests==2.31.0
 requests_toolbelt==1.0.0
 dateutils==0.6.12
-future==0.18.3
 
 [deploy]
 build
@@ -20,6 +19,7 @@ isort
 [devtools]
 ipython
 ipdb
+devpi-client>=7.2.0
 
 [doc]
 sphinx==5.0.0

{mambupy-2.1.0 → mambupy-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: MambuPy
-Version: 2.1.0
+Version: 2.1.1
 Summary: A python library for using Mambu APIs.
 Author-email: "Javier Novoa C." <jstitch@gmail.com>
 License: LICENSE
@@ -694,14 +694,13 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 or later (G
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: requests==2.31.0
 Requires-Dist: requests_toolbelt==1.0.0
 Requires-Dist: dateutils==0.6.12
-Requires-Dist: future==0.18.3
 Provides-Extra: full
 Requires-Dist: SQLAlchemy==1.3.6; extra == "full"
 Requires-Dist: mysqlclient==2.1.0; extra == "full"
@@ -722,6 +721,8 @@ Requires-Dist: twine; extra == "deploy"
 Provides-Extra: devtools
 Requires-Dist: ipython; extra == "devtools"
 Requires-Dist: ipdb; extra == "devtools"
+Requires-Dist: devpi-client>=7.2.0; extra == "devtools"
+Dynamic: license-file
 
 MambuPy
 =======

{mambupy-2.1.0 → mambupy-2.1.1}/mambupy/__init__.py

@@ -39,7 +39,7 @@ import sys
 from importlib.abc import MetaPathFinder
 from importlib.util import spec_from_file_location
 
-__version__ = "2.1.0"
+__version__ = "2.1.1"
 """The version of this module."""
 
 

{mambupy-2.1.0/MambuPy → mambupy-2.1.1/mambupy}/api/connector/rest.py

@@ -36,12 +36,82 @@ from MambuPy.mambuutil import (
     apiurl,
     apiuser,
     setup_logging,
+    activate_request_session_objects,
 )
 
 
 logger = setup_logging(__name__)
 
 
+def _configure_retry_strategy(session, retries=5):
+    """Configure retry strategy for a session.
+
+    Args:
+        session (requests.Session): The session to configure
+        retries (int, optional): Number of retries. Defaults to 5.
+    """
+    retry_strategy = Retry(
+        total=retries,
+        status_forcelist=[429, 500, 502, 503, 504],
+        backoff_factor=1,
+        allowed_methods=[
+            "HEAD",
+            "GET",
+            "OPTIONS",
+            "POST",
+            "PUT",
+            "DELETE",
+            "TRACE",
+            "PATCH",
+        ],
+    )
+    adapter = HTTPAdapter(max_retries=retry_strategy)
+    session.mount("https://", adapter)
+    session.mount("http://", adapter)
+
+
+class SessionSingleton:
+    """Singleton class to manage HTTP sessions for MambuPy.
+
+    This class ensures that only one requests.Session object is created and reused
+    across all requests to the Mambu API. This helps improve performance by reusing
+    TCP connections.
+
+    Example:
+        >>> session = SessionSingleton()
+        >>> session.get_session()  # Returns a requests.Session object
+        >>> session2 = SessionSingleton()
+        >>> session2.get_session()  # Returns the same requests.Session object
+    """
+
+    __instance = None
+    __session = None
+    _RETRIES = 5
+
+    def __new__(cls):
+        """Create a new instance of SessionSingleton if one doesn't exist.
+
+        Returns:
+            SessionSingleton: The singleton instance.
+        """
+        if cls.__instance is None:
+            cls.__instance = super(SessionSingleton, cls).__new__(cls)
+        return cls.__instance
+
+    def get_session(self):
+        """Get the requests.Session object.
+
+        If no session exists, create a new one. Otherwise, return the existing one.
+
+        Returns:
+            requests.Session: The session object to use for HTTP requests.
+        """
+        if self.__session is None:
+            self.__session = requests.Session()
+            _configure_retry_strategy(self.__session, self._RETRIES)
+        return self.__session
+
+
 class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWriter):
     """A connector for Mambu REST API"""
 
@@ -55,6 +125,9 @@ class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWri
         }
         self.__set_authorization_header(user, pwd)
         self.__set_url(url)
+        self._session = None
+        if activate_request_session_objects.lower() == "true":
+            self._session = SessionSingleton().get_session()
 
     def __set_authorization_header(self, user, pwd):
         self._headers["Authorization"] = "Basic {}".format(
@@ -108,26 +181,6 @@ class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWri
         params = self.__request_params(params)
         data = self.__request_data(data)
 
-        retry_strategy = Retry(
-            total=self._RETRIES,
-            status_forcelist=[429, 500, 502, 503, 504],
-            backoff_factor=1,
-            allowed_methods=[
-                "HEAD",
-                "GET",
-                "OPTIONS",
-                "POST",
-                "PUT",
-                "DELETE",
-                "TRACE",
-                "PATCH",
-            ],
-        )
-        adapter = HTTPAdapter(max_retries=retry_strategy)
-        http = requests.Session()
-        http.mount("https://", adapter)
-        http.mount("http://", adapter)
-
         resp = ""
         try:
             logger.debug(
@@ -139,10 +192,15 @@ url %s, params %s, data %s, headers %s",
                 data,
                 [(k, v) for k, v in headers.items() if k != "Authorization"],
             )
-            resp = http.request(method, url, params=params, data=data, headers=headers)
+            if self._session:
+                resp = self._session.request(method, url, params=params, data=data, headers=headers)
+            else:
+                http = requests.Session()
+                _configure_retry_strategy(http, self._RETRIES)
+                resp = http.request(method, url, params=params, data=data, headers=headers)
             resp.raise_for_status()
         except requests.exceptions.HTTPError as httperr:
-            logger.error(
+            logger.warning(
                 "%s on %s request: params %s, data %s, headers %s",
                 str(httperr),
                 method,
@@ -151,7 +209,7 @@ url %s, params %s, data %s, headers %s",
                 [(k, v) for k, v in headers.items() if k != "Authorization"],
             )
             if hasattr(resp, "content"):  # pragma: no cover
-                logger.error("HTTPError, resp content: %s", resp.content)
+                logger.warning("HTTPError, resp content: %s", resp.content)
             try:
                 content = json.loads(resp.content.decode())
             except ValueError:

{mambupy-2.1.0/MambuPy → mambupy-2.1.1/mambupy}/mambuconfig.py

@@ -24,6 +24,7 @@ RC files must have the following format:
     apiuser=API_user
     apipwd=API_password
     apipagination=API_pagination_limit
+    activate_request_session_objects=API_persistent_session
     [DB]
     dbname=Database_name
     dbuser=Database_user
@@ -75,6 +76,10 @@ user on your Mambu instance
 
 The db* configs refer to Database configurations which hold a backup of
 your Mambu Database on some server.
+
+The activate_request_session_objects config enables or disables HTTP persistent sessions
+for API requests. When enabled, it will reuse the same TCP connection for
+multiple requests, improving performance. Default is False.
 """
 
 default_configs = {
@@ -83,6 +88,7 @@ default_configs = {
     "apiuser": "mambu_api_user",
     "apipwd": "mambu_api_password",
     "apipagination": "50",
+    "activate_request_session_objects": "False",
     # Mambu DB configurations
     "dbname": "mambu_db",
     "dbuser": "mambu_db_user",
@@ -123,6 +129,7 @@ argparser.add_argument("--mambupy_apiurl")
 argparser.add_argument("--mambupy_apiuser")
 argparser.add_argument("--mambupy_apipwd")
 argparser.add_argument("--mambupy_apipagination")
+argparser.add_argument("--mambupy_activate_request_session_objects")
 argparser.add_argument("--mambupy_dbname")
 argparser.add_argument("--mambupy_dbuser")
 argparser.add_argument("--mambupy_dbpwd")
@@ -184,6 +191,8 @@ apipwd = get_conf(config, "API", "apipwd")
 """Password to access Mambu API"""
 apipagination = get_conf(config, "API", "apipagination")
 """Pagination default limit for requests to Mambu API"""
+activate_request_session_objects = get_conf(config, "API", "activate_request_session_objects")
+"""Whether to use persistent HTTP sessions for API requests"""
 dbname = get_conf(config, "DB", "dbname")
 """Name of the DB with a backup of Mambu's DB"""
 dbuser = get_conf(config, "DB", "dbuser")

{mambupy-2.1.0/MambuPy → mambupy-2.1.1/mambupy}/mambuutil.py

@@ -28,7 +28,7 @@ from codecs import open as copen
 
 import yaml
 
-from .mambuconfig import apipagination, apipwd, apiurl, apiuser, loggingconf
+from .mambuconfig import apipagination, apipwd, apiurl, apiuser, loggingconf, activate_request_session_objects
 from .mambugeturl import getmambuurl
 
 try:
@@ -258,7 +258,7 @@ def strip_consecutive_repeated_char(s, ch):
 
 if sys.version_info >= (3, 0):
     # python3
-    from future.moves.urllib import parse as urlparse
+    from urllib import parse as urlparse
 else:  # pragma: no cover
     # python2
     import urlparse

{mambupy-2.1.0 → mambupy-2.1.1}/mambupy/rest/mambuclient.py

@@ -13,7 +13,7 @@ Uses mambugeturl.getclienturl as default urlfunc
 """
 
 
-from builtins import str as unicode
+unicode = str
 
 from ..mambugeturl import getclientcustominformationurl, getclienturl
 from ..mambuutil import strip_consecutive_repeated_char as scrc

{mambupy-2.1.0 → mambupy-2.1.1}/mambupy/rest/mamburestutils.py

@@ -1,5 +1,3 @@
-from future.utils import implements_iterator
-
 from ..mambuutil import MambuError
 
 
@@ -30,7 +28,6 @@ class RequestsCounter(object):
         cls.requests = []
 
 
-@implements_iterator
 class MambuStructIterator:
     """Enables iteration for some Mambu objects that may want to have iterators.
 

{mambupy-2.1.0/MambuPy → mambupy-2.1.1/mambupy}/rest/mambustruct.py

@@ -31,7 +31,7 @@ Some basic definitions:
   relational database but the term table is preferred in this case.
 """
 import json
-from builtins import str as unicode
+unicode = str
 from datetime import datetime
 
 import requests

{mambupy-2.1.0 → mambupy-2.1.1}/pyproject.toml

@@ -4,9 +4,14 @@ authors = [{name = "Javier Novoa C.", email = "jstitch@gmail.com"}]
 license = {file = "LICENSE"}
 description="A python library for using Mambu APIs."
 readme = {file = "README.md", content-type = "text/markdown"}
-requires-python = ">=3.8"
+requires-python = ">=3.7"
 dynamic = ["version"]
-dependencies = ["PyYAML==6.0.1", "requests==2.31.0", "requests_toolbelt==1.0.0", "dateutils==0.6.12", "future==0.18.3"]
+dependencies = [
+ "PyYAML==6.0.1",
+ "requests==2.31.0",
+ "requests_toolbelt==1.0.0",
+ "dateutils==0.6.12",
+]
 keywords = ["mambu"]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
@@ -23,7 +28,7 @@ full = ["SQLAlchemy==1.3.6", "mysqlclient==2.1.0"]
 doc = ["sphinx==5.0.0", "sphinx_rtd_theme"]
 dev = ["freezegun==1.1.0", "mock", "coverage", "pylint", "ruff", "black", "isort"]
 deploy = ["build", "twine"]
-devtools = ["ipython", "ipdb"]
+devtools = ["ipython", "ipdb", "devpi-client>=7.2.0"]
 
 [project.urls]
 Homepage = "https://mambupydocs.readthedocs.io"