Add ttp dependency and refactor OxiAPI and NodeConfig classes
- Added `ttp` as a dependency in `pyproject.toml` and `uv.lock`. - Updated `NodeConfig` to store model names in lowercase. - Refactored `OxiAPI` to always create a new session and added a `close` method. - Removed unnecessary logging in `Node` class. - Introduced interfaces for device registration with a new `BaseDevice` class and a `register_parser` function. - Created initial structure for device models, including a `Mikrotik` parser.
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
from functools import cached_property
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from .interfaces import BaseDevice, device_registry
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from requests import Session
|
||||
@@ -10,7 +11,7 @@ class NodeConfig:
|
||||
def __init__(self, session: "Session", full_name: str, model: str, base_url: str):
|
||||
self._session = session
|
||||
self._full_name = full_name
|
||||
self._model = model
|
||||
self._model = model.lower()
|
||||
self._url = f"{base_url}/node/fetch/{full_name}"
|
||||
self._device: type[BaseDevice] = device_registry.get(self._model.lower())
|
||||
if self._device is None:
|
||||
@@ -19,7 +20,6 @@ class NodeConfig:
|
||||
|
||||
@cached_property
|
||||
def _response(self):
|
||||
log.debug(f"Fetching config from {self._url}")
|
||||
response = self._session.get(self._url)
|
||||
response.raise_for_status()
|
||||
return response
|
||||
|
||||
15
oxi/core.py
15
oxi/core.py
@@ -7,13 +7,12 @@ class OxiAPI:
|
||||
def __init__(
|
||||
self,
|
||||
url: str,
|
||||
session: Optional[Session] = None,
|
||||
username: Optional[str] = None,
|
||||
password: Optional[str] = None,
|
||||
verify: bool = True,
|
||||
):
|
||||
self.base_url = url.rstrip("/")
|
||||
self._session = session or Session()
|
||||
self._session = Session()
|
||||
self._session.verify = verify
|
||||
if username and password:
|
||||
self._session.auth = (username, password)
|
||||
@@ -23,13 +22,7 @@ class OxiAPI:
|
||||
return self
|
||||
|
||||
def __exit__(self, *args):
|
||||
self._session.close()
|
||||
self.close()
|
||||
|
||||
def get(self, endpoint: str, **kwargs) -> dict:
|
||||
url = f"{self.base_url}/{endpoint.lstrip('/')}"
|
||||
if not url.endswith(".json"):
|
||||
url += ".json"
|
||||
result = self._session.get(url, **kwargs)
|
||||
if result.status_code == 500:
|
||||
raise ValueError(f"page {url} not found")
|
||||
return result.json()
|
||||
def close(self):
|
||||
return self._session.close()
|
||||
|
||||
21
oxi/interfaces/__init__.py
Normal file
21
oxi/interfaces/__init__.py
Normal file
@@ -0,0 +1,21 @@
|
||||
from typing import Callable, Type
|
||||
|
||||
from .base import BaseDevice
|
||||
|
||||
device_registry = {}
|
||||
|
||||
|
||||
def register_parser(
|
||||
name: list[str],
|
||||
) -> Callable[[Type[BaseDevice]], Type[BaseDevice]]:
|
||||
def wrapper(cls):
|
||||
for item in name:
|
||||
device_registry[item.lower()] = cls
|
||||
return cls
|
||||
|
||||
return wrapper
|
||||
|
||||
|
||||
from . import models # noqa: E402, F401
|
||||
|
||||
__all__ = ["register_parser", "device_registry"]
|
||||
1
oxi/interfaces/base.py
Normal file
1
oxi/interfaces/base.py
Normal file
@@ -0,0 +1 @@
|
||||
class BaseDevice: ...
|
||||
7
oxi/interfaces/models/__init__.py
Normal file
7
oxi/interfaces/models/__init__.py
Normal file
@@ -0,0 +1,7 @@
|
||||
import importlib
|
||||
import pkgutil
|
||||
|
||||
package = __package__
|
||||
|
||||
for loader, module_name, is_pkg in pkgutil.iter_modules(__path__):
|
||||
importlib.import_module(f"{package}.{module_name}")
|
||||
5
oxi/interfaces/models/mikrotik.py
Normal file
5
oxi/interfaces/models/mikrotik.py
Normal file
@@ -0,0 +1,5 @@
|
||||
from oxi.interfaces import register_parser
|
||||
|
||||
|
||||
@register_parser(["routeros", "ros", "mikrotik"])
|
||||
class Mikrotik: ...
|
||||
@@ -1,6 +1,6 @@
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from oxi.view import NodeView
|
||||
from .view import NodeView
|
||||
|
||||
|
||||
if TYPE_CHECKING:
|
||||
@@ -19,9 +19,6 @@ class Node:
|
||||
url += ".json"
|
||||
response = self._session.get(url)
|
||||
if response.status_code == 500:
|
||||
log.warning(
|
||||
"Oxidized response: %r , %r not found", response.status_code, url
|
||||
)
|
||||
raise ValueError(f"page {url} not found")
|
||||
return NodeView(
|
||||
session=self._session, base_url=self._base_url, data=response.json()
|
||||
|
||||
@@ -10,6 +10,7 @@ readme = "README.md"
|
||||
requires-python = ">=3.13"
|
||||
dependencies = [
|
||||
"requests>=2.32.5",
|
||||
"ttp>=0.10.0",
|
||||
]
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["."]
|
||||
|
||||
15
uv.lock
generated
15
uv.lock
generated
@@ -67,10 +67,14 @@ version = "0.1.0"
|
||||
source = { editable = "." }
|
||||
dependencies = [
|
||||
{ name = "requests" },
|
||||
{ name = "ttp" },
|
||||
]
|
||||
|
||||
[package.metadata]
|
||||
requires-dist = [{ name = "requests", specifier = ">=2.32.5" }]
|
||||
requires-dist = [
|
||||
{ name = "requests", specifier = ">=2.32.5" },
|
||||
{ name = "ttp", specifier = ">=0.10.0" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "requests"
|
||||
@@ -87,6 +91,15 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/1e/db/4254e3eabe8020b458f1a747140d32277ec7a271daf1d235b70dc0b4e6e3/requests-2.32.5-py3-none-any.whl", hash = "sha256:2462f94637a34fd532264295e186976db0f5d453d1cdd31473c85a6a161affb6", size = 64738, upload-time = "2025-08-18T20:46:00.542Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ttp"
|
||||
version = "0.10.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/83/e6/9169d35574be82df2a0cdd2546f4f83d0d30964cf0043fc9784df855b024/ttp-0.10.0.tar.gz", hash = "sha256:40f1ca61ee1431f5b1ab5326fb55f852a04749e9574792d45455b62c5e7ac97b", size = 64665, upload-time = "2025-11-02T08:47:50.329Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/b3/c3/60abb45bd8eb973997f133eb76949523478d35dfc551a0dbd8906b6a8075/ttp-0.10.0-py3-none-any.whl", hash = "sha256:9985e0ca414e85d41493a6291a924624b9a08c48c78d2d01477cc60ba2a347c1", size = 84287, upload-time = "2025-11-02T08:47:48.656Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "urllib3"
|
||||
version = "2.6.3"
|
||||
|
||||
Reference in New Issue
Block a user