python-library-lan-router 0.1.0__tar.gz

python_library_lan_router-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.venv/
+.env
+.pytest_cache/
+config.yaml
+logs/

python_library_lan_router-0.1.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: python-library-lan-router
+Version: 0.1.0
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: tplinkrouterc6u>=0.1.0

python_library_lan_router-0.1.0/lan_router/__init__.py

@@ -0,0 +1,16 @@
+from .device import Device
+from .base import BaseRouter
+from .tplink import TPLinkRouter
+from typing import Literal
+
+def create_router(vendor: Literal["tplink"],**kwargs) -> BaseRouter:
+    if vendor == "tplink":
+        return TPLinkRouter(**kwargs)
+    else:
+        raise ValueError(f"不支持的厂商: {vendor}")
+
+__all__ = [
+    "Device",
+    "BaseRouter",
+    "TPLinkRouter",
+]

python_library_lan_router-0.1.0/lan_router/base.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel
+from abc import ABC, abstractmethod
+from .device import Device
+
+class BaseRouter(BaseModel, ABC):
+    hostname: str
+    """路由器主机名"""
+    username: str
+    """路由器用户名"""
+    password: str
+    """路由器密码"""
+
+    @abstractmethod
+    def scan(self) -> list[Device]:
+        """扫描设备"""
+        pass
+
+    def login(self):
+        """登录"""
+        pass
+
+    def logout(self):
+        """登出"""
+        pass

python_library_lan_router-0.1.0/lan_router/device.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+class Device(BaseModel):
+    name: str
+    """设备名称"""
+    ip: str
+    """设备IP地址"""
+    mac: str
+    """设备MAC地址"""
+    type: str
+    """设备类型"""

python_library_lan_router-0.1.0/lan_router/tplink.py

@@ -0,0 +1,33 @@
+from .base import BaseRouter
+from .device import Device
+from tplinkrouterc6u import TPLinkXDRClient
+
+class TPLinkRouter(BaseRouter):
+    _router: TPLinkXDRClient = None
+
+    def model_post_init(self,ctx):
+        self._router = TPLinkXDRClient(self.hostname, self.username, self.password)
+
+    def login(self):
+        self._router.authorize()
+
+    def logout(self):
+        self._router.logout()
+
+    def scan(self) -> list[Device]:
+        devices = []
+        status = self._router.get_status()
+
+        for data in status.devices:
+            type = getattr(data.type, "value", str(data.type))
+            name = data.hostname or ""
+            ip =  self._show(data.ipaddr)
+            mac = self._show(data.macaddr)
+            device = Device(name=name, ip=ip, mac=mac, type=type)
+            devices.append(device)
+
+        return devices
+
+    def _show(self, v: str | None) -> str:
+        """显示空值"""
+        return "-" if v is None or v == "" else v

python_library_lan_router-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-library-lan-router"
+version = "0.1.0"
+requires-python = ">=3.10"
+dependencies = [
+    "tplinkrouterc6u>=0.1.0",
+    "pydantic>=2.0.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["lan_router"]

python_library_lan_router-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+pydantic-settings>=2.0.0
+PyYAML>=6.0.0

python_library_lan_router-0.1.0/settings.py

@@ -0,0 +1,46 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from pathlib import Path
+import yaml
+from typing import Literal
+
+def find_env_file() -> Path | None:
+    """从当前文件所在目录开始，逐层向上查找 .env"""
+    start = Path(__file__).resolve().parent
+    for parent in [start, *start.parents]:
+        env_file = parent / ".env"
+        if env_file.is_file():
+            return env_file
+    return None
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(
+        env_file=find_env_file(),
+        env_file_encoding="utf-8",
+    )
+
+    router_vendor: Literal["tplink"]
+    """路由器厂商"""
+    router_hostname: str
+    """路由器主机名"""
+    router_username: str
+    """路由器用户名"""
+    router_password: str
+    """路由器密码"""
+
+settings = Settings()
+
+def load_settings(input_yaml:str|None):
+    """加载配置文件"""
+    global settings
+
+    if input_yaml:
+        with open(input_yaml) as f:
+            local_overrides = yaml.safe_load(f)
+        for key, value in local_overrides.items():
+            if hasattr(settings, key):
+                setattr(settings, key, value)
+
+__all__ = [
+    "settings",
+    "load_settings",
+]

python_library_lan_router-0.1.0/test.bat

@@ -0,0 +1,11 @@
+@echo off
+cd /d %~dp0
+
+if not exist .venv (
+    python -m venv .venv
+)
+
+call .venv\Scripts\activate.bat
+python -m pip install -e .
+pip install -r requirements.txt
+python -m unittest discover -s tests -p "test_*.py"

python_library_lan_router-0.1.0/tests/router_scan_demo.py

@@ -0,0 +1,25 @@
+"""需配置 .env 与真实路由器，在包根目录执行: python tests/router_scan_demo.py"""
+
+from lan_router import create_router
+from settings import settings
+
+if __name__ == "__main__":
+    router = create_router(
+        settings.router_vendor,
+        hostname=settings.router_hostname,
+        username=settings.router_username,
+        password=settings.router_password,
+    )
+
+    router.login()
+
+    devices = router.scan()
+    for i, device in enumerate(devices):
+        print(f"[{i}] {device.name}")
+        print(f"  连接类型      : {device.type}")
+        print(f"  主机名        : {device.name}")
+        print(f"  IP            : {device.ip}")
+        print(f"  MAC           : {device.mac}")
+        print("-" * 90)
+
+    router.logout()

python_library_lan_router-0.1.0/tests/test_lan_router.py

@@ -0,0 +1,19 @@
+import unittest
+
+from lan_router import Device, create_router
+
+
+class LanRouterTests(unittest.TestCase):
+    def test_create_router_rejects_unknown_vendor(self) -> None:
+        with self.assertRaises(ValueError) as ctx:
+            create_router("unknown")  # type: ignore[arg-type]
+        self.assertIn("不支持", str(ctx.exception))
+
+    def test_device_model(self) -> None:
+        d = Device(name="n", ip="192.168.0.1", mac="00:00:00:00:00:01", type="wifi")
+        self.assertEqual(d.name, "n")
+        self.assertEqual(d.ip, "192.168.0.1")
+
+
+if __name__ == "__main__":
+    unittest.main()