2.0.4 (2025-05-17)

------------------
**Changed:** `FortiGateBase.get_session()`, private to public

Author: vladimirs-git

CHANGELOG.rst

@@ -13,6 +13,14 @@ Unreleased
 **New:** `FortiGateAPI.monitor` connectors, to work with all `Monitor API` endpoints.
 
 
+2.0.4 (2025-05-17)
+------------------
+
+**Changed:** `FortiGateBase.get_session()`, private to public
+
+**Added:** example policy_filter_efilter.py
+
+
 2.0.3 (2024-12-30)
 ------------------
 

docs/conf.py

@@ -8,7 +8,7 @@
 project = "fortigate-api"
 copyright = "2021, Vladimirs Prusakovs"
 author = "Vladimirs Prusakovs"
-release = "2.0.3"
+release = "2.0.4"
 
 extensions = [
     "sphinx.ext.autodoc",

fortigate_api/fortigate_base.py

@@ -197,13 +197,13 @@ def _bearer_token(self) -> DStr:
         """Return bearer token."""
         return {"Authorization": f"Bearer {self.token}"}
 
-    def _get_session(self) -> Session:
+    def get_session(self) -> Session:
         """Return an existing session or create a new one."""
         if not self.is_connected:
             self.login()
         session = self._session
         if not isinstance(session, Session):
-            raise TypeError(f"{session=} {Session} expected.")
+            raise TypeError(f"{Session.__name__} expected.")
         return session
 
     @staticmethod
@@ -291,7 +291,7 @@ def _response(self, method: Method, url: str, data: ODAny = None) -> Response:
         if self.token:
             params["headers"] = self._bearer_token()
 
-        session: Session = self._get_session()
+        session: Session = self.get_session()
         method_: Callable = getattr(session, method)
         try:
             response: Response = method_(**params)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fortigate_api"
-version = "2.0.3"
+version = "2.0.4"
 description = "Python package to configure Fortigate (Fortios) devices using REST API and SSH"
 authors = ["Vladimirs Prusakovs <vladimir.prusakovs@gmail.com>"]
 readme = "README.rst"
@@ -62,7 +62,7 @@ test = ["pytest"]
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/vladimirs-git/fortigate-api/issues"
-"Download URL" = "https://github.com/vladimirs-git/fortigate-api/archive/refs/tags/2.0.3.tar.gz"
+"Download URL" = "https://github.com/vladimirs-git/fortigate-api/archive/refs/tags/2.0.4.tar.gz"
 
 [tool.pylint]
 max-line-length = 100

tests/test__connector.py

@@ -212,6 +212,7 @@ def test__get_uid(connectors_name: list, uid, data, expected: Any):
     """Connector._get_uid()"""
     connector = connectors_name[0]
     connector.uid = uid
+
     if isinstance(expected, str):
         actual = connector._get_uid(data=data)
         assert actual == expected

tests/test__fortigate_base.py

@@ -6,7 +6,6 @@
 import requests_mock
 from pytest_mock import MockerFixture
 from requests import Session
-from requests_mock import Mocker
 
 from fortigate_api import fortigate_base
 from fortigate_api.fortigate import FortiGate
@@ -16,8 +15,8 @@
 
 
 @pytest.fixture
-def api():
-    """Init FortiGate"""
+def api() -> FortiGate:
+    """Init FortiGate."""
     return FortiGate(host="host")
 
 
@@ -63,7 +62,7 @@ def test__enter__(mocker: MockerFixture):
     session_m = mocker.Mock()
     mocker.patch(target="requests.Session.post", return_value=session_m)
     mocker.patch(target="requests.Session.get", return_value=tst.crate_response(200))
-    with patch("fortigate_api.FortiGate._get_token_from_cookies", return_value="token"):
+    with patch("fortigate_api.FortiGate._get_token_from_cookies", return_value="TOKEN"):
         with FortiGate(host="host") as fgt:
             session = fgt._session
             assert isinstance(session, Session) is True
@@ -125,21 +124,22 @@ def test__login(token, expected, headers):
 
 # =========================== helpers ============================
 
-def test__get_session(api: FortiGate, mocker: MockerFixture):
-    """FortiGateBase._get_session()"""
-    # session
-    api._session = Session()
-    session = api._get_session()
-    assert isinstance(session, Session)
-
-    # login
-    api._session = None
-    mock_response = mocker.Mock()
-    mocker.patch(target="requests.Session.post", return_value=mock_response)
-    mocker.patch(target="requests.Session.get", return_value=tst.crate_response(200))
-    with patch("fortigate_api.FortiGate._get_token_from_cookies", return_value="token"):
-        session = api._get_session()
-        assert isinstance(session, Session) is True
+@pytest.mark.parametrize("session, expected", [
+    (Session(), True),
+    (None, TypeError),
+])
+def test__get_session(api: FortiGate, session, expected):
+    """FortiGateBase.get_session()"""
+    api._session = session
+
+    if isinstance(expected, bool):
+        session = api.get_session()
+        assert isinstance(session, Session)
+
+    else:
+        with pytest.raises(expected):
+            with patch.object(FortiGate, "login", return_value=None):
+                api.get_session()
 
 
 @pytest.mark.parametrize("name, expected", [