diff --git a/.pc/.quilt_patches b/.pc/.quilt_patches new file mode 100644 index 0000000..6857a8d --- /dev/null +++ b/.pc/.quilt_patches @@ -0,0 +1 @@ +debian/patches diff --git a/.pc/.quilt_series b/.pc/.quilt_series new file mode 100644 index 0000000..c206706 --- /dev/null +++ b/.pc/.quilt_series @@ -0,0 +1 @@ +series diff --git a/.pc/.version b/.pc/.version new file mode 100644 index 0000000..0cfbf08 --- /dev/null +++ b/.pc/.version @@ -0,0 +1 @@ +2 diff --git a/.pc/1/SRV/services/ip_service.py b/.pc/1/SRV/services/ip_service.py new file mode 100644 index 0000000..84c3cca --- /dev/null +++ b/.pc/1/SRV/services/ip_service.py @@ -0,0 +1,75 @@ +import asyncio +from typing import Dict, Any +from sdbus_async.networkmanager import ( + NetworkManager, + NetworkManagerSettings, + NetworkConnectionSettings, + NetworkDeviceGeneric, +) +import sdbus +from sdbus_async.networkmanager.settings import ConnectionProfile +from services.arp_service import NetworkScanner + +class IPService: + """ + Сервис проверки доступности IP-адреса и применения настроек сети + """ + def __init__(self): + self.arp_scanner = NetworkScanner() + self.bus = sdbus.sd_bus_open_system() + sdbus.set_default_bus(self.bus) + + def _reset_bus(self): + """ Перезапускает соединение с системной шиной D-Bus """ + new_bus = sdbus.sd_bus_open_system() + sdbus.set_default_bus(new_bus) + if hasattr(self, 'bus') and self.bus is not None: + self.bus = None + self.bus = new_bus + + async def check_ip_config(self, args: Dict[str, Any]) -> Dict[str, Any]: + """ Проверяет доступность IP-адреса перед его применением """ + self._reset_bus() + clients = self.arp_scanner.scan_network() + new_ip = args["ipv4_updates"]["ipv4.address-data"][0]["address"] + if any(client['ip'] == new_ip for client in clients): + return {"available": False, "message": f"IP address {new_ip} уже занят."} + return {"available": True, "message": "Network profile settings are available for use."} + + async def apply_ip_config(self, args: Dict[str, Any]) -> None: + """ Применяет проверенные настройки IP """ + self._reset_bus() + nm = NetworkManager() + settings = NetworkManagerSettings() + connection_paths = await settings.get_connections_by_id(args["connection_id"]) + + if not connection_paths: + raise ValueError(f"Подключение {args['connection_id']} не найдено") + + connection = NetworkConnectionSettings(connection_paths[0]) + profile = await connection.get_profile() + settings_dict = profile.to_settings_dict() + + for key_path, value in args["ipv4_updates"].items(): + section, *props = key_path.split('.') + current = settings_dict[section] + for prop in props[:-1]: + current = current.setdefault(prop, {}) + current[props[-1]] = value + + new_profile = ConnectionProfile.from_settings_dict(settings_dict) + await connection.update(new_profile.to_dbus()) + print(f"Обновлены настройки для {args['connection_id']}:") + + interface_name = settings_dict['connection']['interface-name'] + devices = await nm.get_devices() + for device_path in devices: + device = NetworkDeviceGeneric(device_path) + if await device.interface == interface_name: + await device.disconnect() + print(f"Отключён от {interface_name}") + await nm.activate_connection(connection=connection_paths[0], device=device_path) + print(f"Переподключён к {args['connection_id']}") + return + + raise RuntimeError(f"Устройство для интерфейса {interface_name} не найдено") diff --git a/.pc/2/SRV/services/ip_service.py b/.pc/2/SRV/services/ip_service.py new file mode 100644 index 0000000..b0c35af --- /dev/null +++ b/.pc/2/SRV/services/ip_service.py @@ -0,0 +1,112 @@ +from sdbus_async.networkmanager import NetworkManager, NetworkManagerSettings, NetworkConnectionSettings, NetworkDeviceGeneric, ActiveConnection +import asyncio +from sdbus_async.networkmanager.settings import ConnectionProfile +from typing import Dict, Any +import sdbus +from services.arp_service import NetworkScanner + +class IPService: + """ + Сервис проверки доступности IP-адреса и применения настроек сети + """ + def __init__(self): + self.arp_scanner = NetworkScanner() + self.bus = sdbus.sd_bus_open_system() + sdbus.set_default_bus(self.bus) + + def _reset_bus(self): + """ Перезапускает соединение с системной шиной D-Bus """ + new_bus = sdbus.sd_bus_open_system() + sdbus.set_default_bus(new_bus) + if hasattr(self, 'bus') and self.bus is not None: + self.bus = None + self.bus = new_bus + + async def check_ip_config(self, args: Dict[str, Any]) -> Dict[str, Any]: + """ Проверяет доступность IP-адреса перед его применением """ + self._reset_bus() + clients = self.arp_scanner.scan_network() + new_ip = args["ipv4_updates"]["ipv4.address-data"][0]["address"] + if any(client['ip'] == new_ip for client in clients): + return {"available": False, "message": f"IP address {new_ip} уже доступен."} + return {"available": True, "message": "Network profile settings are available for use."} + + async def apply_ip_config(self, args: Dict[str, Any]) -> None: + """ Применяет проверенные настройки IP """ + self._reset_bus() + nm = NetworkManager(self.bus) + settings = NetworkManagerSettings(self.bus) + connection_paths = await settings.get_connections_by_id(args["connection_id"]) + + if not connection_paths: + raise ValueError(f"Подключение {args['connection_id']} не найдено") + + connection = NetworkConnectionSettings(connection_paths[0], self.bus) + profile = await connection.get_profile() + settings_dict = profile.to_settings_dict() + + # Обновляем настройки IPv4 + for key_path, value in args["ipv4_updates"].items(): + section, *props = key_path.split('.') + current = settings_dict[section] + for prop in props[:-1]: + current = current.setdefault(prop, {}) + current[props[-1]] = value + + new_profile = ConnectionProfile.from_settings_dict(settings_dict) + await connection.update(new_profile.to_dbus()) + print(f"Обновлены настройки для {args['connection_id']}:") + + # Проверяем interface-name + interface_name = settings_dict['connection'].get('interface-name') + if not interface_name: + # Ищем устройство, связанное с connection_id через активное соединение + devices = await nm.get_devices() + for device_path in devices: + device = NetworkDeviceGeneric(device_path, self.bus) + active_connection = await device.active_connection + if active_connection != '/': + active_conn = ActiveConnection(active_connection, self.bus) + conn_path = await active_conn.connection # Путь к настройкам соединения + if conn_path != '/': + conn_settings = NetworkConnectionSettings(conn_path, self.bus) + active_profile = await conn_settings.get_profile() + if active_profile.to_settings_dict()['connection']['id'] == args["connection_id"]: + interface_name = await device.interface + settings_dict['connection']['interface-name'] = interface_name + new_profile = ConnectionProfile.from_settings_dict(settings_dict) + await connection.update(new_profile.to_dbus()) + print(f"Добавлен interface-name: {interface_name} для {args['connection_id']}") + break + + if not interface_name: + # Если не нашли активное соединение, пробуем получить интерфейс из настроек устройства + devices = await nm.get_devices() + for device_path in devices: + device = NetworkDeviceGeneric(device_path, self.bus) + applied_connection = await device.get_applied_connection() + connection_settings = applied_connection[0] + conn_id = connection_settings.get('connection', {}).get('id', ('s', ''))[1] + if conn_id == args["connection_id"]: + interface_name = await device.interface + settings_dict['connection']['interface-name'] = interface_name + new_profile = ConnectionProfile.from_settings_dict(settings_dict) + await connection.update(new_profile.to_dbus()) + print(f"Добавлен interface-name: {interface_name} для {args['connection_id']}") + break + + if not interface_name: + raise ValueError(f"Не удалось определить interface-name для {args['connection_id']}") + + # Переподключаем устройство + devices = await nm.get_devices() + for device_path in devices: + device = NetworkDeviceGeneric(device_path, self.bus) + if await device.interface == interface_name: + await device.disconnect() + print(f"Отключён от {interface_name}") + await nm.activate_connection(connection=connection_paths[0], device=device_path) + print(f"Переподключён к {args['connection_id']}") + return + + raise RuntimeError(f"Устройство для интерфейса {interface_name} не найдено") \ No newline at end of file diff --git a/.pc/applied-patches b/.pc/applied-patches new file mode 100644 index 0000000..1191247 --- /dev/null +++ b/.pc/applied-patches @@ -0,0 +1,2 @@ +1 +2 diff --git a/.woodpecker/.woodpecker.yml b/.woodpecker/.woodpecker.yml deleted file mode 100644 index 6220c93..0000000 --- a/.woodpecker/.woodpecker.yml +++ /dev/null @@ -1,137 +0,0 @@ -when: - event: manual - -steps: - checkout: - image: debian:latest - commands: - # ПОДГОТОВКА ГИТА И КЛОНИРОВАНИЕ GONETS - - apt update - - apt install -y git git-lfs - - git lfs install - - # УСТАНОВКА НЕОБХОДИМЫХ ЗАВИСИМОСТЕЙ НА СИСТЕМЕ - - apt update - - apt install -y python3 curl findutils grep sed openssh-server tree libnss3 libnss3-dev libnspr4 libnspr4-dev libasound2 libasound2-dev python3.11-venv python3-pip python3-poetry nodejs npm debhelper devscripts build-essential fakeroot dh-make dpkg-dev cmake libgirepository1.0-dev gobject-introspection libcairo2-dev pkg-config python3-dev libdbus-1-dev - - python3 --version - - node -v - - npm -v - raspberry - - # ПОДГОТОВКА СПИСКА PYTHON ЗАВИСИМОСТЕЙ GONETS - - rm -rf /usr/lib/python3.11/EXTERNALLY-MANAGED - - rm -rf /root/.local/share/pypoetry - - rm -rf /root/.poetry - - rm -rf /usr/bin/poetry - - pip install pipx - - pipx ensurepath - - pipx install poetry - - echo 'export PATH="$HOME/.local/bin:$PATH"' >> /root/.bashrc - - . /root/.bashrc - - poetry --version - - cd SRV - - poetry env activate - - poetry add poetry-plugin-export - - poetry install - - poetry self update - - rm -f requirements.txt - - poetry run poetry export -f requirements.txt --output requirements.txt --without-hashes - - # ПОДГОТОВКА И СБОРКА FRONTEND ЧАСТИ GONETS - - pwd - - cd .. - - pwd - - cd FRONT/DEV - - pwd - - npm install - - npm run package - - cd dist/gonets-linux-x64/resources/app - - pwd - - npm run build - - sed -i 's#href="/assets/#href="./assets/#g' dist/index.html - - sed -i 's#src="/assets/#src="./assets/#g' dist/index.html - - cd ../../../../.. - - pwd - - rm -rf BUILD/* - - cp -r DEV/dist/gonets-linux-x64/* BUILD/ - - rm -rf DEV - - # ИНИЦИАЛИЗАЦИЯ DEBIAN КОНФИГУРАЦИЙ ДЛЯ СБОРКИ - - cd .. - - pwd - - cd .. - - pwd - - mv gonets gonets-0.1 - - cd gonets-0.1 - - pwd - - ls - - DEBEMAIL="devteam@gossys.dev" DEBFULLNAME="GOSSYS LLC" dh_make --single -y --createorig - - cd debian/ - - rm -f *.ex - - rm -f README.* - - # КЛОНИРОВАНИЕ НЕОБХОДИМЫХ ШАБЛОНОВ КОНФИГОВ ДЕБИАНА ДЛЯ СБОРКИ - - mkdir -p /woodpecker/src/dev.gossys.dev/HybrydMain/templates - - git clone https://s.galanskiy:${GONETS}@dev.gossys.dev/s.galanskiy/gonets-debian-template.git /woodpecker/src/dev.gossys.dev/HybrydMain/templates - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/changelog /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/control /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/copyright /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/install /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/postinst /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/postrm /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - mv /woodpecker/src/dev.gossys.dev/HybrydMain/templates/rules /woodpecker/src/dev.gossys.dev/HybrydMain/gonets-0.1/debian/ - - # СБОРКА ДЕБИАН ПАКЕТА - - cd .. - - pwd - - dpkg-buildpackage -us -uc -b - - # ИЗВЛЕЧЕНИЕ ВЕРСИИ ПАКЕТА ДЛЯ КОММИТА - - VERSION=$(dpkg-parsechangelog -l./debian/changelog --show-field Version) - - echo "VERSION=$VERSION" > version.env - - # КОММИТ И ТЕГ НА ВЕТКУ DEVELOP - - . ./version.env - - git config user.name "s.galanskiy" - - git config user.email "s.galanskiy@gossys.dev" - - git fetch --all --prune - - git branch -r - - git checkout -b "release/$VERSION" - - git commit -am "Релиз $VERSION" - - git tag -f "v$VERSION" - - git push "https://s.galanskiy:b4785198d18200dfed812dc4299575f736255bd7@dev.gossys.dev/HybrydMain/gonets.git" "release/$VERSION" - - git push -f https://s.galanskiy:b4785198d18200dfed812dc4299575f736255bd7@dev.gossys.dev/HybrydMain/gonets.git "v$VERSION" - - # СОЗДАНИЕ И ЗАГРУЗКА РЕЛИЗА ЧЕРЕЗ API - - | - VERSION=$(dpkg-parsechangelog -l./debian/changelog --show-field Version) - echo "VERSION=$VERSION" > version.env - - # Задать переменные - . ./version.env - TAG="v$VERSION" - - DEB_PATH=$(find .. -maxdepth 1 -type f -name "gonets_*_amd64.deb" | head -n 1) - - if [ ! -f "$DEB_PATH" ]; then - echo ".deb файл не найден по пути: $DEB_PATH" - exit 1 - fi - - RELEASE_JSON=$(curl -s -X POST "https://dev.gossys.dev/api/v1/repos/HybrydMain/gonets/releases" \ - -H "Authorization: token b4785198d18200dfed812dc4299575f736255bd7" \ - -H "Content-Type: application/json" \ - -d "{\"tag_name\": \"$TAG\", \"name\": \"Релиз $TAG\", \"body\": \"Сборка .deb пакета для версии $TAG\", \"draft\": false, \"prerelease\": true}") - - RELEASE_ID=$(echo "$RELEASE_JSON" | grep '"id":' | head -n1 | sed 's/[^0-9]*\([0-9]*\).*/\1/') - - if [ -z "$RELEASE_ID" ]; then - echo "Не удалось получить ID релиза из ответа:" - echo "$RELEASE_JSON" - exit 1 - fi - - curl -s -X POST \ - -H "Authorization: token b4785198d18200dfed812dc4299575f736255bd7" \ - -F "attachment=@$DEB_PATH" \ - "https://dev.gossys.dev/api/v1/repos/HybrydMain/gonets/releases/$RELEASE_ID/assets" || echo "Ошибка загрузки файла" \ No newline at end of file diff --git a/FRONT/BUILD/index.html b/FRONT/BUILD/index.html deleted file mode 100644 index 8f4d4d1..0000000 --- a/FRONT/BUILD/index.html +++ /dev/null @@ -1,13 +0,0 @@ - - - - - GoNets - - - - - -
- - \ No newline at end of file diff --git a/FRONT/BUILD/resources/app/index.tsx b/FRONT/BUILD/resources/app/index.tsx index eeb0635..38c8de5 100644 --- a/FRONT/BUILD/resources/app/index.tsx +++ b/FRONT/BUILD/resources/app/index.tsx @@ -1,8 +1,10 @@ import React from 'react'; import { createRoot } from 'react-dom/client'; import { HashRouter } from 'react-router-dom'; +import { NetworkService } from './src/api/request.ts'; import { useIpStore } from './src/store'; import { useEffect } from 'react'; +import { useAdminStore } from './src/store/adminStore.ts'; import {useCheckAdmin} from './src/utils/checkAdmin.ts' import { diff --git a/FRONT/BUILD/resources/app/main.js b/FRONT/BUILD/resources/app/main.js index df09e91..4c3bd59 100644 --- a/FRONT/BUILD/resources/app/main.js +++ b/FRONT/BUILD/resources/app/main.js @@ -21,7 +21,7 @@ function createWindow() { win.show(); if (process.env.NODE_ENV === 'development') { - win.loadURL('https://localhost:8001'); + win.loadURL('http://localhost:3000'); win.webContents.openDevTools(); } else { win.loadFile(path.join(__dirname, 'dist/index.html')); diff --git a/FRONT/BUILD/resources/app/package.json b/FRONT/BUILD/resources/app/package.json index 304540a..0873f2e 100644 --- a/FRONT/BUILD/resources/app/package.json +++ b/FRONT/BUILD/resources/app/package.json @@ -11,7 +11,6 @@ }, "dependencies": { "@iconify/icons-ic": "^1.2.13", - "@iconify/icons-ph": "^1.2.5", "@iconify/react": "^5.2.0", "@reduxjs/toolkit": "^2.6.0", "@xyflow/react": "^12.3.5", diff --git a/FRONT/BUILD/resources/app/src/api/request.ts b/FRONT/BUILD/resources/app/src/api/request.ts index 27dafd1..377d522 100644 --- a/FRONT/BUILD/resources/app/src/api/request.ts +++ b/FRONT/BUILD/resources/app/src/api/request.ts @@ -82,79 +82,4 @@ export class NetworkService { return error.response; } } - - static async scanUser(ipAddress: string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.get('/subnet/devices'); - } catch (error: any) { - return error.response; - } - } - - static async scanWifi(ipAddress: string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.get('/subnet/wifi'); - } catch (error: any) { - return error.response; - } - } - static async addNote(ipAddress: string, address:string, note: string,type:string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.post(`/subnet/${type}/${address}/note`, { - note: note - }); - } catch (error: any) { - return error.response; - } - } - static async editNote(ipAddress: string, address:string, note: string,type:string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.put(`/subnet/${type}/${address}/note`, { - note: note - }); - } catch (error: any) { - return error.response; - } - } - static async deleteNote(ipAddress: string, address:string, type:string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.delete(`/subnet/${type}/${address}/note`); - } catch (error: any) { - return error.response; - } - } - static async statusNetwork(ipAddress: string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.get(`/subnet/wifi/status`); - } catch (error: any) { - return error.response; - } - } - static async connectNetwork(ipAddress: string, password:string, address: string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.post(`/subnet/wifi/connect`, { - ssid: address, - password: password, - }); - } catch (error: any) { - return error.response; - } - } - static async disconnectNetwork(ipAddress: string, ssid: string): Promise { - try { - const axiosInstance = this.createAxiosInstance(ipAddress); - return await axiosInstance.post(`/subnet/wifi/disconnect`, { - ssid: ssid, - }); - } catch (error: any) { - return error.response; - } - } } \ No newline at end of file diff --git a/FRONT/BUILD/resources/app/src/components/UI/Dropdown/DeviceCard.tsx b/FRONT/BUILD/resources/app/src/components/UI/Dropdown/DeviceCard.tsx deleted file mode 100644 index cfed6c4..0000000 --- a/FRONT/BUILD/resources/app/src/components/UI/Dropdown/DeviceCard.tsx +++ /dev/null @@ -1,137 +0,0 @@ -import React, {useState} from 'react'; -import styled, { css } from 'styled-components'; -import { DeviceUser } from "../../../store/useDeviceStore"; -import {buttonNames} from "../../../const/buttons/names"; -import {ModalMap} from "../../modalwindows/windowsType"; -import {IconComponent} from "../../../const/buttons/icons"; -import {useModalContext} from "../../../store"; - -interface DeviceCardProps { - device: DeviceUser; - status: 'online' | 'offline'; -} - -const CardWrapper = styled.div<{ status: 'online' | 'offline' }>` - background: white; - border-radius: 12px; - box-shadow: 0 4px 12px rgba(0, 0, 0, 0.1); - overflow: hidden; - transition: all 0.3s ease; - cursor: pointer; - margin-bottom: 16px; - - &:hover { - transform: translateY(-2px); - box-shadow: 0 6px 16px rgba(0, 0, 0, 0.15); - } -`; - -const CardHeader = styled.div<{ status: 'online' | 'offline' }>` - background: ${({ status, theme }) => - status === 'online' ? theme.successColor : theme.offlineColor}; - color: white; - padding: 16px; - font-size: 18px; - font-weight: 500; - display: flex; - justify-content: space-between; - align-items: center; -`; - - -const CardContent = styled.div<{ isExpanded: boolean }>` - max-height: 0; - opacity: 0; - padding: 0 16px; - transition: all 0.3s ease; - color: #333; - font-size: 14px; - display: grid; - gap: 12px; - - ${({ isExpanded }) => isExpanded && css` - max-height: 500px; - opacity: 1; - padding: 16px; - `} -`; - -const InfoRow = styled.div` - display: flex; - justify-content: space-between; - align-items: center; -`; - -const Label = styled.span` - font-weight: 500; - color: #666; -`; - -const Value = styled.span` - color: #333; -`; - - -const DeviceCard: React.FC = ({ device, status }) => { - const [isExpanded, setIsExpanded] = useState(false); - const toggleExpanded = () => setIsExpanded(!isExpanded); - const { openModal } = useModalContext(); - - const openModalNote = (e: React.MouseEvent) => { - e.stopPropagation(); - openModal(ModalMap['6'], { - address: device.mac, - currentNote: device.note || '' - }); - }; - - - return ( - - -

- MAC: {device.mac} -

- - - -
- - - - - {device.hostname || 'Неизвестно'} - - - - - {device.vendor || 'Неизвестно'} - - - - - {device.ip} - - - {device.open_ports?.length > 0 && ( - - - {device.open_ports.join(', ')} - - )} - - - - {device.last_seen} - - - - - {device.note || '-'} - - -
- ); -}; - -export default DeviceCard; \ No newline at end of file diff --git a/FRONT/BUILD/resources/app/src/components/UI/Dropdown/DropdownType.tsx b/FRONT/BUILD/resources/app/src/components/UI/Dropdown/DropdownType.tsx deleted file mode 100644 index d1e90c5..0000000 --- a/FRONT/BUILD/resources/app/src/components/UI/Dropdown/DropdownType.tsx +++ /dev/null @@ -1,130 +0,0 @@ -import React, {useEffect, useRef, useState} from 'react'; -import styled from "styled-components"; -import {buttonNames} from "../../../const/buttons/names"; -import {IconComponent} from "../../../const/buttons/icons"; - -type Option = { - value: number, - label: string, -} - -interface DropdownTypeProps { - options: Option[]; - label?: string; - onChange?: (selectedItem: Option) => void; - value: Option | null; -} - -const DropdownWrapper = styled.div` - position: absolute; - top: 18px; - right:20px; - display: inline-block; - background-color: ${({theme}) => theme.background}; - padding: 12px 16px; - border-radius: 12px; - box-shadow: 0 4px 12px rgba(0, 0, 0, 0.1); - z-index: 10; -` -const Label = styled.p` - color: ${({theme}) => theme.textColor}; - font-size: 16px; -` - -const Dropdown = styled.div` - background-color: ${({theme}) => theme.primary}; - border-radius: 15px; - overflow: hidden; - transition: all .3s ease; - cursor: pointer; - z-index: 10; - margin-top: 6px; -` - -const DropdownHeader = styled.div` - display: flex; - justify-content: space-between; - gap: 14px; - padding: 12px 24px; - font-size: 16px; - align-items: center; - height: 100%; - min-width: 200px; -` - -const DropdownContent = styled.div<{$isOpen: boolean}>` - max-height: ${({$isOpen}) => $isOpen ? '500px' : '0'}; - opacity: ${({$isOpen}) => $isOpen ? 1 : 0}; - transition: all .3s ease; - display: flex; - flex-direction: column; - overflow: hidden; -` - -const DropdownRow = styled.button` - padding: 12px 24px; - background-color: transparent; - text-align: start; - font-size: 16px; - border: none; - width: 100%; - color: ${({theme}) => theme.textColor}; - transition: all .3s ease; - cursor: pointer; - - &:hover { - background-color: ${({theme}) => theme.background}; - } -` - -const DropdownArrow = styled.div<{ $isOpen: boolean }>` - transition: transform 0.3s ease; - transform: rotate(${({ $isOpen }) => ($isOpen ? "90deg" : "0deg")}); -`; - -const DropdownType = ({options, value, onChange, label}: DropdownTypeProps) => { - const [isOpen, setIsOpen] = useState(false); - const dropdownRef = useRef(null); - - function toggleOpen() { - setIsOpen((prev) => !prev); - } - - function handleSelect(option: Option) { - onChange?.(option); - setIsOpen(false); - } - - useEffect(() => { - function handleClickOutside(event: MouseEvent) { - if (dropdownRef.current && !dropdownRef.current.contains(event.target as Node)) { - setIsOpen(false); - } - } - document.addEventListener("mousedown", handleClickOutside); - return () => document.removeEventListener("mousedown", handleClickOutside); - }, []); - - return ( - - - - -

{value?.label || 'Select an option'}

- - - -
- - {options.map((option, i) => ( - handleSelect(option)}> - {option.label} - - ))} - -
-
- ); -}; - -export default DropdownType; \ No newline at end of file diff --git a/FRONT/BUILD/resources/app/src/components/UI/buttons/mainButton.tsx b/FRONT/BUILD/resources/app/src/components/UI/buttons/mainButton.tsx index 55ca7e3..0afe0a2 100644 --- a/FRONT/BUILD/resources/app/src/components/UI/buttons/mainButton.tsx +++ b/FRONT/BUILD/resources/app/src/components/UI/buttons/mainButton.tsx @@ -9,15 +9,15 @@ const Button = styled.button.withConfig({ border: none; padding: ${(props) => props.size === "small" - ? "10px 28px" + ? "4px 8px" : props.size === "big" ? "10px 20px" - : "12px 20px"}; // По умолчанию + : "6px 10px"}; // По умолчанию border-radius: 8px; color: white; font-size: ${(props) => props.size === "small" - ? "14px" + ? "12px" : props.size === "big" ? "16px" : "14px"}; // По умолчанию @@ -30,7 +30,7 @@ const Button = styled.button.withConfig({ ? 'row-reverse' : 'row'}; gap: 10px; - transition: all .3s ease; + &:hover{ background-color: ${(props) => props.$hoverсolor}; } diff --git a/FRONT/BUILD/resources/app/src/components/UI/inputs/input.tsx b/FRONT/BUILD/resources/app/src/components/UI/inputs/input.tsx index dd2b9c9..0fac915 100644 --- a/FRONT/BUILD/resources/app/src/components/UI/inputs/input.tsx +++ b/FRONT/BUILD/resources/app/src/components/UI/inputs/input.tsx @@ -5,7 +5,7 @@ type Props = { placeholderText: string; id: string; value?: string; - onChange?: (value: string) => void; + onChange?: (identifier: string, value: string) => void; onFileChange?: (event: React.ChangeEvent) => void; type?: string; multiple?: boolean; @@ -33,7 +33,7 @@ const StyledInput = styled.input` border: 1px solid #adadad; } width: 100%; - font-size: 18px; + font-size: 14px; color: ${props=>props.theme.textColor} `; @@ -41,7 +41,7 @@ const Input = React.forwardRef(({ placeholderText, id, const handleInputChange = (e: React.ChangeEvent) => { const { value } = e.target; if (onChange) { - onChange(value); + onChange(id, value); } }; diff --git a/FRONT/BUILD/resources/app/src/components/UI/signalSvg.tsx b/FRONT/BUILD/resources/app/src/components/UI/signalSvg.tsx index 9590433..a8c5c32 100644 --- a/FRONT/BUILD/resources/app/src/components/UI/signalSvg.tsx +++ b/FRONT/BUILD/resources/app/src/components/UI/signalSvg.tsx @@ -2,21 +2,19 @@ import React, { useEffect, useRef } from 'react'; interface SignalSVGProps { signal: number; // Принимаем signal как пропс - color: string; - size: string; } -const SignalSVG: React.FC = ({ signal, color, size }) => { +const SignalSVG: React.FC = ({ signal }) => { const svgRef = useRef(null); useEffect(() => { // Устанавливаем цвета в зависимости от signal const colors = { - '--st1-color': signal >= 1 ? color : 'black', - '--st2-color': signal >= 2 ? color : 'black', - '--st3-color': signal >= 3 ? color : 'black', - '--st4-color': signal >= 4 ? color : 'black', - '--st5-color': signal === 5 ? color : 'black', + '--st1-color': signal >= 1 ? 'white' : 'black', + '--st2-color': signal >= 2 ? 'white' : 'black', + '--st3-color': signal >= 3 ? 'white' : 'black', + '--st4-color': signal >= 4 ? 'white' : 'black', + '--st5-color': signal === 5 ? 'white' : 'black', }; // Применяем стили к SVG @@ -37,8 +35,8 @@ const SignalSVG: React.FC = ({ signal, color, size }) => { y="0px" viewBox="0 0 296 235" xmlSpace="preserve" - width={size} // Фиксированная ширина - height={size} + width="20px" // Фиксированная ширина + height="20px" > - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.auth

-from fastapi import APIRouter, Depends, HTTPException, Request
-from fastapi.security import OAuth2PasswordBearer
-from services.auth_service import AuthService
-from models.auth import UserCreate, UserLogin, UserResponse, Token
-from storage.json_storage import JsonStorage
-from utils.i18n import get_translations, _
-from babel.support import Translations
-import logging
-import os
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-router = APIRouter()
-auth_service = AuthService()
-oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login")
-
-
-[docs] -@router.post("/register", response_model=UserResponse) -async def register(user: UserCreate, translations: Translations = Depends(get_translations())): - """Регистрирует нового пользователя. - - Создаёт нового пользователя на основе предоставленных данных и возвращает - информацию о зарегистрированном пользователе. - - Args: - user (UserCreate): Объект с данными нового пользователя (username, password, is_admin). - translations: Объект переводов для текущего языка. - - Returns: - UserResponse: Объект с данными зарегистрированного пользователя (id, username, is_admin). - - Raises: - HTTPException: Если пользователь уже существует (status_code=400) или произошла - внутренняя ошибка (status_code=500). - """ - try: - db_user = auth_service.register(user) - logger.info(f"Пользователь {user.username} успешно зарегистрирован") - return db_user - except HTTPException as e: - raise e - except Exception as e: - logger.error(f"Error in register: {type(e).__name__} - {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось зарегистрировать пользователя"))
- - -
-[docs] -@router.post("/login", response_model=Token) -async def login(user: UserLogin, request: Request, translations: Translations = Depends(get_translations())): - """Авторизует пользователя и создаёт сессию. - - Проверяет учетные данные пользователя и возвращает токен и session_id для - последующей авторизации. - - Args: - user (UserLogin): Объект с данными для входа (username, password). - request (Request): Объект запроса для получения client_id (IP-адрес клиента). - translations: Объект переводов для текущего языка. - - Returns: - Token: Объект с access_token и session_id для авторизации. - - Raises: - HTTPException: Если учетные данные неверны (status_code=401) или произошла - внутренняя ошибка (status_code=500). - """ - try: - client_id = request.client.host - logger.debug(f"Попытка входа в систему клиента {client_id}") - result = auth_service.login(user, client_id) - logger.info(f"Успешная авторизация для клиента {client_id}, Идентификатор сессии: {result['session_id']}") - return result - except HTTPException as e: - raise e - except Exception as e: - logger.error(f"Ошибка при авторизации: {type(e).__name__} - {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось авторизовать пользователя"))
- - -
-[docs] -@router.get("/me") -async def get_current_user(request: Request, translations: Translations = Depends(get_translations())): - """Возвращает данные текущего пользователя и токен. - - Проверяет активную сессию по client_id и возвращает информацию о пользователе - и токен для дальнейшего использования. - - Args: - request (Request): Объект запроса для получения client_id (IP-адрес клиента). - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с ключами "user" (UserResponse), "access_token" (str) и - "token_type" (str, всегда "bearer"). - - Raises: - HTTPException: Если сессия не найдена или истекла (status_code=401) или - произошла внутренняя ошибка (status_code=500). - """ - try: - client_id = request.client.host - logger.debug(f"Запрос /me для клиента {client_id}") - result = auth_service.get_user_by_session(client_id) - return { - "user": result["user"], - "access_token": result["access_token"], - "token_type": translations.gettext("bearer"), - } - except HTTPException as e: - raise e - except Exception as e: - logger.error(f"Ошибка при get_current_user: {type(e).__name__} - {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось получить данные пользователя"))
- - -
-[docs] -@router.get("/logout") -async def logout(request: Request, translations: Translations = Depends(get_translations())): - """Выход из системы, удаление сессии. - - Удаляет активную сессию пользователя по client_id. - - Args: - request (Request): Объект запроса для получения client_id (IP-адрес клиента). - translations: Объект переводов для текущего языка. - - Returns: - dict: Пустой словарь или сообщение об успешном выходе. - - Raises: - HTTPException: Если сессия не найдена (status_code=401) или произошла - внутренняя ошибка (status_code=500). - """ - try: - client_id = request.client.host - logger.debug(f"Запрос на выход из системы для клиента {client_id}") - return auth_service.logout(client_id) - except HTTPException as e: - raise e - except Exception as e: - logger.error(f"Не удалось выйти из системы: {type(e).__name__} - {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось выйти из системы"))
- - -
-[docs] -@router.get("/check_json") -async def check_users_file(translations: Translations = Depends(get_translations())): - """Проверяет, существует ли файл users.json и содержит ли он пользователей. - - Возвращает информацию о состоянии файла и наличии пользователей. - - Returns: - dict: Словарь с ключами: - - "exists" (bool): Существует ли файл. - - "has_users" (bool): Содержит ли файл пользователей. - - "message" (str): Сообщение с описанием результата. - - Raises: - HTTPException: Если произошла ошибка при проверке файла (status_code=500). - """ - try: - file_path = "/etc/gonets/users.json" - storage = JsonStorage(file_path=file_path) - - if not os.path.exists(file_path): - logger.info(f"Файл {file_path} не существует") - return { - "exists": False, - "has_users": False, - "message": translations.gettext("Файл users.json не существует"), - } - - data = storage._read_data() - has_users = len(data.get("users", [])) > 0 - if has_users: - logger.info(f"Файл {file_path} существует и содержит пользователей") - return { - "exists": True, - "has_users": True, - "message": translations.gettext("Файл users.json существует и содержит пользователей"), - } - else: - logger.info(f"Файл {file_path} существует, но не содержит пользователей") - return { - "exists": True, - "has_users": False, - "message": translations.gettext("Файл users.json существует, но не содержит пользователей"), - } - except Exception as e: - logger.error(f"Ошибка при проверке файла: {type(e).__name__} - {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка при проверке файла"))
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/api/v1/ip.html b/SRV/docs/_build/html/_modules/api/v1/ip.html deleted file mode 100644 index 4ca4a98..0000000 --- a/SRV/docs/_build/html/_modules/api/v1/ip.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - - - - api.v1.ip - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.ip

-from typing import Dict, Any
-from fastapi import APIRouter, Body, HTTPException, Depends
-from services.ip_service import IPService
-from utils.i18n import get_translations
-from babel.support import Translations
-
-router = APIRouter()
-ip_service = IPService()
-
-
-[docs] -@router.post("/check_ip") -async def check_ip_config(data: Dict[str, Any] = Body(...), translations: Translations = Depends(get_translations())): - """Проверяет доступность IP-адреса перед его применением. - - Выполняет ARP-сканирование для проверки, занят ли указанный IP-адрес, - и возвращает результат проверки. - - Args: - data (Dict[str, Any]): Словарь с данными конфигурации, включая - "ipv4_updates" с полем "ipv4.address-data" для нового IP-адреса. - translations: Объект переводов для текущего языка. - - Returns: - Dict[str, Any]: Словарь с ключами: - - "available" (bool): Доступен ли IP-адрес. - - "message" (str): Сообщение о результате проверки. - - Raises: - HTTPException: Если произошла внутренняя ошибка (status_code=500). - """ - try: - result = await ip_service.check_ip_config(data, translations) - return result - except Exception as e: - raise HTTPException( - status_code=500, - detail=translations.gettext("Ошибка проверки IP конфигурации: {error}").format(error=str(e)) - )
- - -
-[docs] -@router.post("/apply_ip") -async def apply_ip_config(data: Dict[str, Any] = Body(...), translations: Translations = Depends(get_translations())): - """Применяет проверенные IP-настройки к указанному сетевому профилю. - - Обновляет настройки соединения через NetworkManager, отключает и - переподключает устройство к сети. - - Args: - data (Dict[str, Any]): Словарь с данными конфигурации, включая - "connection_id" и "ipv4_updates" с обновлениями IP-настроек. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с ключами: - - "success" (bool): Успешность операции. - - "message" (str): Сообщение об успешном применении настроек. - - Raises: - HTTPException: Если подключение не найдено (status_code=404) или - произошла внутренняя ошибка (status_code=500). - """ - try: - await ip_service.apply_ip_config(data, translations) - return { - "success": True, - "message": translations.gettext("Настройки сетевого профиля для {connection_id} применены").format( - connection_id=data["connection_id"] - ), - } - except ValueError as e: - raise HTTPException(status_code=404, detail=translations.gettext(str(e))) - except Exception as e: - raise HTTPException( - status_code=500, - detail=translations.gettext("Ошибка проверки IP конфигурации: {error}").format(error=str(e)) - )
- - -
-[docs] -@router.post("/save_ip") -async def save_ip_config(data: Dict[str, Any] = Body(...), translations: Translations = Depends(get_translations())): - """Применяет проверенные IP-настройки для отката сетевого профиля. - - Используется для сохранения и отката настроек сетевого профиля к предыдущему - состоянию через NetworkManager. - - Args: - data (Dict[str, Any]): Словарь с данными конфигурации, включая - "connection_id" и "ipv4_updates" с обновлениями IP-настроек. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с ключами: - - "success" (bool): Успешность операции. - - "message" (str): Сообщение об успешном применении настроек. - - Raises: - HTTPException: Если подключение не найдено (status_code=404) или - произошла внутренняя ошибка (status_code=500). - """ - try: - await ip_service.apply_ip_config(data, translations) - return { - "success": True, - "message": translations.gettext("Настройки сетевого профиля для {connection_id} применены").format( - connection_id=data["connection_id"] - ), - } - except ValueError as e: - raise HTTPException(status_code=404, detail=translations.gettext(str(e))) - except Exception as e: - raise HTTPException( - status_code=500, - detail=translations.gettext("Ошибка проверки IP конфигурации: {error}").format(error=str(e)) - )
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/api/v1/network.html b/SRV/docs/_build/html/_modules/api/v1/network.html deleted file mode 100644 index a213c29..0000000 --- a/SRV/docs/_build/html/_modules/api/v1/network.html +++ /dev/null @@ -1,558 +0,0 @@ - - - - - - - - api.v1.network - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.network

-from fastapi import APIRouter, Body, HTTPException, Depends
-import logging
-from typing import Dict, Tuple, List, Union
-from services.network_service import NetworkService
-from models.network import (
-    NetworkInterfacesContainer,
-    Activation,
-    Deactivation,
-    NetworkInterface,
-    WiFiDevice,
-)
-from utils.i18n import get_translations, _
-from babel.support import Translations
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-router = APIRouter()
-network_service = NetworkService()
-
-
-[docs] -class ContainerPositionManager: - """Класс для управления позициями и состоянием контейнеров. - - Хранит и обновляет координаты (x, y) и состояние (isOpen) для контейнеров - активации и деактивации. - """ - - def __init__(self): - """Инициализирует менеджер позиций контейнеров. - - Создаёт начальные позиции и состояния для контейнеров "activation" и - "deactivation" с координатами (0, 0) и закрытым состоянием (False). - """ - self.positions: Dict[str, Dict[str, Union[int, bool]]] = { - "activation": { - "x": 0, - "y": 0, - "isOpen": False - }, - "deactivation": { - "x": 0, - "y": 0, - "isOpen": False - }, - } - -
-[docs] - def get_position_and_state(self, container_name: str, translations: Translations = Depends(get_translations())) -> Tuple[int, int, bool]: - """Получает текущие координаты и состояние указанного контейнера. - - Args: - container_name (str): Имя контейнера ("activation" или "deactivation"). - translations: Объект переводов для текущего языка. - - Returns: - Tuple[int, int, bool]: Кортеж с координатами (x, y) и состоянием (isOpen). - - Raises: - ValueError: Если указан неверный идентификатор контейнера. - """ - container = self.positions.get(container_name) - if not container: - raise ValueError(translations.gettext("Неверное имя контейнера: {container_name}").format(container_name=container_name)) - return container["x"], container["y"], container["isOpen"]
- - -
-[docs] - def update_position(self, container_id: int, x: int, y: int, isOpen: bool) -> None: - """Обновляет позицию и состояние контейнера по его идентификатору. - - Args: - container_id (int): Идентификатор контейнера (1 для "activation", 2 для "deactivation"). - x (int): Новая координата X. - y (int): Новая координата Y. - isOpen (bool): Новое состояние контейнера (открыт/закрыт). - - Raises: - ValueError: Если container_id не соответствует ни одному контейнеру. - """ - container_name = "activation" if container_id == 1 else "deactivation" - self.positions[container_name] = {"x": x, "y": y, "isOpen": isOpen}
-
- - -container_manager = ContainerPositionManager() - -
-[docs] -async def get_network_data(translations: Translations = Depends(get_translations())) -> Dict[str, Dict]: - """Возвращает текущие сетевые данные в виде словаря. - - Получает данные о сетевых интерфейсах, разделяет их на активные и неактивные, - и возвращает их в формате Activation и Deactivation с учётом позиций и состояний - контейнеров. - - Args: - translations: Объект переводов для текущего языка. - - Returns: - Dict[str, Dict]: Словарь с ключами "activation" и "deactivation", содержащими - данные о соответствующих контейнерах. - - Raises: - HTTPException: Если произошла ошибка при получении данных (status_code=500). - """ - logger.debug("Calling get_network_data()") - try: - network_data = await network_service.get_network_interfaces_container() - - activation_interfaces, deactivation_interfaces = _split_interfaces(network_data.interfaces) - - activation_x, activation_y, activation_is_open = (container_manager.get_position_and_state("activation")) - deactivation_x, deactivation_y, deactivation_is_open = (container_manager.get_position_and_state("deactivation")) - - activation = Activation( - id=1, - interfaces=activation_interfaces, - container_x=activation_x, - container_y=activation_y, - isOpen=activation_is_open, - ) - deactivation = Deactivation( - id=2, - interfaces=deactivation_interfaces, - container_x=deactivation_x, - container_y=deactivation_y, - isOpen=deactivation_is_open, - ) - - return { - "activation": activation.model_dump(), - "deactivation": deactivation.model_dump(), - } - except Exception as e: - logger.error(f"Error in get_network_data: {e}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось получить сетевые данные"))
- - -def _split_interfaces( - interfaces: List[Union[NetworkInterface, WiFiDevice]], -) -> Tuple[List[Union[NetworkInterface, WiFiDevice]], List[Union[NetworkInterface, WiFiDevice]]]: - """Разделяет интерфейсы на активные и неактивные. - - Args: - interfaces (List[Union[NetworkInterface, WiFiDevice]]): Список сетевых интерфейсов. - - Returns: - Tuple[List[Union[NetworkInterface, WiFiDevice]], List[Union[NetworkInterface, WiFiDevice]]]: - Кортеж из списков активных и неактивных интерфейсов. - """ - activation_interfaces = [] - deactivation_interfaces = [] - for interface in interfaces: - if interface.device_state == "100": - activation_interfaces.append(interface) - else: - deactivation_interfaces.append(interface) - return activation_interfaces, deactivation_interfaces - -
-[docs] -@router.post("/update_container_position") -async def update_container_position(data: Dict[str, Union[int, bool]] = Body(...), translations: Translations = Depends(get_translations())): - """Обновляет позицию и состояние контейнера. - - Принимает данные о новом положении и состоянии контейнера и обновляет их - в менеджере позиций. - - Args: - data (Dict[str, Union[int, bool]]): Словарь с ключами: - - "container_id" (int): Идентификатор контейнера (1 или 2). - - "container_x" (int): Новая координата X. - - "container_y" (int): Новая координата Y. - - "isOpen" (bool): Новое состояние контейнера (открыт/закрыт). - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с ключами: - - "success" (bool): Успешность операции. - - "message" (str): Сообщение об успешном обновлении. - - Raises: - HTTPException: Если отсутствуют обязательные поля (status_code=400) или - типы данных неверны. - """ - try: - required_keys = [ - "container_id", "container_x", "container_y", "isOpen" - ] - if not all(key in data for key in required_keys): - raise ValueError( - translations.gettext("Отсутствуют обязательные поля: container_id, container_x, container_y, isOpen") - ) - - container_id = data["container_id"] - container_x = data["container_x"] - container_y = data["container_y"] - is_open = data["isOpen"] - - if (not isinstance(container_id, int) - or not isinstance(container_x, int) - or not isinstance(container_y, int) - or not isinstance(is_open, bool)): - raise ValueError(translations.gettext("Неверный тип данных в запросе")) - - container_manager.update_position(container_id, container_x, container_y, is_open) - return { - "success": True, - "message": translations.gettext("Позиция и состояние контейнера обновлены") - } - except Exception as e: - logger.error(f"Error updating container position: {e}") - raise HTTPException(status_code=400, detail=translations.gettext("Не удалось обновить положение контейнера: {error}").format(error=str(e)))
- - -
-[docs] -@router.get("/get_hostname") -async def get_hostname(translations: Translations = Depends(get_translations())): - """Возвращает имя хоста системы. - - Выполняет запрос к сервису для получения имени хоста. - - Args: - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с ключом "hostname" и значением имени хоста. - - Raises: - HTTPException: Если произошла ошибка при получении имени хоста (status_code=500). - """ - try: - hostname_info = await network_service.get_hostname() - return hostname_info - except Exception as e: - logger.error(f"Error in get_hostname: {e}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось получить имя хоста"))
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/api/v1/settings.html b/SRV/docs/_build/html/_modules/api/v1/settings.html deleted file mode 100644 index a3a6f4e..0000000 --- a/SRV/docs/_build/html/_modules/api/v1/settings.html +++ /dev/null @@ -1,545 +0,0 @@ - - - - - - - - api.v1.settings - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.settings

-import os
-import logging
-import subprocess
-from typing import Optional
-from fastapi import APIRouter, HTTPException, Depends, Response, Request, Body
-from starlette.responses import FileResponse
-from services.settings_service import SettingsService
-from utils.i18n import get_translations
-from babel.support import Translations
-from models.subnet import SubnetScanRequest  # Предполагается, что модель определена
-
-logging.basicConfig(level=logging.DEBUG)
-logger = logging.getLogger(__name__)
-
-router = APIRouter()
-settings_service = SettingsService()
-
-
-[docs] -@router.post("/clear_subnet") -def clear_subnet(subnet: Optional[str] = None, translations: Translations = Depends(get_translations())): - """Очищает данные узлов подсети, сохранённые в devices.json. - - Удаляет все записи об узлах подсети, оставляя файл пустым. - - Args: - subnet (Optional[str]): Подсеть в формате CIDR (например, "10.1.1.0/24"). - Если None, очищает все подсети. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешной очистке. - - Raises: - HTTPException: Если произошла ошибка очистки (status_code=500). - """ - try: - success = settings_service.clear_subnet(subnet) - if success: - if subnet: - return {"message": translations.gettext("Данные узлов подсети {subnet} успешно очищены").format(subnet=subnet)} - else: - return {"message": translations.gettext("Данные всех подсетей успешно очищены")} - else: - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось очистить данные узлов подсети")) - except Exception as e: - logger.error(f"Error clearing subnet data: {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка очистки: {error}").format(error=str(e)))
- - -
-[docs] -@router.post("/clear_wifi") -def clear_wifi(translations: Translations = Depends(get_translations())): - """Очищает данные точек доступа Wi-Fi, сохранённые в wifi.json. - - Удаляет все записи о точках доступа, оставляя файл пустым. - - Args: - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешной очистке. - - Raises: - HTTPException: Если произошла ошибка очистки (status_code=500). - """ - try: - success = settings_service.clear_wifi() - if success: - return {"message": translations.gettext("Данные точек доступа Wi-Fi успешно очищены")} - else: - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось очистить данные точек доступа Wi-Fi")) - except Exception as e: - logger.error(f"Error clearing wifi data: {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка очистки: {error}").format(error=str(e)))
- - -
-[docs] -@router.post("/clear_all_data") -def clear_all_data(translations: Translations = Depends(get_translations())): - """Очищает данные узлов подсети и точек доступа Wi-Fi в обоих файлах. - - Удаляет все записи из devices.json и wifi.json. - - Args: - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешной очистке. - - Raises: - HTTPException: Если произошла ошибка очистки (status_code=500). - """ - try: - success = settings_service.clear_all_data() - if success: - return {"message": translations.gettext("Все сетевые данные успешно очищены")} - else: - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось очистить все сетевые данные")) - except Exception as e: - logger.error(f"Error clearing all data: {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка очистки: {error}").format(error=str(e)))
- - -WIFI_PATH = "storage/wifi/wifi.json" - -
-[docs] -@router.post("/export_devices", response_class=FileResponse) -async def export_devices(request: SubnetScanRequest = Body(...), translations: Translations = Depends(get_translations())): - """ - Экспортирует файл с данными устройств в формате JSON для указанной подсети. - - Args: - request (SubnetScanRequest): Объект с полем subnet в формате CIDR. - translations: Объект переводов для текущего языка. - - Returns: - FileResponse: Файл <subnet>.json для скачивания. - - Raises: - HTTPException: Если файл не найден (status_code=404). - """ - subnet = request.subnet - file_path = f"storage/subnets/{subnet.replace('/', '_')}.json" - if not os.path.exists(file_path): - logger.warning(f"Export file not found: {file_path}") - raise HTTPException(status_code=404, detail=translations.gettext("Файл для подсети {subnet} не найден").format(subnet=subnet)) - logger.info(f"Exporting file: {file_path}") - return FileResponse( - path=file_path, - filename=f"{subnet.replace('/', '_')}.json", - media_type="application/json" - )
- - -
-[docs] -@router.get("/export_wifi", response_class=FileResponse) -async def export_wifi(translations: Translations = Depends(get_translations())): - """ - Экспортирует файл с данными устройств в формате JSON. - - Args: - translations: Объект переводов для текущего языка. - - Returns: - FileResponse: Файл wifi.json для скачивания. - - Raises: - HTTPException: Если файл не найден (status_code=404). - """ - if not os.path.exists(WIFI_PATH): - logger.warning(f"Export file not found: {WIFI_PATH}") - raise HTTPException(status_code=404, detail=translations.gettext("Файл не найден")) - logger.info(f"Exporting file: {WIFI_PATH}") - return FileResponse( - path=WIFI_PATH, - filename="wifi.json", - media_type="application/json" - )
- - -
-[docs] -@router.post("/set_language") -def set_language(locale: str, response: Response, translations: Translations = Depends(get_translations())): - """ - Устанавливает куку locale для смены языка пользователя. - - Args: - locale (str): Используемый язык. - response (Response): Запрос. - translations: Объект переводов текущего языка. - - Returns: - dict: Сообщение об успешной установке языка. - """ - lc_messages_path = os.path.join(os.path.dirname(__file__), '..', '..', 'locales', locale, 'LC_MESSAGES') - if not os.path.isdir(lc_messages_path): - raise HTTPException( - status_code=400, - detail=translations.gettext("Язык '{locale}' не поддерживается.").format(locale=locale) - ) - has_mo_or_po = any(f.endswith('.mo') or f.endswith('.po') for f in os.listdir(lc_messages_path)) - if not has_mo_or_po: - raise HTTPException( - status_code=400, - detail=translations.gettext("Язык '{locale}' не поддерживается (нет файлов переводов).").format(locale=locale) - ) - response.set_cookie(key="locale", value=locale, path="/", httponly=True) - return {"message": translations.gettext("Язык успешно установлен: {locale}").format(locale=locale)}
- - -
-[docs] -@router.get("/get_system_language") -async def get_system_language(request: Request, translations: Translations = Depends(get_translations())): - """Выводит текущий язык, установленный в системе на основе locale. - - Выполняет команду 'locale' в системе и извлекает параметры LANG - - Args: - request (Request): Объект запроса для доступа к параметрам. - translations: Объект переводов текущего языка. - - Returns: - dict: Словарь с текущим языком системы. - - Raises: - HTTPException: Если не удалось извлечь системный язык (status_code=500). - """ - try: - result = subprocess.run(['locale'], capture_output=True, text=True, check=True) - output = result.stdout - lang = next((line.split('=')[1].strip() for line in output.splitlines() if line.startswith('LANG=')), None) - if lang: - return {"language": lang} - else: - logger.warning(f"No locale found: {output}") - return {"language": 'unknown'} - except subprocess.CalledProcessError as e: - logger.error(f"Error executing locale command: {e}") - raise HTTPException(status_code=500, detail=translations.gettext("Не удалось определить язык в системе")) - except Exception as e: - logger.error(f"Unexpected error getting system language: {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка при определении языка в системе {error}").format(error=str(e)))
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/api/v1/subnet.html b/SRV/docs/_build/html/_modules/api/v1/subnet.html deleted file mode 100644 index a7ae76d..0000000 --- a/SRV/docs/_build/html/_modules/api/v1/subnet.html +++ /dev/null @@ -1,700 +0,0 @@ - - - - - - - - api.v1.subnet - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.subnet

-from fastapi import APIRouter, HTTPException, Body, Depends
-from models.subnet import SubnetScanResult, SubnetScanRequest
-from models.wifi import WifiScanResult
-from models.request import NoteRequest, WifiConnectRequest, WifiDisconnectRequest
-from services.subnet_service import SubnetService, get_subnet_service
-from services.wifi_service import WifiService
-from services.connect_service import WifiConnectionService
-from utils.i18n import get_translations, _
-from babel.support import Translations
-import logging
-
-router = APIRouter()
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-
-[docs] -@router.post("/devices", response_model=SubnetScanResult) -def scan_subnet(request: SubnetScanRequest = Body(...), subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(get_translations())): - """Сканирует локальную подсеть и возвращает данные об устройствах. - - Выполняет сканирование указанной подсети для обнаружения активных устройств. - - Args: - request (SubnetScanRequest): Объект с полем subnet. - subnet_service: Сервис сканирования подсети. - translations: Объект переводов для текущего языка. - - Returns: - SubnetScanResult: Объект с результатами сканирования (устройства и их данные). - - Raises: - HTTPException: Если произошла ошибка сканирования (status_code=500). - """ - try: - # Если subnet пустая строка, определяем автоматически - subnet = request.subnet.strip() if request.subnet else None - logger.info(f"Requested subnet scan for: {subnet or 'auto-detected'}") - result = subnet_service.scan_subnet(subnet) - if not result.devices and result.error: - logger.warning(f"No devices found in subnet {subnet or 'auto-detected'}") - return result - except Exception as e: - logger.error(f"Error in scan_subnet: {str(e)}") - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка сканирования подсети: {error}").format(error=str(e)))
- - -
-[docs] -@router.get("/wifi", response_model=WifiScanResult) -def scan_wifi(timeout: int = 30, translations: Translations = Depends(get_translations())): - """Сканирует Wi-Fi точки доступа и возвращает данные о них. - - Выполняет сканирование доступных Wi-Fi сетей с указанным таймаутом. - - Args: - timeout (int, optional): Таймаут сканирования в секундах. По умолчанию 30. - translations: Объект переводов для текущего языка. - - Returns: - WifiScanResult: Объект с результатами сканирования (список Wi-Fi сетей). - - Raises: - HTTPException: Если произошла ошибка сканирования Wi-Fi (status_code=500). - """ - try: - wifi_service = WifiService() - result = wifi_service.scan_wifi(timeout=timeout) - return result - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка сканирования Wi-Fi: {error}").format(error=str(e)))
- - -
-[docs] -@router.post("/devices/{mac}/note") -def add_note(mac: str, request: NoteRequest, subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(get_translations())): - """Добавляет заметку для устройства по MAC-адресу. - - Привязывает заметку к устройству, идентифицируемому по MAC-адресу. - - Args: - mac (str): MAC-адрес устройства. - request (NoteRequest): Объект с полем "note" для текста заметки. - subnet_service: Сервис сканирования подсети. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном добавлении заметки. - - Raises: - HTTPException: Если устройство не найдено (status_code=404), заметка уже - существует (status_code=400), или произошла внутренняя ошибка (status_code=500). - """ - try: - success, result = subnet_service.add_note(mac, request.note, translations) - if not success: - if result[0] == "not_found": - raise HTTPException(status_code=404, detail=translations.gettext("Устройство с MAC {mac} не найдено").format(mac=mac)) - elif result[0] == "note_exists": - raise HTTPException(status_code=400, detail=translations.gettext("Заметка для устройства с MAC {mac} уже существует").format(mac=mac)) - else: - raise HTTPException(status_code=500, detail=translations.gettext("Внутренняя ошибка сервера: {error}").format(error=result[1]["error"])) - return {"message": translations.gettext("Заметка '{note}' добавлена для устройства {mac}").format(note=request.note, mac=mac)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка добавления заметки: {error}").format(error=str(e)))
- - -
-[docs] -@router.put("/devices/{mac}/note") -def update_note(mac: str, request: NoteRequest, subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(get_translations())): - """Обновляет заметку для устройства по MAC-адресу. - - Изменяет существующую заметку, привязанную к устройству. - - Args: - mac (str): MAC-адрес устройства. - request (NoteRequest): Объект с полем "note" для нового текста заметки. - subnet_service: Сервис сканирования подсети. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном обновлении заметки. - - Raises: - HTTPException: Если устройство не найдено (status_code=404), заметка не - существует (status_code=400), или произошла внутренняя ошибка (status_code=500). - """ - try: - success, result = subnet_service.update_note(mac, request.note, translations) - if not success: - if result[0] == "not_found": - raise HTTPException(status_code=404, detail=translations.gettext("Устройство с MAC {mac} не найдено").format(mac=mac)) - elif result[0] == "note_not_exists": - raise HTTPException(status_code=400, detail=translations.gettext("Заметка для устройства с MAC {mac} не существует").format(mac=mac)) - else: - raise HTTPException(status_code=500, detail=translations.gettext("Внутренняя ошибка сервера: {error}").format(error=result[1]["error"])) - return {"message": translations.gettext("Заметка '{note}' обновлена для устройства {mac}").format(note=request.note, mac=mac)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка обновления заметки: {error}").format(error=str(e)))
- - -
-[docs] -@router.delete("/devices/{mac}/note") -def delete_note(mac: str, subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(get_translations())): - """Удаляет заметку для устройства по MAC-адресу. - - Удаляет привязанную заметку для указанного устройства. - - Args: - mac (str): MAC-адрес устройства. - subnet_service: Сервис сканирования подсети. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном удалении заметки. - - Raises: - HTTPException: Если устройство не найдено (status_code=404), заметка не - существует (status_code=400), или произошла внутренняя ошибка (status_code=500). - """ - try: - success, result = subnet_service.delete_note(mac, translations) - if not success: - if result[0] == "not_found": - raise HTTPException(status_code=404, detail=translations.gettext("Устройство с MAC {mac} не найдено").format(mac=mac)) - elif result[0] == "note_not_exists": - raise HTTPException(status_code=400, detail=translations.gettext("Заметка для устройства с MAC {mac} не существует").format(mac=mac)) - else: - raise HTTPException(status_code=500, detail=translations.gettext("Внутренняя ошибка сервера: {error}").format(error=result[1]["error"])) - return {"message": translations.gettext("Заметка удалена для устройства {mac}").format(mac=mac)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка удаления заметки: {error}").format(error=str(e)))
- - -
-[docs] -@router.post("/wifi/{ssid}/note") -def add_wifi_note(ssid: str, request: NoteRequest, translations: Translations = Depends(get_translations())): - """Добавляет заметку для сети Wi-Fi по SSID. - - Привязывает заметку к Wi-Fi сети, идентифицируемой по SSID. - - Args: - ssid (str): Идентификатор Wi-Fi сети. - request (NoteRequest): Объект с полем "note" для текста заметки. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном добавлении заметки. - - Raises: - HTTPException: Если сеть не найдена (status_code=404), заметка уже - существует (status_code=400), или произошла внутренняя ошибка (status_code=500). - """ - try: - wifi_service = WifiService() - success, result = wifi_service.add_note(ssid, request.note) - if not success: - if result[0] == "not_found": - raise HTTPException(status_code=404, detail=translations.gettext("Сеть с SSID {ssid} не найдена").format(ssid=ssid)) - elif result[0] == "note_exists": - raise HTTPException(status_code=400, detail=translations.gettext("Заметка для сети с SSID {ssid} уже существует").format(ssid=ssid)) - else: - raise HTTPException(status_code=500, detail=translations.gettext("Внутренняя ошибка сервера: {error}").format(error=result[1]["error"])) - return {"message": translations.gettext("Заметка '{note}' добавлена для сети с SSID {ssid}").format(note=request.note, ssid=ssid)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка добавления заметки: {error}").format(error=str(e)))
- - -
-[docs] -@router.put("/wifi/{ssid}/note") -def update_wifi_note(ssid: str, request: NoteRequest, translations: Translations = Depends(get_translations())): - """Обновляет заметку для сети Wi-Fi по SSID. - - Изменяет существующую заметку, привязанную к Wi-Fi сети. - - Args: - ssid (str): Идентификатор Wi-Fi сети. - request (NoteRequest): Объект с полем "note" для нового текста заметки. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном обновлении заметки. - - Raises: - HTTPException: Если сеть не найдена (status_code=404), заметка не - существует (status_code=400), или произошла внутренняя ошибка (status_code=500). - """ - try: - wifi_service = WifiService() - success, result = wifi_service.update_note(ssid, request.note) - if not success: - if result[0] == "not_found": - raise HTTPException(status_code=404, detail=translations.gettext("Сеть с SSID {ssid} не найдена").format(ssid=ssid)) - elif result[0] == "note_not_exists": - raise HTTPException(status_code=400, detail=translations.gettext("Заметка для сети с SSID {ssid} не существует").format(ssid=ssid)) - else: - raise HTTPException(status_code=500, detail=translations.gettext("Внутренняя ошибка сервера: {error}").format(error=result[1]["error"])) - return {"message": translations.gettext("Заметка '{note}' обновлена для сети с SSID {ssid}").format(note=request.note, ssid=ssid)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка обновления заметки: {error}").format(error=str(e)))
- - -
-[docs] -@router.delete("/wifi/{ssid}/note") -def delete_wifi_note(ssid: str, translations: Translations = Depends(get_translations())): - """Удаляет заметку для сети Wi-Fi по SSID. - - Удаляет привязанную заметку для указанной Wi-Fi сети. - - Args: - ssid (str): Идентификатор Wi-Fi сети. - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном удалении заметки. - - Raises: - HTTPException: Если сеть не найдена (status_code=404), заметка не - существует (status_code=400), или произошла внутренняя ошибка (status_code=500). - """ - try: - wifi_service = WifiService() - success, result = wifi_service.delete_note(ssid) - if not success: - if result[0] == "not_found": - raise HTTPException(status_code=404, detail=translations.gettext("Сеть с SSID {ssid} не найдена").format(ssid=ssid)) - elif result[0] == "note_not_exists": - raise HTTPException(status_code=400, detail=translations.gettext("Заметка для сети с SSID {ssid} не существует").format(ssid=ssid)) - else: - raise HTTPException(status_code=500, detail=translations.gettext("Внутренняя ошибка сервера: {error}").format(error=result[1]["error"])) - return {"message": translations.gettext("Заметка удалена для сети с SSID {ssid}").format(ssid=ssid)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка удаления заметки: {error}").format(error=str(e)))
- - -
-[docs] -@router.post("/wifi/connect") -def connect_to_wifi(request: WifiConnectRequest, translations: Translations = Depends(get_translations())): - """Подключается к Wi-Fi сети по SSID и паролю. - - Выполняет подключение к указанной Wi-Fi сети с использованием предоставленных - учетных данных. - - Args: - request (WifiConnectRequest): Объект с полями "ssid" и "password". - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном подключении. - - Raises: - HTTPException: Если подключение не удалось (status_code=400). - """ - try: - wifi_service = WifiConnectionService(translations) - success, message = wifi_service.connect(request.ssid, request.password) - if not success: - raise HTTPException(status_code=400, detail=translations.gettext(message)) - return {"message": translations.gettext("Успешно подключено к {ssid}").format(ssid=request.ssid)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка подключения к Wi-Fi: {error}").format(error=str(e)))
- - -
-[docs] -@router.post("/wifi/disconnect") -def disconnect_from_wifi(request: WifiDisconnectRequest, translations: Translations = Depends(get_translations())): - """Отключается от Wi-Fi сети по указанному SSID. - - Выполняет отключение от указанной Wi-Fi сети. - - Args: - request (WifiDisconnectRequest): Объект с полем "ssid". - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с сообщением об успешном отключении. - - Raises: - HTTPException: Если отключение не удалось (status_code=400). - """ - try: - wifi_service = WifiConnectionService(translations) - success, message = wifi_service.disconnect(request.ssid) - if not success: - raise HTTPException(status_code=400, detail=translations.gettext(message)) - return {"message": translations.gettext(message or "Успешно отключено от {ssid}").format(ssid=request.ssid)} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка отключения от Wi-Fi: {error}").format(error=str(e)))
- - -
-[docs] -@router.get("/wifi/status") -def get_wifi_status(translations: Translations = Depends(get_translations())): - """Проверяет статус текущего подключения к Wi-Fi. - - Возвращает информацию о текущем состоянии подключения и SSID, если подключение активно. - - Args: - translations: Объект переводов для текущего языка. - - Returns: - dict: Словарь с ключами: - - "status" (str): Состояние ("connected" или другое). - - "ssid" (str, optional): SSID текущей сети, если подключено. - - Raises: - HTTPException: Если проверка статуса не удалась (status_code=400). - """ - try: - wifi_service = WifiConnectionService(translations) - success, message = wifi_service.get_status() - if not success: - raise HTTPException(status_code=400, detail=translations.gettext(message)) - return {"status": translations.gettext("connected"), "ssid": message} - except HTTPException as e: - raise e - except Exception as e: - raise HTTPException(status_code=500, detail=translations.gettext("Ошибка проверки статуса Wi-Fi: {error}").format(error=str(e)))
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/api/v1/ufw.html b/SRV/docs/_build/html/_modules/api/v1/ufw.html deleted file mode 100644 index edb6aa6..0000000 --- a/SRV/docs/_build/html/_modules/api/v1/ufw.html +++ /dev/null @@ -1,555 +0,0 @@ - - - - - - - - api.v1.ufw - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.ufw

-from fastapi import APIRouter, HTTPException
-from typing import List
-from pydantic import BaseModel, Field
-
-from models.ufw import UFWRulesResponse, UFWStatus, UFWRule
-from services.ufw_service import UFWService
-
-router = APIRouter()
-
-
-
-[docs] -class RuleNumbers(BaseModel): - """Модель запроса на удаление UFW правил. - - Атрибуты: - - - ``numbers`` (List[int]): Список номеров правил для удаления. - """ - numbers: List[int] = Field( - ..., description="Список номеров правил для удаления")
- - - -
-[docs] -@router.get("/rules", response_model=UFWRulesResponse) -async def get_ufw_rules(): - """Возвращает все правила UFW. - - Осуществляет обращение к сервису `UFWService` для чтения текущего списка - правил брандмауэра и возвращает результат в сериализованном виде для клиента. - - Returns: - UFWRulesResponse: Структура с коллекцией правил и сопутствующей - информацией о состоянии. - - Raises: - HTTPException: В случае ошибок взаимодействия с UFW (status_code=500). - """ - ufw_service = UFWService() - try: - return ufw_service.get_ufw_rules() - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- - - -
-[docs] -@router.get("/status", response_model=UFWStatus) -async def get_ufw_status(): - """Возвращает текущий статус UFW. - - Returns: - UFWStatus: Объект со сведениями о включенности UFW и деталями статуса. - - Raises: - HTTPException: Если не удалось получить статус (status_code=500). - """ - ufw_service = UFWService() - try: - return ufw_service.get_ufw_status() - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- - - -
-[docs] -@router.post("/enable") -async def enable_ufw(): - """Включает UFW. - - Returns: - dict: Словарь с ключами `status` и `message` при успешном выполнении. - - Raises: - HTTPException: Если включение завершилось неуспешно (status_code=500). - """ - ufw_service = UFWService() - try: - success = ufw_service.enable_ufw() - if success: - return {"status": "success", "message": "UFW успешно включен"} - else: - raise HTTPException(status_code=500, - detail="Не удалось включить UFW") - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- - - -
-[docs] -@router.post("/disable") -async def disable_ufw(): - """Выключает UFW. - - Returns: - dict: Словарь с ключами `status` и `message` при успешном выполнении. - - Raises: - HTTPException: Если выключение завершилось неуспешно (status_code=500). - """ - ufw_service = UFWService() - try: - success = ufw_service.disable_ufw() - if success: - return {"status": "success", "message": "UFW успешно выключен"} - else: - raise HTTPException(status_code=500, - detail="Не удалось выключить UFW") - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- - - -
-[docs] -@router.post("/rules/in") -async def add_ufw_in_rules(rules: List[UFWRule]): - """Добавляет входящие (in) правила UFW. - - Args: - rules (List[UFWRule]): Список правил, определяющих направления, - порты/диапазоны/протоколы и действия (allow/deny/reject). - - Returns: - dict: Итог выполнения с количеством успешно добавленных правил и деталями - по каждому правилу. - - Raises: - HTTPException: Если UFW отключен (status_code=400) или при внутренних - ошибках (status_code=500). - """ - ufw_service = UFWService() - try: - # Проверяем статус UFW - status = ufw_service.get_ufw_status() - if not status.enabled: - raise HTTPException( - status_code=400, - detail="UFW отключен. Включите UFW перед добавлением правил.", - ) - - result = ufw_service.add_rules(rules) - if result["success"]: - successful_rules = len( - [r for r in result["results"] if r["success"]]) - total_rules = len(result["results"]) - return { - "status": "success", - "message": - f"Добавлено {successful_rules} из {total_rules} правил", - "details": result, - } - else: - raise HTTPException( - status_code=500, - detail=result.get("error", "Не удалось добавить правила"), - ) - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- - - -
-[docs] -@router.post("/rules/out") -async def add_ufw_out_rules(rules: List[UFWRule]): - """Добавляет исходящие (out) правила UFW. - - Args: - rules (List[UFWRule]): Список правил исходящего трафика для добавления. - - Returns: - dict: Объект статуса с сообщением об успешном добавлении. - - Raises: - HTTPException: Если UFW отключен (status_code=400) или при внутренних - ошибках (status_code=500). - """ - ufw_service = UFWService() - try: - # Проверяем статус UFW - status = ufw_service.get_ufw_status() - if not status.enabled: - raise HTTPException( - status_code=400, - detail="UFW отключен. Включите UFW перед добавлением правил.", - ) - - success = ufw_service.add_ufw_out_rules(rules) - if success: - return { - "status": "success", - "message": "Исходящие правила UFW успешно добавлены", - } - else: - raise HTTPException( - status_code=500, - detail="Не удалось добавить исходящие правила UFW") - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- - - -
-[docs] -@router.delete("/rules") -async def delete_ufw_rules(rule_numbers: RuleNumbers): - """Удаляет правила UFW по их номерам. - - Args: - rule_numbers (RuleNumbers): Номера правил, подлежащих удалению (как в - выводе `ufw status numbered`). - - Returns: - dict: Информация об общем количестве удаляемых правил, числе успешных и - возможной ошибке. - - Raises: - HTTPException: При ошибках удаления (status_code=500). - """ - ufw_service = UFWService() - try: - result = ufw_service.delete_rules(rule_numbers.numbers) - if result["success"]: - return { - "status": "success", - "message": - f"Удалено {result['successful']} из {result['total']} правил", - "details": result, - } - else: - raise HTTPException(status_code=500, detail=result["error"]) - except Exception as e: - raise HTTPException(status_code=500, detail=f"Error: {str(e)}")
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/api/v1/websocket.html b/SRV/docs/_build/html/_modules/api/v1/websocket.html deleted file mode 100644 index de6a1be..0000000 --- a/SRV/docs/_build/html/_modules/api/v1/websocket.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - - - - api.v1.websocket - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for api.v1.websocket

-import asyncio
-import logging
-from typing import Set
-
-from fastapi import APIRouter, WebSocket, WebSocketDisconnect, Depends
-from starlette.websockets import WebSocketState
-from utils.i18n import get_translations, _
-from babel.support import Translations
-
-from .network import update_container_position, get_network_data
-
-router = APIRouter()
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-
-[docs] -class WebSocketManager: - """Класс для управления подключениями к WebSocket-серверу. - - Обрабатывает подключение, отключение и трансляцию сообщений для клиентов, - подключённых через WebSocket. - """ - - def __init__(self): - """Инициализирует менеджер подключений к WebSocket-серверу. - - Создаёт пустое множество для хранения активных соединений. - """ - self.active_connections: Set[WebSocket] = set() - -
-[docs] - async def connect(self, websocket: WebSocket): - """Подключает клиента к WebSocket-серверу. - - Принимает подключение и добавляет WebSocket в список активных соединений. - - Args: - websocket (WebSocket): Объект WebSocket для подключения. - - Raises: - Exception: Если произошла ошибка при принятии подключения. - """ - await websocket.accept() - self.active_connections.add(websocket)
- - -
-[docs] - def disconnect(self, websocket: WebSocket): - """Отключает клиента от WebSocket-серверу. - - Удаляет WebSocket из списка активных соединений. - - Args: - websocket (WebSocket): Объект WebSocket для отключения. - """ - self.active_connections.remove(websocket)
- - -
-[docs] - async def broadcast(self, message: dict): - """Транслирует сообщения всем подключённым клиентам. - - Отправляет JSON-данные всем активным соединениям, обрабатывая - отключения клиентов. - - Args: - message (dict): Сообщение для трансляции в формате JSON. - - Raises: - WebSocketDisconnect: Если клиент неожиданно отключился. - Exception: Если произошла другая ошибка при отправке. - """ - for connection in list(self.active_connections): - try: - if connection.client_state == WebSocketState.CONNECTED: - await connection.send_json(message) - except WebSocketDisconnect: - self.disconnect(connection) - except Exception as e: - logger.error(f"Broadcast error: {e}") - self.disconnect(connection)
-
- - -manager = WebSocketManager() - -
-[docs] -@router.websocket("/api/v1") -async def websocket_endpoint(websocket: WebSocket, translations: Translations = Depends(get_translations())): - """Обработчик WebSocket-соединения. - - Управляет соединением клиента, принимает данные для обновления позиций - контейнеров и транслирует сетевые данные. - - Args: - websocket (WebSocket): Объект WebSocket для обработки соединения. - translations: Объект переводов для текущего языка. - - Raises: - WebSocketDisconnect: Если клиент отключился. - Exception: Если произошла ошибка при обработке данных. - """ - await manager.connect(websocket) - try: - while True: - data = await websocket.receive_json() - logger.info(f"Received data: {data}") - - if all(key in data for key in ["container_id", "container_x", "container_y"]): - await update_container_position(data) - - network_data = await get_network_data() - logger.info(f"Current network data: {network_data}") - - await manager.broadcast(network_data) - await asyncio.sleep(2) - except WebSocketDisconnect: - logger.info("Client disconnected") - except Exception as e: - logger.error(f"Error in websocket_endpoint: {e}") - finally: - manager.disconnect(websocket) - if websocket.client_state != WebSocketState.DISCONNECTED: - await websocket.close()
- - -
-[docs] -@router.on_event("startup") -async def startup_event(): - """Запуск таска для трансляции сетевых данных при старте приложения. - - Создаёт асинхронную задачу для периодической трансляции данных. - - Raises: - Exception: Если произошла ошибка при запуске таска. - """ - asyncio.create_task(broadcast_data())
- - -
-[docs] -async def broadcast_data(translations: Translations = Depends(get_translations())): - """Таск для периодической трансляции сетевых данных. - - Выполняет сканирование сети и отправляет данные всем подключённым клиентам - с интервалом в 2 секунды. - - Args: - translations: Объект переводов для текущего языка. - - Raises: - Exception: Если произошла ошибка при получении данных или трансляции. - """ - while True: - try: - network_data = await get_network_data() - if "activation" not in network_data: - logger.error(translations.gettext("Ошибка: Ключ 'activation' отсутствует в полученных данных сети")) - await asyncio.sleep(2) - continue - - await manager.broadcast(network_data) - except Exception as e: - logger.error(f"Error in broadcast_data: {e}") - await asyncio.sleep(2)
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/config/cors.html b/SRV/docs/_build/html/_modules/config/cors.html deleted file mode 100644 index 5288c7d..0000000 --- a/SRV/docs/_build/html/_modules/config/cors.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - - - config.cors - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for config.cors

-"""
-Конфигурация CORS для FastAPI-приложения GONETS.
-
-Модуль инкапсулирует добавление middleware `CORSMiddleware` со списком
-разрешённых источников (origins), характерных для локальной разработки и
-типовых портов фронтенда (например, Vite/React на 5173/5174, dev-серверы).
-
-Использование:
-    cors_config = CORSMiddlewareConfig(app)
-    cors_config.add_cors_middleware()
-
-Поведение:
- - Разрешены все методы (`allow_methods=["*"]`) и заголовки (`allow_headers=["*"]`).
- - Разрешены креденшлы (`allow_credentials=True`) для работы с куками (локаль и др.).
- - При необходимости список `origins` можно расширить или параметризовать
-   на основе конфигурационного файла окружения.
-"""
-from fastapi import FastAPI
-from starlette.middleware.cors import CORSMiddleware
-
-
-
-[docs] -class CORSMiddlewareConfig: - """ - Класс для настройки CORS политики в FastAPI - """ - - def __init__(self, app: FastAPI) -> None: - """Инициализируем приложение FastAPI и список допустимых CORS-оригинов""" - self.app = app - self.origins = [ - "http://localhost.tiangolo.com", - "https://localhost.tiangolo.com", - "http://localhost", - "http://localhost:8080", - "http://localhost:5174", - "http://localhost:5173", - ] - -
-[docs] - def add_cors_middleware(self) -> None: - """Добавляем CORS в приложение FastAPI""" - self.app.add_middleware( - CORSMiddleware, - allow_origins=self.origins, - allow_credentials=True, - allow_methods=["*"], - allow_headers=["*"], - )
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/config/init_config.html b/SRV/docs/_build/html/_modules/config/init_config.html deleted file mode 100644 index 707f1dd..0000000 --- a/SRV/docs/_build/html/_modules/config/init_config.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - - - - config.init_config - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for config.init_config

-import configparser
-import os
-import secrets
-import logging
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-
-
-[docs] -def init_config(): - """ - Инициализация конфигурации приложения (JWT SECRET_KEY). - - Назначение: - - Создаёт файл `/etc/gonets/config.ini` с секцией `[JWT]` и случайным - `secret_key`, если он отсутствует. Устанавливает права `0o600`. - - Замечания: - - Функция предназначена для однократного запуска (в инсталляторе/скрипте - подготовки окружения) и безопасно пропускает работу, если файл уже существует. - """ - config_path = "/etc/gonets/config.ini" - config_dir = os.path.dirname(config_path) - - if os.path.exists(config_path): - logger.info( - f"Конфигурационный файл {config_path} уже существует, пропускаем инициализацию" - ) - return - - try: - secret_key = secrets.token_urlsafe(32) - os.makedirs(config_dir, exist_ok=True) - config = configparser.ConfigParser() - config["JWT"] = {"secret_key": secret_key} - with open(config_path, "w") as config_file: - config.write(config_file) - os.chmod(config_path, 0o600) - logger.info(f"Создан конфигурационный файл {config_path}") - except Exception as e: - logger.error( - f"Ошибка при создании конфигурационного файла: {type(e).__name__} - {str(e)}" - ) - raise
- - -# Нативный запуск для тестов -if __name__ == "__main__": - init_config() -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/config/ports.html b/SRV/docs/_build/html/_modules/config/ports.html deleted file mode 100644 index 0bb3985..0000000 --- a/SRV/docs/_build/html/_modules/config/ports.html +++ /dev/null @@ -1,432 +0,0 @@ - - - - - - - - config.ports - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for config.ports

-from typing import Dict, List
-
-
-
-[docs] -class PortConfig: - """Конфигурация известных портов для сетевого анализа. - - Назначение: - Предоставляет сопоставление распространённых портов с человекочитаемыми - названиями сервисов для отображения в UI и логах. Поддерживает расширение - пользовательским словарём. - """ - - _DEFAULT_PORTS: Dict[int, str] = { - 20: "FTP (Data)", - 21: "FTP (Control)", - 22: "SSH", - 23: "Telnet", - 25: "SMTP", - 53: "DNS", - 67: "DHCP (Server)", - 68: "DHCP (Client)", - 69: "TFTP", - 80: "HTTP", - 110: "POP3", - 123: "NTP (Network Time Protocol)", - 137: "NetBIOS Name Service", - 138: "NetBIOS Datagram Service", - 139: "NetBIOS Session Service", - 143: "IMAP", - 161: "SNMP", - 162: "SNMP Trap", - 179: "BGP (Border Gateway Protocol)", - 443: "HTTPS", - 445: "SMB (Microsoft-DS)", - 465: "SMTPS", - 514: "Syslog (UDP)", - 515: "LPD (Printer)", - 587: "SMTP Submission", - 631: "IPP (Printing)", - 993: "IMAPS", - 995: "POP3S", - # --- Базы данных --- - 1433: "Microsoft SQL Server", - 1521: "Oracle DB", - 3306: "MySQL/MariaDB", - 5432: "PostgreSQL", - 6379: "Redis", - 27017: "MongoDB", - # --- VPN и удалённый доступ --- - 1723: "PPTP VPN", - 1701: "L2TP", - 500: "IPSec", - 4500: "IPSec NAT-T", - 1194: "OpenVPN", - 3389: "RDP (Remote Desktop Protocol)", - 5900: "VNC", - # --- Прокси / Веб --- - 1080: "SOCKS Proxy", - 8000: "HTTP-Alt", - 8080: "HTTP Proxy", - 8443: "HTTPS-Alt", - # --- DevOps / Monitoring / Tools --- - 9000: "SonarQube / PHP-FPM", - 9100: "Prometheus Node Exporter", - 9200: "Elasticsearch HTTP", - 9300: "Elasticsearch Cluster", - 11211: "Memcached", - # --- Прочее --- - 6667: "IRC", - 4000: "ICQ / Custom apps", - 25565: "Minecraft Server", - 53: "DNS (UDP & TCP)", - } - - def __init__(self, custom_ports: Dict[int, str] = None): - """ - Инициализирует конфигурацию портов. - - Args: - custom_ports: Пользовательский словарь портов для добавления или переопределения. - """ - self._ports = self._DEFAULT_PORTS.copy() - if custom_ports: - self._ports.update(custom_ports) - -
-[docs] - def get_port_name(self, port: int) -> str: - """ - Возвращает название сервиса для указанного порта. - - Args: - port: Номер порта. - - Returns: - Название сервиса или строка вида 'Port-<port>'. - """ - return self._ports.get(port, f"Port-{port}")
- - -
-[docs] - def get_ports(self) -> List[int]: - """ - Возвращает список всех номеров портов. - - Returns: - Список номеров портов. - """ - return list(self._ports.keys())
-
- - - -port_config = PortConfig() -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/core/cli_executor.html b/SRV/docs/_build/html/_modules/core/cli_executor.html deleted file mode 100644 index 90456d7..0000000 --- a/SRV/docs/_build/html/_modules/core/cli_executor.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - core.cli_executor - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for core.cli_executor

-import subprocess
-from typing import Tuple
-
-
-
-[docs] -class CLIExecutor: - """Утилита для безопасного выполнения CLI-команд. - - Назначение: - Инкапсулирует вызов `subprocess.run` и приводит результат к удобному - кортежу (код возврата, stdout) без генерации исключений при ошибках. - """ - -
-[docs] - @staticmethod - def run(command: list) -> Tuple[int, str]: - """ - Выполняет команду в системе и возвращает код и вывод. - - Args: - command (list): Список аргументов команды для выполнения. - - Returns: - tuple: Код возврата и вывод команды. - """ - result = subprocess.run( - command, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, - check=False, # Не вызываем исключение при ошибке - ) - return result.returncode, result.stdout.decode("utf-8")
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/index.html b/SRV/docs/_build/html/_modules/index.html deleted file mode 100644 index a68c954..0000000 --- a/SRV/docs/_build/html/_modules/index.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - Overview: module code - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- - -
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/models/auth.html b/SRV/docs/_build/html/_modules/models/auth.html deleted file mode 100644 index afe07e1..0000000 --- a/SRV/docs/_build/html/_modules/models/auth.html +++ /dev/null @@ -1,389 +0,0 @@ - - - - - - - - models.auth - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for models.auth

-from pydantic import BaseModel
-from typing import Optional
-
-
-
-[docs] -class UserCreate(BaseModel): - """Модель созданного пользователя. - - Атрибуты: - - - ``username`` (str): Имя пользователя. - - ``password`` (str): Пароль пользователя. - - ``is_admin`` (bool): Флаг административного доступа. - """ - - username: str - password: str - is_admin: bool = False
- - - -
-[docs] -class UserLogin(BaseModel): - """Модель авторизации пользователя. - - Атрибуты: - - - ``username`` (str): Имя пользователя. - - ``password`` (str): Пароль пользователя. - """ - - username: str - password: str
- - - -
-[docs] -class UserResponse(BaseModel): - """Модель, используемая при возврате сведений о пользователе. - - Атрибуты: - - - ``id`` (int): Идентификатор пользователя. - - ``username`` (str): Имя пользователя. - - ``is_admin`` (bool): Флаг административного доступа. - """ - - id: int - username: str - is_admin: bool
- - - -
-[docs] -class Token(BaseModel): - """Модель JWT-токена. - - Атрибуты: - - - ``access_token`` (str): Значение токена (в формате JWT). - - ``token_type`` (str): Тип токена (обычно ``bearer``). - - ``session_id`` (Optional[str]): Идентификатор сессии. - - ``user`` (Optional[UserResponse]): Данные пользователя, если включены в ответ. - """ - - access_token: str - token_type: str - session_id: Optional[str] = None - user: Optional[UserResponse] = None
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/models/network.html b/SRV/docs/_build/html/_modules/models/network.html deleted file mode 100644 index 58d8e9e..0000000 --- a/SRV/docs/_build/html/_modules/models/network.html +++ /dev/null @@ -1,511 +0,0 @@ - - - - - - - - models.network - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for models.network

-from typing import List, Optional, Union
-from pydantic import BaseModel
-
-
-
-[docs] -class IPv4Route(BaseModel): - """Модель маршрута IPv4. - - Атрибуты: - - - ``destination`` (str): IP-адрес назначения. - - ``prefix`` (int): Префикс подсети в формате CIDR. - - ``next_hop`` (str): Адрес следующего узла (маршрутизатор). - - ``metric`` (int): Метрика маршрута. - """ - - destination: str - prefix: int - next_hop: str - metric: int
- - - -
-[docs] -class IPv6Route(BaseModel): - """Модель маршрута IPv6. - - Атрибуты: - - - ``destination`` (str): IP-адрес назначения. - - ``prefix`` (int): Префикс подсети в формате CIDR. - - ``next_hop`` (str): Адрес следующего узла. - - ``metric`` (int): Метрика маршрута. - """ - - destination: str - prefix: int - next_hop: str - metric: int
- - - -
-[docs] -class IndividualIPConfig(BaseModel): - """Модель индивидуальной конфигурации IP-адреса. - - Атрибуты: - - - ``address`` (str): IP-адрес интерфейса. - - ``routes`` (List[Union[IPv4Route, IPv6Route]]): Список маршрутов. - - ``method`` (Optional[str]): Метод назначения IP. - - ``gateway`` (str): Шлюз по умолчанию. - - ``dns`` (List[str]): Список DNS-серверов. - """ - - address: str - routes: List[Union[IPv4Route, IPv6Route]] - method: Optional[str] - gateway: str - dns: List[str]
- - - -
-[docs] -class IPConfig(BaseModel): - """Групповая конфигурация IP-адресов. - - Атрибуты: - - - ``configurations`` (List[IndividualIPConfig]): Индивидуальные IP-конфигурации. - """ - - configurations: List[IndividualIPConfig]
- - - -
-[docs] -class NetworkInterface(BaseModel): - """Модель базового сетевого интерфейса. - - Атрибуты: - - - ``name`` (str): Название интерфейса. - - ``type`` (str): Тип устройства. - - ``mac_address`` (str): MAC-адрес. - - ``device_state`` (str): Текущее состояние. - - ``active_connection`` (str): Название активного соединения. - - ``device_mtu`` (str): MTU устройства. - - ``ipv4`` (IPConfig): IPv4-конфигурация. - - ``ipv6`` (IPConfig): IPv6-конфигурация. - - ``container_x`` (int): Положение по оси X на холсте. - - ``container_y`` (int): Положение по оси Y на холсте. - """ - - name: str - type: str - mac_address: str - device_state: str - active_connection: str - device_mtu: str - ipv4: IPConfig - ipv6: IPConfig - container_x: int = 0 - container_y: int = 0
- - - -
-[docs] -class WiFiDevice(NetworkInterface): - """Расширенная модель Wi-Fi устройства. - - Атрибуты: - - - ``ssid`` (Optional[str]): Название Wi-Fi сети. - - ``bssid`` (Optional[str]): MAC-адрес точки доступа. - - ``bitrate`` (Optional[int]): Скорость соединения. - - ``strength`` (Optional[int]): Уровень сигнала. - - ``frequency`` (Optional[float]): Рабочая частота. - - ``mode`` (Union[str, int]): Режим работы. - """ - - ssid: Optional[str] = None - bssid: Optional[str] = None - bitrate: Optional[int] = None - strength: Optional[int] = None - frequency: Optional[float] = None - mode: Union[str, int] = None
- - - -
-[docs] -class NetworkInterfacesContainer(BaseModel): - """Контейнер для набора сетевых интерфейсов. - - Атрибуты: - - - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Список интерфейсов. - - ``container_x`` (int): Положение по оси X. - - ``container_y`` (int): Положение по оси Y. - """ - - interfaces: List[Union[NetworkInterface, WiFiDevice]] - container_x: int - container_y: int
- - - -
-[docs] -class Activation(BaseModel): - """Модель узла активных интерфейсов. - - Атрибуты: - - - ``id`` (int): Идентификатор ноды. - - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Активные интерфейсы. - - ``container_x`` (int): Координата X на холсте. - - ``container_y`` (int): Координата Y на холсте. - - ``isOpen`` (bool): Флаг отображения узла на холсте. - """ - - id: int - interfaces: List[Union[NetworkInterface, WiFiDevice]] - container_x: int - container_y: int - isOpen: bool = True
- - - -
-[docs] -class Deactivation(BaseModel): - """Модель узла отключённых интерфейсов. - - Атрибуты: - - - ``id`` (int): Идентификатор ноды. - - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Список отключённых интерфейсов. - - ``container_x`` (int): Координата X на холсте. - - ``container_y`` (int): Координата Y на холсте. - - ``isOpen`` (bool): Флаг отображения узла на холсте. - """ - - id: int - interfaces: List[Union[NetworkInterface, WiFiDevice]] - container_x: int - container_y: int - isOpen: bool = True
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/models/request.html b/SRV/docs/_build/html/_modules/models/request.html deleted file mode 100644 index ea70831..0000000 --- a/SRV/docs/_build/html/_modules/models/request.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - models.request - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for models.request

-from pydantic import BaseModel
-
-
-
-[docs] -class NoteRequest(BaseModel): - """Модель запроса на добавление заметки к устройству. - - Атрибуты: - - - ``note`` (str): Текст заметки. - """ - - note: str
- - -
-[docs] -class WifiConnectRequest(BaseModel): - """Модель запроса на подключение к Wi-Fi. - - Атрибуты: - - - ``ssid`` (str): Название точки доступа. - - ``password`` (str): Пароль доступа. - """ - ssid: str - password: str
- - -
-[docs] -class WifiDisconnectRequest(BaseModel): - """Модель запроса на отключение от Wi-Fi. - - Атрибуты: - - - ``ssid`` (str): Название точки доступа. - """ - ssid: str
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/models/subnet.html b/SRV/docs/_build/html/_modules/models/subnet.html deleted file mode 100644 index 751d67c..0000000 --- a/SRV/docs/_build/html/_modules/models/subnet.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - - models.subnet - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for models.subnet

-from pydantic import BaseModel
-from typing import Optional, List
-
-
-[docs] -class Device(BaseModel): - """Модель устройства, обнаруженного в подсети. - - Атрибуты: - - - ``ip`` (str): IP-адрес устройства. - - ``mac`` (Optional[str]): MAC-адрес устройства. - - ``hostname`` (Optional[str]): Имя хоста. - - ``vendor`` (Optional[str]): Производитель оборудования. - - ``open_ports`` (List[str]): Открытые порты. - - ``status`` (str): Состояние устройства (online/offline). - - ``last_seen`` (Optional[str]): Время последнего обнаружения. - - ``note`` (Optional[str]): Пользовательская заметка. - """ - - ip: str - mac: Optional[str] = None - hostname: Optional[str] = None - vendor: Optional[str] = None - open_ports: List[str] = [] - status: str - last_seen: Optional[str] = None - note: Optional[str] = None
- - -
-[docs] -class SubnetScanResult(BaseModel): - """Результат сканирования подсети. - - Атрибуты: - - - ``devices`` (List[Device]): Найденные устройства. - - ``error`` (Optional[str]): Сообщение об ошибке сканирования. - """ - - devices: List[Device] = [] - error: Optional[str] = None
- - -
-[docs] -class SubnetScanRequest(BaseModel): - """Параметры запроса на сканирование подсети. - - Атрибуты: - - - ``subnet`` (Optional[str]): CIDR подсети (например, ``192.168.1.0/24``). - """ - subnet: Optional[str] = None
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/models/ufw.html b/SRV/docs/_build/html/_modules/models/ufw.html deleted file mode 100644 index 6028b30..0000000 --- a/SRV/docs/_build/html/_modules/models/ufw.html +++ /dev/null @@ -1,635 +0,0 @@ - - - - - - - - models.ufw - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for models.ufw

-from typing import List, Optional, Annotated, Union
-from enum import Enum
-from pydantic import BaseModel, Field, validator
-import ipaddress
-
-
-
-[docs] -class Protocol(str, Enum): - """ - Enum для сетевых протоколов UFW. - """ - - TCP = "tcp" - UDP = "udp" - BOTH = "both" - - @property - def protocols(self) -> List[str]: - """Возвращает список протоколов для использования в команде UFW.""" - return ["tcp", "udp"] if self == Protocol.BOTH else [self.value]
- - - -
-[docs] -class Action(str, Enum): - """ - Enum для действий UFW. - - Attributes: - ALLOW: Разрешить трафик - DENY: Запретить трафик без уведомления - REJECT: Запретить трафик с уведомлением отправителю - """ - - ALLOW = "allow" - DENY = "deny" - REJECT = "reject"
- - - -
-[docs] -class Direction(str, Enum): - """ - Enum для направления трафика UFW. - - Attributes: - IN: Входящий трафик - OUT: Исходящий трафик - """ - - IN = "in" - OUT = "out"
- - - -
-[docs] -class UFWRule(BaseModel): - """Модель правила UFW""" - - action: Action - direction: Direction - from_ip: str - to_ip: str - port: Union[int, str] - protocol: Protocol - comment: Optional[str] = None - -
-[docs] - @validator("port") - def validate_port(cls, v): - """ - Проверяет корректность порта или диапазона портов. - - Args: - v: Порт (число) или диапазон портов (строка вида "3000:3999") - - Returns: - Union[int, str]: Валидированное значение порта - - Raises: - ValueError: Если порт или диапазон портов некорректен - """ - if isinstance(v, int): - if not (1 <= v <= 65535): - raise ValueError( - f"Порт должен быть в диапазоне 1-65535, получено: {v}") - return v - elif isinstance(v, str): - try: - start, end = map(int, v.split(":")) - if not (1 <= start <= end <= 65535): - raise ValueError - return v - except (ValueError, TypeError): - raise ValueError( - f"Некорректный диапазон портов: {v}. Формат: start:end, где 1 <= start <= end <= 65535" - ) - else: - raise ValueError( - f"Порт должен быть числом или строкой с диапазоном, получено: {type(v)}" - )
- - -
-[docs] - @validator("from_ip", "to_ip") - def validate_ip(cls, v): - """Проверяет корректность IP адреса""" - try: - # Пробуем создать объект IP-сети, что автоматически проверит корректность адреса - ipaddress.ip_network(v, strict=False) - return v - except ValueError: - raise ValueError(f"Некорректный IP адрес или подсеть: {v}")
- - -
-[docs] - @validator("to_ip") - def validate_ip_version_compatibility(cls, v, values): - """Проверяет совместимость версий IP адресов""" - if "from_ip" not in values: - return v - - # Определяем версии IP - from_ip = ipaddress.ip_network(values["from_ip"], strict=False) - to_ip = ipaddress.ip_network(v, strict=False) - - if isinstance(from_ip, ipaddress.IPv6Network) != isinstance( - to_ip, ipaddress.IPv6Network): - raise ValueError( - "Несовместимые версии IP: нельзя смешивать IPv4 и IPv6 в одном правиле" - ) - - return v
- - -
-[docs] - @validator("action", pre=True) - def validate_action(cls, v): - """Приводит значение action к нижнему регистру перед валидацией""" - if isinstance(v, str): - return v.lower() - return v
- - -
-[docs] - @validator("protocol", pre=True) - def validate_protocol(cls, v): - """Приводит значение protocol к нижнему регистру перед валидацией""" - if isinstance(v, str): - return v.lower() - return v
- - -
-[docs] - def to_ufw_command(self) -> str: - """Преобразует правило в команду UFW.""" - cmd_parts = ["ufw"] - - # Добавляем действие - cmd_parts.append(self.action.value) - - # Добавляем направление - cmd_parts.append(self.direction.value) - - # Добавляем from с IP - cmd_parts.extend(["from", self.from_ip]) - - # Добавляем to с IP - cmd_parts.extend(["to", self.to_ip]) - - # Добавляем порт и протокол - port_str = str( - self.port) # Работает как с числами, так и с диапазонами - cmd_parts.extend(["port", port_str]) - - # Добавляем протокол - proto = self.protocol.value - if proto == "both": - cmd_parts.append("proto tcp/udp") - else: - cmd_parts.extend(["proto", proto]) - - # Добавляем комментарий если есть - if self.comment: - cmd_parts.extend(["comment", f"'{self.comment}'"]) - - return " ".join(cmd_parts)
- - -
-[docs] - @classmethod - def from_ufw_output(cls, line: str) -> "UFWRule": - """ - Создает экземпляр UFWRule из строки вывода команды 'ufw status numbered'. - - Args: - line: Строка вывода UFW (например, "[1] 80/tcp ALLOW IN 192.168.1.0/24 # Web Server") - - Returns: - UFWRule: Новый экземпляр правила - """ - import re - - # Регулярное выражение для разбора строки правила UFW - pattern = r"""^\s* - \[\s*(?P<number>\d+)\s*\]\s* - (?P<port>\d+(?::\d+)?)/(?P<protocol>tcp(?:/udp)?|udp)\s+ - (?P<action>ALLOW|DENY|REJECT)\s+(?P<direction>IN|OUT)\s+ - (?P<from_ip>[\w\d\./]+|\bAnywhere\b) - (?:\s+\(v6\))? - (?:\s+\((?:out|in)\))? - \s* - (?:\#\s*(?P<comment>.*?))? - \s*$ - """ - - match = re.match(pattern, line, re.VERBOSE | re.IGNORECASE) - if not match: - raise ValueError( - f"Невозможно разобрать строку правила UFW: {line}") - - groups = match.groupdict() - - # Преобразуем протокол в enum - proto_str = groups["protocol"].lower() - protocol = (Protocol.BOTH if proto_str == "tcp/udp" else - Protocol.UDP if proto_str == "udp" else Protocol.TCP) - - # Преобразуем действие в enum (игнорируем регистр) - action_str = groups["action"].lower() - action = (Action.ALLOW if action_str == "allow" else - Action.DENY if action_str == "deny" else Action.REJECT) - - # Преобразуем направление в enum - direction_str = groups["direction"].lower() - direction = Direction.IN if direction_str == "in" else Direction.OUT - - # Обрабатываем IP адреса - from_ip = groups["from_ip"].strip() - if from_ip.lower() == "anywhere": - from_ip = "0.0.0.0/0" - - # Для исходящих правил меняем местами from и to - to_ip = "0.0.0.0/0" # По умолчанию anywhere - - # Обрабатываем порт - port = groups["port"] - if ":" in port: - # Оставляем как строку для диапазона - port = port.strip() - else: - # Преобразуем в число для одиночного порта - port = int(port) - - # Обрабатываем комментарий - comment = groups.get("comment", - "").strip() if groups.get("comment") else None - - return cls( - action=action, - direction=direction, - from_ip=from_ip, - to_ip=to_ip, - port=port, - protocol=protocol, - comment=comment, - )
-
- - - -
-[docs] -class UFWRulesResponse(BaseModel): - """ - Модель для представления списка правил UFW. - - Attributes: - enabled: Включен ли UFW - rules: Список правил UFW - total_rules: Общее количество правил - """ - - enabled: bool = Field(..., description="Включен ли UFW") - rules: List[UFWRule] = Field(default_factory=list, - description="Список правил UFW") - - @property - def total_rules(self) -> int: - """Возвращает общее количество правил.""" - return len(self.rules)
- - - -
-[docs] -class UFWStatus(BaseModel): - """ - Модель для представления статуса UFW. - - Attributes: - enabled: Включен ли UFW - message: Сообщение о статусе - last_checked: Время последней проверки статуса - """ - - enabled: bool = Field(..., description="Включен ли UFW") - message: str = Field(..., description="Сообщение о статусе")
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/models/wifi.html b/SRV/docs/_build/html/_modules/models/wifi.html deleted file mode 100644 index c68745a..0000000 --- a/SRV/docs/_build/html/_modules/models/wifi.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - - models.wifi - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for models.wifi

-from pydantic import BaseModel
-from typing import Optional, List
-
-
-
-[docs] -class WifiAccessPoint(BaseModel): - """Модель Wi-Fi точки доступа. - - Атрибуты: - - - ``ssid`` (Optional[str]): Название сети (может быть скрытым). - - ``bssid`` (str): Уникальный идентификатор точки доступа. - - ``channel`` (Optional[int]): Номер канала. - - ``signal`` (Optional[int]): Уровень сигнала в dBm. - - ``encryption`` (Optional[str]): Тип шифрования (WPA/WPA2/WPA3/открытая). - - ``frequency`` (Optional[str]): Диапазон частот (2.4/5 ГГц). - - ``vendor`` (Optional[str]): Производитель оборудования. - - ``hidden`` (bool): Флаг скрытого SSID. - - ``note`` (Optional[str]): Пользовательская заметка. - """ - - ssid: Optional[str] = None - bssid: str - channel: Optional[int] = None - signal: Optional[int] = None - encryption: Optional[str] = None - frequency: Optional[str] = None - vendor: Optional[str] = None - hidden: bool = False - note: Optional[str] = None
- - - -
-[docs] -class WifiScanResult(BaseModel): - """Результат сканирования Wi-Fi. - - Атрибуты: - - - ``access_points`` (List[WifiAccessPoint]): Найденные точки доступа. - """ - - access_points: List[WifiAccessPoint]
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/arp_service.html b/SRV/docs/_build/html/_modules/services/arp_service.html deleted file mode 100644 index d311770..0000000 --- a/SRV/docs/_build/html/_modules/services/arp_service.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - services.arp_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.arp_service

-"""
-Сервис низкоуровневого ARP-сканирования локальной сети.
-
-Назначение:
-
-- Обнаружение активных узлов в пределах сетей хоста путём широковещательных ARP-запросов от имени выбранного интерфейса.
-- Помощь сервисам более высокого уровня (например, IPService) при проверке занятости адресов перед применением конфигураций.
-
-Особенности реализации:
-
-- Определяет подключённые сети интерфейса через `netifaces` и строит CIDR для сканирования.
-- Формирует ARP-пакеты с помощью `scapy` (Ether/ARP) и отправляет их с таймаутом.
-- Добавляет локальный адрес интерфейса в результирующий список клиентов.
-
-Требования/ограничения:
-
-- Для отправки ARP-кадров могут потребоваться повышенные привилегии или capability на сырой сокет.
-"""
-import os
-import logging
-from fastapi import Depends
-import netifaces
-from netaddr import IPNetwork
-from utils.i18n import get_translations, _
-from babel.support import Translations
-
-logger = logging.getLogger(__name__)
-
-try:
-    from scapy.layers.l2 import ARP, Ether
-    from scapy.sendrecv import srp
-except Exception as exc:  # pragma: no cover - fallback for doc builds
-    if os.getenv("SPHINX_BUILD"):
-        ARP = Ether = None  # type: ignore
-
-        def srp(*args, **kwargs):
-            raise RuntimeError("scapy is unavailable during documentation build") from exc
-    else:
-        raise
-
-
-[docs] -class NetworkScanner: - """Инициализация сетевого сканера. - - Предоставляет методы для сканирования сети с использованием ARP-запросов и - вывода информации о клиентах. - """ - - def __init__(self, interface=None, translations: Translations = Depends(get_translations())): - """Инициализация параметров сетевого сканера. - - Args: - interface (str, optional): Название сетевого интерфейса. По умолчанию - используется интерфейс по умолчанию из netifaces.gateways(). - translations: Объект переводов для текущего языка. - - Инициализирует интерфейс, информацию об IP-адресах и локальный MAC-адрес. - """ - self.translations = translations - self.interface = None - self.ip_info = [] - self.networks = [] - self.local_mac = None - - try: - candidate_interface = interface - if not candidate_interface: - gateways = netifaces.gateways() - default_gateway = gateways.get("default", {}).get(netifaces.AF_INET) - if default_gateway: - candidate_interface = default_gateway[1] - else: - for iface in netifaces.interfaces(): - if iface == "lo": - continue - addrs = netifaces.ifaddresses(iface) - if netifaces.AF_INET in addrs and addrs[netifaces.AF_INET]: - candidate_interface = iface - break - - if candidate_interface: - self.interface = candidate_interface - addresses = netifaces.ifaddresses(self.interface) - self.ip_info = addresses.get(netifaces.AF_INET, []) - self.networks = [ - IPNetwork( - f"{ip['addr']}/{ip['netmask']}" - ) for ip in self.ip_info if ip.get("addr") and ip.get("netmask") - ] - link_info = addresses.get(netifaces.AF_LINK, []) - if link_info: - self.local_mac = link_info[0].get("addr") - else: - logger.warning( - "NetworkScanner: IPv4 интерфейс не найден, сканирование будет недоступно" - ) - except Exception as exc: - if os.getenv("SPHINX_BUILD"): - self.interface = interface or "eth0" - self.ip_info = [] - self.networks = [] - self.local_mac = "00:00:00:00:00:00" - logger.warning( - "NetworkScanner falling back to mocked interface during documentation build: %s", - exc, - ) - else: - logger.error("NetworkScanner инициализация завершилась ошибкой: %s", exc) - raise - - def _create_arp_packet(self, target_ip): - """Создаёт ARP-пакет для отправки на указанный IP-адрес. - - Args: - target_ip (str): Целевой IP-адрес или подсеть для сканирования. - - Returns: - scapy.packet.Packet: Сформированный ARP-пакет с Ethernet-заголовком. - """ - arp = ARP(pdst=target_ip) - ether = Ether(dst="ff:ff:ff:ff:ff:ff") - return ether / arp - -
-[docs] - def scan_network(self, attempts=3, timeout=2): - """Сканирует сеть для обнаружения активных клиентов. - - Args: - attempts (int, optional): Количество попыток отправки ARP-запросов. - По умолчанию 3. - timeout (int, optional): Таймаут ожидания ответа в секундах. - По умолчанию 2. - - Returns: - List[dict]: Список словарей с ключами "ip" и "mac", представляющих - обнаруженных клиентов, включая локальные IP-адреса. - - Note: - Учитывает локальные IP-адреса интерфейса и удаляет дубликаты. - """ - if not self.interface or not self.networks or ARP is None or Ether is None: - fallback_clients = [] - if self.ip_info: - for ip_info in self.ip_info: - fallback_clients.append({ - "ip": ip_info.get("addr"), - "mac": self.local_mac, - }) - return [client for client in fallback_clients if client["ip"]] - - all_clients = [] - - for network in self.networks: - target_ip = f"{network.network}/{network.prefixlen}" - packet = self._create_arp_packet(target_ip) - clients = [] - - for _ in range(attempts): - result = srp(packet, - timeout=timeout, - iface=self.interface, - verbose=0)[0] - for _, received in result: - client = {"ip": received.psrc, "mac": received.hwsrc} - if client not in clients: - clients.append(client) - - all_clients.extend(clients) - - for ip_info in self.ip_info: - if not ip_info.get("addr"): - continue - local_client = { - "ip": ip_info["addr"], - "mac": self.local_mac, - } - if local_client not in all_clients: - all_clients.append(local_client) - - unique_clients = {tuple(client.items()) for client in all_clients} - return [dict(client) for client in unique_clients]
- - -
-[docs] - def print_clients(self, clients): - """Выводит список адресов клиентов в формате таблицы. - - Args: - clients (List[dict]): Список словарей с ключами "ip" и "mac", - представляющих клиентов. - - Выводит IP-адреса и MAC-адреса в отсортированном по IP порядке. - """ - print(self.translations.gettext("Доступные устройства в сети:")) - print(self.translations.gettext("IP") + " " * 18 + self.translations.gettext("MAC")) - for client in sorted(clients, key=lambda x: x["ip"]): - print(f"{client['ip']:<16} {client['mac']}")
-
- - -# Оставил нативный запуск сервиса для тестов -if __name__ == "__main__": - scanner = NetworkScanner() - clients = scanner.scan_network() - scanner.print_clients(clients) -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/auth_service.html b/SRV/docs/_build/html/_modules/services/auth_service.html deleted file mode 100644 index 34e4d34..0000000 --- a/SRV/docs/_build/html/_modules/services/auth_service.html +++ /dev/null @@ -1,492 +0,0 @@ - - - - - - - - services.auth_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.auth_service

-from jose import JWTError, jwt
-from datetime import datetime, timedelta
-from fastapi import HTTPException, Depends, Request
-from fastapi.security import OAuth2PasswordBearer
-from models.auth import UserCreate, UserLogin, UserResponse, Token
-from storage.json_storage import JsonStorage
-from storage.session_storage import SessionStorage
-from typing import Optional
-import configparser
-import os
-import logging
-from utils.i18n import get_translations, _
-from babel.support import Translations
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-CONFIG_PATH = os.getenv("GONETS_CONFIG_PATH", "/etc/gonets/config.ini")
-config = configparser.ConfigParser()
-read_files = config.read(CONFIG_PATH)
-
-if "JWT" in config:
-    SECRET_KEY = config["JWT"]["secret_key"]
-elif os.getenv("SPHINX_BUILD"):
-    logger.warning("JWT secret not found; using dummy value for documentation build")
-    SECRET_KEY = "sphinx-placeholder-secret"
-else:
-    raise RuntimeError(f"Configuration file {CONFIG_PATH} not found or missing [JWT] section")
-
-ALGORITHM = "HS256"
-ACCESS_TOKEN_EXPIRE_MINUTES = 30
-
-oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login")
-
-
-[docs] -class AuthService: - """Сервис для регистрации, авторизации и управления сессиями""" - - def __init__(self, translations: Translations = Depends(get_translations())): - self.storage = JsonStorage() - self.session_storage = SessionStorage() - self.translations = translations - -
-[docs] - def create_access_token(self, data: dict) -> str: - """Создаёт токен""" - to_encode = data.copy() - expire = datetime.utcnow() + timedelta( - minutes=ACCESS_TOKEN_EXPIRE_MINUTES) - to_encode.update({"exp": expire}) - encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM) - return encoded_jwt
- - -
-[docs] - def verify_token(self, token: str) -> Optional[dict]: - """Проверяет токен""" - try: - payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM]) - username: str = payload.get("sub") - if username is None: - return None - return {"username": username} - except JWTError: - return None
- - -
-[docs] - def register(self, user: UserCreate) -> UserResponse: - """Регистрирует нового пользователя""" - try: - db_user = self.storage.create_user(user) - return db_user - except ValueError as e: - logger.error( - f"Error registering user {user.username}: {str(e)}" - ) - raise HTTPException(status_code=400, detail=self.translations.gettext(str(e))) - except Exception as e: - logger.error( - f"Error registering user {user.username}: {type(e).__name__} - {str(e)}" - ) - raise HTTPException(status_code=500, detail=self.translations.gettext("Ошибка регистрации"))
- - -
-[docs] - def login(self, user: UserLogin, client_id: str) -> dict: - """Авторизует пользователя, создаёт сессию и возвращает токен""" - try: - db_user = self.storage.get_user_by_username(user.username) - if not db_user: - logger.error(f"User {user.username} not found") - raise HTTPException(status_code=401, detail=self.translations.gettext("Неверный логин или пароль")) - if not self.storage.verify_password(user.password, db_user["password_hash"]): - logger.error( - f"Invalid password for user {user.username}") - raise HTTPException(status_code=401, detail=self.translations.gettext("Неверный логин или пароль")) - access_token = self.create_access_token( - data={"sub": user.username}) - session_id = self.session_storage.create_session( - user.username, access_token, client_id) - logger.info(f"User {user.username} successfully logged in") - return { - "access_token": access_token, - "token_type": "bearer", - "session_id": session_id, - "user": UserResponse(id=db_user["id"], username=db_user["username"], is_admin=db_user["is_admin"]), - } - except Exception as e: - logger.error( - f"Error logging in user {user.username}: {type(e).__name__} - {str(e)}" - ) - raise HTTPException(status_code=500, detail=self.translations.gettext("Ошибка авторизации"))
- - -
-[docs] - def get_current_user( - self, token: str = Depends(oauth2_scheme)) -> UserResponse: - """Получает текущего пользователя по токену""" - credentials = self.verify_token(token) - if not credentials: - logger.error("Invalid or expired token") - raise HTTPException(status_code=401, detail=self.translations.gettext("Неверный токен")) - username = credentials["username"] - db_user = self.storage.get_user_by_username(username) - if not db_user: - logger.error(f"User {username} not found") - raise HTTPException(status_code=401, detail=self.translations.gettext("Пользователь не найден")) - return UserResponse(id=db_user["id"], username=db_user["username"], is_admin=db_user["is_admin"])
- - -
-[docs] - def get_user_by_session(self, client_id: str) -> dict: - """Получает пользователя и токен по client_id""" - session = self.session_storage.get_latest_session(client_id) - if not session: - logger.error( - f"Session for client_id {client_id} not found or expired") - raise HTTPException(status_code=401, detail=self.translations.gettext("Сессия недействительна")) - username = session["username"] - token = session["token"] - db_user = self.storage.get_user_by_username(username) - if not db_user: - logger.error(f"User {username} not found") - raise HTTPException(status_code=401, detail=self.translations.gettext("Пользователь не найден")) - return { - "user": - UserResponse(id=db_user["id"], username=db_user["username"], is_admin=db_user["is_admin"]), - "access_token": token - }
- - -
-[docs] - def logout(self, client_id: str): - """Выполняет выход из системы, удаляя последнюю сессию для client_id""" - try: - session = self.session_storage.get_latest_session(client_id) - if session: - self.session_storage.delete_session(session["session_id"]) - logger.info( - f"User successfully logged out for client_id {client_id}" - ) - return {"message": self.translations.gettext("Успешный выход из системы")} - except Exception as e: - logger.error( - f"Error logging out: {type(e).__name__} - {str(e)}") - raise HTTPException(status_code=500, detail=self.translations.gettext("Ошибка при выходе из системы"))
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/connect_service.html b/SRV/docs/_build/html/_modules/services/connect_service.html deleted file mode 100644 index df624b4..0000000 --- a/SRV/docs/_build/html/_modules/services/connect_service.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - - - - services.connect_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.connect_service

-"""
-Сервис управления подключениями Wi-Fi через `nmcli`.
-
-Назначение:
-
-- Предоставляет операции подключения/отключения к точкам доступа и проверки текущего статуса, ориентируясь на системный NetworkManager.
-
-Поведение:
-
-- Автоматически определяет активный Wi-Fi-интерфейс.
-- Валидирует наличие SSID в листинге перед подключением и интерпретирует частые ошибки `nmcli` (неверный пароль, отсутствующая сеть и т.п.).
-
-Ограничения:
-
-- Требуются права для управления сетевыми соединениями в системе.
-- В окружениях без NetworkManager команды `nmcli` будут недоступны.
-"""
-import subprocess
-import logging
-from typing import Tuple, Optional
-from utils.i18n import get_translations, _
-from babel.support import Translations
-from fastapi import Depends
-
-logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-logger = logging.getLogger(__name__)
-
-
-[docs] -class WifiConnectionService: - """Сервис для управления подключением к Wi-Fi сетям с использованием nmcli. - - Предоставляет методы для подключения, отключения и проверки статуса Wi-Fi соединений. - """ - - def __init__(self, translations: Optional[Translations] = None): - """Инициализирует сервис Wi-Fi. - - Автоматически определяет доступный Wi-Fi-интерфейс и сохраняет его имя. - """ - self.interface = self._get_wifi_interface() - if translations is None: - try: - self.translations = Translations.load("locales", ["ru"], "messages") - except Exception: - self.translations = Translations() - else: - self.translations = translations - - def _get_wifi_interface(self) -> str: - """Автоматически определяет Wi-Fi-интерфейс. - - Returns: - str: Название Wi-Fi-интерфейса (например, "wlan0") или пустая строка, - если интерфейс не найден или Wi-Fi отключён. - - Raises: - Exception: Если произошла ошибка при выполнении команд nmcli. - """ - try: - result = subprocess.run( - ["nmcli", "radio", "wifi"], capture_output=True, text=True - ) - if "enabled" not in result.stdout.lower(): - logger.error("Wi-Fi radio is disabled") - return "" - - interfaces_output = subprocess.run( - ["nmcli", "device", "status"], capture_output=True, text=True - ).stdout - - for line in interfaces_output.splitlines(): - parts = line.split() - if len(parts) < 2: - continue - device_name, device_type = parts[0], parts[1] - if device_type.lower() == "wifi": - logger.info(f"Using Wi-Fi interface: {device_name}") - return device_name - - logger.warning("Wi-Fi interface not found in `nmcli device status` output") - return "" - except Exception as e: - logger.error(f"Error detecting Wi-Fi interface: {str(e)}") - return "" - -
-[docs] - def connect(self, ssid: str, password: str) -> Tuple[bool, Optional[str]]: - """Подключается к Wi-Fi сети по SSID и паролю. - - Args: - ssid (str): Идентификатор сети Wi-Fi. - password (str): Пароль для подключения. - - Returns: - Tuple[bool, Optional[str]]: Кортеж (успех, сообщение об ошибке). - - Успех: (True, None). - - Ошибка: (False, сообщение об ошибке). - - Raises: - subprocess.CalledProcessError: Если команда nmcli завершилась с ошибкой. - Exception: Если произошла неизвестная ошибка при выполнении. - """ - try: - if not self.interface: - return False, self.translations.gettext("Wi-Fi-интерфейс не доступен") - - result = subprocess.run( - ["nmcli", "-f", "SSID", "device", "wifi", "list"], - capture_output=True, - text=True, - ) - if ssid not in result.stdout: - return False, self.translations.gettext("Сеть с SSID {ssid} не найдена в списке доступных сетей").format(ssid=ssid) - - def run_connect() -> subprocess.CompletedProcess[str]: - cmd = [ - "nmcli", - "device", - "wifi", - "connect", - ssid, - "ifname", - self.interface, - ] - if password: - cmd.extend(["password", password]) - return subprocess.run(cmd, capture_output=True, text=True, check=False) - - process = run_connect() - if process.returncode != 0: - error_msg = process.stderr.lower() - key_mgmt_error = ( - "secrets were required" in error_msg - or "authentication failed" in error_msg - or "802-11-wireless-security.psk" in error_msg - or "key-mgmt" in error_msg - ) - if key_mgmt_error: - subprocess.run( - ["nmcli", "connection", "delete", "id", ssid], - capture_output=True, - text=True, - ) - retry_process = run_connect() - if retry_process.returncode == 0: - logger.info(f"Successfully connected to network {ssid} after profile reset") - return True, None - error_msg = retry_process.stderr.lower() - if ( - "secrets were required" in error_msg - or "authentication failed" in error_msg - or "802-11-wireless-security.psk" in error_msg - or "key-mgmt" in error_msg - ): - return False, self.translations.gettext("Ошибка подключения к {ssid}: Неверный пароль или тип безопасности").format(ssid=ssid) - elif "no network with ssid" in error_msg: - return False, self.translations.gettext("Ошибка подключения к {ssid}: Сеть с SSID {ssid} недоступна или неверно указана").format(ssid=ssid) - else: - return False, self.translations.gettext("Ошибка подключения к {ssid}: {error}").format(ssid=ssid, error=retry_process.stderr) - elif "no network with ssid" in error_msg: - return False, self.translations.gettext("Ошибка подключения к {ssid}: Сеть с SSID {ssid} недоступна или неверно указана").format(ssid=ssid) - else: - return False, self.translations.gettext("Ошибка подключения к {ssid}: {error}").format(ssid=ssid, error=process.stderr) - - logger.info(f"Successfully connected to network {ssid}") - return True, None - except subprocess.CalledProcessError as e: - logger.error(f"Error connecting to {ssid}: {e.stderr}") - error_msg = e.stderr.lower() - if "secrets were required" in error_msg or "authentication failed" in error_msg or "802-11-wireless-security.psk: недействительное свойство" in e.stderr: - return False, self.translations.gettext("Ошибка подключения к {ssid}: Неверный пароль").format(ssid=ssid) - elif "no network with ssid" in error_msg: - return False, self.translations.gettext("Ошибка подключения к {ssid}: Сеть с SSID {ssid} недоступна или неверно указана").format(ssid=ssid) - return False, self.translations.gettext("Ошибка подключения к {ssid}: {error}").format(ssid=ssid, error=e.stderr) - except Exception as e: - logger.error(f"Unknown error connecting to {ssid}: {str(e)}") - return False, self.translations.gettext("Ошибка подключения к {ssid}: Неизвестная ошибка - {error}").format(ssid=ssid, error=str(e))
- - -
-[docs] - def disconnect(self, ssid: str) -> Tuple[bool, Optional[str]]: - """Отключается от Wi-Fi сети по указанному SSID. - - Args: - ssid (str): Идентификатор сети Wi-Fi для отключения. - - Returns: - Tuple[bool, Optional[str]]: Кортеж (успех, сообщение об ошибке). - - Успех: (True, None или сообщение, если подключение не найдено). - - Ошибка: (False, сообщение об ошибке). - - Raises: - subprocess.CalledProcessError: Если команда nmcli завершилась с ошибкой. - Exception: Если произошла неизвестная ошибка при выполнении. - """ - try: - if not self.interface: - return False, self.translations.gettext("Wi-Fi-интерфейс не доступен") - result = subprocess.run(["nmcli", "connection", "show", "--active"], capture_output=True, text=True) - active_connections = result.stdout.strip().splitlines() - if not active_connections: - logger.info(f"No active connections for SSID {ssid}") - return True, self.translations.gettext("Нет активного подключения для SSID {ssid}").format(ssid=ssid) - for conn in active_connections: - conn_details = conn.split() - if len(conn_details) > 1: - conn_name = conn_details[0] - conn_info = subprocess.run(["nmcli", "connection", "show", conn_name], capture_output=True, text=True).stdout - if "802-11-wireless.ssid:" in conn_info and ssid in conn_info: - subprocess.run(["nmcli", "connection", "down", conn_name], capture_output=True, text=True, check=True) - logger.info(f"Disconnected from SSID {ssid}") - return True, None - logger.warning(f"Active connection with SSID {ssid} not found") - return True, self.translations.gettext("Активное подключение с SSID {ssid} не найдено").format(ssid=ssid) - except subprocess.CalledProcessError as e: - logger.error(f"Error disconnecting from {ssid}: {e.stderr}") - return False, self.translations.gettext("Ошибка отключения от {ssid}: {error}").format(ssid=ssid, error=e.stderr) - except Exception as e: - logger.error(f"Unknown error disconnecting from {ssid}: {str(e)}") - return False, self.translations.gettext("Ошибка отключения от {ssid}: {error}").format(ssid=ssid, error=str(e))
- - -
-[docs] - def get_status(self) -> Tuple[bool, Optional[str]]: - """Проверяет статус текущего подключения к Wi-Fi. - - Returns: - Tuple[bool, Optional[str]]: Кортеж (успех, SSID или сообщение об ошибке). - - Успех: (True, SSID текущей сети). - - Ошибка или отсутствие подключения: (False, сообщение об ошибке). - - Raises: - Exception: Если произошла ошибка при выполнении команды nmcli. - """ - try: - if not self.interface: - return False, self.translations.gettext("Wi-Fi-интерфейс не доступен") - result = subprocess.run(["nmcli", "connection", "show", "--active"], capture_output=True, text=True) - if result.stdout.strip(): - ssid = result.stdout.splitlines()[1].split()[0] - logger.info(f"Current network: {ssid}") - return True, ssid - return False, self.translations.gettext("Не подключено к Wi-Fi") - except Exception as e: - logger.error(f"Error checking status: {str(e)}") - return False, self.translations.gettext("Ошибка проверки статуса: {error}").format(error=str(e))
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/firewalld_service.html b/SRV/docs/_build/html/_modules/services/firewalld_service.html deleted file mode 100644 index 498bfa9..0000000 --- a/SRV/docs/_build/html/_modules/services/firewalld_service.html +++ /dev/null @@ -1,522 +0,0 @@ - - - - - - - - services.firewalld_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.firewalld_service

-"""
-Сервис для управления firewalld через D-Bus.
-
-Назначение:
-- Обёртка над интерфейсами `org.fedoraproject.FirewallD1` для выполнения
-  типовых операций по зонам: просмотр/изменение дефолтной зоны, добавление и
-  удаление сервисов, портов, источников, перезагрузка конфигурации.
-
-Примечания:
-- Используется `pydbus.SystemBus` для доступа к системной шине.
-- Методы генерируют дружелюбные исключения при ошибках, содержащие контекст
-  операции.
-"""
-from re import DEBUG
-from typing import Dict, List, Optional
-
-from pydbus import SystemBus
-
-DEBUG = True
-
-
-
-[docs] -class FirewalldService: - - def __init__(self): - self.bus = SystemBus() - self.proxy = self.bus.get("org.fedoraproject.FirewallD1", - "/org/fedoraproject/FirewallD1") - -
-[docs] - def get_zones(self) -> List[str]: - """Get list of all zones.""" - try: - return self.proxy.getZones() - except Exception as e: - raise Exception(f"Failed to get zones: {str(e)}")
- - -
-[docs] - def get_default_zone(self) -> str: - """Get the default zone.""" - try: - return self.proxy.getDefaultZone() - except Exception as e: - raise Exception(f"Failed to get default zone: {str(e)}")
- - -
-[docs] - def set_default_zone(self, zone: str) -> None: - """Set the default zone.""" - try: - self.proxy.setDefaultZone(zone) - except Exception as e: - raise Exception(f"Failed to set default zone to {zone}: {str(e)}")
- - -
-[docs] - def add_service(self, - zone: str, - service: str, - timeout: Optional[int] = 0) -> None: - """Add a service to a zone.""" - try: - self.proxy.addService(zone, service, timeout) - except Exception as e: - raise Exception( - f"Failed to add service {service} to zone {zone}: {str(e)}")
- - -
-[docs] - def remove_service(self, zone: str, service: str) -> None: - """Remove a service from a zone.""" - try: - self.proxy.removeService(zone, service) - except Exception as e: - raise Exception( - f"Failed to remove service {service} from zone {zone}: {str(e)}" - )
- - -
-[docs] - def get_services(self, zone: str) -> List[str]: - """Get list of services in a zone.""" - try: - return self.proxy.getServices(zone) - except Exception as e: - raise Exception( - f"Failed to get services for zone {zone}: {str(e)}")
- - -
-[docs] - def add_port(self, - zone: str, - port: int, - protocol: str, - timeout: Optional[int] = 0) -> None: - """Add a port to a zone.""" - try: - if DEBUG: - print(f"Adding port {port}/{protocol} to zone {zone}") - print(f"Timeout: {timeout}") - # Get the zone interface - zone_proxy = self.bus.get("org.fedoraproject.FirewallD1", - "/org/fedoraproject/FirewallD1") - zone_iface = zone_proxy["org.fedoraproject.FirewallD1.zone"] - # Convert port to string - port_str = str(port) - # Convert timeout to integer - timeout_int = int(timeout) if timeout is not None else 0 - # Call addPort with the correct signature (sssi) - zone_iface.addPort(zone, port_str, protocol, timeout_int) - except Exception as e: - raise Exception( - f"Failed to add port {port}/{protocol} to zone {zone}: {str(e)}" - )
- - -
-[docs] - def remove_port(self, zone: str, port: int, protocol: str) -> None: - """Remove a port from a zone.""" - try: - port_str = f"{port}/{protocol}" - self.proxy.removePort(zone, port_str) - except Exception as e: - raise Exception( - f"Failed to remove port {port}/{protocol} from zone {zone}: {str(e)}" - )
- - -
-[docs] - def get_ports(self, zone: str) -> List[str]: - """Get list of ports in a zone.""" - try: - ports = self.proxy.getPorts(zone) - # Convert port list items to strings in format "port/protocol" - return [f"{port[0]}/{port[1]}" for port in ports] - except Exception as e: - raise Exception(f"Failed to get ports for zone {zone}: {str(e)}")
- - -
-[docs] - def add_source(self, zone: str, source: str) -> None: - """Add a source to a zone.""" - try: - self.proxy.addSource(zone, source) - except Exception as e: - raise Exception( - f"Failed to add source {source} to zone {zone}: {str(e)}")
- - -
-[docs] - def remove_source(self, zone: str, source: str) -> None: - """Remove a source from a zone.""" - try: - self.proxy.removeSource(zone, source) - except Exception as e: - raise Exception( - f"Failed to remove source {source} from zone {zone}: {str(e)}")
- - -
-[docs] - def get_sources(self, zone: str) -> List[str]: - """Get list of sources in a zone.""" - try: - return self.proxy.getSources(zone) - except Exception as e: - raise Exception(f"Failed to get sources for zone {zone}: {str(e)}")
- - -
-[docs] - def reload(self) -> None: - """Reload firewall rules.""" - try: - self.proxy.reload() - except Exception as e: - raise Exception(f"Failed to reload firewall rules: {str(e)}")
- - -
-[docs] - def get_zone_settings(self, zone: str) -> Dict: - """Get all settings for a zone.""" - try: - return { - "services": self.get_services(zone), - "ports": self.get_ports(zone), - "sources": self.get_sources(zone), - } - except Exception as e: - raise Exception( - f"Failed to get zone settings for {zone}: {str(e)}")
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/ip_service.html b/SRV/docs/_build/html/_modules/services/ip_service.html deleted file mode 100644 index 991df10..0000000 --- a/SRV/docs/_build/html/_modules/services/ip_service.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - - services.ip_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.ip_service

-"""
-Сервис проверки и применения IP-настроек через NetworkManager (D-Bus).
-
-Назначение:
-- Перед применением конфигурации проверяет занятость IP адреса, сканируя сегмент
-  сети средствами ARP (через `NetworkScanner`).
-- Применяет изменения профиля подключения через `sdbus_async.networkmanager` и
-  выполняет переподключение интерфейса.
-
-Требования/ограничения:
-- Доступ к системной шине D-Bus и права на изменения сетевых профилей.
-- Структура входных данных должна соответствовать схеме `ipv4_updates` для
-  корректного обновления вложенных полей у профиля.
-"""
-from typing import Dict, Any
-from sdbus_async.networkmanager import (
-    NetworkManager,
-    NetworkManagerSettings,
-    NetworkConnectionSettings,
-    NetworkDeviceGeneric,
-)
-import sdbus
-from sdbus_async.networkmanager.settings import ConnectionProfile
-from services.arp_service import NetworkScanner
-from utils.i18n import get_translations
-from babel.support import Translations
-from fastapi import Depends
-
-
-[docs] -class IPService: - """Сервис проверки доступности IP-адреса и применения настроек сети. - - Предоставляет асинхронные методы для проверки занятости IP-адреса с использованием - ARP-сканирования и применения настроек через NetworkManager. - """ - - def __init__(self): - """Инициализирует сервис IP. - - Создаёт объект ARP-сканера и устанавливает системную шину D-Bus как - по умолчанию. - """ - self.arp_scanner = NetworkScanner() - self.bus = sdbus.sd_bus_open_system() - sdbus.set_default_bus(self.bus) - - def _reset_bus(self): - """Перезапускает соединение с системной шиной D-Bus. - - Закрывает текущее соединение и создаёт новое, устанавливая его как - по умолчанию. - """ - new_bus = sdbus.sd_bus_open_system() - sdbus.set_default_bus(new_bus) - if hasattr(self, "bus") and self.bus is not None: - self.bus = None - self.bus = new_bus - -
-[docs] - async def check_ip_config(self, args: Dict[str, Any], translations: Translations = Depends(get_translations())) -> Dict[str, Any]: - """Проверяет доступность IP-адреса перед его применением. - - Выполняет ARP-сканирование сети для проверки, занят ли указанный IP-адрес. - Перезапускает шину D-Bus перед выполнением. - - Args: - args (Dict[str, Any]): Словарь с данными, включая "ipv4_updates" - с полем "ipv4.address-data" для нового IP-адреса. - translations (Translations): Объект переводов. - - Returns: - Dict[str, Any]: Словарь с ключами: - - "available" (bool): Доступен ли IP-адрес. - - "message" (str): Сообщение о результате проверки. - - Raises: - Exception: Если произошла ошибка при сканировании ARP. - """ - self._reset_bus() - clients = self.arp_scanner.scan_network() - new_ip = args["ipv4_updates"]["ipv4.address-data"][0]["address"] - if any(client["ip"] == new_ip for client in clients): - return { - "available": False, - "message": translations.gettext("IP-адрес {ip} уже занят.").format(ip=new_ip) - } - return { - "available": True, - "message": translations.gettext("Настройки сетевого профиля доступны для использования.") - }
- - -
-[docs] - async def apply_ip_config(self, args: Dict[str, Any], translations: Translations = Depends(get_translations())) -> None: - """Применяет проверенные настройки IP к указанному соединению. - - Перезапускает шину D-Bus, обновляет настройки соединения через NetworkManager, - отключает и переподключает устройство к сети. - - Args: - args (Dict[str, Any]): Словарь с данными, включая: - - "connection_id" (str): Идентификатор соединения. - - "ipv4_updates" (Dict): Обновления настроек IPv4. - translations (Translations): Объект переводов. - - Raises: - ValueError: Если соединение с указанным ID не найдено. - RuntimeError: Если устройство для интерфейса не найдено. - - Note: - Требуются права для изменения настроек через NetworkManager. - """ - self._reset_bus() - nm = NetworkManager() - settings = NetworkManagerSettings() - connection_paths = await settings.get_connections_by_id( - args["connection_id"]) - - if not connection_paths: - raise ValueError(translations.gettext("Подключение {connection_id} не найдено").format(connection_id=args["connection_id"])) - - connection = NetworkConnectionSettings(connection_paths[0]) - profile = await connection.get_profile() - settings_dict = profile.to_settings_dict() - - for key_path, value in args["ipv4_updates"].items(): - section, *props = key_path.split(".") - current = settings_dict[section] - for prop in props[:-1]: - current = current.setdefault(prop, {}) - current[props[-1]] = value - - new_profile = ConnectionProfile.from_settings_dict(settings_dict) - await connection.update(new_profile.to_dbus()) - print(f"Updated settings for {args['connection_id']}") - - interface_name = settings_dict["connection"]["interface-name"] - devices = await nm.get_devices() - for device_path in devices: - device = NetworkDeviceGeneric(device_path) - if await device.interface == interface_name: - await device.disconnect() - print(f"Disconnected from {interface_name}") - await nm.activate_connection(connection=connection_paths[0], device=device_path) - print(f"Reconnected to {args['connection_id']}") - return - - raise RuntimeError(translations.gettext("Устройство для интерфейса {interface} не найдено").format(interface=interface_name))
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/network_service.html b/SRV/docs/_build/html/_modules/services/network_service.html deleted file mode 100644 index 0a79a74..0000000 --- a/SRV/docs/_build/html/_modules/services/network_service.html +++ /dev/null @@ -1,744 +0,0 @@ - - - - - - - - services.network_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.network_service

-"""
-Сервис чтения сетевого состояния через NetworkManager (D-Bus).
-
-Назначение:
-- Предоставляет асинхронные методы для сборки унифицированных моделей
-  сетевых интерфейсов (Ethernet/Wi-Fi), их IP-конфигураций, а также получения
-  имени хоста. Используется API-слоем для визуализации и управления.
-
-Особенности:
-- Фильтрация loopback и явно неактивных интерфейсов.
-- Адаптация данных D-Bus в pydantic-модели (`NetworkInterface`, `WiFiDevice`,
-  `NetworkInterfacesContainer`).
-"""
-from typing import List, Dict, Tuple, Union, Optional
-from sdbus_async.networkmanager import (
-    NetworkManager,
-    NetworkDeviceGeneric,
-    IPv4Config,
-    IPv6Config,
-    NetworkManagerSettings,
-    NetworkDeviceWireless,
-    AccessPoint,
-    DeviceType,
-)
-from sdbus import sd_bus_open_system
-from models.network import (
-    NetworkInterface,
-    IPv4Route,
-    IPv6Route,
-    IPConfig,
-    IndividualIPConfig,
-    NetworkInterfacesContainer,
-    WiFiDevice,
-)
-import subprocess
-from utils.i18n import get_translations, _
-from babel.support import Translations
-from fastapi import Depends
-
-
-[docs] -class NetworkService: - """Сервис для взаимодействия с NetworkManager через D-Bus. - - Предоставляет асинхронные методы для получения информации о сетевых интерфейсах, - их конфигурациях IP, Wi-Fi и состояниях. - """ - - def __init__(self, translations: Translations = Depends(get_translations())): - """Инициализирует сервис NetworkManager. - - Устанавливает системный D-Bus и создаёт объекты для взаимодействия с - NetworkManager и его настройками. - """ - self.system_bus = sd_bus_open_system() - self.nm = NetworkManager(self.system_bus) - self.nm_settings = NetworkManagerSettings(self.system_bus) - self.translations = translations - -
-[docs] - async def get_ip_method(self, device: NetworkDeviceGeneric, ip_type: str) -> str: - """Получает метод IP (например, "auto", "manual") для указанного устройства. - - Args: - device (NetworkDeviceGeneric): Объект устройства NetworkManager. - ip_type (str): Тип IP (например, "ipv4" или "ipv6"). - - Returns: - str: Метод IP или "unknown" в случае ошибки. - - Raises: - Exception: Если произошла ошибка при получении настроек соединения. - """ - try: - config = await device.get_applied_connection() - settings = config[0].get(ip_type, {}) - return str(settings.get("method", ("s", "unknown"))[1]) - except Exception: - return "unknown"
- - -
-[docs] - async def get_connection_name(self, device: NetworkDeviceGeneric) -> str: - """Извлекает имя соединения (GENERAL.CONNECTION) для устройства. - - Args: - device (NetworkDeviceGeneric): Объект устройства NetworkManager. - - Returns: - str: Имя соединения или "unknown" в случае ошибки. - - Raises: - Exception: Если произошла ошибка при получении настроек соединения. - """ - try: - applied_connection = await device.get_applied_connection() - connection_settings = applied_connection[0] - connection_info = connection_settings.get("connection", {}) - return str(connection_info.get("id", ("s", "unknown"))[1]) - except Exception as e: - return "unknown"
- - -
-[docs] - async def get_ip_config(self, device: NetworkDeviceGeneric, ip_version: str) -> List[IndividualIPConfig]: - """Получает конфигурацию IP для устройства. - - Args: - device (NetworkDeviceGeneric): Объект устройства NetworkManager. - ip_version (str): Версия IP ("4" или "6"). - - Returns: - List[IndividualIPConfig]: Список конфигураций IP, включая адреса и маршруты. - - Raises: - Exception: Если произошла ошибка при получении данных IP. - """ - configs = [] - device_ip = await getattr(device, f"ip{ip_version}_config") - if device_ip != "/": - ip_config = globals()[f"IPv{ip_version}Config"](device_ip, self.system_bus) - address_data = await ip_config.address_data - for address in address_data: - config = IndividualIPConfig( - address=str(address["address"][1]), - routes=[ - globals()[f"IPv{ip_version}Route"]( - destination=route.get("dest", ("s", "0.0.0.0" if ip_version == "4" else "::"))[1], - prefix=route.get("prefix", ("u", 0))[1], - next_hop=route.get("next-hop", ("s", "0.0.0.0" if ip_version == "4" else "::"))[1], - metric=route.get("metric", ("u", 0))[1], - ) for route in await ip_config.route_data - ], - method=await self.get_ip_method(device, f"ipv{ip_version}"), - gateway=str(await ip_config.gateway), - dns=[ - str(ns["address"][1]) if ip_version == "4" else str(ns) - for ns in await getattr( - ip_config, - "nameserver_data" if ip_version == "4" else "nameservers", - ) - ], - ) - configs.append(config) - return configs
- - -
-[docs] - async def get_wifi_info(self, wifi_device: NetworkDeviceWireless) -> Dict[str, Optional[Union[str, int]]]: - """Получает информацию о Wi-Fi устройстве. - - Args: - wifi_device (NetworkDeviceWireless): Объект Wi-Fi устройства NetworkManager. - - Returns: - Dict[str, Optional[Union[str, int]]]: Словарь с данными Wi-Fi (SSID, BSSID, - bitrate, strength, frequency, mode), где значения могут быть None. - - Raises: - Exception: Если произошла ошибка при получении данных точки доступа. - """ - active_ap = await wifi_device.active_access_point - wifi_info = { - "ssid": None, - "bssid": None, - "bitrate": await wifi_device.bitrate, - "strength": None, - "frequency": None, - "mode": None, - } - if active_ap != "/": - ap = AccessPoint(active_ap, self.system_bus) - wifi_info.update({ - "ssid": await ap.ssid, - "bssid": await ap.hw_address, - "strength": await ap.strength, - "frequency": await ap.frequency, - "mode": await ap.mode, - }) - return wifi_info
- - -
-[docs] - async def get_network_interfaces( - self, - initial_positions: Dict[str, Tuple[int, int]] = None - ) -> List[Union[NetworkInterface, WiFiDevice]]: - """Получает список сетевых интерфейсов. - - Args: - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None (используются (100, 100)). - - Returns: - List[Union[NetworkInterface, WiFiDevice]]: Список объектов интерфейсов, - включая Wi-Fi устройства. - - Исключает интерфейсы типа LOOPBACK и неактивные состояния (state == "10"). - """ - devices_paths = await self.nm.get_devices() - network_interfaces = [] - initial_positions = initial_positions or {} - - for device_path in devices_paths: - generic_device = NetworkDeviceGeneric(device_path, self.system_bus) - interface_name = str(await generic_device.interface) - device_type = DeviceType(await generic_device.device_type).name - - if device_type == "LOOPBACK": - continue - - device_state = str(await generic_device.state) - if device_state == "10": - continue - - common_data = { - "name": interface_name, - "type": device_type, - "device_state": device_state, - "active_connection": await self.get_connection_name(generic_device), - "mac_address": str(await generic_device.hw_address), - "device_mtu": str(await generic_device.mtu), - "ipv4": IPConfig(configurations=await self.get_ip_config(generic_device, "4")), - "ipv6": IPConfig(configurations=await self.get_ip_config(generic_device, "6")), - "x": initial_positions.get(interface_name, (100, 100))[0], - "y": initial_positions.get(interface_name, (100, 100))[1], - } - - if device_type == "WIFI": - wifi_device = NetworkDeviceWireless(device_path, self.system_bus) - wifi_info = await self.get_wifi_info(wifi_device) - network_interfaces.append(WiFiDevice(**common_data, **wifi_info)) - else: - network_interfaces.append(NetworkInterface(**common_data)) - - return network_interfaces
- - -
-[docs] - async def get_hostname(self) -> Dict[str, str]: - """Возвращает имя хоста из команды hostname в формате JSON. - - Returns: - Dict[str, str]: Словарь с ключом "hostname" и значением имени хоста. - - Raises: - RuntimeError: Если произошла ошибка при выполнении команды hostname - или обработке вывода. - """ - try: - result = subprocess.run(["hostname"], - capture_output=True, - text=True, - check=True) - hostname = result.stdout.strip() - return {"hostname": hostname} - except subprocess.CalledProcessError as e: - raise RuntimeError(self.translations.gettext("Не удалось выполнить команду hostname: {error}").format(error=str(e))) - except Exception as e: - raise RuntimeError(self.translations.gettext("Ошибка обработки вывода hostname: {error}").format(error=str(e)))
- - -
-[docs] - async def get_interfaces_by_state( - self, - state: str, - initial_positions: Dict[str, Tuple[int, int]] = None - ) -> List[NetworkInterface]: - """Получает список интерфейсов по указанному состоянию. - - Args: - state (str): Состояние интерфейса (например, "100" для активных). - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None. - - Returns: - List[NetworkInterface]: Список интерфейсов с указанным состоянием. - """ - all_interfaces = await self.get_network_interfaces(initial_positions) - return [ - interface for interface in all_interfaces - if interface.device_state == state - ]
- - -
-[docs] - async def get_interfaces_container( - self, - state: Optional[str] = None, - initial_positions: Dict[str, Tuple[int, int]] = None, - container_x: int = 0, - container_y: int = 0, - ) -> NetworkInterfacesContainer: - """Получает объект, содержащий список интерфейсов и координаты контейнера. - - Args: - state (Optional[str], optional): Состояние интерфейсов (например, "100"). - По умолчанию None (все интерфейсы). - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None. - container_x (int, optional): Координата X контейнера. По умолчанию 0. - container_y (int, optional): Координата Y контейнера. По умолчанию 0. - - Returns: - NetworkInterfacesContainer: Объект с интерфейсами и координатами контейнера. - """ - if state: - interfaces = await self.get_interfaces_by_state(state, initial_positions) - else: - interfaces = await self.get_network_interfaces(initial_positions) - return NetworkInterfacesContainer(interfaces=interfaces, - container_x=container_x, - container_y=container_y)
- - -
-[docs] - async def get_network_interfaces_container( - self, - initial_positions: Optional[Dict[str, Tuple[int, int]]] = None, - ) -> NetworkInterfacesContainer: - """Получает контейнер с сетевыми интерфейсами и координатами контейнера. - - Args: - initial_positions (Optional[Dict[str, Tuple[int, int]]], optional): - Словарь начальных координат (x, y) для интерфейсов. По умолчанию None. - - Returns: - NetworkInterfacesContainer: Объект с интерфейсами и координатами (0, 0). - """ - interfaces = await self.get_network_interfaces(initial_positions) - return NetworkInterfacesContainer(interfaces=interfaces, - container_x=0, - container_y=0)
- - -
-[docs] - async def get_activated_interfaces( - self, - initial_positions: Dict[str, Tuple[int, int]] = None - ) -> List[NetworkInterface]: - """Получает список активных сетевых интерфейсов. - - Args: - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None. - - Returns: - List[NetworkInterface]: Список активных интерфейсов (state == "100"). - """ - return await self.get_interfaces_by_state("100", initial_positions)
- - -
-[docs] - async def get_deactivated_interfaces( - self, - initial_positions: Dict[str, Tuple[int, int]] = None - ) -> List[NetworkInterface]: - """Получает список неактивных сетевых интерфейсов. - - Args: - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None. - - Returns: - List[NetworkInterface]: Список интерфейсов с state != "100". - """ - all_interfaces = await self.get_network_interfaces(initial_positions) - return [ - interface for interface in all_interfaces - if interface.device_state != "100" - ]
- - -
-[docs] - async def get_activated_interfaces_container( - self, - initial_positions: Dict[str, Tuple[int, int]] = None, - container_x: int = 0, - container_y: int = 0, - ) -> NetworkInterfacesContainer: - """Получает объект, содержащий список активных интерфейсов и координаты контейнера. - - Args: - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None. - container_x (int, optional): Координата X контейнера. По умолчанию 0. - container_y (int, optional): Координата Y контейнера. По умолчанию 0. - - Returns: - NetworkInterfacesContainer: Объект с активными интерфейсами и координатами. - """ - return await self.get_interfaces_container("100", initial_positions, container_x, container_y)
- - -
-[docs] - async def get_deactivated_interfaces_container( - self, - initial_positions: Dict[str, Tuple[int, int]] = None, - container_x: int = 0, - container_y: int = 0, - ) -> NetworkInterfacesContainer: - """Получает объект, содержащий список неактивных интерфейсов и координаты контейнера. - - Args: - initial_positions (Dict[str, Tuple[int, int]], optional): Словарь начальных - координат (x, y) для интерфейсов. По умолчанию None. - container_x (int, optional): Координата X контейнера. По умолчанию 0. - container_y (int, optional): Координата Y контейнера. По умолчанию 0. - - Returns: - NetworkInterfacesContainer: Объект с неактивными интерфейсами и координатами. - """ - interfaces = await self.get_deactivated_interfaces(initial_positions) - return NetworkInterfacesContainer(interfaces=interfaces, container_x=container_x, container_y=container_y)
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/settings_service.html b/SRV/docs/_build/html/_modules/services/settings_service.html deleted file mode 100644 index 5caff6b..0000000 --- a/SRV/docs/_build/html/_modules/services/settings_service.html +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - - - services.settings_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.settings_service

-import json
-import logging
-from typing import Optional
-
-from utils.i18n import get_translations
-from babel.support import Translations
-from fastapi import Depends
-from pathlib import Path
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-
-[docs] -class SettingsService: - """Сервис для управления настройками и очистки данных сети.""" - - def __init__(self, translations: Translations = Depends(get_translations())): - self.subnet_base_path = "storage/subnets" - self.wifi_file = "storage/wifi/wifi.json" - self.translations = translations - -
-[docs] - def clear_subnet(self, subnet: Optional[str] = None) -> bool: - """Очищает данные узлов подсети в указанном файле или во всех файлах. - - Args: - subnet (Optional[str]): Подсеть в формате CIDR (например, "10.1.1.0/24"). - Если None, очищает все подсети. - - Returns: - bool: True, если очистка успешна. - - Raises: - Exception: Если произошла ошибка при записи в файл. - """ - try: - if subnet: - file_path = Path(self.subnet_base_path) / f"{subnet.replace('/', '_')}.json" - if file_path.exists(): - with open(file_path, "w") as f: - json.dump([], f) - logger.info(f"Subnet nodes data cleared for {subnet}") - else: - logger.info(f"Subnet file not found for {subnet}, clearing considered successful") - return True - else: - for file_path in Path(self.subnet_base_path).glob("*.json"): - with open(file_path, "w") as f: - json.dump([], f) - logger.info(f"Cleared subnet data in {file_path}") - return True - except FileNotFoundError: - logger.info("No subnet files found, clearing considered successful") - return True - except Exception as e: - logger.error(f"Error clearing subnet nodes: {str(e)}") - raise Exception(self.translations.gettext("Ошибка очистки узлов подсети: {error}").format(error=str(e)))
- - -
-[docs] - def clear_wifi(self) -> bool: - """Очищает данные точек доступа Wi-Fi в файле wifi.json. - - Returns: - bool: True, если очистка успешна. - - Raises: - Exception: Если произошла ошибка при записи в файл. - """ - try: - with open(self.wifi_file, "w") as f: - json.dump([], f) - logger.info("Wi-Fi access points data successfully cleared") - return True - except FileNotFoundError: - logger.info("Wi-Fi file not found, clearing considered successful") - return True - except Exception as e: - logger.error(f"Error clearing Wi-Fi access points: {str(e)}") - raise Exception(self.translations.gettext("Ошибка очистки точек доступа Wi-Fi: {error}").format(error=str(e)))
- - -
-[docs] - def clear_all_data(self) -> bool: - """Очищает данные узлов всех подсетей и точек доступа Wi-Fi. - - Returns: - bool: True, если очистка успешна. - - Raises: - Exception: Если произошла ошибка при записи в один из файлов. - """ - try: - try: - for file_path in Path(self.subnet_base_path).glob("*.json"): - with open(file_path, "w") as f: - json.dump([], f) - logger.info(f"Cleared subnet data in {file_path}") - except FileNotFoundError: - logger.info("No subnet files found, clearing considered successful") - try: - with open(self.wifi_file, "w") as f: - json.dump([], f) - except FileNotFoundError: - logger.info("Wi-Fi file not found, clearing considered successful") - logger.info("All network data successfully cleared") - return True - except Exception as e: - logger.error(f"Error clearing all network data: {str(e)}") - raise Exception(self.translations.gettext("Ошибка очистки всех сетевых данных: {error}").format(error=str(e)))
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/subnet_service.html b/SRV/docs/_build/html/_modules/services/subnet_service.html deleted file mode 100644 index 03c03b3..0000000 --- a/SRV/docs/_build/html/_modules/services/subnet_service.html +++ /dev/null @@ -1,1095 +0,0 @@ - - - - - - - - services.subnet_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.subnet_service

-from scapy.config import conf
-from mac_vendor_lookup import MacLookup
-from typing import List, Optional, Tuple, Dict
-import socket
-import logging
-import netifaces
-import ipaddress
-from concurrent.futures import ThreadPoolExecutor
-import time
-from functools import lru_cache
-import json
-from pathlib import Path
-from datetime import datetime, timedelta
-import subprocess
-
-from scapy.layers.l2 import ARP, Ether
-from scapy.sendrecv import srp
-from utils.i18n import get_translations
-from babel.support import Translations
-from fastapi import Depends
-
-from models.subnet import SubnetScanResult, Device
-
-logging.basicConfig(
-    level=logging.INFO,
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-)
-logger = logging.getLogger(__name__)
-
-
-[docs] -def get_subnet_service(translations: Translations = Depends(get_translations())): - """Фабричная функция для создания экземпляра SubnetService. - - Использует зависимости FastAPI для получения объекта переводов и возвращает - экземпляр SubnetService с текущей локализацией. - - Args: - translations (Translations): Объект переводов для текущего языка. - - Returns: - SubnetService: Экземпляр сервиса для работы с подсетями. - """ - return SubnetService(translations)
- - -
-[docs] -class NetworkScanner: - """Класс для сканирования подсети с использованием ARP-запросов. - - Назначение: - Обнаруживает активные устройства в локальной сети, отправляя широковещательные - ARP-запросы по указанной подсети и собирая ответы (IP, MAC). - - Детали реализации: - - Использует `scapy` (`Ether` + `ARP`) для генерации пакетов и `srp` для - отправки/получения на канальном уровне от имени заданного интерфейса. - - Таймаут ожидания ответа короткий (2 секунды), ориентирован на интерактивные - сценарии UI. - - Ограничения и замечания: - - Требуются права для отправки низкоуровневых пакетов (capabilities/root). - - В сетях с фильтрацией широковещания количество обнаруженных устройств - может быть ограничено. - """ - def __init__(self, interface: str, translations: Translations): - """Инициализирует сканер сети. - - Устанавливает интерфейс для сканирования и объект переводов. - - Args: - interface (str): Имя сетевого интерфейса (например, "wlp0s20f3"). - translations (Translations): Объект переводов для текущего языка. - """ - self.interface = interface - conf.iface = interface - self.translations = translations - -
-[docs] - def scan(self, subnet: str) -> List[Tuple[str, str]]: - """Сканирует подсеть с использованием ARP-запросов. - - Отправляет ARP-пакеты для обнаружения активных устройств и возвращает - список кортежей (IP, MAC). - - Args: - subnet (str): Подсеть в формате CIDR (например, "10.1.1.0/24"). - - Returns: - List[Tuple[str, str]]: Список кортежей (IP-адрес, MAC-адрес) обнаруженных устройств. - - Raises: - Exception: Если произошла ошибка сканирования. - """ - try: - arp = ARP(pdst=subnet) - except Exception as e: - logger.error(f"Error checking status: {str(e)}") - try: - arp = ARP(pdst=subnet) - ether = Ether(dst="ff:ff:ff:ff:ff:ff") - packet = ether / arp - result = srp(packet, timeout=2, verbose=False, iface=self.interface)[0] - return [(received.psrc, received.hwsrc) for sent, received in result] - except Exception as e: - logger.error(f"Error scanning subnet {subnet}: {str(e)}") - return []
-
- - -
-[docs] -class PortScanner: - """Класс для сканирования открытых портов на устройствах. - - Назначение: - Плейсхолдер для будущего функционала активного сканирования TCP/UDP-портов - у обнаруженных узлов. В текущей версии возвращает пустой список. - - План развития: - - Добавить неблокирующее сканирование наиболее распространённых портов - (22, 80, 443 и т.д.) с ограничением по времени. - - Настраиваемые профили глубины и скорости сканирования. - """ - def __init__(self, interface: str, translations: Translations): - """Инициализирует сканер портов. - - Устанавливает интерфейс для сканирования и объект переводов. - - Args: - interface (str): Имя сетевого интерфейса. - translations (Translations): Объект переводов для текущего языка. - """ - self.interface = interface - self.translations = translations - -
-[docs] - def scan(self, ip: str) -> List[str]: - """Сканирует открытые порты на указанном IP-адресе. - - Пока возвращает пустой список, так как функциональность не реализована. - - Args: - ip (str): IP-адрес устройства для сканирования. - - Returns: - List[str]: Список открытых портов (пока пустой). - """ - return []
-
- - -
-[docs] -class DeviceInfoCollector: - """Класс для сбора информации об устройствах, включая вендоров и хостнеймы. - - Источники данных: - - MacLookup: сопоставление префикса MAC (OUI) с названием производителя. - - DNS: `gethostbyaddr` с малым таймаутом для обратного разрешения имени. - - NetBIOS (nbtscan): опрос сегмента сети для извлечения NetBIOS-имён. - - Политика кэширования: - - Результаты `get_vendor` кэшируются с помощью `functools.lru_cache`. - - Результаты `nbtscan` аккумулируются в словарях `nbtscan_cache`/`nbtscan_results` - на время жизни экземпляра. - """ - def __init__(self, translations: Translations): - """Инициализирует коллектор информации об устройствах. - - Настраивает кэширование и объект переводов. - - Args: - translations (Translations): Объект переводов для текущего языка. - """ - self.mac_lookup = MacLookup() - self.nbtscan_cache = {} - self.nbtscan_results = {} - self.translations = translations - -
-[docs] - @lru_cache(maxsize=1000) - def get_vendor(self, mac: str) -> str: - """Получает вендора устройства по MAC-адресу. - - Использует кэширование для повышения производительности. - - Args: - mac (str): MAC-адрес устройства. - - Returns: - str: Название вендора или "Неизвестный" в случае ошибки. - """ - try: - return self.mac_lookup.lookup(mac) - except Exception as e: - logger.warning(f"Failed to determine vendor for MAC {mac}: {str(e)}") - return self.translations.gettext("Неизвестный")
- - -
-[docs] - def scan_nbtscan(self, subnet: str) -> None: - """Сканирует подсеть с помощью nbtscan для получения хостнеймов. - - Сохраняет результаты в кэш и логирует процесс. - - Args: - subnet (str): Подсеть в формате CIDR. - """ - if subnet not in self.nbtscan_results: - try: - logger.debug(f"Starting nbtscan for subnet {subnet}") - result = subprocess.run(["sudo", "nbtscan", "-r", str(subnet)], - capture_output=True, - text=True, - check=False, - timeout=10) - logger.debug(f"Full nbtscan output: {result.stdout}") - if result.returncode == 0: - for line in result.stdout.splitlines(): - logger.debug(f"Processing line: {line}") - if not line.startswith(("IP address", "-", "Doing NBT")): - parts = [p for p in line.split() if p] - if len(parts) >= 2: - ip_addr, hostname = parts[0], parts[1] - if hostname != "<unknown>": - self.nbtscan_cache[ip_addr] = hostname - logger.info(f"NetBIOS: Found hostname {hostname} for IP {ip_addr}") - self.nbtscan_results[subnet] = True - except subprocess.TimeoutExpired: - logger.error(f"NetBIOS: Timeout for subnet {subnet}") - except Exception as e: - logger.error(f"NetBIOS: Error for subnet {subnet}: {str(e)}")
- - -
-[docs] - def get_hostname(self, ip: str) -> Optional[str]: - """Получает хостнейм для указанного IP-адреса. - - Пробует сначала DNS, затем NetBIOS. - - Args: - ip (str): IP-адрес устройства. - - Returns: - Optional[str]: Хостнейм или None, если не удалось определить. - """ - try: - socket.setdefaulttimeout(2) - return socket.gethostbyaddr(ip)[0] - except (socket.herror, socket.gaierror, socket.timeout): - logger.debug(f"DNS: Failed to resolve name for IP {ip}") - - subnet = ipaddress.ip_network(f"{ip}/24", strict=False) - if subnet not in self.nbtscan_results: - self.scan_nbtscan(str(subnet)) - - if ip in self.nbtscan_cache: - return self.nbtscan_cache[ip] - - logger.debug(f"Failed to determine hostname for IP {ip} via DNS or NetBIOS") - return None
-
- - -
-[docs] -class DeviceStorage: - """Класс для хранения и управления данными об устройствах. - - Формат файла подсети: - JSON-структура вида - { - "devices": [Device, ...] - } - - Политика очистки: - - Метод `_clean_old_devices` удаляет оффлайн-устройства, не наблюдавшиеся - более 7 дней, чтобы поддерживать актуальность списка. - """ - def __init__(self, base_path: str = "storage/subnets", translations: Translations = None): - """Инициализирует хранилище устройств. - - Создаёт директорию, если её нет, и задаёт параметры очистки. - - Args: - base_path (str): Путь к директории хранения данных. - translations (Translations, optional): Объект переводов. - """ - self.base_path = Path(base_path) - self.base_path.mkdir(parents=True, exist_ok=True) - self.offline_timeout = timedelta(days=7) - self.translations = translations or Translations.load("locales", ["ru"], "messages") # Fallback на русский - -
-[docs] - def get_subnet_file(self, subnet: str) -> Path: - """Возвращает путь к файлу для конкретной подсети. - - Заменяет символы '/' на '_' для корректного имени файла. - - Args: - subnet (str): Подсеть в формате CIDR. - - Returns: - Path: Путь к файлу. - """ - sanitized_subnet = subnet.replace("/", "_") - return self.base_path / f"{sanitized_subnet}.json"
- - -
-[docs] - def load_devices(self, subnet: str) -> Dict[str, Device]: - """Загружает устройства для указанной подсети. - - Читает данные из JSON-файла и фильтрует устаревшие устройства. - - Args: - subnet (str): Подсеть в формате CIDR. - - Returns: - Dict[str, Device]: Словарь устройств с MAC как ключом. - """ - file_path = self.get_subnet_file(subnet) - try: - if file_path.exists(): - with open(file_path, "r", encoding="utf-8") as f: - data = json.load(f) - if not isinstance(data, dict) or "devices" not in data: - logger.warning(f"Invalid JSON structure in {file_path}, expected {'devices': [...]}, got {data}") - return {} - devices = {} - for device_data in data.get("devices", []): - device = Device(**device_data) - if device.mac: - devices[device.mac] = device - return self._clean_old_devices(devices) - return {} - except json.JSONDecodeError as e: - logger.error(f"JSON decode error in {file_path}: {str(e)}") - return {} - except Exception as e: - logger.error(f"Error loading devices for subnet {subnet}: {str(e)}") - return {}
- - - def _clean_old_devices(self, devices: Dict[str, Device]) -> Dict[str, Device]: - """Очищает список устройств от устаревших оффлайн-устройств. - - Удаляет устройства, которые оффлайн более 7 дней. - - Args: - devices (Dict[str, Device]): Словарь устройств. - - Returns: - Dict[str, Device]: Отфильтрованный словарь устройств. - """ - now = datetime.now() - filtered = {} - for mac, device in devices.items(): - if device.status == "offline" and device.last_seen: - try: - last_seen = datetime.fromisoformat(device.last_seen) - if now - last_seen <= self.offline_timeout: - filtered[mac] = device - else: - logger.info(f"Removed device {mac} (offline > 7 days)") - except ValueError: - logger.warning(f"Invalid last_seen format for device {mac}") - else: - filtered[mac] = device - return filtered - -
-[docs] - def save_devices(self, subnet: str, devices: List[Device]) -> None: - """Сохраняет устройства для указанной подсети. - - Записывает данные в JSON-файл. - - Args: - subnet (str): Подсеть в формате CIDR. - devices (List[Device]): Список устройств для сохранения. - - Raises: - Exception: Если произошла ошибка при сохранении. - """ - file_path = self.get_subnet_file(subnet) - try: - data = SubnetScanResult(devices=devices).model_dump() - with open(file_path, "w", encoding="utf-8") as f: - json.dump(data, f, indent=2, ensure_ascii=False) - logger.info(f"Saved {len(devices)} devices to {file_path}") - except Exception as e: - logger.error(f"Error saving devices for subnet {subnet}: {str(e)}") - if self.translations: - raise Exception(self.translations.gettext("Ошибка при сохранении устройств: {error}").format(error=str(e))) - else: - raise Exception(f"Ошибка при сохранении устройств: {str(e)}")
-
- - -
-[docs] -class SubnetService: - """Сервис для сканирования подсетей и управления устройствами. - - Роль сервиса: - Объединяет сетевое сканирование (ARP), сбор дополнительной информации - (вендор, хостнейм), слияние с кэшем предыдущих результатов и персистентное - хранение данных по подсетям. Предоставляет вспомогательные операции для - локального узла и работы с заметками устройств. - - Поток выполнения скана (`scan_subnet`): - 1) Определение подсети (вручную или авто по интерфейсу). - 2) Загрузка ранее сохранённых устройств подсети. - 3) Добавление локального устройства (если принадлежит подсети). - 4) ARP-сканирование и параллельная обработка узлов (обогащение данных). - 5) Маркировка оффлайн-узлов из кэша, не встреченных в текущем скане. - 6) Сортировка по IP и сохранение объединённого списка в JSON. - """ - def __init__(self, translations: Translations): - """Инициализирует сервис подсети. - - Настраивает интерфейс, сканеры и хранилище с текущей локализацией. - - Args: - translations (Translations): Объект переводов для текущего языка. - """ - self.interface = self._get_default_interface() - self.network_scanner = NetworkScanner(self.interface, translations) - self.port_scanner = PortScanner(self.interface, translations) - self.device_info = DeviceInfoCollector(translations) - self.storage = DeviceStorage(translations=translations) - self.translations = translations - logger.info(f"Initialized SubnetService with interface: {self.interface}") - - def _get_default_interface(self) -> str: - """Определяет интерфейс по умолчанию. - - Использует информацию о шлюзе или первый доступный интерфейс. - - Returns: - str: Имя интерфейса (например, "wlp0s20f3" или "eth0"). - - Raises: - Exception: Если не удалось определить интерфейс. - """ - try: - gateways = netifaces.gateways() - default_gateway = gateways.get("default", {}).get(netifaces.AF_INET) - if default_gateway: - iface = default_gateway[1] - logger.info(f"Default interface from gateway: {iface}") - return iface - interfaces = netifaces.interfaces() - for iface in interfaces: - if iface != "lo": - addrs = netifaces.ifaddresses(iface) - if netifaces.AF_INET in addrs: - logger.info(f"Selected interface: {iface}") - return iface - logger.warning("No suitable interface found, defaulting to eth0") - return "eth0" - except Exception as e: - logger.warning(f"Failed to determine interface: {str(e)}, defaulting to eth0") - return "eth0" - - def _get_default_subnet(self) -> str: - """Автоматически определяет подсеть локального устройства. - - Использует информацию о текущем интерфейсе для определения подсети. - - Returns: - str: Подсеть в формате CIDR (например, "10.1.1.0/24"). - - Raises: - Exception: Если не удалось определить подсеть. - """ - try: - interfaces = netifaces.interfaces() - for iface in interfaces: - if iface == "lo" or iface != self.interface: - continue - addrs = netifaces.ifaddresses(iface) - if netifaces.AF_INET in addrs: - ip_info = addrs[netifaces.AF_INET][0] - ip = ip_info["addr"] - netmask = ip_info["netmask"] - # Преобразуем маску из строки (например, "255.255.255.0") в CIDR - mask = ipaddress.ip_network(f"0.0.0.0/{netmask}", strict=False).prefixlen - network = ipaddress.ip_network(f"{ip}/{mask}", strict=False) - logger.info(f"Auto-detected subnet: {network} (IP: {ip}, Mask: {netmask} -> /{mask})") - return str(network) - logger.warning("No suitable subnet found, defaulting to 0.0.0.0/0") - return "0.0.0.0/0" - except Exception as e: - logger.error(f"Error determining default subnet: {str(e)}") - return "0.0.0.0/0" - -
-[docs] - def scan_subnet(self, subnet: Optional[str] = None) -> SubnetScanResult: - """Сканирует указанную подсеть и возвращает результаты. - - Выполняет ARP-сканирование, собирает информацию о устройствах и сохраняет данные. - - Args: - subnet (Optional[str]): Подсеть в формате CIDR (например, "10.1.1.0/24"). - Если None или пустая строка, определяется автоматически. - - Returns: - SubnetScanResult: Объект с результатами сканирования, содержащий список - устройств или сообщение об ошибке. - - Raises: - Exception: Если произошла ошибка сканирования. - """ - start_time = time.time() - devices = [] - now = datetime.now().astimezone() - formatted_now = now.strftime("%d-%m-%Y, %H:%M") - try: - # Определяем подсеть, если не указана или пустая - if not subnet or subnet.strip() == "": - subnet = self._get_default_subnet() - if subnet == "0.0.0.0/0": - logger.warning("Default subnet is invalid, scan aborted") - return SubnetScanResult(devices=devices, error=self.translations.gettext("Недопустимая подсеть по умолчанию")) - - saved_devices = self.storage.load_devices(subnet) - - local_device = self._get_local_device(subnet) - if local_device: - local_device.status = "online" - local_device.last_seen = formatted_now - devices.append(local_device) - if local_device.mac: - saved_devices[local_device.mac] = local_device - logger.info(f"Detected local device: {local_device.ip}, MAC: {local_device.mac}") - - logger.info(f"Scanning subnet: {subnet} with interface: {self.interface}") - discovered_devices = self.network_scanner.scan(subnet) - logger.info(f"Discovered devices: {len(discovered_devices)}") - self.device_info.scan_nbtscan(subnet) - - if not discovered_devices and not local_device: - logger.warning(f"No devices found in subnet {subnet}") - return SubnetScanResult(devices=[], error=self.translations.gettext("В данной подсети не обнаружено устройств")) - - def process_device(ip_mac: Tuple[str, str]) -> Optional[Device]: - ip, mac = ip_mac - if local_device and ip == local_device.ip: - return None - - existing_device = saved_devices.get(mac) - if existing_device: - return Device( - ip=ip, - mac=mac, - hostname=self.device_info.get_hostname(ip) or existing_device.hostname, - vendor=self.device_info.get_vendor(mac), - open_ports=existing_device.open_ports, - status="online", - last_seen=formatted_now, - note=existing_device.note, - ) - vendor = self.device_info.get_vendor(mac) - hostname = self.device_info.get_hostname(ip) - return Device( - ip=ip, - mac=mac, - hostname=hostname, - vendor=vendor, - open_ports=[], - status="online", - last_seen=formatted_now, - note=None, - ) - - with ThreadPoolExecutor(max_workers=10) as executor: - device_results = executor.map(process_device, discovered_devices) - devices.extend([d for d in device_results if d is not None]) - - active_macs = {d.mac for d in devices if d.mac} - for mac, device in saved_devices.items(): - if mac not in active_macs: - device.status = "offline" - devices.append(device) - - devices.sort(key=lambda x: int(ipaddress.IPv4Address(x.ip))) - - for device in devices: - if device.mac: - saved_devices[device.mac] = device - self.storage.save_devices(subnet, list(saved_devices.values())) - - logger.info( - f"Subnet scan {subnet} completed in {time.time() - start_time:.2f} seconds, " - f"found {len(devices)} devices (active: {len(active_macs)})" - ) - return SubnetScanResult(devices=devices) - - except Exception as e: - logger.error(f"Error scanning subnet {subnet}: {str(e)}") - return SubnetScanResult(devices=devices, error=self.translations.gettext("Ошибка сканирования: {error}").format(error=str(e)))
- - - def _get_local_device(self, subnet: str) -> Optional[Device]: - """Определяет локальное устройство в указанной подсети. - - Использует информацию об интерфейсе для обнаружения. - - Args: - subnet (str): Подсеть в формате CIDR. - - Returns: - Optional[Device]: Объект устройства или None, если не найдено. - """ - now = datetime.now().astimezone() - formatted_now = now.strftime("%d-%m-%Y, %H:%M") - try: - subnet_network = ipaddress.ip_network(subnet, strict=False) - interfaces = netifaces.interfaces() - for iface in interfaces: - if iface == "lo": - continue - addrs = netifaces.ifaddresses(iface) - if netifaces.AF_INET in addrs and netifaces.AF_LINK in addrs: - ip = addrs[netifaces.AF_INET][0]["addr"] - if ipaddress.ip_address(ip) in subnet_network: - mac = addrs[netifaces.AF_LINK][0]["addr"] - vendor = self.device_info.get_vendor(mac) - hostname = self.device_info.get_hostname(ip) - logger.info(f"Local device detected: IP={ip}, MAC={mac}, Interface={iface}") - return Device( - ip=ip, - mac=mac, - hostname=hostname, - vendor=vendor, - open_ports=[], - status="online", - last_seen=formatted_now, - note=None, - ) - logger.warning(f"Local device not found in subnet {subnet}") - return None - except Exception as e: - logger.warning(f"Failed to get local device: {str(e)}") - return None - -
-[docs] - def add_note(self, mac: str, note: str, translations: Translations) -> Tuple[bool, Optional[Tuple[str, Dict]]]: - """Добавляет заметку для устройства по MAC-адресу. - - Привязывает заметку к устройству, если оно существует. - - Args: - mac (str): MAC-адрес устройства. - note (str): Текст заметки. - translations (Translations): Объект переводов для текущего языка. - - Returns: - Tuple[bool, Optional[Tuple[str, Dict]]]: Кортеж (успех, результат), - где результат содержит код ошибки/успеха и данные. - """ - try: - saved_devices = {} - for subnet in self.storage.base_path.glob("*.json"): - devices = self.storage.load_devices(subnet.stem.replace("_", "/")) - saved_devices.update(devices) - if mac not in saved_devices: - logger.warning(f"Device with MAC {mac} not found") - return False, ("not_found", {"mac": mac}) - if saved_devices[mac].note is not None: - logger.error(f"Note for device with MAC {mac} already exists") - return False, ("note_exists", {"mac": mac}) - for subnet_file in self.storage.base_path.glob("*.json"): - subnet = subnet_file.stem.replace("_", "/") - devices = self.storage.load_devices(subnet) - if mac in devices: - devices[mac].note = note - self.storage.save_devices(subnet, list(devices.values())) - break - logger.info(f"Added note '{note}' for device with MAC {mac}") - return True, ("success", {"mac": mac, "note": note}) - except Exception as e: - logger.error(f"Error adding note for MAC {mac}: {str(e)}") - return False, ("internal_error", {"error": str(e)})
- - -
-[docs] - def update_note(self, mac: str, note: str, translations: Translations) -> Tuple[bool, Optional[Tuple[str, Dict]]]: - """Обновляет заметку для устройства по MAC-адресу. - - Изменяет существующую заметку, если она есть. - - Args: - mac (str): MAC-адрес устройства. - note (str): Новый текст заметки. - translations (Translations): Объект переводов для текущего языка. - - Returns: - Tuple[bool, Optional[Tuple[str, Dict]]]: Кортеж (успех, результат), - где результат содержит код ошибки/успеха и данные. - """ - try: - saved_devices = {} - for subnet in self.storage.base_path.glob("*.json"): - devices = self.storage.load_devices(subnet.stem.replace("_", "/")) - saved_devices.update(devices) - if mac not in saved_devices: - logger.warning(f"Device with MAC {mac} not found") - return False, ("not_found", {"mac": mac}) - if saved_devices[mac].note is None: - logger.error(f"Note for device with MAC {mac} does not exist") - return False, ("note_not_exists", {"mac": mac}) - for subnet_file in self.storage.base_path.glob("*.json"): - subnet = subnet_file.stem.replace("_", "/") - devices = self.storage.load_devices(subnet) - if mac in devices: - devices[mac].note = note - self.storage.save_devices(subnet, list(devices.values())) - break - logger.info(f"Updated note '{note}' for device with MAC {mac}") - return True, ("success", {"mac": mac, "note": note}) - except Exception as e: - logger.error(f"Error updating note for MAC {mac}: {str(e)}") - return False, ("internal_error", {"error": str(e)})
- - -
-[docs] - def delete_note(self, mac: str, translations: Translations) -> Tuple[bool, Optional[Tuple[str, Dict]]]: - """Удаляет заметку для устройства по MAC-адресу. - - Удаляет привязанную заметку, если она существует. - - Args: - mac (str): MAC-адрес устройства. - translations (Translations): Объект переводов для текущего языка. - - Returns: - Tuple[bool, Optional[Tuple[str, Dict]]]: Кортеж (успех, результат), - где результат содержит код ошибки/успеха и данные. - """ - try: - saved_devices = {} - for subnet in self.storage.base_path.glob("*.json"): - devices = self.storage.load_devices(subnet.stem.replace("_", "/")) - saved_devices.update(devices) - if mac not in saved_devices: - logger.warning(f"Device with MAC {mac} not found") - return False, ("not_found", {"mac": mac}) - if saved_devices[mac].note is None: - logger.error(f"Note for device with MAC {mac} does not exist") - return False, ("note_not_exists", {"mac": mac}) - for subnet_file in self.storage.base_path.glob("*.json"): - subnet = subnet_file.stem.replace("_", "/") - devices = self.storage.load_devices(subnet) - if mac in devices: - devices[mac].note = None - self.storage.save_devices(subnet, list(devices.values())) - break - logger.info(f"Deleted note for device with MAC {mac}") - return True, ("success", {"mac": mac}) - except Exception as e: - logger.error(f"Error deleting note for MAC {mac}: {str(e)}") - return False, ("internal_error", {"error": str(e)})
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/ufw_service.html b/SRV/docs/_build/html/_modules/services/ufw_service.html deleted file mode 100644 index 3afe7f0..0000000 --- a/SRV/docs/_build/html/_modules/services/ufw_service.html +++ /dev/null @@ -1,754 +0,0 @@ - - - - - - - - services.ufw_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.ufw_service

-import ipaddress
-import subprocess
-from typing import List, Union
-
-from models.ufw import Direction, Protocol, UFWRule, UFWRulesResponse, UFWStatus
-
-DEBUG = True
-
-
-
-[docs] -class UFWService: - """Сервис взаимодействия с UFW (Uncomplicated Firewall). - - Назначение: - - Чтение статуса и списка правил брандмауэра. - - Добавление, удаление и массовая обработка правил с поддержкой диапазонов портов, - комментариев и выбором протоколов. - - Детали реализации: - - Команды выполняются через `sudo ufw ...`; вывод парсится в модели pydantic. - - Для операций удаления соблюдается порядок с конца, чтобы не нарушать нумерацию. - """ - - def _run_command(self, command: str) -> str: - """ - Выполняет команду в системе и возвращает ее вывод. - - Args: - command (str): Команда для выполнения в системе. - - Returns: - str: Вывод команды. - """ - try: - if DEBUG: - print(f"Running command: {command}") - - # Используем shell=True для корректной обработки аргументов с пробелами - result = subprocess.run( - f"sudo {command}", - shell=True, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, - text=True, - ) - - if DEBUG: - print(f"Command output: {result.stdout}") - print(f"Command error: {result.stderr}") - - if result.returncode != 0: - raise subprocess.CalledProcessError(result.returncode, command, - result.stdout, - result.stderr) - - return result.stdout - - except subprocess.CalledProcessError as e: - if DEBUG: - print(f"Command failed with return code {e.returncode}") - print(f"Error output: {e.stderr}") - raise Exception(f"Command failed: {e.stderr}") - - def _get_port_range_args(self, port: Union[int, str]) -> List[str]: - """ - Преобразует порт или диапазон портов в аргументы команды UFW. - - Args: - port: Порт (число) или диапазон портов (строка вида "3000:3999") - - Returns: - List[str]: Список аргументов для UFW - """ - if isinstance(port, int): - return [str(port)] - elif isinstance(port, str) and ":" in port: - # Диапазон портов уже в нужном формате - return [port] - else: - raise ValueError(f"Некорректный формат порта: {port}") - -
-[docs] - def get_ufw_rules(self) -> UFWRulesResponse: - """ - Получает список правил UFW. - - Returns: - UFWRulesResponse: Объект, содержащий статус UFW и список правил - """ - # Check UFW status - status_result = self._run_command("ufw status numbered") - lines = status_result.splitlines() - - if not lines: - return UFWRulesResponse(enabled=False, rules=[]) - - first_line = lines[0] - is_enabled = "Status: active" in first_line - - if not is_enabled: - return UFWRulesResponse(enabled=False, rules=[]) - - rules = [] - # Skip header lines - for line in lines[4:]: # Skip Status and header lines - if not line.strip() or not line.startswith("["): - continue - - try: - rule = UFWRule.from_ufw_output(line) - rules.append(rule) - except Exception as e: - if DEBUG: - print(f"Ошибка парсинга правила: {line}, ошибка: {str(e)}") - continue - - return UFWRulesResponse(enabled=is_enabled, rules=rules)
- - -
-[docs] - def get_ufw_status(self) -> UFWStatus: - """ - Проверяет статус UFW. - - Returns: - UFWStatus: Объект с информацией о статусе UFW - """ - try: - status_result = self._run_command("ufw status") - first_line = (status_result.splitlines()[0] - if status_result.splitlines() else "") - is_enabled = "Status: active" in first_line - - message = "UFW активен" if is_enabled else "UFW неактивен" - - if DEBUG: - print(f"Результат статуса: {status_result}") - print(f"Включен: {is_enabled}") - - return UFWStatus(enabled=is_enabled, message=message) - except Exception as e: - if DEBUG: - print(f"Ошибка при проверке статуса UFW: {e}") - return UFWStatus( - enabled=False, - message=f"Ошибка при проверке статуса: {str(e)}", - )
- - -
-[docs] - def enable_ufw(self) -> bool: - """ - Включает UFW. - - Returns: - bool: True если успешно включен, False в противном случае - """ - try: - self._run_command("ufw enable") - return True - except Exception as e: - if DEBUG: - print(f"Ошибка при включении UFW: {e}") - return False
- - -
-[docs] - def disable_ufw(self) -> bool: - """ - Выключает UFW. - - Returns: - bool: True если успешно выключен, False в противном случае - """ - try: - self._run_command("ufw disable") - return True - except Exception as e: - if DEBUG: - print(f"Ошибка при выключении UFW: {e}") - return False
- - -
-[docs] - def add_rules_base(self, - rules: List[UFWRule], - direction: str = "") -> bool: - """ - Базовый метод для добавления правил UFW. - - Args: - rules: Список правил для добавления - direction: Направление трафика ("in" или "out") - - Returns: - bool: True если все правила были успешно добавлены, False в противном случае - """ - try: - for rule in rules: - # Устанавливаем направление правила - rule.direction = Direction.IN if direction == "in" else Direction.OUT - - # Формируем базовую команду - command = f"ufw {rule.action.value}" - - # Добавляем направление - command += f" {rule.direction.value}" - - # Добавляем from IP если он указан - if rule.from_ip and rule.from_ip != "any": - command += f" from {rule.from_ip}" - else: - command += " from any" - - # Добавляем to IP если он указан - if rule.to_ip and rule.to_ip != "any": - command += f" to {rule.to_ip}" - else: - command += " to any" - - # Добавляем порт если он указан - if rule.port: - command += f" port {rule.port}" - - # Добавляем протокол - if rule.protocol != Protocol.BOTH: - command += f" proto {rule.protocol.value}" - - # Добавляем комментарий если он есть - if rule.comment: - command += f" comment '{rule.comment}'" - - self._run_command(command) - - return True - except Exception as e: - if DEBUG: - print(f"Error adding UFW rules: {str(e)}") - return False
- - -
-[docs] - def add_ufw_in_rules(self, rules: List[UFWRule]) -> bool: - """ - Добавляет входящие (in) правила UFW. - - Args: - rules (List[UFWRule]): Список правил для добавления - - Returns: - bool: True если все правила были успешно добавлены, False в противном случае - """ - return self.add_rules_base(rules, "in")
- - -
-[docs] - def add_ufw_out_rules(self, rules: List[UFWRule]) -> bool: - """ - Добавляет исходящие (out) правила UFW. - - Args: - rules (List[UFWRule]): Список правил для добавления - - Returns: - bool: True если все правила были успешно добавлены, False в противном случае - """ - return self.add_rules_base(rules, "out")
- - -
-[docs] - def add_rules(self, rules: List[UFWRule]) -> dict: - """ - Добавляет правила UFW. - - Args: - rules: Список правил для добавления - - Returns: - dict: Результат добавления правил - """ - results = [] - - for rule in rules: - try: - # Определяем версию IP - from_ip = ipaddress.ip_network(rule.from_ip, strict=False) - is_ipv6 = isinstance(from_ip, ipaddress.IPv6Network) - - # Получаем список протоколов - protocols = rule.protocol.protocols - print(f"Обработка правила для протоколов: {protocols}") - - for proto in protocols: - # Формируем базовую команду - command = f"ufw {rule.action.value}" - - # Добавляем IP адреса - command += f" from {rule.from_ip}" - if rule.to_ip: - command += f" to {rule.to_ip}" - - # Добавляем порт и протокол - port_args = self._get_port_range_args(rule.port) - command += f" port {' '.join(port_args)} proto {proto}" - - # Добавляем флаг IPv6 если нужно - if is_ipv6: - command += " v6" - - # Добавляем комментарий если есть - if rule.comment: - command += f" comment '{rule.comment}'" - - print(f"Подготовлена команда: {command}") - - # Выполняем команду - try: - output = self._run_command(command) - results.append({"success": True, "message": output}) - except Exception as e: - error_msg = f"Ошибка выполнения команды: {str(e)}" - print(error_msg) - results.append({ - "success": False, - "message": error_msg - }) - - except Exception as e: - error_msg = f"Ошибка при добавлении правила: {str(e)}" - print(error_msg) - results.append({"success": False, "message": error_msg}) - - # Выводим результаты - print("\nРезультаты добавления правил:") - for result in results: - status = "Успешно" if result["success"] else "Ошибка" - print(f" - {status}: {result['message']}") - - return {"success": True, "results": results}
- - -
-[docs] - def delete_rules(self, rule_numbers: List[int]) -> dict: - """ - Удаляет правила UFW по их номерам. - - Args: - rule_numbers (List[int]): Список номеров правил для удаления - - Returns: - dict: Результат операции удаления - """ - try: - # Проверяем существование правил - status_result = self._run_command("ufw status numbered") - lines = status_result.splitlines() - - # Пропускаем заголовок (первые 4 строки) - rules = [] - for line in lines[4:]: # Skip header lines - if not line.strip() or not line.startswith("["): - continue - - try: - # Извлекаем номер правила из строки [N] - rule_num = int(line[1:line.index("]")]) - rules.append(rule_num) - except (ValueError, IndexError): - continue - - if DEBUG: - print(f"Найдены правила: {rules}") - - results = [] - # Сортируем номера в обратном порядке, чтобы удаление происходило с конца - # Это предотвратит смещение номеров при удалении - for rule_number in sorted(rule_numbers, reverse=True): - try: - # Проверяем существует ли правило с таким номером - if rule_number not in rules: - results.append({ - "number": - rule_number, - "success": - False, - "error": - f"Правило с номером {rule_number} не найдено", - }) - continue - - # Удаляем правило - self._run_command(f"ufw --force delete {rule_number}") - - results.append({ - "number": - rule_number, - "success": - True, - "message": - f"Правило {rule_number} успешно удалено", - }) - - except Exception as e: - if DEBUG: - print( - f"Ошибка при удалении правила {rule_number}: {e}") - results.append({ - "number": rule_number, - "success": False, - "error": str(e) - }) - - # Подсчитываем статистику - total = len(rule_numbers) - successful = len([r for r in results if r["success"]]) - - return { - "success": True, - "total": total, - "successful": successful, - "results": results, - } - - except Exception as e: - if DEBUG: - print(f"Ошибка при удалении правил: {e}") - return {"success": False, "error": str(e), "results": []}
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/services/wifi_service.html b/SRV/docs/_build/html/_modules/services/wifi_service.html deleted file mode 100644 index 7c26610..0000000 --- a/SRV/docs/_build/html/_modules/services/wifi_service.html +++ /dev/null @@ -1,720 +0,0 @@ - - - - - - - - services.wifi_service - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for services.wifi_service

-import time
-import logging
-import subprocess
-import re
-from functools import lru_cache
-from typing import List, Optional, Dict, Tuple
-from mac_vendor_lookup import MacLookup
-import pywifi
-from models.wifi import WifiAccessPoint, WifiScanResult
-from pathlib import Path
-import json
-from utils.i18n import get_translations
-from babel.support import Translations
-from fastapi import Depends
-
-# Настройка логирования
-logging.basicConfig(
-    level=logging.DEBUG,
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-)
-logger = logging.getLogger(__name__)
-
-
-[docs] -class WifiStorage: - """Класс для хранения данных о Wi-Fi сетях и их заметках по SSID. - - Формат:: - - { - "networks": [{"ssid": str, "note": Optional[str]}] - } - - Поведение: - - - Создаёт директорию хранения при инициализации, ведёт логирование путей. - - Валидирует структуру при чтении и безопасно записывает JSON с Unicode и отступами. - """ - def __init__(self, storage_path: str = "storage/wifi/wifi.json", translations: Translations = Depends(get_translations())): - self.storage_file = Path(storage_path) - self.storage_file.parent.mkdir(parents=True, exist_ok=True) - self.translations = translations - logger.info(f"Wi-Fi storage initialized at: {self.storage_file.absolute()}") - -
-[docs] - def load_notes(self) -> Dict[str, Optional[str]]: - """Загружает заметки по SSID из файла хранения.""" - try: - if self.storage_file.exists(): - with open(self.storage_file, "r", encoding="utf-8") as f: - data = json.load(f) - if not isinstance(data, dict) or "networks" not in data: - logger.warning(f"Invalid JSON structure in {self.storage_file}, expected {'networks': [...]}, got {data}") - return {} - return {item["ssid"]: item.get("note") for item in data.get("networks", [])} - return {} - except json.JSONDecodeError as e: - logger.error(f"JSON decode error in {self.storage_file}: {str(e)}") - return {} - except Exception as e: - logger.error(f"Error loading notes from {self.storage_file}: {str(e)}") - return {}
- - -
-[docs] - def save_notes(self, notes: Dict[str, Optional[str]]) -> None: - """Сохраняет заметки по SSID в файл.""" - try: - data = {"networks": [{"ssid": ssid, "note": note} for ssid, note in notes.items()]} - with open(self.storage_file, "w", encoding="utf-8") as f: - json.dump(data, f, indent=2, ensure_ascii=False) - logger.info(f"Saved {len(notes)} notes to {self.storage_file.absolute()}") - except PermissionError as e: - logger.error(f"Permission denied writing to {self.storage_file}: {str(e)}") - raise - except Exception as e: - logger.error(f"Error saving notes to {self.storage_file}: {str(e)}") - raise Exception(self.translations.gettext("Ошибка при сохранении заметок: {error}").format(error=str(e)))
-
- - -
-[docs] -class WifiService: - """Сервис для сканирования текущих Wi-Fi точек доступа и заметок. - - Источники данных: - - `pywifi` для базового сканирования и получения списка AP. - - `iw dev <iface> scan` для уточнения частоты, сигнала и безопасности. - - `MacLookup` для определения вендора по BSSID. - - Политики: - - Выбор лучшего AP по SSID по уровню сигнала. - - Кэширование определения вендора. - - Сохранение SSID даже без заметок для будущих операций. - """ - def __init__(self, translations: Translations = Depends(get_translations())): - self.mac_lookup = MacLookup() - self.wifi = pywifi.PyWiFi() - self.interface = self._get_wifi_interface() - if not hasattr(translations, 'gettext'): - logger.warning("Translations object does not support gettext, using fallback") - self.translations = Translations.load("utils/locales/en/LC_MESSAGES/services.mo") - else: - self.translations = translations - self.storage = WifiStorage() - - def _get_wifi_interface(self) -> Optional[object]: - """Автоматически определяет активный Wi-Fi-интерфейс.""" - try: - interfaces = self.wifi.interfaces() - if not interfaces: - logger.error(self.translations.gettext("Не найдено сетевых интерфейсов")) - return None - - logger.debug(f"Available interfaces: {[iface.name() for iface in interfaces]}") - - for iface in interfaces: - iface_name = iface.name() - if "p2p" in iface_name.lower(): - logger.debug(f"Skipped interface {iface_name} (P2P)") - continue - try: - iface.scan() - time.sleep(1) - results = iface.scan_results() - if results: - logger.info(f"Selected Wi-Fi interface: {iface_name}") - return iface - logger.debug(f"Interface {iface_name} returned no scan results") - except Exception as e: - logger.debug(f"Interface {iface_name} inactive: {str(e)}") - - logger.error(self.translations.gettext("Не найден активный Wi-Fi-интерфейс")) - return None - except Exception as e: - logger.error(f"Error determining Wi-Fi interface: {str(e)}") - return None - -
-[docs] - @lru_cache(maxsize=1000) - def get_vendor(self, mac: str) -> str: - """Определяет вендора по MAC-адресу с использованием кэширования.""" - try: - return self.mac_lookup.lookup(mac) - except Exception as e: - logger.warning(f"Failed to determine vendor for MAC {mac}: {str(e)}") - return self.translations.gettext("Неизвестный")
- - - def _get_encryption_from_iw(self, ap_info: Dict) -> str: - """Определяет тип шифрования из данных, полученных через iw.""" - security = ap_info.get("security", "") - logger.debug(f"Encryption for BSSID {ap_info.get('bssid')}: {security}") - if "WPA3" in security: - return self.translations.gettext("WPA3") - elif "WPA2" in security or "RSN" in security: - return self.translations.gettext("WPA2") - elif "WPA" in security: - return self.translations.gettext("WPA") - elif "WEP" in security: - return self.translations.gettext("WEP") - return self.translations.gettext("Открытая") - - def _get_channel(self, frequency: Optional[int]) -> Optional[int]: - """Преобразует частоту в номер канала.""" - if frequency is None: - return None - try: - if 2412 <= frequency <= 2472: - return (frequency - 2412) // 5 + 1 - elif 5180 <= frequency <= 5825: - return (frequency - 5180) // 5 + 36 - logger.debug(f"Frequency {frequency} outside 2.4/5 GHz range") - return None - except Exception as e: - logger.debug(f"Error determining channel for frequency {frequency}: {str(e)}") - return None - - def _get_frequency(self, frequency: Optional[int]) -> Optional[str]: - """Определяет частотный диапазон на основе частоты.""" - if frequency is None: - return None - try: - if 2412 <= frequency <= 2472: - return self.translations.gettext("2.4 ГГц") - elif 5180 <= frequency <= 5825: - return self.translations.gettext("5 ГГц") - logger.debug(f"Frequency {frequency} outside 2.4/5 GHz range") - return None - except Exception as e: - logger.debug(f"Error determining band for frequency {frequency}: {str(e)}") - return None - - def _get_iw_scan_data(self) -> List[Dict]: - """Получает данные сканирования Wi-Fi через команду iw.""" - try: - if not self.interface: - logger.error(self.translations.gettext("Интерфейс не определён")) - return [] - cmd = ["sudo", "iw", "dev", self.interface.name(), "scan"] - logger.debug(f"Executing command: {' '.join(cmd)}") - result = subprocess.run(cmd, capture_output=True, text=True, timeout=10) - if result.returncode != 0: - logger.error(f"iw scan error: {result.stderr}") - return [] - output = result.stdout - logger.debug(f"iw scan output (first 500 chars): {output[:500]}...") - - aps = [] - current_ap = None - bssid_pattern = re.compile(r"BSS ([0-9a-f:]{17})") - ssid_pattern = re.compile(r"SSID: ?(.*)") - freq_pattern = re.compile(r"freq: (\d+)") - signal_pattern = re.compile(r"signal: ([-\d.]+) dBm") - rsn_pattern = re.compile(r"RSN:") - wpa_pattern = re.compile(r"WPA:") - security_type_pattern = re.compile(r"\* (WPA3|WPA2|WPA|WEP)") - - for line in output.splitlines(): - line = line.strip() - if bssid_match := bssid_pattern.match(line): - if current_ap: - aps.append(current_ap) - current_ap = {"bssid": bssid_match.group(1).lower(), "security": ""} - elif current_ap: - if ssid_match := ssid_pattern.match(line): - current_ap["ssid"] = ssid_match.group(1).strip() if ssid_match.group(1).strip() else "" - elif freq_match := freq_pattern.match(line): - current_ap["frequency"] = int(freq_match.group(1)) - elif signal_match := signal_pattern.match(line): - current_ap["signal"] = float(signal_match.group(1)) - elif rsn_pattern.match(line): - current_ap["security"] += "RSN;" - elif wpa_pattern.match(line): - current_ap["security"] += "WPA;" - elif security_type_match := security_type_pattern.search(line): - current_ap["security"] += security_type_match.group(1) + ";" - - if current_ap: - aps.append(current_ap) - - logger.debug(f"Found {len(aps)} access points via iw: {[ap['bssid'] for ap in aps]}") - return aps - except subprocess.CalledProcessError as e: - logger.error(f"Error executing iw scan: {e.stderr}") - return [] - except subprocess.TimeoutExpired: - logger.error(self.translations.gettext("Таймаут при выполнении iw scan")) - return [] - except Exception as e: - logger.error(f"Error parsing iw scan: {str(e)}") - return [] - -
-[docs] - def scan_wifi(self, timeout: int = 30) -> WifiScanResult: - """Сканирует текущие Wi-Fi точки доступа.""" - start_time = time.time() - aps = [] - - if not self.interface: - logger.error(self.translations.gettext("Wi-Fi-интерфейс не доступен")) - return WifiScanResult(access_points=aps) - - try: - logger.info(f"Starting Wi-Fi scan on interface {self.interface.name()}") - max_attempts = 3 - for attempt in range(max_attempts): - self.interface.scan() - time.sleep(min(timeout, 5)) - py_results = self.interface.scan_results() - if py_results: - logger.info(f"Found {len(py_results)} access points via pywifi after attempt {attempt + 1}") - break - else: - logger.warning(f"Scan attempt {attempt + 1} failed, trying again (FAIL-BUSY?)") - else: - logger.error("All scan attempts failed") - return WifiScanResult(access_points=aps) - - iw_results = self._get_iw_scan_data() - iw_by_bssid = {ap["bssid"]: ap for ap in iw_results if ap.get("bssid")} - - best_aps_by_ssid: Dict[str, WifiAccessPoint] = {} - saved_notes = self.storage.load_notes() - - for ap in py_results: - bssid = ap.bssid.lower() if ap.bssid else None - if not bssid: - logger.debug("Skipped access point without BSSID") - continue - ssid = ap.ssid if ap.ssid else f"Hidden_{bssid}" - hidden = not ap.ssid - signal = ap.signal if ap.signal else None - iw_data = iw_by_bssid.get(bssid, {}) - - frequency = iw_data.get("frequency") - channel = self._get_channel(frequency) - freq_band = self._get_frequency(frequency) - encryption = self._get_encryption_from_iw(iw_data) - vendor = self.get_vendor(bssid) - - current_ap = WifiAccessPoint( - ssid=ssid, - bssid=bssid, - channel=channel, - signal=signal if signal else iw_data.get("signal"), - encryption=encryption, - frequency=freq_band, - vendor=vendor, - hidden=hidden, - note=saved_notes.get(ssid) if ap.ssid else None, - ) - logger.debug(f"Processed AP: {current_ap.model_dump()}") - - if ssid not in best_aps_by_ssid or ( - current_ap.signal and best_aps_by_ssid[ssid].signal - and current_ap.signal > best_aps_by_ssid[ssid].signal): - current_ap.note = saved_notes.get(ssid) if ap.ssid else None - best_aps_by_ssid[ssid] = current_ap - - aps = list(best_aps_by_ssid.values()) - # Сохраняем хотя бы SSID, если заметок нет - notes_to_save = {ap.ssid: ap.note for ap in aps if ap.ssid} - if not notes_to_save and aps: - notes_to_save = {ap.ssid: None for ap in aps if ap.ssid} # Сохраняем SSID без заметок - if notes_to_save: - self.storage.save_notes(notes_to_save) - else: - logger.warning("No notes or SSIDs to save, skipping file write") - - logger.info(f"Wi-Fi scan completed, found {len(aps)} unique networks") - return WifiScanResult(access_points=aps) - - except Exception as e: - logger.error(f"Error scanning Wi-Fi: {str(e)}") - return WifiScanResult(access_points=aps)
- - -
-[docs] - def add_note(self, ssid: str, note: str) -> Tuple[bool, Optional[str]]: - """Добавляет заметку к сети Wi-Fi по SSID.""" - try: - saved_notes = self.storage.load_notes() - if ssid not in saved_notes or saved_notes[ssid] is None: - logger.info(f"Added new note for network with SSID {ssid}") - elif saved_notes[ssid] is not None: - logger.error(f"Note for network with SSID {ssid} already exists") - return False, self.translations.gettext("Заметка для сети с SSID {ssid} уже существует").format(ssid=ssid) - saved_notes[ssid] = note - self.storage.save_notes(saved_notes) - logger.info(f"Added note '{note}' for network with SSID {ssid}") - return True, None - except Exception as e: - logger.error(f"Error adding note for SSID {ssid}: {str(e)}") - return False, self.translations.gettext("Внутренняя ошибка сервера: {error}").format(error=str(e))
- - -
-[docs] - def update_note(self, ssid: str, note: str) -> Tuple[bool, Optional[str]]: - """Обновляет заметку сети Wi-Fi по SSID.""" - try: - saved_notes = self.storage.load_notes() - if ssid not in saved_notes: - logger.warning(f"Network with SSID {ssid} not found") - return False, self.translations.gettext("Сеть с SSID {ssid} не найдена").format(ssid=ssid) - if saved_notes[ssid] is None: - logger.error(f"Note for network with SSID {ssid} does not exist") - return False, self.translations.gettext("Заметка для сети с SSID {ssid} не существует").format(ssid=ssid) - saved_notes[ssid] = note - self.storage.save_notes(saved_notes) - logger.info(f"Updated note '{note}' for network with SSID {ssid}") - return True, None - except Exception as e: - logger.error(f"Error updating note for SSID {ssid}: {str(e)}") - return False, self.translations.gettext("Внутренняя ошибка сервера: {error}").format(error=str(e))
- - -
-[docs] - def delete_note(self, ssid: str) -> Tuple[bool, Optional[str]]: - """Удаляет заметку сети Wi-Fi по SSID.""" - try: - saved_notes = self.storage.load_notes() - if ssid not in saved_notes: - logger.warning(f"Network with SSID {ssid} not found") - return False, self.translations.gettext("Сеть с SSID {ssid} не найдена").format(ssid=ssid) - if saved_notes[ssid] is None: - logger.error(f"Note for network with SSID {ssid} does not exist") - return False, self.translations.gettext("Заметка для сети с SSID {ssid} не существует").format(ssid=ssid) - saved_notes[ssid] = None - self.storage.save_notes(saved_notes) - logger.info(f"Deleted note for network with SSID {ssid}") - return True, None - except Exception as e: - logger.error(f"Error deleting note for SSID {ssid}: {str(e)}") - return False, self.translations.gettext("Внутренняя ошибка сервера: {error}").format(error=str(e))
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/storage/json_storage.html b/SRV/docs/_build/html/_modules/storage/json_storage.html deleted file mode 100644 index c47b992..0000000 --- a/SRV/docs/_build/html/_modules/storage/json_storage.html +++ /dev/null @@ -1,537 +0,0 @@ - - - - - - - - storage.json_storage - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for storage.json_storage

-import json
-import os
-import logging
-from passlib.context import CryptContext
-from typing import Optional
-from models.auth import UserCreate, UserResponse
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-DATA_DIR = os.getenv("GONETS_DATA_DIR", "/etc/gonets")
-DEFAULT_USERS_PATH = os.getenv("GONETS_USERS_PATH",
-                               os.path.join(DATA_DIR, "users.json"))
-
-
-
-[docs] -class JsonStorage: - """Хранилище пользователей в JSON-файле. - - Назначение: - - - Обеспечивает простое файловое хранилище учетных записей без полноценной СУБД. - - Подходит для встраиваемых окружений, где критична минимальная зависимость от внешних сервисов. - - Формат данных:: - - { - "users": [ - {"id": int, "username": str, "password_hash": str, "is_admin": bool}, - ... - ], - "next_id": int - } - - Безопасность: - - - Пароли никогда не сохраняются в открытом виде: используется `passlib.context.CryptContext` со схемой `bcrypt`. - - Файл создаётся с правами доступа ``0o600`` (чтение/запись только владельцу). - - Ограничения: - - - Нет блокировок для конкурентного доступа — в многопроцессной среде требуется внешняя синхронизация. - - Значение пути по умолчанию ``/etc/gonets/users.json`` предполагает наличие прав на запись и предварительную настройку окружения. - """ - - def __init__(self, file_path: Optional[str] = None): - """Инициализирует хранилище пользователей. - - Args: - file_path (str, optional): Путь к JSON-файлу для хранения данных. - По умолчанию "/etc/gonets/users.json". - - Создаёт объект CryptContext для хеширования паролей и проверяет/создаёт - файл, если он отсутствует. - """ - self.file_path = file_path or DEFAULT_USERS_PATH - self.pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto") - self._ensure_file_exists() - - def _ensure_file_exists(self): - """Создаёт JSON-файл, если он не существует. - - Создаёт родительские директории и файл с начальной структурой данных, - устанавливая права доступа 600. - - Raises: - Exception: Если произошла ошибка при создании файла или директории. - """ - try: - logger.info(f"Проверка существования файла {self.file_path}") - if not os.path.exists(self.file_path): - logger.info(f"Создание директории {os.path.dirname(self.file_path)}") - os.makedirs(os.path.dirname(self.file_path), exist_ok=True) - logger.info(f"Создание файла {self.file_path}") - with open(self.file_path, "w") as f: - json.dump({"users": [], "next_id": 1}, f) - os.chmod(self.file_path, 0o600) - logger.info(f"Создан файл {self.file_path}") - else: - logger.info(f"Файл {self.file_path} уже существует") - except Exception as e: - logger.error( - f"Ошибка при создании файла {self.file_path}: {type(e).__name__} - {str(e)}" - ) - raise - - def _read_data(self) -> dict: - """Читает данные из JSON-файла. - - Returns: - dict: Словарь с данными пользователей и следующим ID. - - Raises: - FileNotFoundError: Если файл отсутствует (возвращает пустую структуру). - Exception: Если произошла ошибка при чтении файла. - """ - try: - with open(self.file_path, "r") as f: - return json.load(f) - except FileNotFoundError: - logger.info( - f"Файл {self.file_path} не существует, возвращаем пустую структуру" - ) - return {"users": [], "next_id": 1} - except Exception as e: - logger.error( - f"Ошибка при чтении файла {self.file_path}: {type(e).__name__} - {str(e)}" - ) - raise - - def _write_data(self, data: dict): - """Записывает данные в JSON-файл. - - Args: - data (dict): Словарь с данными для записи (пользователи и next_id). - - Raises: - Exception: Если произошла ошибка при записи в файл. - """ - try: - with open(self.file_path, "w") as f: - json.dump(data, f, indent=2) - except Exception as e: - logger.error( - f"Ошибка при записи файла {self.file_path}: {type(e).__name__} - {str(e)}" - ) - raise - -
-[docs] - def create_user(self, user: UserCreate) -> UserResponse: - """Создаёт нового пользователя с хешированием пароля. - - Args: - user (UserCreate): Объект с данными нового пользователя (username, password, is_admin). - - Returns: - UserResponse: Объект с данными созданного пользователя (id, username, is_admin). - - Raises: - ValueError: Если пользователь с таким именем уже существует. - Exception: Если произошла ошибка при записи данных. - """ - try: - data = self._read_data() - users = data["users"] - next_id = data["next_id"] - if any(u["username"] == user.username for u in users): - logger.error(f"Пользователь {user.username} уже существует") - raise ValueError("Пользователь уже существует") - password_hash = self.pwd_context.hash(user.password) - new_user = { - "id": next_id, - "username": user.username, - "password_hash": password_hash, - "is_admin": user.is_admin, - } - users.append(new_user) - data["next_id"] = next_id + 1 - self._write_data(data) - logger.info( - f"Пользователь {user.username} успешно зарегистрирован") - return UserResponse( - id=new_user["id"], - username=new_user["username"], - is_admin=new_user["is_admin"], - ) - except Exception as e: - logger.error( - f"Ошибка при создании пользователя {user.username}: {type(e).__name__} - {str(e)}" - ) - raise
- - -
-[docs] - def get_user_by_username(self, username: str) -> Optional[dict]: - """Получает данные пользователя по имени. - - Args: - username (str): Имя пользователя для поиска. - - Returns: - Optional[dict]: Словарь с данными пользователя или None, если пользователь не найден. - - Raises: - Exception: Если произошла ошибка при чтении файла. - """ - try: - if not os.path.exists(self.file_path): - logger.info( - f"Файл {self.file_path} не существует, пользователь {username} не найден" - ) - return None - data = self._read_data() - for user in data["users"]: - if user["username"] == username: - return user - return None - except Exception as e: - logger.error( - f"Ошибка при получении пользователя {username}: {type(e).__name__} - {str(e)}" - ) - raise
- - -
-[docs] - def verify_password(self, plain_password: str, hashed_password: str) -> bool: - """Проверяет соответствие введённого пароля хэшированному. - - Args: - plain_password (str): Введённый пользователем пароль. - hashed_password (str): Хэшированный пароль из хранилища. - - Returns: - bool: True, если пароль верен, False в противном случае. - """ - return self.pwd_context.verify(plain_password, hashed_password)
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/storage/session_storage.html b/SRV/docs/_build/html/_modules/storage/session_storage.html deleted file mode 100644 index c007ef2..0000000 --- a/SRV/docs/_build/html/_modules/storage/session_storage.html +++ /dev/null @@ -1,602 +0,0 @@ - - - - - - - - storage.session_storage - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for storage.session_storage

-import json
-import os
-import uuid
-import logging
-from typing import Optional, Dict
-from datetime import datetime, timedelta
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-DATA_DIR = os.getenv("GONETS_DATA_DIR", "/etc/gonets")
-DEFAULT_SESSIONS_PATH = os.getenv("GONETS_SESSIONS_PATH",
-                                  os.path.join(DATA_DIR, "sessions.json"))
-
-
-
-[docs] -class SessionStorage: - """Хранилище сессий пользователей в JSON-файле. - - Назначение: - - - Лёгкое файловое хранилище сессионных токенов, сопоставленных с ``client_id`` (например, IP клиента). - - Предназначено для сред без БД и persistent-кэшей; обеспечивает простые операции и автоочистку истёкших сессий. - - Формат данных:: - - { - "sessions": { - "<session_id>": { - "username": str, - "token": str, - "client_id": str, - "created_at": ISO8601 str, - "expiry": ISO8601 str - }, - ... - } - } - - Политика TTL: - - - Каждая сессия действует 30 минут; метод ``clean_expired_sessions`` удаляет записи с истёкшим сроком. - - Ограничения: - - - Отсутствуют файловые блокировки — в многопроцессной среде возможны гонки. - - Путь по умолчанию ``/etc/gonets/sessions.json`` требует прав на запись. - """ - - def __init__(self, file_path: Optional[str] = None): - """Инициализирует хранилище сессий. - - Args: - file_path (str, optional): Путь к JSON-файлу для хранения сессий. - По умолчанию "/etc/gonets/sessions.json". - - Создаёт файл и директории, если они отсутствуют, с правами доступа 600. - """ - self.file_path = file_path or DEFAULT_SESSIONS_PATH - self._ensure_file_exists() - - def _ensure_file_exists(self): - """Создаёт JSON-файл, если он не существует. - - Создаёт родительские директории и файл с начальной структурой данных, - устанавливая права доступа 600. - - Raises: - Exception: Если произошла ошибка при создании файла или директории. - """ - try: - logger.info(f"Проверка существования файла {self.file_path}") - if not os.path.exists(self.file_path): - logger.info(f"Создание директории {os.path.dirname(self.file_path)}") - os.makedirs(os.path.dirname(self.file_path), exist_ok=True) - logger.info(f"Создание файла {self.file_path}") - with open(self.file_path, "w") as f: - json.dump({"sessions": {}}, f) - os.chmod(self.file_path, 0o600) - logger.info(f"Создан файл {self.file_path}") - else: - logger.info(f"Файл {self.file_path} уже существует") - except Exception as e: - logger.error( - f"Ошибка при создании файла {self.file_path}: {type(e).__name__} - {str(e)}" - ) - raise - - def _read_data(self) -> Dict: - """Читает данные из JSON-файла. - - Returns: - Dict: Словарь с данными сессий. - - Raises: - Exception: Если произошла ошибка при чтении файла. - """ - try: - with open(self.file_path, "r") as f: - return json.load(f) - except Exception as e: - logger.error( - f"Ошибка при чтении файла {self.file_path}: {type(e).__name__} - {str(e)}" - ) - raise - - def _write_data(self, data: Dict): - """Записывает данные в JSON-файл. - - Args: - data (Dict): Словарь с данными сессий для записи. - - Raises: - Exception: Если произошла ошибка при записи в файл. - """ - try: - with open(self.file_path, "w") as f: - json.dump(data, f, indent=2) - except Exception as e: - logger.error( - f"Ошибка при записи файла {self.file_path}: {type(e).__name__} - {str(e)}" - ) - raise - -
-[docs] - def create_session(self, username: str, token: str, client_id: str) -> str: - """Создаёт новую сессию и возвращает уникальный session_id. - - Args: - username (str): Имя пользователя, для которого создаётся сессия. - token (str): Токен аутентификации. - client_id (str): Идентификатор клиента. - - Returns: - str: Уникальный идентификатор сессии (session_id). - - Raises: - Exception: Если произошла ошибка при создании или записи сессии. - - Note: - Удаляет истекшие сессии перед созданием новой и устанавливает срок - действия 30 минут. - """ - try: - self.clean_expired_sessions() - data = self._read_data() - session_id = str(uuid.uuid4()) - created_at = datetime.utcnow().isoformat() - expiry = (datetime.utcnow() + timedelta(minutes=30)).isoformat() - data["sessions"][session_id] = { - "username": username, - "token": token, - "client_id": client_id, - "created_at": created_at, - "expiry": expiry, - } - self._write_data(data) - logger.info( - f"Сессия создана для пользователя {username} с session_id {session_id}" - ) - return session_id - except Exception as e: - logger.error( - f"Ошибка при создании сессии для {username}: {type(e).__name__} - {str(e)}" - ) - raise
- - -
-[docs] - def get_latest_session(self, client_id: str) -> Optional[Dict]: - """Получает последнюю активную сессию для указанного client_id. - - Args: - client_id (str): Идентификатор клиента. - - Returns: - Optional[Dict]: Словарь с данными последней активной сессии, включая - "session_id", или None, если сессия не найдена. - - Raises: - Exception: Если произошла ошибка при чтении или обработке данных. - - Note: - Очищает истекшие сессии перед поиском и возвращает сессию с самым - поздним временем создания. - """ - try: - self.clean_expired_sessions() - data = self._read_data() - latest_session = None - latest_time = None - for session_id, session in data["sessions"].items(): - if session["client_id"] == client_id: - expiry = datetime.fromisoformat(session["expiry"]) - if datetime.utcnow() > expiry: - logger.info(f"Сессия {session_id} истекла") - del data["sessions"][session_id] - continue - created_at = datetime.fromisoformat(session["created_at"]) - if latest_time is None or created_at > latest_time: - latest_time = created_at - latest_session = session - latest_session["session_id"] = session_id - if latest_session: - logger.info(f"Найдена сессия для client_id {client_id}") - return latest_session - logger.info(f"Сессия для client_id {client_id} не найдена") - self._write_data(data) - return None - except Exception as e: - logger.error( - f"Ошибка при получении сессии для client_id {client_id}: {type(e).__name__} - {str(e)}" - ) - raise
- - -
-[docs] - def delete_session(self, session_id: str): - """Удаляет сессию по указанному session_id. - - Args: - session_id (str): Уникальный идентификатор сессии. - - Raises: - Exception: Если произошла ошибка при чтении или записи данных. - - Note: - Очищает истекшие сессии перед удалением. - """ - try: - self.clean_expired_sessions() - data = self._read_data() - if session_id in data["sessions"]: - del data["sessions"][session_id] - self._write_data(data) - logger.info(f"Сессия с session_id {session_id} удалена") - except Exception as e: - logger.error( - f"Ошибка при удалении сессии {session_id}: {type(e).__name__} - {str(e)}" - ) - raise
- - -
-[docs] - def clean_expired_sessions(self): - """Удаляет все истекшие сессии из хранилища. - - Raises: - Exception: Если произошла ошибка при чтении или записи данных. - - Note: - Проверяет срок действия каждой сессии и удаляет те, что истекли, - записывая обновлённые данные. - """ - try: - data = self._read_data() - expired_sessions = [] - current_time = datetime.utcnow() - - for session_id, session in list(data["sessions"].items()): - expiry = datetime.fromisoformat(session["expiry"]) - if current_time > expiry: - expired_sessions.append(session_id) - - for session_id in expired_sessions: - del data["sessions"][session_id] - logger.info( - f"Удалена истекшая сессия с session_id {session_id}") - - if expired_sessions: - self._write_data(data) - logger.info(f"Удалено {len(expired_sessions)} истекших сессий") - else: - logger.debug("Истекшие сессии не найдены") - - except Exception as e: - logger.error( - f"Ошибка при очистке истекших сессий: {type(e).__name__} - {str(e)}" - ) - raise
-
- -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_modules/utils/i18n.html b/SRV/docs/_build/html/_modules/utils/i18n.html deleted file mode 100644 index c2cd81c..0000000 --- a/SRV/docs/_build/html/_modules/utils/i18n.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - utils.i18n - GONETS SRV 0.0.3 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark, in light mode - - - - - - - - - - - - - - - Auto light/dark, in dark mode - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Skip to content - - - -
-
-
- -
- -
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
-
- -
- -
-
-

Source code for utils.i18n

-"""
-Утилиты локализации и зависимости переводов для FastAPI.
-
-Содержимое модуля:
- - `get_translations()`: фабрика зависимости FastAPI, считывающая локаль из
-   query-параметра `locale`, cookie `locale` или заголовка `Accept-Language`
-   (по приоритету), с дефолтом `ru`. Возвращает функцию-зависимость, которая
-   подгружает `babel.support.Translations` из каталога `SRV/locales`.
- - `_()`: удобная обёртка для получения перевода строки с использованием
-   текущей локали (или дефолтного `ru`, если контекст запроса не передан).
-
-Особенности:
- - При отсутствии словаря перевода для выбранной локали выполняется fallback на
-   русскую локаль, что гарантирует наличие строк интерфейса.
- - Локаль определяется только по первому языку из `Accept-Language` (без
-   региональных суффиксов) для упрощения.
- - Модуль ведёт отладочное логирование выбора и загрузки локали.
-"""
-from fastapi import Request, Depends
-from babel.support import Translations
-import logging
-
-logger = logging.getLogger(__name__)
-
-
-[docs] -def get_translations() -> callable: - """ - Создаёт зависимость для загрузки переводов на основе заголовка Accept-Language - или параметра запроса 'locale'. По умолчанию используется русский язык. - """ - def translations_dependency(request: Request) -> Translations: - # Проверяем параметр запроса 'locale', если он есть - locale = request.query_params.get("locale") - if not locale: - # Если параметр отсутствует, проверяем куку 'locale' - locale = request.cookies.get("locale") - if not locale: - # Если куки нет, используем заголовок Accept-Language - locale = request.headers.get("Accept-Language", "ru").split(",")[0].split("-")[0] - - logger.debug(f"Determined locale: {locale}") - try: - translations = Translations.load("locales", [locale], "messages") - if not translations._catalog: - logger.warning(f"Translations for locale {locale} not found, falling back to ru") - translations = Translations.load("locales", ["ru"], "messages") - logger.debug(f"Loaded translations for locale {locale}, catalog size: {len(translations._catalog)}") - return translations - except Exception as e: - logger.error(f"Failed to load translations for locale {locale}: {str(e)}") - # Fallback на русский - logger.debug("Falling back to ru translations") - return Translations.load("locales", ["ru"], "messages") - - return translations_dependency
- - -def _(msgid: str, request: Request = None) -> str: - """ - Переводит строку msgid для текущей локали. - - Args: - msgid (str): Строка для перевода. - request (Request, optional): Объект запроса FastAPI для получения локали. - - Returns: - str: Переведенная строка. - """ - if request is None: - # Язык, который будет отображаться по умолчанию - translations = Translations.load("locales", ["ru"], "messages") - logger.debug(f"Using default ru translations for msgid: {msgid}") - else: - translations = get_translations()(request) - logger.debug(f"Using translations for locale {request.cookies.get('locale', 'ru')} for msgid: {msgid}") - return translations.gettext(msgid) -
-
-
-
- - -
-
- - Made with Sphinx and @pradyunsg's - - Furo - -
-
- -
-
- -
-
- -
-
- - - - - \ No newline at end of file diff --git a/SRV/docs/_build/html/_sources/api/config.rst.txt b/SRV/docs/_build/html/_sources/api/config.rst.txt deleted file mode 100644 index 3dfa707..0000000 --- a/SRV/docs/_build/html/_sources/api/config.rst.txt +++ /dev/null @@ -1,9 +0,0 @@ -Конфигурация -============ - -.. toctree:: - :maxdepth: 1 - - config/cors - config/init_config - config/ports diff --git a/SRV/docs/_build/html/_sources/api/config/cors.rst.txt b/SRV/docs/_build/html/_sources/api/config/cors.rst.txt deleted file mode 100644 index 6dfd244..0000000 --- a/SRV/docs/_build/html/_sources/api/config/cors.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -config.cors -=========== - -.. automodule:: config.cors - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/config/init_config.rst.txt b/SRV/docs/_build/html/_sources/api/config/init_config.rst.txt deleted file mode 100644 index 3386987..0000000 --- a/SRV/docs/_build/html/_sources/api/config/init_config.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -config.init_config -=================== - -.. automodule:: config.init_config - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/config/ports.rst.txt b/SRV/docs/_build/html/_sources/api/config/ports.rst.txt deleted file mode 100644 index b893ee3..0000000 --- a/SRV/docs/_build/html/_sources/api/config/ports.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -config.ports -============ - -.. automodule:: config.ports - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/core.rst.txt b/SRV/docs/_build/html/_sources/api/core.rst.txt deleted file mode 100644 index f859c03..0000000 --- a/SRV/docs/_build/html/_sources/api/core.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Core -==== - -.. toctree:: - :maxdepth: 1 - - core/cli_executor diff --git a/SRV/docs/_build/html/_sources/api/core/cli_executor.rst.txt b/SRV/docs/_build/html/_sources/api/core/cli_executor.rst.txt deleted file mode 100644 index a305ccb..0000000 --- a/SRV/docs/_build/html/_sources/api/core/cli_executor.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -core.cli_executor -================== - -.. automodule:: core.cli_executor - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints.rst.txt deleted file mode 100644 index ca6734e..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints.rst.txt +++ /dev/null @@ -1,13 +0,0 @@ -API эндпоинты -============= - -.. toctree:: - :maxdepth: 1 - - endpoints/auth - endpoints/ip - endpoints/network - endpoints/settings - endpoints/subnet - endpoints/ufw - endpoints/websocket diff --git a/SRV/docs/_build/html/_sources/api/endpoints/auth.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/auth.rst.txt deleted file mode 100644 index df442bf..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/auth.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.auth -=========== - -.. automodule:: api.v1.auth - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints/ip.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/ip.rst.txt deleted file mode 100644 index a3199b5..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/ip.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.ip -========= - -.. automodule:: api.v1.ip - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints/network.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/network.rst.txt deleted file mode 100644 index 86ff9c4..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/network.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.network -============== - -.. automodule:: api.v1.network - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints/settings.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/settings.rst.txt deleted file mode 100644 index 7958dd6..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/settings.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.settings -================ - -.. automodule:: api.v1.settings - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints/subnet.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/subnet.rst.txt deleted file mode 100644 index 05ddfac..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/subnet.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.subnet -============= - -.. automodule:: api.v1.subnet - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints/ufw.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/ufw.rst.txt deleted file mode 100644 index cd5fc6e..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/ufw.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.ufw -========== - -.. automodule:: api.v1.ufw - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/endpoints/websocket.rst.txt b/SRV/docs/_build/html/_sources/api/endpoints/websocket.rst.txt deleted file mode 100644 index 0b8116c..0000000 --- a/SRV/docs/_build/html/_sources/api/endpoints/websocket.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -api.v1.websocket -================ - -.. automodule:: api.v1.websocket - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/models.rst.txt b/SRV/docs/_build/html/_sources/api/models.rst.txt deleted file mode 100644 index 49197ba..0000000 --- a/SRV/docs/_build/html/_sources/api/models.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -Модели -====== - -.. toctree:: - :maxdepth: 1 - - models/auth - models/network - models/request - models/subnet - models/ufw - models/wifi diff --git a/SRV/docs/_build/html/_sources/api/models/auth.rst.txt b/SRV/docs/_build/html/_sources/api/models/auth.rst.txt deleted file mode 100644 index 2c266d2..0000000 --- a/SRV/docs/_build/html/_sources/api/models/auth.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -models.auth -=========== - -.. automodule:: models.auth - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/models/network.rst.txt b/SRV/docs/_build/html/_sources/api/models/network.rst.txt deleted file mode 100644 index 2e88043..0000000 --- a/SRV/docs/_build/html/_sources/api/models/network.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -models.network -============== - -.. automodule:: models.network - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/models/request.rst.txt b/SRV/docs/_build/html/_sources/api/models/request.rst.txt deleted file mode 100644 index 33c43ba..0000000 --- a/SRV/docs/_build/html/_sources/api/models/request.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -models.request -============== - -.. automodule:: models.request - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/models/subnet.rst.txt b/SRV/docs/_build/html/_sources/api/models/subnet.rst.txt deleted file mode 100644 index de0c59c..0000000 --- a/SRV/docs/_build/html/_sources/api/models/subnet.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -models.subnet -============= - -.. automodule:: models.subnet - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/models/ufw.rst.txt b/SRV/docs/_build/html/_sources/api/models/ufw.rst.txt deleted file mode 100644 index 881593a..0000000 --- a/SRV/docs/_build/html/_sources/api/models/ufw.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -models.ufw -========== - -.. automodule:: models.ufw - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/models/wifi.rst.txt b/SRV/docs/_build/html/_sources/api/models/wifi.rst.txt deleted file mode 100644 index 399ba8a..0000000 --- a/SRV/docs/_build/html/_sources/api/models/wifi.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -models.wifi -=========== - -.. automodule:: models.wifi - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services.rst.txt b/SRV/docs/_build/html/_sources/api/services.rst.txt deleted file mode 100644 index ebca7d0..0000000 --- a/SRV/docs/_build/html/_sources/api/services.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -Сервисы -======= - -.. automodule:: services - :members: - :undoc-members: - :show-inheritance: - -.. toctree:: - :maxdepth: 1 - - services/arp_service - services/auth_service - services/connect_service - services/firewalld_service - services/ip_service - services/network_service - services/settings_service - services/subnet_service - services/ufw_service - services/wifi_service diff --git a/SRV/docs/_build/html/_sources/api/services/arp_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/arp_service.rst.txt deleted file mode 100644 index c99d729..0000000 --- a/SRV/docs/_build/html/_sources/api/services/arp_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -ARP Service -=========== - -.. automodule:: services.arp_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/auth_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/auth_service.rst.txt deleted file mode 100644 index 0cbe8ee..0000000 --- a/SRV/docs/_build/html/_sources/api/services/auth_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Auth Service -============ - -.. automodule:: services.auth_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/connect_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/connect_service.rst.txt deleted file mode 100644 index 237c613..0000000 --- a/SRV/docs/_build/html/_sources/api/services/connect_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Connect Service -=============== - -.. automodule:: services.connect_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/firewalld_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/firewalld_service.rst.txt deleted file mode 100644 index 9b6332f..0000000 --- a/SRV/docs/_build/html/_sources/api/services/firewalld_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Firewalld Service -================= - -.. automodule:: services.firewalld_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/ip_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/ip_service.rst.txt deleted file mode 100644 index b976a29..0000000 --- a/SRV/docs/_build/html/_sources/api/services/ip_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -IP Service -========== - -.. automodule:: services.ip_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/network_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/network_service.rst.txt deleted file mode 100644 index 2794801..0000000 --- a/SRV/docs/_build/html/_sources/api/services/network_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Network Service -=============== - -.. automodule:: services.network_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/settings_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/settings_service.rst.txt deleted file mode 100644 index c459fca..0000000 --- a/SRV/docs/_build/html/_sources/api/services/settings_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Settings Service -================ - -.. automodule:: services.settings_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/subnet_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/subnet_service.rst.txt deleted file mode 100644 index d059f8f..0000000 --- a/SRV/docs/_build/html/_sources/api/services/subnet_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Subnet Service -============== - -.. automodule:: services.subnet_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/ufw_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/ufw_service.rst.txt deleted file mode 100644 index 14ddc77..0000000 --- a/SRV/docs/_build/html/_sources/api/services/ufw_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -UFW Service -=========== - -.. automodule:: services.ufw_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/services/wifi_service.rst.txt b/SRV/docs/_build/html/_sources/api/services/wifi_service.rst.txt deleted file mode 100644 index 787b7c5..0000000 --- a/SRV/docs/_build/html/_sources/api/services/wifi_service.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Wifi Service -============ - -.. automodule:: services.wifi_service - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/storage.rst.txt b/SRV/docs/_build/html/_sources/api/storage.rst.txt deleted file mode 100644 index 0a04d57..0000000 --- a/SRV/docs/_build/html/_sources/api/storage.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -Хранилища -========= - -.. toctree:: - :maxdepth: 1 - - storage/json_storage - storage/session_storage diff --git a/SRV/docs/_build/html/_sources/api/storage/json_storage.rst.txt b/SRV/docs/_build/html/_sources/api/storage/json_storage.rst.txt deleted file mode 100644 index 0bb5039..0000000 --- a/SRV/docs/_build/html/_sources/api/storage/json_storage.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -storage.json_storage -===================== - -.. automodule:: storage.json_storage - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/storage/session_storage.rst.txt b/SRV/docs/_build/html/_sources/api/storage/session_storage.rst.txt deleted file mode 100644 index 9ae2a9a..0000000 --- a/SRV/docs/_build/html/_sources/api/storage/session_storage.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -storage.session_storage -======================= - -.. automodule:: storage.session_storage - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/api/utils.rst.txt b/SRV/docs/_build/html/_sources/api/utils.rst.txt deleted file mode 100644 index c50b082..0000000 --- a/SRV/docs/_build/html/_sources/api/utils.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -Утилиты -======= - -.. toctree:: - :maxdepth: 1 - - utils/i18n diff --git a/SRV/docs/_build/html/_sources/api/utils/i18n.rst.txt b/SRV/docs/_build/html/_sources/api/utils/i18n.rst.txt deleted file mode 100644 index 74cd021..0000000 --- a/SRV/docs/_build/html/_sources/api/utils/i18n.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -utils.i18n -========== - -.. automodule:: utils.i18n - :members: - :undoc-members: - :show-inheritance: diff --git a/SRV/docs/_build/html/_sources/index.rst.txt b/SRV/docs/_build/html/_sources/index.rst.txt deleted file mode 100644 index 4887d9d..0000000 --- a/SRV/docs/_build/html/_sources/index.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -GONETS SRV Documentation -========================= - -Добро пожаловать в документацию серверной части GONETS (SRV). - -Содержание ----------- - -.. toctree:: - :maxdepth: 2 - :caption: Разделы - - api/services - api/models - api/endpoints - api/config - api/core - api/storage - api/utils diff --git a/SRV/docs/_build/html/_static/basic.css b/SRV/docs/_build/html/_static/basic.css deleted file mode 100644 index 4738b2e..0000000 --- a/SRV/docs/_build/html/_static/basic.css +++ /dev/null @@ -1,906 +0,0 @@ -/* - * Sphinx stylesheet -- basic theme. - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin-top: 10px; -} - -ul.search li { - padding: 5px 0; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li p.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 360px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a:visited { - color: #551A8B; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, figure.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar, -aside.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -nav.contents, -aside.topic, -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -nav.contents, -aside.topic, -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -aside.sidebar > :last-child, -nav.contents > :last-child, -aside.topic > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -nav.contents::after, -aside.topic::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -aside.footnote > span, -div.citation > span { - float: left; -} -aside.footnote > span:last-of-type, -div.citation > span:last-of-type { - padding-right: 0.5em; -} -aside.footnote > p { - margin-left: 2em; -} -div.citation > p { - margin-left: 4em; -} -aside.footnote > p:last-of-type, -div.citation > p:last-of-type { - margin-bottom: 0em; -} -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -.sig dd { - margin-top: 0px; - margin-bottom: 0px; -} - -.sig dl { - margin-top: 0px; - margin-bottom: 0px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; - white-space: nowrap; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/debug.css b/SRV/docs/_build/html/_static/debug.css deleted file mode 100644 index 74d4aec..0000000 --- a/SRV/docs/_build/html/_static/debug.css +++ /dev/null @@ -1,69 +0,0 @@ -/* - This CSS file should be overridden by the theme authors. It's - meant for debugging and developing the skeleton that this theme provides. -*/ -body { - font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, - "Apple Color Emoji", "Segoe UI Emoji"; - background: lavender; -} -.sb-announcement { - background: rgb(131, 131, 131); -} -.sb-announcement__inner { - background: black; - color: white; -} -.sb-header { - background: lightskyblue; -} -.sb-header__inner { - background: royalblue; - color: white; -} -.sb-header-secondary { - background: lightcyan; -} -.sb-header-secondary__inner { - background: cornflowerblue; - color: white; -} -.sb-sidebar-primary { - background: lightgreen; -} -.sb-main { - background: blanchedalmond; -} -.sb-main__inner { - background: antiquewhite; -} -.sb-header-article { - background: lightsteelblue; -} -.sb-article-container { - background: snow; -} -.sb-article-main { - background: white; -} -.sb-footer-article { - background: lightpink; -} -.sb-sidebar-secondary { - background: lightgoldenrodyellow; -} -.sb-footer-content { - background: plum; -} -.sb-footer-content__inner { - background: palevioletred; -} -.sb-footer { - background: pink; -} -.sb-footer__inner { - background: salmon; -} -.sb-article { - background: white; -} diff --git a/SRV/docs/_build/html/_static/doctools.js b/SRV/docs/_build/html/_static/doctools.js deleted file mode 100644 index 0398ebb..0000000 --- a/SRV/docs/_build/html/_static/doctools.js +++ /dev/null @@ -1,149 +0,0 @@ -/* - * Base JavaScript utilities for all Sphinx HTML documentation. - */ -"use strict"; - -const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", -]); - -const _ready = (callback) => { - if (document.readyState !== "loading") { - callback(); - } else { - document.addEventListener("DOMContentLoaded", callback); - } -}; - -/** - * Small JavaScript module for the documentation. - */ -const Documentation = { - init: () => { - Documentation.initDomainIndexTable(); - Documentation.initOnKeyListeners(); - }, - - /** - * i18n support - */ - TRANSLATIONS: {}, - PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), - LOCALE: "unknown", - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext: (string) => { - const translated = Documentation.TRANSLATIONS[string]; - switch (typeof translated) { - case "undefined": - return string; // no translation - case "string": - return translated; // translation exists - default: - return translated[0]; // (singular, plural) translation tuple exists - } - }, - - ngettext: (singular, plural, n) => { - const translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated !== "undefined") - return translated[Documentation.PLURAL_EXPR(n)]; - return n === 1 ? singular : plural; - }, - - addTranslations: (catalog) => { - Object.assign(Documentation.TRANSLATIONS, catalog.messages); - Documentation.PLURAL_EXPR = new Function( - "n", - `return (${catalog.plural_expr})` - ); - Documentation.LOCALE = catalog.locale; - }, - - /** - * helper function to focus on search bar - */ - focusSearchBar: () => { - document.querySelectorAll("input[name=q]")[0]?.focus(); - }, - - /** - * Initialise the domain index toggle buttons - */ - initDomainIndexTable: () => { - const toggler = (el) => { - const idNumber = el.id.substr(7); - const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); - if (el.src.substr(-9) === "minus.png") { - el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; - toggledRows.forEach((el) => (el.style.display = "none")); - } else { - el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; - toggledRows.forEach((el) => (el.style.display = "")); - } - }; - - const togglerElements = document.querySelectorAll("img.toggler"); - togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) - ); - togglerElements.forEach((el) => (el.style.display = "")); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); - }, - - initOnKeyListeners: () => { - // only install a listener if it is really needed - if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - ) - return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.altKey || event.ctrlKey || event.metaKey) return; - - if (!event.shiftKey) { - switch (event.key) { - case "ArrowLeft": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const prevLink = document.querySelector('link[rel="prev"]'); - if (prevLink && prevLink.href) { - window.location.href = prevLink.href; - event.preventDefault(); - } - break; - case "ArrowRight": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const nextLink = document.querySelector('link[rel="next"]'); - if (nextLink && nextLink.href) { - window.location.href = nextLink.href; - event.preventDefault(); - } - break; - } - } - - // some keyboard layouts may need Shift to get / - switch (event.key) { - case "/": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.focusSearchBar(); - event.preventDefault(); - } - }); - }, -}; - -// quick alias for translations -const _ = Documentation.gettext; - -_ready(Documentation.init); diff --git a/SRV/docs/_build/html/_static/documentation_options.js b/SRV/docs/_build/html/_static/documentation_options.js deleted file mode 100644 index 74029b8..0000000 --- a/SRV/docs/_build/html/_static/documentation_options.js +++ /dev/null @@ -1,13 +0,0 @@ -const DOCUMENTATION_OPTIONS = { - VERSION: '0.0.3', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, - SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, -}; \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/file.png b/SRV/docs/_build/html/_static/file.png deleted file mode 100644 index a858a41..0000000 Binary files a/SRV/docs/_build/html/_static/file.png and /dev/null differ diff --git a/SRV/docs/_build/html/_static/language_data.js b/SRV/docs/_build/html/_static/language_data.js deleted file mode 100644 index c7fe6c6..0000000 --- a/SRV/docs/_build/html/_static/language_data.js +++ /dev/null @@ -1,192 +0,0 @@ -/* - * This script contains the language-specific data used by searchtools.js, - * namely the list of stopwords, stemmer, scorer and splitter. - */ - -var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; - - -/* Non-minified version is copied as a separate JS file, if available */ - -/** - * Porter Stemmer - */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - diff --git a/SRV/docs/_build/html/_static/minus.png b/SRV/docs/_build/html/_static/minus.png deleted file mode 100644 index d96755f..0000000 Binary files a/SRV/docs/_build/html/_static/minus.png and /dev/null differ diff --git a/SRV/docs/_build/html/_static/plus.png b/SRV/docs/_build/html/_static/plus.png deleted file mode 100644 index 7107cec..0000000 Binary files a/SRV/docs/_build/html/_static/plus.png and /dev/null differ diff --git a/SRV/docs/_build/html/_static/pygments.css b/SRV/docs/_build/html/_static/pygments.css deleted file mode 100644 index 9d1083b..0000000 --- a/SRV/docs/_build/html/_static/pygments.css +++ /dev/null @@ -1,250 +0,0 @@ -.highlight pre { line-height: 125%; } -.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #fdf2e2 } -.highlight { background: #f2f2f2; color: #1E1E1E } -.highlight .c { color: #515151 } /* Comment */ -.highlight .err { color: #D71835 } /* Error */ -.highlight .k { color: #8045E5 } /* Keyword */ -.highlight .l { color: #7F4707 } /* Literal */ -.highlight .n { color: #1E1E1E } /* Name */ -.highlight .o { color: #163 } /* Operator */ -.highlight .p { color: #1E1E1E } /* Punctuation */ -.highlight .ch { color: #515151 } /* Comment.Hashbang */ -.highlight .cm { color: #515151 } /* Comment.Multiline */ -.highlight .cp { color: #515151 } /* Comment.Preproc */ -.highlight .cpf { color: #515151 } /* Comment.PreprocFile */ -.highlight .c1 { color: #515151 } /* Comment.Single */ -.highlight .cs { color: #515151 } /* Comment.Special */ -.highlight .gd { color: #00749C } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gh { color: #00749C } /* Generic.Heading */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #00749C } /* Generic.Subheading */ -.highlight .kc { color: #8045E5 } /* Keyword.Constant */ -.highlight .kd { color: #8045E5 } /* Keyword.Declaration */ -.highlight .kn { color: #8045E5 } /* Keyword.Namespace */ -.highlight .kp { color: #8045E5 } /* Keyword.Pseudo */ -.highlight .kr { color: #8045E5 } /* Keyword.Reserved */ -.highlight .kt { color: #7F4707 } /* Keyword.Type */ -.highlight .ld { color: #7F4707 } /* Literal.Date */ -.highlight .m { color: #7F4707 } /* Literal.Number */ -.highlight .s { color: #163 } /* Literal.String */ -.highlight .na { color: #7F4707 } /* Name.Attribute */ -.highlight .nb { color: #7F4707 } /* Name.Builtin */ -.highlight .nc { color: #00749C } /* Name.Class */ -.highlight .no { color: #00749C } /* Name.Constant */ -.highlight .nd { color: #7F4707 } /* Name.Decorator */ -.highlight .ni { color: #163 } /* Name.Entity */ -.highlight .ne { color: #8045E5 } /* Name.Exception */ -.highlight .nf { color: #00749C } /* Name.Function */ -.highlight .nl { color: #7F4707 } /* Name.Label */ -.highlight .nn { color: #1E1E1E } /* Name.Namespace */ -.highlight .nx { color: #1E1E1E } /* Name.Other */ -.highlight .py { color: #00749C } /* Name.Property */ -.highlight .nt { color: #00749C } /* Name.Tag */ -.highlight .nv { color: #D71835 } /* Name.Variable */ -.highlight .ow { color: #8045E5 } /* Operator.Word */ -.highlight .pm { color: #1E1E1E } /* Punctuation.Marker */ -.highlight .w { color: #1E1E1E } /* Text.Whitespace */ -.highlight .mb { color: #7F4707 } /* Literal.Number.Bin */ -.highlight .mf { color: #7F4707 } /* Literal.Number.Float */ -.highlight .mh { color: #7F4707 } /* Literal.Number.Hex */ -.highlight .mi { color: #7F4707 } /* Literal.Number.Integer */ -.highlight .mo { color: #7F4707 } /* Literal.Number.Oct */ -.highlight .sa { color: #163 } /* Literal.String.Affix */ -.highlight .sb { color: #163 } /* Literal.String.Backtick */ -.highlight .sc { color: #163 } /* Literal.String.Char */ -.highlight .dl { color: #163 } /* Literal.String.Delimiter */ -.highlight .sd { color: #163 } /* Literal.String.Doc */ -.highlight .s2 { color: #163 } /* Literal.String.Double */ -.highlight .se { color: #163 } /* Literal.String.Escape */ -.highlight .sh { color: #163 } /* Literal.String.Heredoc */ -.highlight .si { color: #163 } /* Literal.String.Interpol */ -.highlight .sx { color: #163 } /* Literal.String.Other */ -.highlight .sr { color: #D71835 } /* Literal.String.Regex */ -.highlight .s1 { color: #163 } /* Literal.String.Single */ -.highlight .ss { color: #00749C } /* Literal.String.Symbol */ -.highlight .bp { color: #7F4707 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #00749C } /* Name.Function.Magic */ -.highlight .vc { color: #D71835 } /* Name.Variable.Class */ -.highlight .vg { color: #D71835 } /* Name.Variable.Global */ -.highlight .vi { color: #D71835 } /* Name.Variable.Instance */ -.highlight .vm { color: #7F4707 } /* Name.Variable.Magic */ -.highlight .il { color: #7F4707 } /* Literal.Number.Integer.Long */ -@media not print { -body[data-theme="dark"] .highlight pre { line-height: 125%; } -body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight .hll { background-color: #404040 } -body[data-theme="dark"] .highlight { background: #202020; color: #D0D0D0 } -body[data-theme="dark"] .highlight .c { color: #ABABAB; font-style: italic } /* Comment */ -body[data-theme="dark"] .highlight .err { color: #A61717; background-color: #E3D2D2 } /* Error */ -body[data-theme="dark"] .highlight .esc { color: #D0D0D0 } /* Escape */ -body[data-theme="dark"] .highlight .g { color: #D0D0D0 } /* Generic */ -body[data-theme="dark"] .highlight .k { color: #6EBF26; font-weight: bold } /* Keyword */ -body[data-theme="dark"] .highlight .l { color: #D0D0D0 } /* Literal */ -body[data-theme="dark"] .highlight .n { color: #D0D0D0 } /* Name */ -body[data-theme="dark"] .highlight .o { color: #D0D0D0 } /* Operator */ -body[data-theme="dark"] .highlight .x { color: #D0D0D0 } /* Other */ -body[data-theme="dark"] .highlight .p { color: #D0D0D0 } /* Punctuation */ -body[data-theme="dark"] .highlight .ch { color: #ABABAB; font-style: italic } /* Comment.Hashbang */ -body[data-theme="dark"] .highlight .cm { color: #ABABAB; font-style: italic } /* Comment.Multiline */ -body[data-theme="dark"] .highlight .cp { color: #FF3A3A; font-weight: bold } /* Comment.Preproc */ -body[data-theme="dark"] .highlight .cpf { color: #ABABAB; font-style: italic } /* Comment.PreprocFile */ -body[data-theme="dark"] .highlight .c1 { color: #ABABAB; font-style: italic } /* Comment.Single */ -body[data-theme="dark"] .highlight .cs { color: #E50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #FF3A3A } /* Generic.Deleted */ -body[data-theme="dark"] .highlight .ge { color: #D0D0D0; font-style: italic } /* Generic.Emph */ -body[data-theme="dark"] .highlight .ges { color: #D0D0D0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #FF3A3A } /* Generic.Error */ -body[data-theme="dark"] .highlight .gh { color: #FFF; font-weight: bold } /* Generic.Heading */ -body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ -body[data-theme="dark"] .highlight .go { color: #CCC } /* Generic.Output */ -body[data-theme="dark"] .highlight .gp { color: #AAA } /* Generic.Prompt */ -body[data-theme="dark"] .highlight .gs { color: #D0D0D0; font-weight: bold } /* Generic.Strong */ -body[data-theme="dark"] .highlight .gu { color: #FFF; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #FF3A3A } /* Generic.Traceback */ -body[data-theme="dark"] .highlight .kc { color: #6EBF26; font-weight: bold } /* Keyword.Constant */ -body[data-theme="dark"] .highlight .kd { color: #6EBF26; font-weight: bold } /* Keyword.Declaration */ -body[data-theme="dark"] .highlight .kn { color: #6EBF26; font-weight: bold } /* Keyword.Namespace */ -body[data-theme="dark"] .highlight .kp { color: #6EBF26 } /* Keyword.Pseudo */ -body[data-theme="dark"] .highlight .kr { color: #6EBF26; font-weight: bold } /* Keyword.Reserved */ -body[data-theme="dark"] .highlight .kt { color: #6EBF26; font-weight: bold } /* Keyword.Type */ -body[data-theme="dark"] .highlight .ld { color: #D0D0D0 } /* Literal.Date */ -body[data-theme="dark"] .highlight .m { color: #51B2FD } /* Literal.Number */ -body[data-theme="dark"] .highlight .s { color: #ED9D13 } /* Literal.String */ -body[data-theme="dark"] .highlight .na { color: #BBB } /* Name.Attribute */ -body[data-theme="dark"] .highlight .nb { color: #2FBCCD } /* Name.Builtin */ -body[data-theme="dark"] .highlight .nc { color: #71ADFF; text-decoration: underline } /* Name.Class */ -body[data-theme="dark"] .highlight .no { color: #40FFFF } /* Name.Constant */ -body[data-theme="dark"] .highlight .nd { color: #FFA500 } /* Name.Decorator */ -body[data-theme="dark"] .highlight .ni { color: #D0D0D0 } /* Name.Entity */ -body[data-theme="dark"] .highlight .ne { color: #BBB } /* Name.Exception */ -body[data-theme="dark"] .highlight .nf { color: #71ADFF } /* Name.Function */ -body[data-theme="dark"] .highlight .nl { color: #D0D0D0 } /* Name.Label */ -body[data-theme="dark"] .highlight .nn { color: #71ADFF; text-decoration: underline } /* Name.Namespace */ -body[data-theme="dark"] .highlight .nx { color: #D0D0D0 } /* Name.Other */ -body[data-theme="dark"] .highlight .py { color: #D0D0D0 } /* Name.Property */ -body[data-theme="dark"] .highlight .nt { color: #6EBF26; font-weight: bold } /* Name.Tag */ -body[data-theme="dark"] .highlight .nv { color: #40FFFF } /* Name.Variable */ -body[data-theme="dark"] .highlight .ow { color: #6EBF26; font-weight: bold } /* Operator.Word */ -body[data-theme="dark"] .highlight .pm { color: #D0D0D0 } /* Punctuation.Marker */ -body[data-theme="dark"] .highlight .w { color: #666 } /* Text.Whitespace */ -body[data-theme="dark"] .highlight .mb { color: #51B2FD } /* Literal.Number.Bin */ -body[data-theme="dark"] .highlight .mf { color: #51B2FD } /* Literal.Number.Float */ -body[data-theme="dark"] .highlight .mh { color: #51B2FD } /* Literal.Number.Hex */ -body[data-theme="dark"] .highlight .mi { color: #51B2FD } /* Literal.Number.Integer */ -body[data-theme="dark"] .highlight .mo { color: #51B2FD } /* Literal.Number.Oct */ -body[data-theme="dark"] .highlight .sa { color: #ED9D13 } /* Literal.String.Affix */ -body[data-theme="dark"] .highlight .sb { color: #ED9D13 } /* Literal.String.Backtick */ -body[data-theme="dark"] .highlight .sc { color: #ED9D13 } /* Literal.String.Char */ -body[data-theme="dark"] .highlight .dl { color: #ED9D13 } /* Literal.String.Delimiter */ -body[data-theme="dark"] .highlight .sd { color: #ED9D13 } /* Literal.String.Doc */ -body[data-theme="dark"] .highlight .s2 { color: #ED9D13 } /* Literal.String.Double */ -body[data-theme="dark"] .highlight .se { color: #ED9D13 } /* Literal.String.Escape */ -body[data-theme="dark"] .highlight .sh { color: #ED9D13 } /* Literal.String.Heredoc */ -body[data-theme="dark"] .highlight .si { color: #ED9D13 } /* Literal.String.Interpol */ -body[data-theme="dark"] .highlight .sx { color: #FFA500 } /* Literal.String.Other */ -body[data-theme="dark"] .highlight .sr { color: #ED9D13 } /* Literal.String.Regex */ -body[data-theme="dark"] .highlight .s1 { color: #ED9D13 } /* Literal.String.Single */ -body[data-theme="dark"] .highlight .ss { color: #ED9D13 } /* Literal.String.Symbol */ -body[data-theme="dark"] .highlight .bp { color: #2FBCCD } /* Name.Builtin.Pseudo */ -body[data-theme="dark"] .highlight .fm { color: #71ADFF } /* Name.Function.Magic */ -body[data-theme="dark"] .highlight .vc { color: #40FFFF } /* Name.Variable.Class */ -body[data-theme="dark"] .highlight .vg { color: #40FFFF } /* Name.Variable.Global */ -body[data-theme="dark"] .highlight .vi { color: #40FFFF } /* Name.Variable.Instance */ -body[data-theme="dark"] .highlight .vm { color: #40FFFF } /* Name.Variable.Magic */ -body[data-theme="dark"] .highlight .il { color: #51B2FD } /* Literal.Number.Integer.Long */ -@media (prefers-color-scheme: dark) { -body:not([data-theme="light"]) .highlight pre { line-height: 125%; } -body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight .hll { background-color: #404040 } -body:not([data-theme="light"]) .highlight { background: #202020; color: #D0D0D0 } -body:not([data-theme="light"]) .highlight .c { color: #ABABAB; font-style: italic } /* Comment */ -body:not([data-theme="light"]) .highlight .err { color: #A61717; background-color: #E3D2D2 } /* Error */ -body:not([data-theme="light"]) .highlight .esc { color: #D0D0D0 } /* Escape */ -body:not([data-theme="light"]) .highlight .g { color: #D0D0D0 } /* Generic */ -body:not([data-theme="light"]) .highlight .k { color: #6EBF26; font-weight: bold } /* Keyword */ -body:not([data-theme="light"]) .highlight .l { color: #D0D0D0 } /* Literal */ -body:not([data-theme="light"]) .highlight .n { color: #D0D0D0 } /* Name */ -body:not([data-theme="light"]) .highlight .o { color: #D0D0D0 } /* Operator */ -body:not([data-theme="light"]) .highlight .x { color: #D0D0D0 } /* Other */ -body:not([data-theme="light"]) .highlight .p { color: #D0D0D0 } /* Punctuation */ -body:not([data-theme="light"]) .highlight .ch { color: #ABABAB; font-style: italic } /* Comment.Hashbang */ -body:not([data-theme="light"]) .highlight .cm { color: #ABABAB; font-style: italic } /* Comment.Multiline */ -body:not([data-theme="light"]) .highlight .cp { color: #FF3A3A; font-weight: bold } /* Comment.Preproc */ -body:not([data-theme="light"]) .highlight .cpf { color: #ABABAB; font-style: italic } /* Comment.PreprocFile */ -body:not([data-theme="light"]) .highlight .c1 { color: #ABABAB; font-style: italic } /* Comment.Single */ -body:not([data-theme="light"]) .highlight .cs { color: #E50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #FF3A3A } /* Generic.Deleted */ -body:not([data-theme="light"]) .highlight .ge { color: #D0D0D0; font-style: italic } /* Generic.Emph */ -body:not([data-theme="light"]) .highlight .ges { color: #D0D0D0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #FF3A3A } /* Generic.Error */ -body:not([data-theme="light"]) .highlight .gh { color: #FFF; font-weight: bold } /* Generic.Heading */ -body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ -body:not([data-theme="light"]) .highlight .go { color: #CCC } /* Generic.Output */ -body:not([data-theme="light"]) .highlight .gp { color: #AAA } /* Generic.Prompt */ -body:not([data-theme="light"]) .highlight .gs { color: #D0D0D0; font-weight: bold } /* Generic.Strong */ -body:not([data-theme="light"]) .highlight .gu { color: #FFF; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #FF3A3A } /* Generic.Traceback */ -body:not([data-theme="light"]) .highlight .kc { color: #6EBF26; font-weight: bold } /* Keyword.Constant */ -body:not([data-theme="light"]) .highlight .kd { color: #6EBF26; font-weight: bold } /* Keyword.Declaration */ -body:not([data-theme="light"]) .highlight .kn { color: #6EBF26; font-weight: bold } /* Keyword.Namespace */ -body:not([data-theme="light"]) .highlight .kp { color: #6EBF26 } /* Keyword.Pseudo */ -body:not([data-theme="light"]) .highlight .kr { color: #6EBF26; font-weight: bold } /* Keyword.Reserved */ -body:not([data-theme="light"]) .highlight .kt { color: #6EBF26; font-weight: bold } /* Keyword.Type */ -body:not([data-theme="light"]) .highlight .ld { color: #D0D0D0 } /* Literal.Date */ -body:not([data-theme="light"]) .highlight .m { color: #51B2FD } /* Literal.Number */ -body:not([data-theme="light"]) .highlight .s { color: #ED9D13 } /* Literal.String */ -body:not([data-theme="light"]) .highlight .na { color: #BBB } /* Name.Attribute */ -body:not([data-theme="light"]) .highlight .nb { color: #2FBCCD } /* Name.Builtin */ -body:not([data-theme="light"]) .highlight .nc { color: #71ADFF; text-decoration: underline } /* Name.Class */ -body:not([data-theme="light"]) .highlight .no { color: #40FFFF } /* Name.Constant */ -body:not([data-theme="light"]) .highlight .nd { color: #FFA500 } /* Name.Decorator */ -body:not([data-theme="light"]) .highlight .ni { color: #D0D0D0 } /* Name.Entity */ -body:not([data-theme="light"]) .highlight .ne { color: #BBB } /* Name.Exception */ -body:not([data-theme="light"]) .highlight .nf { color: #71ADFF } /* Name.Function */ -body:not([data-theme="light"]) .highlight .nl { color: #D0D0D0 } /* Name.Label */ -body:not([data-theme="light"]) .highlight .nn { color: #71ADFF; text-decoration: underline } /* Name.Namespace */ -body:not([data-theme="light"]) .highlight .nx { color: #D0D0D0 } /* Name.Other */ -body:not([data-theme="light"]) .highlight .py { color: #D0D0D0 } /* Name.Property */ -body:not([data-theme="light"]) .highlight .nt { color: #6EBF26; font-weight: bold } /* Name.Tag */ -body:not([data-theme="light"]) .highlight .nv { color: #40FFFF } /* Name.Variable */ -body:not([data-theme="light"]) .highlight .ow { color: #6EBF26; font-weight: bold } /* Operator.Word */ -body:not([data-theme="light"]) .highlight .pm { color: #D0D0D0 } /* Punctuation.Marker */ -body:not([data-theme="light"]) .highlight .w { color: #666 } /* Text.Whitespace */ -body:not([data-theme="light"]) .highlight .mb { color: #51B2FD } /* Literal.Number.Bin */ -body:not([data-theme="light"]) .highlight .mf { color: #51B2FD } /* Literal.Number.Float */ -body:not([data-theme="light"]) .highlight .mh { color: #51B2FD } /* Literal.Number.Hex */ -body:not([data-theme="light"]) .highlight .mi { color: #51B2FD } /* Literal.Number.Integer */ -body:not([data-theme="light"]) .highlight .mo { color: #51B2FD } /* Literal.Number.Oct */ -body:not([data-theme="light"]) .highlight .sa { color: #ED9D13 } /* Literal.String.Affix */ -body:not([data-theme="light"]) .highlight .sb { color: #ED9D13 } /* Literal.String.Backtick */ -body:not([data-theme="light"]) .highlight .sc { color: #ED9D13 } /* Literal.String.Char */ -body:not([data-theme="light"]) .highlight .dl { color: #ED9D13 } /* Literal.String.Delimiter */ -body:not([data-theme="light"]) .highlight .sd { color: #ED9D13 } /* Literal.String.Doc */ -body:not([data-theme="light"]) .highlight .s2 { color: #ED9D13 } /* Literal.String.Double */ -body:not([data-theme="light"]) .highlight .se { color: #ED9D13 } /* Literal.String.Escape */ -body:not([data-theme="light"]) .highlight .sh { color: #ED9D13 } /* Literal.String.Heredoc */ -body:not([data-theme="light"]) .highlight .si { color: #ED9D13 } /* Literal.String.Interpol */ -body:not([data-theme="light"]) .highlight .sx { color: #FFA500 } /* Literal.String.Other */ -body:not([data-theme="light"]) .highlight .sr { color: #ED9D13 } /* Literal.String.Regex */ -body:not([data-theme="light"]) .highlight .s1 { color: #ED9D13 } /* Literal.String.Single */ -body:not([data-theme="light"]) .highlight .ss { color: #ED9D13 } /* Literal.String.Symbol */ -body:not([data-theme="light"]) .highlight .bp { color: #2FBCCD } /* Name.Builtin.Pseudo */ -body:not([data-theme="light"]) .highlight .fm { color: #71ADFF } /* Name.Function.Magic */ -body:not([data-theme="light"]) .highlight .vc { color: #40FFFF } /* Name.Variable.Class */ -body:not([data-theme="light"]) .highlight .vg { color: #40FFFF } /* Name.Variable.Global */ -body:not([data-theme="light"]) .highlight .vi { color: #40FFFF } /* Name.Variable.Instance */ -body:not([data-theme="light"]) .highlight .vm { color: #40FFFF } /* Name.Variable.Magic */ -body:not([data-theme="light"]) .highlight .il { color: #51B2FD } /* Literal.Number.Integer.Long */ -} -} \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/scripts/furo.js b/SRV/docs/_build/html/_static/scripts/furo.js deleted file mode 100644 index 87e1767..0000000 --- a/SRV/docs/_build/html/_static/scripts/furo.js +++ /dev/null @@ -1,3 +0,0 @@ -/*! For license information please see furo.js.LICENSE.txt */ -(()=>{var t={856:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort(function(t,e){return o(t.content)=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})}),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(function(){r(a),v.detect()})};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}}),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(856),e=n.n(t),o=null,r=null,c=document.documentElement.scrollTop;function s(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function l(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach(t=>{t.addEventListener("click",s)})}(),function(){let t=0,e=!1;window.addEventListener("scroll",function(n){t=window.scrollY,e||(window.requestAnimationFrame(function(){var n;(function(t){t>0?r.classList.add("scrolled"):r.classList.remove("scrolled")})(n=t),function(t){t<64?document.documentElement.classList.remove("show-back-to-top"):tc&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1}),e=!0)}),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);const e=r.getBoundingClientRect();return e.top+e.height+2.5*t+1}})}document.addEventListener("DOMContentLoaded",function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),l()})})()})(); -//# sourceMappingURL=furo.js.map \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/scripts/furo.js.LICENSE.txt b/SRV/docs/_build/html/_static/scripts/furo.js.LICENSE.txt deleted file mode 100644 index 1632189..0000000 --- a/SRV/docs/_build/html/_static/scripts/furo.js.LICENSE.txt +++ /dev/null @@ -1,7 +0,0 @@ -/*! - * gumshoejs v5.1.2 (patched by @pradyunsg) - * A simple, framework-agnostic scrollspy script. - * (c) 2019 Chris Ferdinandi - * MIT License - * http://github.com/cferdinandi/gumshoe - */ diff --git a/SRV/docs/_build/html/_static/scripts/furo.js.map b/SRV/docs/_build/html/_static/scripts/furo.js.map deleted file mode 100644 index 3b316f3..0000000 --- a/SRV/docs/_build/html/_static/scripts/furo.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACLA,OACAC,KAbO,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,EAVgB,CAWrC,EAOIK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,CACpC,EAMIG,EAAe,SAAUC,GACvBA,GACFA,EAASC,KAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,CACT,EAEJ,EAwCIC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,OAC7B,CA2Be4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,CACrC,EAMImC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,aAkC7B,EAmBIU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,GAEvD,CAUMwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,EAEjE,EAOIC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,GAV0B,CAWjD,EAOIiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,EAOIoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,GAVS,CAW9B,EA6LA,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,EAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,GAEb,GAGAL,EAAaC,EACf,EAKAgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,CAqEIuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,KAchB,GAMIe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,OACpD,EAMIC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,QACb,EACF,EAkDA,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,IACb,EAOEA,EA3XS,WACX,IAAI+E,EAAS,CAAC,EAOd,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,UAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,EACpB,CACF,GACOH,CACT,CAkXeK,CAAOhG,EAAUmE,GAAW,CAAC,GAGxCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,CACT,CAOF,CArcW4B,CAAQvG,EAChB,UAFM,SAEN,oB,GCXDwG,EAA2B,CAAC,EAGhC,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,CAAC,GAOX,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,OACf,CCrBAJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,GCLRR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,MCJ3EO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,EAChB,CAAE,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,MACxC,CACA,CAPuB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,G,yCCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgBzF,SAASC,gBAAgByF,UA4E7C,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaIrI,OAAOsI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGT/F,SAASS,KAAK2F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,UA0B5B,CAmDA,SAASlC,KART,WAEE,MAAM2C,EAAUxG,SAASyG,uBAAuB,gBAChDpE,MAAMqE,KAAKF,GAASjE,QAASoE,IAC3BA,EAAI7C,iBAAiB,QAAS6B,IAElC,CAGEiB,GA/CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdpJ,OAAOoG,iBAAiB,SAAU,SAAUuB,GAC1CwB,EAA6BnJ,OAAOqJ,QAE/BD,IACHpJ,OAAOwF,sBAAsB,WAzDnC,IAAuB8D,GArDvB,SAAgCA,GAC1BA,EAAY,EACdxB,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,WAE5B,EAgDEyF,CADqBD,EA0DDH,GAvGtB,SAAmCG,GAC7BA,EAXmB,GAYrBhH,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCwF,EAAYvB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BmF,EAAYvB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBuB,CAClB,CAoCEE,CAA0BF,GAlC5B,SAA6BA,GACT,OAAdzB,IAKa,GAAbyB,EACFzB,EAAU4B,SAAS,EAAG,GAGtB9G,KAAKC,KAAK0G,IACV3G,KAAK+G,MAAMpH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU4B,SAAS,EAAG5B,EAAU7E,cAGhBV,SAASqH,cAAc,mBAc3C,CAKEC,CAAoBN,GAwDdF,GAAU,CACZ,GAEAA,GAAU,EAEd,GACApJ,OAAO6J,QACT,CA8BEC,GA3BkB,OAAdjC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRuJ,WAAW,EACX5J,SAAU,iBACVI,OAAQ,KACN,IAAIyJ,EAAM9H,WAAW+H,iBAAiB3H,SAASC,iBAAiB2H,UAChE,MAAMC,EAAarC,EAAO7F,wBAC1B,OAAOkI,EAAW1H,IAAM0H,EAAWC,OAAS,IAAMJ,EAAM,IAiB9D,CAcA1H,SAAS8D,iBAAiB,mBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASqH,cAAc,UAChC9B,EAAYvF,SAASqH,cAAc,eAEnCxD,GACF,E","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader(positionY) {\n if (positionY > 0) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader(positionY);\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n const headerRect = header.getBoundingClientRect();\n return headerRect.top + headerRect.height + 2.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","scrollHandlerForHeader","scrollHandlerForBackToTop","scrollTo","floor","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","headerRect","height"],"sourceRoot":""} \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/searchtools.js b/SRV/docs/_build/html/_static/searchtools.js deleted file mode 100644 index 91f4be5..0000000 --- a/SRV/docs/_build/html/_static/searchtools.js +++ /dev/null @@ -1,635 +0,0 @@ -/* - * Sphinx JavaScript utilities for the full-text search. - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename, kind] = result - return score - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: { - 0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5, // used to be unimportantResults - }, - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2, - }; -} - -// Global search result kind enum, used by themes to style search results. -class SearchResultKind { - static get index() { return "index"; } - static get object() { return "object"; } - static get text() { return "text"; } - static get title() { return "title"; } -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms, highlightTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const contentRoot = document.documentElement.dataset.content_root; - - const [docName, title, anchor, descr, score, _filename, kind] = item; - - let listItem = document.createElement("li"); - // Add a class representing the item's type: - // can be used by a theme's CSS selector for styling - // See SearchResultKind for the class names. - listItem.classList.add(`kind-${kind}`); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = contentRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = contentRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) { - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - // highlight search terms in the description - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - } - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, anchor) - ); - // highlight search terms in the summary - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." - ); - else - Search.status.innerText = Documentation.ngettext( - "Search finished, found one page matching the search query.", - "Search finished, found ${resultCount} pages matching the search query.", - resultCount, - ).replace('${resultCount}', resultCount); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms, - highlightTerms, -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms, highlightTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; -// Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. -// Order the results by score (in opposite order of appearance, since the -// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. -const _orderResultsByScoreThenName = (a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString, anchor) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlink", "script", "style"]) { - htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); - } - if (anchor) { - const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); - if (anchorContent) return anchorContent.textContent; - - console.warn( - `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` - ); - } - - // if anchor not specified or not found, fall back to main content - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent) return docContent.textContent; - - console.warn( - "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.setAttribute("role", "list"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - _parseQuery: (query) => { - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; - }, - - /** - * execute search (requires search index to be loaded) - */ - _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename, kind]. - const normalResults = []; - const nonMainIndexResults = []; - - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase().trim(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - const score = Math.round(Scorer.title * queryLower.length / title.length); - const boost = titles[file] === title ? 1 : 0; // add a boost for document titles - normalResults.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score + boost, - filenames[file], - SearchResultKind.title, - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id, isMain] of foundEntries) { - const score = Math.round(100 * queryLower.length / entry.length); - const result = [ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - SearchResultKind.index, - ]; - if (isMain) { - normalResults.push(result); - } else { - nonMainIndexResults.push(result); - } - } - } - } - - // lookup as object - objectTerms.forEach((term) => - normalResults.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) { - normalResults.forEach((item) => (item[4] = Scorer.score(item))); - nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); - } - - // Sort each group of results by score and then alphabetically by name. - normalResults.sort(_orderResultsByScoreThenName); - nonMainIndexResults.sort(_orderResultsByScoreThenName); - - // Combine the result groups in (reverse) order. - // Non-main index entries are typically arbitrary cross-references, - // so display them after other results. - let results = [...nonMainIndexResults, ...normalResults]; - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - return results.reverse(); - }, - - query: (query) => { - const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); - const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms, highlightTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const parts = fullnameLower.split("."); - - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower === object || parts.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) - score += Scorer.objPrio[match[2]]; - else score += Scorer.objPrioDefault; - - results.push([ - docNames[match[0]], - fullname, - "#" + anchor, - descr, - score, - filenames[match[0]], - SearchResultKind.object, - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - // find documents, if any, containing the query word in their text/title term indices - // use Object.hasOwnProperty to avoid mismatching against prototype properties - const arr = [ - { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term }, - { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - if (!terms.hasOwnProperty(word)) { - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - } - if (!titleTerms.hasOwnProperty(word)) { - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); - }); - } - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, new Map()); - const fileScores = scoreMap.get(file); - fileScores.set(word, record.score); - }); - }); - - // create the mapping - files.forEach((file) => { - if (!fileMap.has(file)) fileMap.set(file, [word]); - else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w))); - // add result to the result list - results.push([ - docNames[file], - titles[file], - "", - null, - score, - filenames[file], - SearchResultKind.text, - ]); - } - return results; - }, - - /** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words. - */ - makeSearchSummary: (htmlText, keywords, anchor) => { - const text = Search.htmlToText(htmlText, anchor); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/SRV/docs/_build/html/_static/skeleton.css b/SRV/docs/_build/html/_static/skeleton.css deleted file mode 100644 index 467c878..0000000 --- a/SRV/docs/_build/html/_static/skeleton.css +++ /dev/null @@ -1,296 +0,0 @@ -/* Some sane resets. */ -html { - height: 100%; -} - -body { - margin: 0; - min-height: 100%; -} - -/* All the flexbox magic! */ -body, -.sb-announcement, -.sb-content, -.sb-main, -.sb-container, -.sb-container__inner, -.sb-article-container, -.sb-footer-content, -.sb-header, -.sb-header-secondary, -.sb-footer { - display: flex; -} - -/* These order things vertically */ -body, -.sb-main, -.sb-article-container { - flex-direction: column; -} - -/* Put elements in the center */ -.sb-header, -.sb-header-secondary, -.sb-container, -.sb-content, -.sb-footer, -.sb-footer-content { - justify-content: center; -} -/* Put elements at the ends */ -.sb-article-container { - justify-content: space-between; -} - -/* These elements grow. */ -.sb-main, -.sb-content, -.sb-container, -article { - flex-grow: 1; -} - -/* Because padding making this wider is not fun */ -article { - box-sizing: border-box; -} - -/* The announcements element should never be wider than the page. */ -.sb-announcement { - max-width: 100%; -} - -.sb-sidebar-primary, -.sb-sidebar-secondary { - flex-shrink: 0; - width: 17rem; -} - -.sb-announcement__inner { - justify-content: center; - - box-sizing: border-box; - height: 3rem; - - overflow-x: auto; - white-space: nowrap; -} - -/* Sidebars, with checkbox-based toggle */ -.sb-sidebar-primary, -.sb-sidebar-secondary { - position: fixed; - height: 100%; - top: 0; -} - -.sb-sidebar-primary { - left: -17rem; - transition: left 250ms ease-in-out; -} -.sb-sidebar-secondary { - right: -17rem; - transition: right 250ms ease-in-out; -} - -.sb-sidebar-toggle { - display: none; -} -.sb-sidebar-overlay { - position: fixed; - top: 0; - width: 0; - height: 0; - - transition: width 0ms ease 250ms, height 0ms ease 250ms, opacity 250ms ease; - - opacity: 0; - background-color: rgba(0, 0, 0, 0.54); -} - -#sb-sidebar-toggle--primary:checked - ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--primary"], -#sb-sidebar-toggle--secondary:checked - ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--secondary"] { - width: 100%; - height: 100%; - opacity: 1; - transition: width 0ms ease, height 0ms ease, opacity 250ms ease; -} - -#sb-sidebar-toggle--primary:checked ~ .sb-container .sb-sidebar-primary { - left: 0; -} -#sb-sidebar-toggle--secondary:checked ~ .sb-container .sb-sidebar-secondary { - right: 0; -} - -/* Full-width mode */ -.drop-secondary-sidebar-for-full-width-content - .hide-when-secondary-sidebar-shown { - display: none !important; -} -.drop-secondary-sidebar-for-full-width-content .sb-sidebar-secondary { - display: none !important; -} - -/* Mobile views */ -.sb-page-width { - width: 100%; -} - -.sb-article-container, -.sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content .sb-article, -.drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 100vw; -} - -.sb-article, -.match-content-width { - padding: 0 1rem; - box-sizing: border-box; -} - -@media (min-width: 32rem) { - .sb-article, - .match-content-width { - padding: 0 2rem; - } -} - -/* Tablet views */ -@media (min-width: 42rem) { - .sb-article-container { - width: auto; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 42rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} -@media (min-width: 46rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 46rem; - } - .sb-article, - .match-content-width { - width: 46rem; - } -} -@media (min-width: 50rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 50rem; - } - .sb-article, - .match-content-width { - width: 50rem; - } -} - -/* Tablet views */ -@media (min-width: 59rem) { - .sb-sidebar-secondary { - position: static; - } - .hide-when-secondary-sidebar-shown { - display: none !important; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 59rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} -@media (min-width: 63rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 63rem; - } - .sb-article, - .match-content-width { - width: 46rem; - } -} -@media (min-width: 67rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } - .sb-article, - .match-content-width { - width: 50rem; - } -} - -/* Desktop views */ -@media (min-width: 76rem) { - .sb-sidebar-primary { - position: static; - } - .hide-when-primary-sidebar-shown { - display: none !important; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 59rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} - -/* Full desktop views */ -@media (min-width: 80rem) { - .sb-article, - .match-content-width { - width: 46rem; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 63rem; - } -} - -@media (min-width: 84rem) { - .sb-article, - .match-content-width { - width: 50rem; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } -} - -@media (min-width: 88rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } - .sb-page-width { - width: 88rem; - } -} diff --git a/SRV/docs/_build/html/_static/sphinx_highlight.js b/SRV/docs/_build/html/_static/sphinx_highlight.js deleted file mode 100644 index 8a96c69..0000000 --- a/SRV/docs/_build/html/_static/sphinx_highlight.js +++ /dev/null @@ -1,154 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - const rest = document.createTextNode(val.substr(pos + text.length)); - parent.insertBefore( - span, - parent.insertBefore( - rest, - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - /* There may be more occurrences of search term in this node. So call this - * function recursively on the remaining fragment. - */ - _highlight(rest, addItems, text, className); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute("class", className); - addItems.push({ parent: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(() => { - /* Do not call highlightSearchWords() when we are on the search page. - * It will highlight words from the *previous* search query. - */ - if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); - SphinxHighlight.initEscapeListener(); -}); diff --git a/SRV/docs/_build/html/_static/styles/furo-extensions.css b/SRV/docs/_build/html/_static/styles/furo-extensions.css deleted file mode 100644 index 2d74267..0000000 --- a/SRV/docs/_build/html/_static/styles/furo-extensions.css +++ /dev/null @@ -1,2 +0,0 @@ -#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0s}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} -/*# sourceMappingURL=furo-extensions.css.map*/ \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/styles/furo-extensions.css.map b/SRV/docs/_build/html/_static/styles/furo-extensions.css.map deleted file mode 100644 index 68fb7fd..0000000 --- a/SRV/docs/_build/html/_static/styles/furo-extensions.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAEE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cAIA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,mBACA,CACA,wCACE,cAEJ,8BACE,UCzCN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""} \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/styles/furo.css b/SRV/docs/_build/html/_static/styles/furo.css deleted file mode 100644 index 592d5bf..0000000 --- a/SRV/docs/_build/html/_static/styles/furo.css +++ /dev/null @@ -1,2 +0,0 @@ -/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,p,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;width:1px!important;clip:rect(0,0,0,0)!important;background:var(--color-background-primary);border:0!important;color:var(--color-foreground-primary);white-space:nowrap!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-stack--headings:var(--font-stack);--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,');--icon-pencil:url('data:image/svg+xml;charset=utf-8,');--icon-abstract:url('data:image/svg+xml;charset=utf-8,');--icon-info:url('data:image/svg+xml;charset=utf-8,');--icon-flame:url('data:image/svg+xml;charset=utf-8,');--icon-question:url('data:image/svg+xml;charset=utf-8,');--icon-warning:url('data:image/svg+xml;charset=utf-8,');--icon-failure:url('data:image/svg+xml;charset=utf-8,');--icon-spark:url('data:image/svg+xml;charset=utf-8,');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.2);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.2);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.2);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.2);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.2);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.2);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.2);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.2);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.2);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.2);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.2);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.2);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.2);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#6b6f76;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#0a4bff;--color-brand-content:#2757dd;--color-brand-visited:#872ee0;--color-api-background:var(--color-background-hover--transparent);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-api-added:#21632c;--color-api-added-border:#38a84d;--color-api-changed:#046172;--color-api-changed-border:#06a1bc;--color-api-deprecated:#605706;--color-api-deprecated-border:#f0d90f;--color-api-removed:#b30000;--color-api-removed-border:#ff5c5c;--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link--hover:var(--color-brand-content);--color-link-underline--hover:var(--color-foreground-border);--color-link--visited:var(--color-brand-visited);--color-link-underline--visited:var(--color-background-border);--color-link--visited--hover:var(--color-brand-visited);--color-link-underline--visited--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#cfd0d0;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#3d94ff;--color-brand-content:#5ca5ff;--color-brand-visited:#b27aeb;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-api-added:#3db854;--color-api-added-border:#267334;--color-api-changed:#09b0ce;--color-api-changed-border:#056d80;--color-api-deprecated:#b1a10b;--color-api-deprecated-border:#6e6407;--color-api-removed:#ff7575;--color-api-removed-border:#b03b3b;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#cfd0d0;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#3d94ff;--color-brand-content:#5ca5ff;--color-brand-visited:#b27aeb;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-api-added:#3db854;--color-api-added-border:#267334;--color-api-changed:#09b0ce;--color-api-changed-border:#056d80;--color-api-deprecated:#b1a10b;--color-api-deprecated-border:#6e6407;--color-api-removed:#ff7575;--color-api-removed-border:#b03b3b;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light{display:block}@media(prefers-color-scheme:dark){body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-dark{display:block}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto-light{display:none}}body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-family:var(--font-stack--headings);font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}a:visited{color:var(--color-link--visited);text-decoration-color:var(--color-link-underline--visited)}a:visited:hover{color:var(--color-link--visited--hover);text-decoration-color:var(--color-link-underline--visited--hover)}a:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link:hover:visited{color:var(--color-link--visited--hover);text-decoration-color:var(--color-link-underline--visited--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}body,html{height:100%}.skip-to-content,body,html{background:var(--color-background-primary);color:var(--color-foreground-primary)}.skip-to-content{border-radius:1rem;left:.25rem;padding:1rem;position:fixed;top:.25rem;transform:translateY(-200%);transition:transform .3s ease-in-out;z-index:40}.skip-to-content:focus-within{transform:translateY(0)}article{background:var(--color-content-background);color:var(--color-content-foreground);overflow-wrap:break-word}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{display:flex}.theme-toggle{background:transparent;border:none;cursor:pointer;display:flex;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1.25rem;width:1.25rem}.theme-toggle-header{align-items:center;display:flex;justify-content:center}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1.5rem;width:1.5rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg,.content-icon-container .view-this-page svg{color:inherit;height:1.25rem;width:1.25rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0s,height 0s,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{height:1rem;width:1rem;fill:currentColor;display:inline-block}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.content{margin-left:auto;margin-right:auto;padding:0 1em}}@media(max-width:63em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.theme-toggle-header,.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.nav-overlay-icon .icon,.theme-toggle svg{height:1.5rem;width:1.5rem}:target{scroll-margin-top:calc(var(--header-height) + 2.5rem)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}}@media(max-width:48em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){article[role=main] aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}.admonition p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}.admonition p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;margin-left:-.25rem;margin-right:-.25rem;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em;transition:background .1s ease-out}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:4.25rem}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}div.deprecated,div.versionadded,div.versionchanged,div.versionremoved{border-left:.1875rem solid;border-radius:.125rem;padding-left:.75rem}div.deprecated p,div.versionadded p,div.versionchanged p,div.versionremoved p{margin-bottom:.125rem;margin-top:.125rem}div.versionadded{border-color:var(--color-api-added-border)}div.versionadded .versionmodified{color:var(--color-api-added)}div.versionchanged{border-color:var(--color-api-changed-border)}div.versionchanged .versionmodified{color:var(--color-api-changed)}div.deprecated{border-color:var(--color-api-deprecated-border)}div.deprecated .versionmodified{color:var(--color-api-deprecated)}div.versionremoved{border-color:var(--color-api-removed-border)}div.versionremoved .versionmodified{color:var(--color-api-removed)}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}pre.literal-block .sig-inline,pre.literal-block code.literal{font-size:inherit;padding:0}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}pre{overflow:auto}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class]>.highlight{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>:not(span),div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}ol.arabic{list-style:decimal}ol.loweralpha{list-style:lower-alpha}ol.upperalpha{list-style:upper-alpha}ol.lowerroman{list-style:lower-roman}ol.upperroman{list-style:upper-roman}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}[role=main] .table-wrapper.container{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:2.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(2.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(2.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover);color:var(--color-sidebar-link-text)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23607d8b' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' viewBox='0 0 24 24'%3E%3Cpath stroke='none' d='M0 0h24v24H0z'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree a.reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling. Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} -/*# sourceMappingURL=furo.css.map*/ \ No newline at end of file diff --git a/SRV/docs/_build/html/_static/styles/furo.css.map b/SRV/docs/_build/html/_static/styles/furo.css.map deleted file mode 100644 index 280b3fe..0000000 --- a/SRV/docs/_build/html/_static/styles/furo.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"styles/furo.css","mappings":"AAAA,2EAA2E,CAU3E,KACE,gBAAiB,CACjB,6BACF,CASA,KACE,QACF,CAMA,KACE,aACF,CAOA,GACE,aAAc,CACd,cACF,CAUA,GACE,sBAAuB,CACvB,QAAS,CACT,gBACF,CAOA,IACE,+BAAiC,CACjC,aACF,CASA,EACE,4BACF,CAOA,YACE,kBAAmB,CACnB,yBAA0B,CAC1B,gCACF,CAMA,SAEE,kBACF,CAOA,cAGE,+BAAiC,CACjC,aACF,CAeA,QAEE,aAAc,CACd,aAAc,CACd,iBAAkB,CAClB,uBACF,CAEA,IACE,aACF,CAEA,IACE,SACF,CASA,IACE,iBACF,CAUA,sCAKE,mBAAoB,CACpB,cAAe,CACf,gBAAiB,CACjB,QACF,CAOA,aAEE,gBACF,CAOA,cAEE,mBACF,CAMA,gDAIE,yBACF,CAMA,wHAIE,iBAAkB,CAClB,SACF,CAMA,4GAIE,6BACF,CAMA,SACE,0BACF,CASA,OACE,qBAAsB,CACtB,aAAc,CACd,aAAc,CACd,cAAe,CACf,SAAU,CACV,kBACF,CAMA,SACE,uBACF,CAMA,SACE,aACF,CAOA,6BAEE,qBAAsB,CACtB,SACF,CAMA,kFAEE,WACF,CAOA,cACE,4BAA6B,CAC7B,mBACF,CAMA,yCACE,uBACF,CAOA,6BACE,yBAA0B,CAC1B,YACF,CASA,QACE,aACF,CAMA,QACE,iBACF,CAiBA,kBACE,YACF,CCvVA,aAcE,kEACE,uBAOF,WACE,iDAMF,kCACE,wBAEF,qCAEE,uBADA,uBACA,CAEF,SACE,wBAtBA,CCpBJ,iBAGE,qBAEA,sBACA,0BAFA,oBAHA,4BACA,oBAKA,6BAIA,2CAFA,mBACA,sCAFA,4BAGA,CAEF,gBACE,aCPF,KCCE,mHAGA,wGAGA,wCAAyC,CAEzC,wBAAyB,CACzB,wBAAyB,CACzB,4BAA6B,CAC7B,yBAA0B,CAC1B,2BAA4B,CAG5B,sDAAuD,CACvD,gDAAiD,CACjD,wDAAyD,CAGzD,0CAA2C,CAC3C,gDAAiD,CACjD,gDAAiD,CAKjD,gCAAiC,CACjC,sCAAuC,CAGvC,2CAA4C,CAG5C,uCAAwC,CCnCxC,+FAIA,uBAAwB,CAGxB,iCAAkC,CAClC,kCAAmC,CAEnC,+BAAgC,CAChC,sCAAuC,CACvC,sCAAuC,CACvC,qGAIA,mDAAoD,CAEpD,mCAAoC,CACpC,8CAA+C,CAC/C,gDAAiD,CACjD,kCAAmC,CACnC,6DAA8D,CAG9D,6BAA8B,CAC9B,6BAA8B,CAC9B,+BAAgC,CAChC,kCAAmC,CACnC,kCAAmC,CCRjC,+jBCaA,iqCAZF,iaCXA,8KAOA,4SAWA,4SAUA,0CACA,gEAGA,0CAGA,gEAGA,yCACA,+DAIA,4CACA,kEAGA,wCAUA,8DACA,uCAGA,4DACA,sCACA,2DAGA,4CACA,kEACA,uCAGA,6DACA,2GAGA,sHAEA,yFAEA,+CACA,+EAGA,4MAOA,gCACA,sHAIA,kCACA,uEACA,gEACA,4DACA,kEAGA,2DACA,sDACA,0CACA,8CACA,wGAGA,0BACA,iCAGA,+DACA,+BACA,sCACA,+DAEA,kGACA,oCACA,yDACA,sCL3HF,kCAEA,sDAIA,0CKyHE,kEAIA,oDACA,sDAGA,oCACA,oEAEA,0DACA,qDAIA,oDACA,6DAIA,iEAIA,2DAIA,2DAGA,4DACA,gEAIA,gEAEA,gFAEA,oNASA,qDLtKE,gFAGE,4DAIF,oEKgHF,yEAEA,6DAGA,0DAEA,uDACA,qDACA,wDAIA,6DAIA,yDACA,2DAIA,uCAGA,wCACA,sDAGA,+CAGA,6DAEA,iDACA,+DAEA,wDAEA,sEAMA,0DACA,sBACA,mEL5JI,wEAEA,iCACE,+BAMN,wEAGA,iCACE,kFAEA,uEAIF,gEACE,8BAGF,qEMzDA,sCAKA,wFAKA,iCAIA,0BAWA,iCACA,4BACA,mCAGA,+BAEA,sCACA,4BAEA,mCAEA,sCAKA,sDAIA,gCAEA,gEAQF,wCAME,sBACA,kCAKA,uBAEA,gEAIA,2BAIA,mCAEA,qCACA,iCAGE,+BACA,wEAEE,iCACA,kFAGF,6BACA,0CACF,kCAEE,8BACE,8BACA,qEAEE,sCACA,wFClFN,iCAGF,2DACE,4BACA,oCAKF,8BAGE,sCACA,+DAIA,sCAEA,sDAGA,gCACA,gEAGA,+CAEA,sBACE,yCAGF,uBACA,sEAIA,aAEA,mCAIA,kEACA,aACA,oEACA,YAIA,EAQE,4HAGA,gDACE,mBACA,wCAON,wCAGE,0DACA,mBAKA,mBACA,CANA,uCAKA,iBALA,iBAWA,mBAGF,mBACE,mDAIF,+BAEE,CAEA,yBAFA,kBAMA,CAJA,GACA,aAGA,mBAEF,wBAEE,iBACA,iBAEA,OACA,aAGF,CAHE,WAGF,GAEE,oBAEA,CAJF,gBAIE,aAEA,+CAKA,UANA,WACA,cADA,SAMA,WACA,iBAEE,GAMF,wBANE,yBAMF,kDACA,WAEA,gCACA,2DAGA,iBACE,uCAEJ,kEAIE,uCAGA,yDACE,cACA,+DAEA,yDAEE,mEAMJ,kEAMA,uBACA,kBAEA,uBACA,kDAKA,0DAIA,CALA,oBAKA,WACA,WAQA,4BAFF,0CAEE,CARA,qCAsBA,CAdA,iBAEA,kBACE,aADF,4BACE,WAMF,2BAGF,qCAEE,CAXE,UAWF,+BAGA,uBAEA,SAEA,0CAIE,CANF,qCAEA,CAIE,2DACE,gBAIN,+CAIA,CAEA,kDAKE,CAPF,8BAEA,CAOE,YACA,CAjBI,2BAGN,CAHM,WAcJ,UAGA,CAEA,2GAIF,iCAGE,8BAIA,qBACA,oBACF,uBAOI,0CAIA,CATF,6DAKE,CALF,sBASE,qCAKF,CACE,cACA,CAFF,sBAEE,CACA,+BAEA,qBAEE,WAKN,aACE,sCAGA,mBAEA,6BAMA,kCACA,CAJA,sBACA,aAEA,CAJA,eACA,MAIA,2FAEA,UAGA,YACA,sBACE,8BAEA,CALF,aACA,WAIE,OACA,oBAEF,uBACE,WAEF,YAFE,UAEF,eAgBA,kBACE,CAhBA,qDAQF,qCAGF,CAGI,YACF,CAJF,2BAGI,CAEA,eACA,qBAGA,mEAEA,qBACA,8BAIA,kBADF,kBACE,yBAEJ,oCAGI,qDAIJ,+BAGI,oCAEA,+CAQF,4CACE,yBACF,2BAOE,sBACA,CAHA,WACA,CAFF,cACE,CAJA,YAGF,CAEE,SAEA,mBAGA,kDAEE,CAJF,cAEA,cAEE,sBAEA,mBADA,YACA,uBACA,mDACE,CADF,YACE,iDAEA,uCAEN,+DAOE,mBADF,sBACE,mBAGF,aACE,sCAIA,aADF,WACE,CAKF,SACE,CAHJ,kBAEE,CAJE,gBAEJ,CAHI,iBAMA,yFAKA,aACA,eACA,cCxaJ,iBAEE,aADA,iBACA,6BAEA,kCAEA,SACA,UAIA,gCACA,CALA,SAEA,SAEA,CAJA,wEAEA,CAFA,OAKA,CAGA,mDACE,iBAGF,gCACE,CADF,UACE,aAEJ,iCAEE,CAFF,UAEE,wCAEA,WACA,WADA,UACA,CACA,4CAGA,MACA,CADA,KACA,wCACA,UAGA,CAJA,UAIA,6DAUA,0CACE,CAFF,mBAEE,wEACA,CAVA,YACA,CAMF,mBAJE,OAOA,gBAJJ,gCACE,CANE,cACA,CAHA,oBACA,CAGA,QAGJ,CAII,0BACA,CADA,UACA,wCAEJ,kBACE,0DACA,gCACE,kBACA,CADA,YACA,oEACA,2CAMF,mDAII,CALN,YACE,CANE,cAKJ,CACE,iBAII,kEACA,yCACE,kDACA,yDACE,+CACA,uBANN,CAMM,+BANN,uCACE,qDACA,4BAEE,mBADA,0CACA,CADA,qBACA,0DACE,wCACA,sGALJ,oCACA,sBACE,kBAFF,UAEE,2CACA,wFACE,cACA,kEANN,uBACE,iDACA,CADA,UACA,0DACE,wDAEE,iEACA,qEANN,sCACE,CAGE,iBAHF,gBAGE,qBACE,CAJJ,uBACA,gDACE,wDACA,6DAHF,2CACA,CADA,gBACA,eACE,CAGE,sBANN,8BACE,CAII,iBAFF,4DACA,WACE,YADF,uCACE,6EACA,2BANN,8CACE,kDACA,0CACE,8BACA,yFACE,sBACA,sFALJ,mEACA,sBACE,kEACA,6EACE,uCACA,kEALJ,qGAEE,kEACA,6EACE,uCACA,kEALJ,8CACA,uDACE,sEACA,2EACE,sCACA,iEALJ,mGACA,qCACE,oDACA,0DACE,6GACA,gDAGR,yDCvEA,sEACE,CACA,6GACE,gEACF,iGAIF,wFACE,qDAGA,mGAEE,2CAEF,4FACE,gCACF,wGACE,8DAEE,6FAIA,iJAKN,6GACE,gDAKF,yDACA,qCAGA,6BACA,kBACA,qDAKA,oCAEA,+DAGA,2CAGE,oDAIA,oEAEE,qBAGJ,wDAEE,uCAEF,kEAGA,8CAEA,uDAIF,gEAIE,6BACA,gEAIA,+CACE,0EAIF,sDAEE,+DAGF,sCACA,8BACE,oCAEJ,wBACE,4FAEE,gBAEJ,yGAGI,kBAGJ,CCnHE,2MCFF,oBAGE,wGAKA,iCACE,CADF,wBACE,8GAQA,mBCjBJ,2GAIE,mBACA,6HAMA,YACE,mIAYF,eACA,CAHF,YAGE,4FAGE,8BAKF,uBAkBE,sCACA,CADA,qBAbA,wCAIA,CALF,8BACE,CADF,gBAKE,wCACA,CAOA,kDACA,CACA,kCAKF,6BAGA,4CACE,kDACA,eAGF,cACE,aACA,iBACA,yBACA,8BACA,WAGJ,2BACE,cAGA,+BACA,CAHA,eAGA,wCACA,YACA,iBACA,uEAGA,0BACA,2CAEA,8EAGI,qBACA,CAFF,kBAEE,4DAMJ,mCACE,4BAGA,oBAGF,4CACE,qCACA,8BACA,gBACA,+CAEA,iCAEF,iCACE,oBACA,4CACA,qCAGF,8BAEE,+BAEA,WAEA,8BACE,oBACA,CADA,gBACA,yBAKF,gBADF,YACE,CACA,iBACA,qDAEA,mDCvIJ,2FAMA,iCACE,CACA,eAEA,CAFA,mBADA,wBAIA,8BACA,gBADA,YACA,0BAEE,8CAGA,wDAIE,gFAGE,iBAEN,wCAKF,+CACE,CACA,oDAEF,kDAIE,YAEF,CAHE,YAGF,CCpCE,mFAFA,QACA,UAIA,CAHA,IAGA,gDAGE,eACA,iEAGF,wBAEE,mBAMA,6CAEF,CAJE,mBACA,CAGF,kCAGE,CARF,kBACE,CAHA,eAUA,YACA,mBACA,CAFA,UAEA,wCC/BJ,mBACE,CDkCE,wBACA,sBCpCJ,iBACE,mDACA,2CACA,sBAGA,qBCDA,6CAIE,CATJ,uBAKE,CDGE,oBACF,yDAEE,CCDE,2CAGF,CAJA,kCACE,CDJJ,aAKE,eCXJ,CDME,uBCOE,gCACE,YAEF,2CAEE,wBACA,0BAIF,iBAEA,cADF,UACE,uBAEA,iCAEA,wCAEA,6CAMA,CAYF,gCATI,4BASJ,CAZE,mCAEE,iCAUJ,4BAGE,4DADA,+BACA,CAHF,qBAGE,sCACE,OAEF,iBAHA,SAGA,iHACE,2DAKF,CANA,8EAMA,uSAEE,kBAEF,+FACE,yCCjEJ,WACA,yBAGA,uBACA,gBAEA,uCAIA,CAJA,iCAIA,uCAGA,UACE,gBACA,qBAEA,0CClBJ,gBACE,KAGF,qBACE,YAGF,CAHE,cAGF,gCAEE,mBACA,iEAEA,oCACA,wCAEA,sBACA,WAEA,CAFA,YAEA,8EAEA,mCAFA,iBAEA,6BAIA,wEAKA,sDAIE,CARF,mDAIA,CAIE,cAEF,8CAIA,oBAFE,iBAEF,8CAGE,eAEF,CAFE,YAEF,OAEE,kBAGJ,CAJI,eACA,CAFF,mBAKF,yCCjDE,oBACA,CAFA,iBAEA,uCAKE,iBACA,qCAGA,mBCZJ,CDWI,gBCXJ,6BAEE,eACA,sBAGA,eAEA,sBACA,oDACA,iGAMA,gBAFE,YAEF,8FAME,iJCnBF,YACA,gNAWE,gDAEF,iSAaE,kBACE,gHAKF,oCACE,eACF,CADE,UACF,8CACE,gDACF,wCACE,oBCtCJ,oBAEF,6BACE,QACE,kDAGF,yBACE,kDAmBA,kDAEF,CAhBA,+CAaA,CAbA,oBAaA,0FACE,CADF,gGAfF,cACE,gBACA,CAaA,0BAGA,mQACE,gBAGF,oMACE,iBACA,CAFF,eACE,CADF,gBAEE,aAGJ,iCAEE,CAFF,wCAEE,wBAUE,+VAIE,uEAHA,2BAGA,wXAKJ,iDAGF,CARM,+CACE,iDAIN,CALI,gBAQN,mHACE,gBAGF,2DACE,0EAOA,0EAGF,gBAEE,6DCjFA,kDACA,gCACA,qDAGA,qBACA,qDCDA,cACA,eAEA,yBAGF,sBAEE,iBACA,sNAWA,iBACE,kBACA,wRAgBA,kBAEA,iOAgBA,uCACE,uEAEA,kBAEF,qUAuBE,iDAIJ,CACA,geCzFF,4BAEE,CAQA,6JACA,iDAIA,sEAGA,mDAOF,iDAGE,4DAIA,8CACA,qDAEE,eAFF,cAEE,oBAEF,uBAFE,kCAGA,eACA,iBACA,mBAIA,mDACA,CAHA,uCAEA,CAJA,0CACA,CAIA,gBAJA,gBACA,oBADA,gBAIA,wBAEJ,gBAGE,6BACA,YAHA,iBAGA,gCACA,iEAEA,6CACA,sDACA,0BADA,wBACA,0BACA,oIAIA,mBAFA,YAEA,qBACA,0CAIE,uBAEF,CAHA,yBACE,CAEF,iDACE,mFAKJ,oCACE,CANE,aAKJ,CACE,qEAIA,YAFA,WAEA,CAHA,aACA,CAEA,gBACE,4BACA,sBADA,aACA,gCAMF,oCACA,yDACA,2CAEA,qBAGE,kBAEA,CACA,mCAIF,CARE,YACA,CAOF,iCAEE,CAPA,oBACA,CAQA,oBACE,uDAEJ,sDAGA,CAHA,cAGA,0BACE,oDAIA,oCACA,4BACA,sBAGA,cAEA,oFAGA,sBAEA,yDACE,CAIF,iBAJE,wBAIF,6CAHE,6CAKA,eACA,aACA,CADA,cACA,yCAGJ,kBACE,CAKA,iDAEA,CARF,aACE,4CAGA,kBAIA,wEAGA,wDAGA,kCAOA,iDAGA,CAPF,WAEE,sCAEA,CAJF,2CACE,CAMA,qCACA,+BARF,kBACE,qCAOA,iBAsBA,sBACE,CAvBF,WAKA,CACE,0DAIF,CALA,uDACE,CANF,sBAqBA,4CACA,CALA,gRAIA,YAEE,6CAEN,mCAEE,+CASA,6EAIA,4BChNA,SDmNA,qFCnNA,gDACA,sCAGA,qCACA,sDACA,CAKA,kDAGA,CARA,0CAQA,kBAGA,YACA,sBACA,iBAFA,gBADF,YACE,CAHA,SAKA,kBAEA,SAFA,iBAEA,uEAGA,CAEE,6CAFF,oCAgBI,CAdF,yBACE,qBACF,CAGF,oBACE,CAIF,WACE,CALA,2CAGA,uBACF,CACE,mFAGE,CALF,qBAEA,UAGE,gCAIF,sDAEA,CALE,oCAKF,yCC7CJ,oCACE,CD+CA,yXAQE,sCCrDJ,wCAGA,oCACE","sources":["webpack:///./node_modules/normalize.css/normalize.css","webpack:///./src/furo/assets/styles/base/_print.sass","webpack:///./src/furo/assets/styles/base/_screen-readers.sass","webpack:///./src/furo/assets/styles/base/_theme.sass","webpack:///./src/furo/assets/styles/variables/_fonts.scss","webpack:///./src/furo/assets/styles/variables/_spacing.scss","webpack:///./src/furo/assets/styles/variables/_icons.scss","webpack:///./src/furo/assets/styles/variables/_admonitions.scss","webpack:///./src/furo/assets/styles/variables/_colors.scss","webpack:///./src/furo/assets/styles/base/_typography.sass","webpack:///./src/furo/assets/styles/_scaffold.sass","webpack:///./src/furo/assets/styles/content/_admonitions.sass","webpack:///./src/furo/assets/styles/content/_api.sass","webpack:///./src/furo/assets/styles/content/_blocks.sass","webpack:///./src/furo/assets/styles/content/_captions.sass","webpack:///./src/furo/assets/styles/content/_code.sass","webpack:///./src/furo/assets/styles/content/_footnotes.sass","webpack:///./src/furo/assets/styles/content/_images.sass","webpack:///./src/furo/assets/styles/content/_indexes.sass","webpack:///./src/furo/assets/styles/content/_lists.sass","webpack:///./src/furo/assets/styles/content/_math.sass","webpack:///./src/furo/assets/styles/content/_misc.sass","webpack:///./src/furo/assets/styles/content/_rubrics.sass","webpack:///./src/furo/assets/styles/content/_sidebar.sass","webpack:///./src/furo/assets/styles/content/_tables.sass","webpack:///./src/furo/assets/styles/content/_target.sass","webpack:///./src/furo/assets/styles/content/_gui-labels.sass","webpack:///./src/furo/assets/styles/components/_footer.sass","webpack:///./src/furo/assets/styles/components/_sidebar.sass","webpack:///./src/furo/assets/styles/components/_table_of_contents.sass","webpack:///./src/furo/assets/styles/_shame.sass"],"sourcesContent":["/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */\n\n/* Document\n ========================================================================== */\n\n/**\n * 1. Correct the line height in all browsers.\n * 2. Prevent adjustments of font size after orientation changes in iOS.\n */\n\nhtml {\n line-height: 1.15; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n}\n\n/* Sections\n ========================================================================== */\n\n/**\n * Remove the margin in all browsers.\n */\n\nbody {\n margin: 0;\n}\n\n/**\n * Render the `main` element consistently in IE.\n */\n\nmain {\n display: block;\n}\n\n/**\n * Correct the font size and margin on `h1` elements within `section` and\n * `article` contexts in Chrome, Firefox, and Safari.\n */\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n/* Grouping content\n ========================================================================== */\n\n/**\n * 1. Add the correct box sizing in Firefox.\n * 2. Show the overflow in Edge and IE.\n */\n\nhr {\n box-sizing: content-box; /* 1 */\n height: 0; /* 1 */\n overflow: visible; /* 2 */\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\npre {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/* Text-level semantics\n ========================================================================== */\n\n/**\n * Remove the gray background on active links in IE 10.\n */\n\na {\n background-color: transparent;\n}\n\n/**\n * 1. Remove the bottom border in Chrome 57-\n * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n */\n\nabbr[title] {\n border-bottom: none; /* 1 */\n text-decoration: underline; /* 2 */\n text-decoration: underline dotted; /* 2 */\n}\n\n/**\n * Add the correct font weight in Chrome, Edge, and Safari.\n */\n\nb,\nstrong {\n font-weight: bolder;\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\ncode,\nkbd,\nsamp {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/**\n * Add the correct font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/**\n * Prevent `sub` and `sup` elements from affecting the line height in\n * all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsub {\n bottom: -0.25em;\n}\n\nsup {\n top: -0.5em;\n}\n\n/* Embedded content\n ========================================================================== */\n\n/**\n * Remove the border on images inside links in IE 10.\n */\n\nimg {\n border-style: none;\n}\n\n/* Forms\n ========================================================================== */\n\n/**\n * 1. Change the font styles in all browsers.\n * 2. Remove the margin in Firefox and Safari.\n */\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 1 */\n line-height: 1.15; /* 1 */\n margin: 0; /* 2 */\n}\n\n/**\n * Show the overflow in IE.\n * 1. Show the overflow in Edge.\n */\n\nbutton,\ninput { /* 1 */\n overflow: visible;\n}\n\n/**\n * Remove the inheritance of text transform in Edge, Firefox, and IE.\n * 1. Remove the inheritance of text transform in Firefox.\n */\n\nbutton,\nselect { /* 1 */\n text-transform: none;\n}\n\n/**\n * Correct the inability to style clickable types in iOS and Safari.\n */\n\nbutton,\n[type=\"button\"],\n[type=\"reset\"],\n[type=\"submit\"] {\n -webkit-appearance: button;\n}\n\n/**\n * Remove the inner border and padding in Firefox.\n */\n\nbutton::-moz-focus-inner,\n[type=\"button\"]::-moz-focus-inner,\n[type=\"reset\"]::-moz-focus-inner,\n[type=\"submit\"]::-moz-focus-inner {\n border-style: none;\n padding: 0;\n}\n\n/**\n * Restore the focus styles unset by the previous rule.\n */\n\nbutton:-moz-focusring,\n[type=\"button\"]:-moz-focusring,\n[type=\"reset\"]:-moz-focusring,\n[type=\"submit\"]:-moz-focusring {\n outline: 1px dotted ButtonText;\n}\n\n/**\n * Correct the padding in Firefox.\n */\n\nfieldset {\n padding: 0.35em 0.75em 0.625em;\n}\n\n/**\n * 1. Correct the text wrapping in Edge and IE.\n * 2. Correct the color inheritance from `fieldset` elements in IE.\n * 3. Remove the padding so developers are not caught out when they zero out\n * `fieldset` elements in all browsers.\n */\n\nlegend {\n box-sizing: border-box; /* 1 */\n color: inherit; /* 2 */\n display: table; /* 1 */\n max-width: 100%; /* 1 */\n padding: 0; /* 3 */\n white-space: normal; /* 1 */\n}\n\n/**\n * Add the correct vertical alignment in Chrome, Firefox, and Opera.\n */\n\nprogress {\n vertical-align: baseline;\n}\n\n/**\n * Remove the default vertical scrollbar in IE 10+.\n */\n\ntextarea {\n overflow: auto;\n}\n\n/**\n * 1. Add the correct box sizing in IE 10.\n * 2. Remove the padding in IE 10.\n */\n\n[type=\"checkbox\"],\n[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/**\n * Correct the cursor style of increment and decrement buttons in Chrome.\n */\n\n[type=\"number\"]::-webkit-inner-spin-button,\n[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n/**\n * 1. Correct the odd appearance in Chrome and Safari.\n * 2. Correct the outline style in Safari.\n */\n\n[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n outline-offset: -2px; /* 2 */\n}\n\n/**\n * Remove the inner padding in Chrome and Safari on macOS.\n */\n\n[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/**\n * 1. Correct the inability to style clickable types in iOS and Safari.\n * 2. Change font properties to `inherit` in Safari.\n */\n\n::-webkit-file-upload-button {\n -webkit-appearance: button; /* 1 */\n font: inherit; /* 2 */\n}\n\n/* Interactive\n ========================================================================== */\n\n/*\n * Add the correct display in Edge, IE 10+, and Firefox.\n */\n\ndetails {\n display: block;\n}\n\n/*\n * Add the correct display in all browsers.\n */\n\nsummary {\n display: list-item;\n}\n\n/* Misc\n ========================================================================== */\n\n/**\n * Add the correct display in IE 10+.\n */\n\ntemplate {\n display: none;\n}\n\n/**\n * Add the correct display in IE 10.\n */\n\n[hidden] {\n display: none;\n}\n","// This file contains styles for managing print media.\n\n////////////////////////////////////////////////////////////////////////////////\n// Hide elements not relevant to print media.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Hide icon container.\n .content-icon-container\n display: none !important\n\n // Hide showing header links if hovering over when printing.\n .headerlink\n display: none !important\n\n // Hide mobile header.\n .mobile-header\n display: none !important\n\n // Hide navigation links.\n .related-pages\n display: none !important\n\n////////////////////////////////////////////////////////////////////////////////\n// Tweaks related to decolorization.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Apply a border around code which no longer have a color background.\n .highlight\n border: 0.1pt solid var(--color-foreground-border)\n\n////////////////////////////////////////////////////////////////////////////////\n// Avoid page break in some relevant cases.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n ul, ol, dl, a, table, pre, blockquote, p\n page-break-inside: avoid\n\n h1, h2, h3, h4, h5, h6, img, figure, caption\n page-break-inside: avoid\n page-break-after: avoid\n\n ul, ol, dl\n page-break-before: avoid\n",".visually-hidden\n position: absolute !important\n width: 1px !important\n height: 1px !important\n padding: 0 !important\n margin: -1px !important\n overflow: hidden !important\n clip: rect(0,0,0,0) !important\n white-space: nowrap !important\n border: 0 !important\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\n:-moz-focusring\n outline: auto\n","// This file serves as the \"skeleton\" of the theming logic.\n//\n// This contains the bulk of the logic for handling dark mode, color scheme\n// toggling and the handling of color-scheme-specific hiding of elements.\n\n@use \"../variables\" as *\n\nbody\n @include fonts\n @include spacing\n @include icons\n @include admonitions\n @include default-admonition(#651fff, \"abstract\")\n @include default-topic(#14B8A6, \"pencil\")\n\n @include colors\n\n.only-light\n display: block !important\nhtml body .only-dark\n display: none !important\n\n// Ignore dark-mode hints if print media.\n@media not print\n // Enable dark-mode, if requested.\n body[data-theme=\"dark\"]\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n // Enable dark mode, unless explicitly told to avoid.\n @media (prefers-color-scheme: dark)\n body:not([data-theme=\"light\"])\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n//\n// Theme toggle presentation\n//\nbody[data-theme=\"auto\"]\n .theme-toggle svg.theme-icon-when-auto-light\n display: block\n\n @media (prefers-color-scheme: dark)\n .theme-toggle svg.theme-icon-when-auto-dark\n display: block\n .theme-toggle svg.theme-icon-when-auto-light\n display: none\n\nbody[data-theme=\"dark\"]\n .theme-toggle svg.theme-icon-when-dark\n display: block\n\nbody[data-theme=\"light\"]\n .theme-toggle svg.theme-icon-when-light\n display: block\n","// Fonts used by this theme.\n//\n// There are basically two things here -- using the system font stack and\n// defining sizes for various elements in %ages. We could have also used `em`\n// but %age is easier to reason about for me.\n\n@mixin fonts {\n // These are adapted from https://systemfontstack.com/\n --font-stack:\n -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif,\n Apple Color Emoji, Segoe UI Emoji;\n --font-stack--monospace:\n \"SFMono-Regular\", Menlo, Consolas, Monaco, Liberation Mono, Lucida Console,\n monospace;\n --font-stack--headings: var(--font-stack);\n\n --font-size--normal: 100%;\n --font-size--small: 87.5%;\n --font-size--small--2: 81.25%;\n --font-size--small--3: 75%;\n --font-size--small--4: 62.5%;\n\n // Sidebar\n --sidebar-caption-font-size: var(--font-size--small--2);\n --sidebar-item-font-size: var(--font-size--small);\n --sidebar-search-input-font-size: var(--font-size--small);\n\n // Table of Contents\n --toc-font-size: var(--font-size--small--3);\n --toc-font-size--mobile: var(--font-size--normal);\n --toc-title-font-size: var(--font-size--small--4);\n\n // Admonitions\n //\n // These aren't defined in terms of %ages, since nesting these is permitted.\n --admonition-font-size: 0.8125rem;\n --admonition-title-font-size: 0.8125rem;\n\n // Code\n --code-font-size: var(--font-size--small--2);\n\n // API\n --api-font-size: var(--font-size--small);\n}\n","// Spacing for various elements on the page\n//\n// If the user wants to tweak things in a certain way, they are permitted to.\n// They also have to deal with the consequences though!\n\n@mixin spacing {\n // Header!\n --header-height: calc(\n var(--sidebar-item-line-height) + 4 *\n #{var(--sidebar-item-spacing-vertical)}\n );\n --header-padding: 0.5rem;\n\n // Sidebar\n --sidebar-tree-space-above: 1.5rem;\n --sidebar-caption-space-above: 1rem;\n\n --sidebar-item-line-height: 1rem;\n --sidebar-item-spacing-vertical: 0.5rem;\n --sidebar-item-spacing-horizontal: 1rem;\n --sidebar-item-height: calc(\n var(--sidebar-item-line-height) + 2 *#{var(--sidebar-item-spacing-vertical)}\n );\n\n --sidebar-expander-width: var(--sidebar-item-height); // be square\n\n --sidebar-search-space-above: 0.5rem;\n --sidebar-search-input-spacing-vertical: 0.5rem;\n --sidebar-search-input-spacing-horizontal: 0.5rem;\n --sidebar-search-input-height: 1rem;\n --sidebar-search-icon-size: var(--sidebar-search-input-height);\n\n // Table of Contents\n --toc-title-padding: 0.25rem 0;\n --toc-spacing-vertical: 1.5rem;\n --toc-spacing-horizontal: 1.5rem;\n --toc-item-spacing-vertical: 0.4rem;\n --toc-item-spacing-horizontal: 1rem;\n}\n","// Expose theme icons as CSS variables.\n\n$icons: (\n // Adapted from tabler-icons\n // url: https://tablericons.com/\n \"search\":\n url('data:image/svg+xml;charset=utf-8,'),\n // Factored out from mkdocs-material on 24-Aug-2020.\n // url: https://squidfunk.github.io/mkdocs-material/reference/admonitions/\n \"pencil\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"abstract\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"info\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"flame\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"question\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"warning\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"failure\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"spark\":\n url('data:image/svg+xml;charset=utf-8,')\n);\n\n@mixin icons {\n @each $name, $glyph in $icons {\n --icon-#{$name}: #{$glyph};\n }\n}\n","@use \"sass:list\";\n// Admonitions\n\n// Structure of these is:\n// admonition-class: color \"icon-name\";\n//\n// The colors are translated into CSS variables below. The icons are\n// used directly in the main declarations to set the `mask-image` in\n// the title.\n\n// prettier-ignore\n$admonitions: (\n // Each of these has an reST directives for it.\n \"caution\": #ff9100 \"spark\",\n \"warning\": #ff9100 \"warning\",\n \"danger\": #ff5252 \"spark\",\n \"attention\": #ff5252 \"warning\",\n \"error\": #ff5252 \"failure\",\n \"hint\": #00c852 \"question\",\n \"tip\": #00c852 \"info\",\n \"important\": #00bfa5 \"flame\",\n \"note\": #00b0ff \"pencil\",\n \"seealso\": #448aff \"info\",\n \"admonition-todo\": #808080 \"pencil\"\n);\n\n@mixin default-admonition($color, $icon-name) {\n --color-admonition-title: #{$color};\n --color-admonition-title-background: #{rgba($color, 0.2)};\n\n --icon-admonition-default: var(--icon-#{$icon-name});\n}\n\n@mixin default-topic($color, $icon-name) {\n --color-topic-title: #{$color};\n --color-topic-title-background: #{rgba($color, 0.2)};\n\n --icon-topic-default: var(--icon-#{$icon-name});\n}\n\n@mixin admonitions {\n @each $name, $values in $admonitions {\n --color-admonition-title--#{$name}: #{list.nth($values, 1)};\n --color-admonition-title-background--#{$name}: #{rgba(\n list.nth($values, 1),\n 0.2\n )};\n }\n}\n","// Colors used throughout this theme.\n//\n// The aim is to give the user more control. Thus, instead of hard-coding colors\n// in various parts of the stylesheet, the approach taken is to define all\n// colors as CSS variables and reusing them in all the places.\n//\n// `colors-dark` depends on `colors` being included at a lower specificity.\n\n@mixin colors {\n --color-problematic: #b30000;\n\n // Base Colors\n --color-foreground-primary: black; // for main text and headings\n --color-foreground-secondary: #5a5c63; // for secondary text\n --color-foreground-muted: #6b6f76; // for muted text\n --color-foreground-border: #878787; // for content borders\n\n --color-background-primary: white; // for content\n --color-background-secondary: #f8f9fb; // for navigation + ToC\n --color-background-hover: #efeff4ff; // for navigation-item hover\n --color-background-hover--transparent: #efeff400;\n --color-background-border: #eeebee; // for UI borders\n --color-background-item: #ccc; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #0a4bff;\n --color-brand-content: #2757dd;\n --color-brand-visited: #872ee0;\n\n // API documentation\n --color-api-background: var(--color-background-hover--transparent);\n --color-api-background-hover: var(--color-background-hover);\n --color-api-overall: var(--color-foreground-secondary);\n --color-api-name: var(--color-problematic);\n --color-api-pre-name: var(--color-problematic);\n --color-api-paren: var(--color-foreground-secondary);\n --color-api-keyword: var(--color-foreground-primary);\n\n --color-api-added: #21632c;\n --color-api-added-border: #38a84d;\n --color-api-changed: #046172;\n --color-api-changed-border: #06a1bc;\n --color-api-deprecated: #605706;\n --color-api-deprecated-border: #f0d90f;\n --color-api-removed: #b30000;\n --color-api-removed-border: #ff5c5c;\n\n --color-highlight-on-target: #ffffcc;\n\n // Inline code background\n --color-inline-code-background: var(--color-background-secondary);\n\n // Highlighted text (search)\n --color-highlighted-background: #ddeeff;\n --color-highlighted-text: var(--color-foreground-primary);\n\n // GUI Labels\n --color-guilabel-background: #ddeeff80;\n --color-guilabel-border: #bedaf580;\n --color-guilabel-text: var(--color-foreground-primary);\n\n // Admonitions!\n --color-admonition-background: transparent;\n\n //////////////////////////////////////////////////////////////////////////////\n // Everything below this should be one of:\n // - var(...)\n // - *-gradient(...)\n // - special literal values (eg: transparent, none)\n //////////////////////////////////////////////////////////////////////////////\n\n // Tables\n --color-table-header-background: var(--color-background-secondary);\n --color-table-border: var(--color-background-border);\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: transparent;\n --color-card-marginals-background: var(--color-background-secondary);\n\n // Header\n --color-header-background: var(--color-background-primary);\n --color-header-border: var(--color-background-border);\n --color-header-text: var(--color-foreground-primary);\n\n // Sidebar (left)\n --color-sidebar-background: var(--color-background-secondary);\n --color-sidebar-background-border: var(--color-background-border);\n\n --color-sidebar-brand-text: var(--color-foreground-primary);\n --color-sidebar-caption-text: var(--color-foreground-muted);\n --color-sidebar-link-text: var(--color-foreground-secondary);\n --color-sidebar-link-text--top-level: var(--color-brand-primary);\n\n --color-sidebar-item-background: var(--color-sidebar-background);\n --color-sidebar-item-background--current: var(\n --color-sidebar-item-background\n );\n --color-sidebar-item-background--hover: linear-gradient(\n 90deg,\n var(--color-background-hover--transparent) 0%,\n var(--color-background-hover) var(--sidebar-item-spacing-horizontal),\n var(--color-background-hover) 100%\n );\n\n --color-sidebar-item-expander-background: transparent;\n --color-sidebar-item-expander-background--hover: var(\n --color-background-hover\n );\n\n --color-sidebar-search-text: var(--color-foreground-primary);\n --color-sidebar-search-background: var(--color-background-secondary);\n --color-sidebar-search-background--focus: var(--color-background-primary);\n --color-sidebar-search-border: var(--color-background-border);\n --color-sidebar-search-icon: var(--color-foreground-muted);\n\n // Table of Contents (right)\n --color-toc-background: var(--color-background-primary);\n --color-toc-title-text: var(--color-foreground-muted);\n --color-toc-item-text: var(--color-foreground-secondary);\n --color-toc-item-text--hover: var(--color-foreground-primary);\n --color-toc-item-text--active: var(--color-brand-primary);\n\n // Actual page contents\n --color-content-foreground: var(--color-foreground-primary);\n --color-content-background: transparent;\n\n // Links\n --color-link: var(--color-brand-content);\n --color-link-underline: var(--color-background-border);\n --color-link--hover: var(--color-brand-content);\n --color-link-underline--hover: var(--color-foreground-border);\n\n --color-link--visited: var(--color-brand-visited);\n --color-link-underline--visited: var(--color-background-border);\n --color-link--visited--hover: var(--color-brand-visited);\n --color-link-underline--visited--hover: var(--color-foreground-border);\n}\n\n@mixin colors-dark {\n --color-problematic: #ee5151;\n\n // Base Colors\n --color-foreground-primary: #cfd0d0; // for main text and headings\n --color-foreground-secondary: #9ca0a5; // for secondary text\n --color-foreground-muted: #81868d; // for muted text\n --color-foreground-border: #666666; // for content borders\n\n --color-background-primary: #131416; // for content\n --color-background-secondary: #1a1c1e; // for navigation + ToC\n --color-background-hover: #1e2124ff; // for navigation-item hover\n --color-background-hover--transparent: #1e212400;\n --color-background-border: #303335; // for UI borders\n --color-background-item: #444; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #3d94ff;\n --color-brand-content: #5ca5ff;\n --color-brand-visited: #b27aeb;\n\n // Highlighted text (search)\n --color-highlighted-background: #083563;\n\n // GUI Labels\n --color-guilabel-background: #08356380;\n --color-guilabel-border: #13395f80;\n\n // API documentation\n --color-api-keyword: var(--color-foreground-secondary);\n --color-highlight-on-target: #333300;\n\n --color-api-added: #3db854;\n --color-api-added-border: #267334;\n --color-api-changed: #09b0ce;\n --color-api-changed-border: #056d80;\n --color-api-deprecated: #b1a10b;\n --color-api-deprecated-border: #6e6407;\n --color-api-removed: #ff7575;\n --color-api-removed-border: #b03b3b;\n\n // Admonitions\n --color-admonition-background: #18181a;\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: #18181a;\n --color-card-marginals-background: var(--color-background-hover);\n}\n","// This file contains the styling for making the content throughout the page,\n// including fonts, paragraphs, headings and spacing among these elements.\n\nbody\n font-family: var(--font-stack)\npre,\ncode,\nkbd,\nsamp\n font-family: var(--font-stack--monospace)\n\n// Make fonts look slightly nicer.\nbody\n -webkit-font-smoothing: antialiased\n -moz-osx-font-smoothing: grayscale\n\n// Line height from Bootstrap 4.1\narticle\n line-height: 1.5\n\n//\n// Headings\n//\nh1,\nh2,\nh3,\nh4,\nh5,\nh6\n line-height: 1.25\n font-family: var(--font-stack--headings)\n font-weight: bold\n\n border-radius: 0.5rem\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n margin-left: -0.5rem\n margin-right: -0.5rem\n padding-left: 0.5rem\n padding-right: 0.5rem\n\n + p\n margin-top: 0\n\nh1\n font-size: 2.5em\n margin-top: 1.75rem\n margin-bottom: 1rem\nh2\n font-size: 2em\n margin-top: 1.75rem\nh3\n font-size: 1.5em\nh4\n font-size: 1.25em\nh5\n font-size: 1.125em\nh6\n font-size: 1em\n\nsmall\n opacity: 75%\n font-size: 80%\n\n// Paragraph\np\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n\n// Horizontal rules\nhr.docutils\n height: 1px\n padding: 0\n margin: 2rem 0\n background-color: var(--color-background-border)\n border: 0\n\n.centered\n text-align: center\n\n// Links\na\n text-decoration: underline\n\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n &:visited\n color: var(--color-link--visited)\n text-decoration-color: var(--color-link-underline--visited)\n &:hover\n color: var(--color-link--visited--hover)\n text-decoration-color: var(--color-link-underline--visited--hover)\n\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &.muted-link\n color: inherit\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &:visited\n color: var(--color-link--visited--hover)\n text-decoration-color: var(--color-link-underline--visited--hover)\n","// This file contains the styles for the overall layouting of the documentation\n// skeleton, including the responsive changes as well as sidebar toggles.\n//\n// This is implemented as a mobile-last design, which isn't ideal, but it is\n// reasonably good-enough and I got pretty tired by the time I'd finished this\n// to move the rules around to fix this. Shouldn't take more than 3-4 hours,\n// if you know what you're doing tho.\n\n// HACK: Not all browsers account for the scrollbar width in media queries.\n// This results in horizontal scrollbars in the breakpoint where we go\n// from displaying everything to hiding the ToC. We accomodate for this by\n// adding a bit of padding to the TOC drawer, disabling the horizontal\n// scrollbar and allowing the scrollbars to cover the padding.\n// https://www.456bereastreet.com/archive/201301/media_query_width_and_vertical_scrollbars/\n\n// HACK: Always having the scrollbar visible, prevents certain browsers from\n// causing the content to stutter horizontally between taller-than-viewport and\n// not-taller-than-viewport pages.\n@use \"variables\" as *\n\nhtml\n overflow-x: hidden\n overflow-y: scroll\n scroll-behavior: smooth\n\n.sidebar-scroll, .toc-scroll, article[role=main] *\n scrollbar-width: thin\n scrollbar-color: var(--color-foreground-border) transparent\n\n//\n// Overalls\n//\nhtml,\nbody\n height: 100%\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\n.skip-to-content\n position: fixed\n padding: 1rem\n border-radius: 1rem\n left: 0.25rem\n top: 0.25rem\n z-index: 40\n background: var(--color-background-primary)\n color: var(--color-foreground-primary)\n\n transform: translateY(-200%)\n transition: transform 300ms ease-in-out\n\n &:focus-within\n transform: translateY(0%)\n\narticle\n color: var(--color-content-foreground)\n background: var(--color-content-background)\n overflow-wrap: break-word\n\n.page\n display: flex\n // fill the viewport for pages with little content.\n min-height: 100%\n\n.mobile-header\n width: 100%\n height: var(--header-height)\n background-color: var(--color-header-background)\n color: var(--color-header-text)\n border-bottom: 1px solid var(--color-header-border)\n\n // Looks like sub-script/super-script have this, and we need this to\n // be \"on top\" of those.\n z-index: 10\n\n // We don't show the header on large screens.\n display: none\n\n // Add shadow when scrolled\n &.scrolled\n border-bottom: none\n box-shadow: 0 0 0.2rem rgba(0, 0, 0, 0.1), 0 0.2rem 0.4rem rgba(0, 0, 0, 0.2)\n\n .header-center\n a\n color: var(--color-header-text)\n text-decoration: none\n\n.main\n display: flex\n flex: 1\n\n// Sidebar (left) also covers the entire left portion of screen.\n.sidebar-drawer\n box-sizing: border-box\n\n border-right: 1px solid var(--color-sidebar-background-border)\n background: var(--color-sidebar-background)\n\n display: flex\n justify-content: flex-end\n // These next two lines took me two days to figure out.\n width: calc((100% - #{$full-width}) / 2 + #{$sidebar-width})\n min-width: $sidebar-width\n\n// Scroll-along sidebars\n.sidebar-container,\n.toc-drawer\n box-sizing: border-box\n width: $sidebar-width\n\n.toc-drawer\n background: var(--color-toc-background)\n // See HACK described on top of this document\n padding-right: 1rem\n\n.sidebar-sticky,\n.toc-sticky\n position: sticky\n top: 0\n height: min(100%, 100vh)\n height: 100vh\n\n display: flex\n flex-direction: column\n\n.sidebar-scroll,\n.toc-scroll\n flex-grow: 1\n flex-shrink: 1\n\n overflow: auto\n scroll-behavior: smooth\n\n// Central items.\n.content\n padding: 0 $content-padding\n width: $content-width\n\n display: flex\n flex-direction: column\n justify-content: space-between\n\n.icon\n display: inline-block\n height: 1rem\n width: 1rem\n svg\n width: 100%\n height: 100%\n\n//\n// Accommodate announcement banner\n//\n.announcement\n background-color: var(--color-announcement-background)\n color: var(--color-announcement-text)\n\n height: var(--header-height)\n display: flex\n align-items: center\n overflow-x: auto\n & + .page\n min-height: calc(100% - var(--header-height))\n\n.announcement-content\n box-sizing: border-box\n padding: 0.5rem\n min-width: 100%\n white-space: nowrap\n text-align: center\n\n a\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-announcement-text)\n\n &:hover\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-link--hover)\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for theme\n////////////////////////////////////////////////////////////////////////////////\n.no-js .theme-toggle-container // don't show theme toggle if there's no JS\n display: none\n\n.theme-toggle-container\n display: flex\n\n.theme-toggle\n display: flex\n cursor: pointer\n border: none\n padding: 0\n background: transparent\n\n.theme-toggle svg\n height: 1.25rem\n width: 1.25rem\n color: var(--color-foreground-primary)\n display: none\n\n.theme-toggle-header\n display: flex\n align-items: center\n justify-content: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for elements\n////////////////////////////////////////////////////////////////////////////////\n.toc-overlay-icon, .nav-overlay-icon\n display: none\n cursor: pointer\n\n .icon\n color: var(--color-foreground-secondary)\n height: 1.5rem\n width: 1.5rem\n\n.toc-header-icon, .nav-overlay-icon\n // for when we set display: flex\n justify-content: center\n align-items: center\n\n.toc-content-icon\n height: 1.5rem\n width: 1.5rem\n\n.content-icon-container\n float: right\n display: flex\n margin-top: 1.5rem\n margin-left: 1rem\n margin-bottom: 1rem\n gap: 0.5rem\n\n .edit-this-page, .view-this-page\n svg\n color: inherit\n height: 1.25rem\n width: 1.25rem\n\n.sidebar-toggle\n position: absolute\n display: none\n// \n.sidebar-toggle[name=\"__toc\"]\n left: 20px\n.sidebar-toggle:checked\n left: 40px\n// \n\n.overlay\n position: fixed\n top: 0\n width: 0\n height: 0\n\n transition: width 0ms, height 0ms, opacity 250ms ease-out\n\n opacity: 0\n background-color: rgba(0, 0, 0, 0.54)\n.sidebar-overlay\n z-index: 20\n.toc-overlay\n z-index: 40\n\n// Keep things on top and smooth.\n.sidebar-drawer\n z-index: 30\n transition: left 250ms ease-in-out\n.toc-drawer\n z-index: 50\n transition: right 250ms ease-in-out\n\n// Show the Sidebar\n#__navigation:checked\n & ~ .sidebar-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .sidebar-drawer\n top: 0\n left: 0\n // Show the toc sidebar\n#__toc:checked\n & ~ .toc-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .toc-drawer\n top: 0\n right: 0\n\n////////////////////////////////////////////////////////////////////////////////\n// Back to top\n////////////////////////////////////////////////////////////////////////////////\n.back-to-top\n text-decoration: none\n\n display: none\n position: fixed\n left: 0\n top: 1rem\n padding: 0.5rem\n padding-right: 0.75rem\n border-radius: 1rem\n font-size: 0.8125rem\n\n background: var(--color-background-primary)\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), #6b728080 0px 0px 1px 0px\n\n z-index: 10\n\n margin-left: 50%\n transform: translateX(-50%)\n svg\n height: 1rem\n width: 1rem\n fill: currentColor\n display: inline-block\n\n span\n margin-left: 0.25rem\n\n .show-back-to-top &\n display: flex\n align-items: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Responsive layouting\n////////////////////////////////////////////////////////////////////////////////\n// Make things a bit bigger on bigger screens.\n@media (min-width: $full-width + $sidebar-width)\n html\n font-size: 110%\n\n@media (max-width: $full-width)\n // Collapse \"toc\" into the icon.\n .toc-content-icon\n display: flex\n .toc-drawer\n position: fixed\n height: 100vh\n top: 0\n right: -$sidebar-width\n border-left: 1px solid var(--color-background-muted)\n .toc-tree\n border-left: none\n font-size: var(--toc-font-size--mobile)\n\n // Accomodate for a changed content width.\n .sidebar-drawer\n width: calc((100% - #{$full-width - $sidebar-width}) / 2 + #{$sidebar-width})\n\n@media (max-width: $content-padded-width + $sidebar-width)\n // Center the page\n .content\n margin-left: auto\n margin-right: auto\n padding: 0 $content-padding--small\n\n@media (max-width: $content-padded-width--small + $sidebar-width)\n // Collapse \"navigation\".\n .nav-overlay-icon\n display: flex\n .sidebar-drawer\n position: fixed\n height: 100vh\n width: $sidebar-width\n\n top: 0\n left: -$sidebar-width\n\n // Swap which icon is visible.\n .toc-header-icon, .theme-toggle-header\n display: flex\n .toc-content-icon, .theme-toggle-content\n display: none\n\n // Show the header.\n .mobile-header\n position: sticky\n top: 0\n display: flex\n justify-content: space-between\n align-items: center\n\n .header-left,\n .header-right\n display: flex\n height: var(--header-height)\n padding: 0 var(--header-padding)\n label\n height: 100%\n width: 100%\n user-select: none\n\n .nav-overlay-icon .icon,\n .theme-toggle svg\n height: 1.5rem\n width: 1.5rem\n\n // Add a scroll margin for the content\n :target\n scroll-margin-top: calc(var(--header-height) + 2.5rem)\n\n // Show back-to-top below the header\n .back-to-top\n top: calc(var(--header-height) + 0.5rem)\n\n // Accommodate for the header.\n .page\n flex-direction: column\n justify-content: center\n\n@media (max-width: $content-width + 2* $content-padding--small)\n // Content should respect window limits.\n .content\n width: 100%\n overflow-x: auto\n\n@media (max-width: $content-width)\n article[role=main] aside.sidebar\n float: none\n width: 100%\n margin: 1rem 0\n","@use \"sass:list\"\n@use \"../variables\" as *\n\n// The design here is strongly inspired by mkdocs-material.\n.admonition, .topic\n margin: 1rem auto\n padding: 0 0.5rem 0.5rem 0.5rem\n\n background: var(--color-admonition-background)\n\n border-radius: 0.2rem\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n font-size: var(--admonition-font-size)\n\n overflow: hidden\n page-break-inside: avoid\n\n // First element should have no margin, since the title has it.\n > :nth-child(2)\n margin-top: 0\n\n // Last item should have no margin, since we'll control that w/ padding\n > :last-child\n margin-bottom: 0\n\n.admonition p.admonition-title,\np.topic-title\n position: relative\n margin: 0 -0.5rem 0.5rem\n padding-left: 2rem\n padding-right: .5rem\n padding-top: .4rem\n padding-bottom: .4rem\n\n font-weight: 500\n font-size: var(--admonition-title-font-size)\n line-height: 1.3\n\n // Our fancy icon\n &::before\n content: \"\"\n position: absolute\n left: 0.5rem\n width: 1rem\n height: 1rem\n\n// Default styles\np.admonition-title\n background-color: var(--color-admonition-title-background)\n &::before\n background-color: var(--color-admonition-title)\n mask-image: var(--icon-admonition-default)\n mask-repeat: no-repeat\n\np.topic-title\n background-color: var(--color-topic-title-background)\n &::before\n background-color: var(--color-topic-title)\n mask-image: var(--icon-topic-default)\n mask-repeat: no-repeat\n\n//\n// Variants\n//\n.admonition\n border-left: 0.2rem solid var(--color-admonition-title)\n\n @each $type, $value in $admonitions\n &.#{$type}\n border-left-color: var(--color-admonition-title--#{$type})\n > .admonition-title\n background-color: var(--color-admonition-title-background--#{$type})\n &::before\n background-color: var(--color-admonition-title--#{$type})\n mask-image: var(--icon-#{list.nth($value, 2)})\n\n.admonition-todo > .admonition-title\n text-transform: uppercase\n","// This file stylizes the API documentation (stuff generated by autodoc). It's\n// deeply nested due to how autodoc structures the HTML without enough classes\n// to select the relevant items.\n\n// API docs!\ndl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)\n // Tweak the spacing of all the things!\n dd\n margin-left: 2rem\n > :first-child\n margin-top: 0.125rem\n > :last-child\n margin-bottom: 0.75rem\n\n // This is used for the arguments\n .field-list\n margin-bottom: 0.75rem\n\n // \"Headings\" (like \"Parameters\" and \"Return\")\n > dt\n text-transform: uppercase\n font-size: var(--font-size--small)\n\n dd:empty\n margin-bottom: 0.5rem\n dd > ul\n margin-left: -1.2rem\n > li\n > p:nth-child(2)\n margin-top: 0\n // When the last-empty-paragraph follows a paragraph, it doesn't need\n // to augument the existing spacing.\n > p + p:last-child:empty\n margin-top: 0\n margin-bottom: 0\n\n // Colorize the elements\n > dt\n color: var(--color-api-overall)\n\n.sig:not(.sig-inline)\n font-weight: bold\n\n font-size: var(--api-font-size)\n font-family: var(--font-stack--monospace)\n\n margin-left: -0.25rem\n margin-right: -0.25rem\n padding-top: 0.25rem\n padding-bottom: 0.25rem\n padding-right: 0.5rem\n\n // These are intentionally em, to properly match the font size.\n padding-left: 3em\n text-indent: -2.5em\n\n border-radius: 0.25rem\n\n background: var(--color-api-background)\n transition: background 100ms ease-out\n\n &:hover\n background: var(--color-api-background-hover)\n\n // adjust the size of the [source] link on the right.\n a.reference\n .viewcode-link\n font-weight: normal\n width: 4.25rem\n\nem.property\n font-style: normal\n &:first-child\n color: var(--color-api-keyword)\n.sig-name\n color: var(--color-api-name)\n.sig-prename\n font-weight: normal\n color: var(--color-api-pre-name)\n.sig-paren\n color: var(--color-api-paren)\n.sig-param\n font-style: normal\n\ndiv.versionadded,\ndiv.versionchanged,\ndiv.deprecated,\ndiv.versionremoved\n border-left: 0.1875rem solid\n border-radius: 0.125rem\n\n padding-left: 0.75rem\n\n p\n margin-top: 0.125rem\n margin-bottom: 0.125rem\n\ndiv.versionadded\n border-color: var(--color-api-added-border)\n .versionmodified\n color: var(--color-api-added)\n\ndiv.versionchanged\n border-color: var(--color-api-changed-border)\n .versionmodified\n color: var(--color-api-changed)\n\ndiv.deprecated\n border-color: var(--color-api-deprecated-border)\n .versionmodified\n color: var(--color-api-deprecated)\n\ndiv.versionremoved\n border-color: var(--color-api-removed-border)\n .versionmodified\n color: var(--color-api-removed)\n\n// Align the [docs] and [source] to the right.\n.viewcode-link, .viewcode-back\n float: right\n text-align: right\n",".line-block\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n .line-block\n margin-top: 0rem\n margin-bottom: 0rem\n padding-left: 1rem\n","// Captions\narticle p.caption,\ntable > caption,\n.code-block-caption\n font-size: var(--font-size--small)\n text-align: center\n\n// Caption above a TOCTree\n.toctree-wrapper.compound\n .caption, :not(.caption) > .caption-text\n font-size: var(--font-size--small)\n text-transform: uppercase\n\n text-align: initial\n margin-bottom: 0\n\n > ul\n margin-top: 0\n margin-bottom: 0\n","// Inline code\ncode.literal, .sig-inline\n background: var(--color-inline-code-background)\n border-radius: 0.2em\n // Make the font smaller, and use padding to recover.\n font-size: var(--font-size--small--2)\n padding: 0.1em 0.2em\n\n pre.literal-block &\n font-size: inherit\n padding: 0\n\n p &\n border: 1px solid var(--color-background-border)\n\n.sig-inline\n font-family: var(--font-stack--monospace)\n\n// Code and Literal Blocks\n$code-spacing-vertical: 0.625rem\n$code-spacing-horizontal: 0.875rem\n\n// Wraps every literal block + line numbers.\ndiv[class*=\" highlight-\"],\ndiv[class^=\"highlight-\"]\n margin: 1em 0\n display: flex\n\n .table-wrapper\n margin: 0\n padding: 0\n\npre\n margin: 0\n padding: 0\n overflow: auto\n\n // Needed to have more specificity than pygments' \"pre\" selector. :(\n article[role=\"main\"] .highlight &\n line-height: 1.5\n\n &.literal-block,\n .highlight &\n font-size: var(--code-font-size)\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n // Make it look like all the other blocks.\n &.literal-block\n margin-top: 1rem\n margin-bottom: 1rem\n\n border-radius: 0.2rem\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n\n// All code is always contained in this.\n.highlight\n width: 100%\n border-radius: 0.2rem\n\n // Make line numbers and prompts un-selectable.\n .gp, span.linenos\n user-select: none\n pointer-events: none\n\n // Expand the line-highlighting.\n .hll\n display: block\n margin-left: -$code-spacing-horizontal\n margin-right: -$code-spacing-horizontal\n padding-left: $code-spacing-horizontal\n padding-right: $code-spacing-horizontal\n\n/* Make code block captions be nicely integrated */\n.code-block-caption\n display: flex\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n border-radius: 0.25rem\n border-bottom-left-radius: 0\n border-bottom-right-radius: 0\n font-weight: 300\n border-bottom: 1px solid\n\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n border-color: var(--color-background-border)\n\n + div[class]\n margin-top: 0\n > .highlight\n border-top-left-radius: 0\n border-top-right-radius: 0\n\n// When `html_codeblock_linenos_style` is table.\n.highlighttable\n width: 100%\n display: block\n tbody\n display: block\n\n tr\n display: flex\n\n // Line numbers\n td.linenos\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n padding: $code-spacing-vertical $code-spacing-horizontal\n padding-right: 0\n border-top-left-radius: 0.2rem\n border-bottom-left-radius: 0.2rem\n\n .linenodiv\n padding-right: $code-spacing-horizontal\n font-size: var(--code-font-size)\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n\n // Actual code\n td.code\n padding: 0\n display: block\n flex: 1\n overflow: hidden\n\n .highlight\n border-top-left-radius: 0\n border-bottom-left-radius: 0\n\n// When `html_codeblock_linenos_style` is inline.\n.highlight\n span.linenos\n display: inline-block\n padding-left: 0\n padding-right: $code-spacing-horizontal\n margin-right: $code-spacing-horizontal\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n","// Inline Footnote Reference\n.footnote-reference\n font-size: var(--font-size--small--4)\n vertical-align: super\n\n// Definition list, listing the content of each note.\n// docutils <= 0.17\ndl.footnote.brackets\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\n display: grid\n grid-template-columns: max-content auto\n dt\n margin: 0\n > .fn-backref\n margin-left: 0.25rem\n\n &:after\n content: \":\"\n\n .brackets\n &:before\n content: \"[\"\n &:after\n content: \"]\"\n\n dd\n margin: 0\n padding: 0 1rem\n\n// docutils >= 0.18\naside.footnote\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\naside.footnote > span,\ndiv.citation > span\n float: left\n font-weight: 500\n padding-right: 0.25rem\n\naside.footnote > *:not(span),\ndiv.citation > p\n margin-left: 2rem\n","//\n// Figures\n//\nimg\n box-sizing: border-box\n max-width: 100%\n height: auto\n\narticle\n figure, .figure\n border-radius: 0.2rem\n\n margin: 0\n :last-child\n margin-bottom: 0\n\n .align-left\n float: left\n clear: left\n margin: 0 1rem 1rem\n\n .align-right\n float: right\n clear: right\n margin: 0 1rem 1rem\n\n .align-default,\n .align-center\n display: block\n text-align: center\n margin-left: auto\n margin-right: auto\n\n // WELL, table needs to be stylised like a table.\n table.align-default\n display: table\n text-align: initial\n",".genindex-jumpbox, .domainindex-jumpbox\n border-top: 1px solid var(--color-background-border)\n border-bottom: 1px solid var(--color-background-border)\n padding: 0.25rem\n\n.genindex-section, .domainindex-section\n h2\n margin-top: 0.75rem\n margin-bottom: 0.5rem\n ul\n margin-top: 0\n margin-bottom: 0\n","ul,\nol\n padding-left: 1.2rem\n\n // Space lists out like paragraphs\n margin-top: 1rem\n margin-bottom: 1rem\n // reduce margins within li.\n li\n > p:first-child\n margin-top: 0.25rem\n margin-bottom: 0.25rem\n\n > p:last-child\n margin-top: 0.25rem\n\n > ul,\n > ol\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n\nol\n &.arabic\n list-style: decimal\n &.loweralpha\n list-style: lower-alpha\n &.upperalpha\n list-style: upper-alpha\n &.lowerroman\n list-style: lower-roman\n &.upperroman\n list-style: upper-roman\n\n// Don't space lists out when they're \"simple\" or in a `.. toctree::`\n.simple,\n.toctree-wrapper\n li\n > ul,\n > ol\n margin-top: 0\n margin-bottom: 0\n\n// Definition Lists\n.field-list,\n.option-list,\ndl:not([class]),\ndl.simple,\ndl.footnote,\ndl.glossary\n dt\n font-weight: 500\n margin-top: 0.25rem\n + dt\n margin-top: 0\n\n .classifier::before\n content: \":\"\n margin-left: 0.2rem\n margin-right: 0.2rem\n\n dd\n > p:first-child,\n ul\n margin-top: 0.125rem\n\n ul\n margin-bottom: 0.125rem\n",".math-wrapper\n width: 100%\n overflow-x: auto\n\ndiv.math\n position: relative\n text-align: center\n\n .headerlink,\n &:focus .headerlink\n display: none\n\n &:hover .headerlink\n display: inline-block\n\n span.eqno\n position: absolute\n right: 0.5rem\n top: 50%\n transform: translate(0, -50%)\n z-index: 1\n","// Abbreviations\nabbr[title]\n cursor: help\n\n// \"Problematic\" content, as identified by Sphinx\n.problematic\n color: var(--color-problematic)\n\n// Keyboard / Mouse \"instructions\"\nkbd:not(.compound)\n margin: 0 0.2rem\n padding: 0 0.2rem\n border-radius: 0.2rem\n border: 1px solid var(--color-foreground-border)\n color: var(--color-foreground-primary)\n vertical-align: text-bottom\n\n font-size: var(--font-size--small--3)\n display: inline-block\n\n box-shadow: 0 0.0625rem 0 rgba(0, 0, 0, 0.2), inset 0 0 0 0.125rem var(--color-background-primary)\n\n background-color: var(--color-background-secondary)\n\n// Blockquote\nblockquote\n border-left: 4px solid var(--color-background-border)\n background: var(--color-background-secondary)\n\n margin-left: 0\n margin-right: 0\n padding: 0.5rem 1rem\n\n .attribution\n font-weight: 600\n text-align: right\n\n &.pull-quote,\n &.highlights\n font-size: 1.25em\n\n &.epigraph,\n &.pull-quote\n border-left-width: 0\n border-radius: 0.5rem\n\n &.highlights\n border-left-width: 0\n background: transparent\n\n// Center align embedded-in-text images\np .reference img\n vertical-align: middle\n","p.rubric\n line-height: 1.25\n font-weight: bold\n font-size: 1.125em\n\n // For Numpy-style documentation that's got rubrics within it.\n // https://github.com/pradyunsg/furo/discussions/505\n dd &\n line-height: inherit\n font-weight: inherit\n\n font-size: var(--font-size--small)\n text-transform: uppercase\n","article .sidebar\n float: right\n clear: right\n width: 30%\n\n margin-left: 1rem\n margin-right: 0\n\n border-radius: 0.2rem\n background-color: var(--color-background-secondary)\n border: var(--color-background-border) 1px solid\n\n > *\n padding-left: 1rem\n padding-right: 1rem\n\n > ul, > ol // lists need additional padding, because bullets.\n padding-left: 2.2rem\n\n .sidebar-title\n margin: 0\n padding: 0.5rem 1rem\n border-bottom: var(--color-background-border) 1px solid\n\n font-weight: 500\n\n// TODO: subtitle\n// TODO: dedicated variables?\n","[role=main] .table-wrapper.container\n width: 100%\n overflow-x: auto\n margin-top: 1rem\n margin-bottom: 0.5rem\n padding: 0.2rem 0.2rem 0.75rem\n\ntable.docutils\n border-radius: 0.2rem\n border-spacing: 0\n border-collapse: collapse\n\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n th\n background: var(--color-table-header-background)\n\n td,\n th\n // Space things out properly\n padding: 0 0.25rem\n\n // Get the borders looking just-right.\n border-left: 1px solid var(--color-table-border)\n border-right: 1px solid var(--color-table-border)\n border-bottom: 1px solid var(--color-table-border)\n\n p\n margin: 0.25rem\n\n &:first-child\n border-left: none\n &:last-child\n border-right: none\n\n // MyST-parser tables set these classes for control of column alignment\n &.text-left\n text-align: left\n &.text-right\n text-align: right\n &.text-center\n text-align: center\n","@use \"../variables\" as *\n\n:target\n scroll-margin-top: 2.5rem\n\n@media (max-width: $full-width - $sidebar-width)\n :target\n scroll-margin-top: calc(2.5rem + var(--header-height))\n\n // When a heading is selected\n section > span:target\n scroll-margin-top: calc(2.8rem + var(--header-height))\n\n// Permalinks\n.headerlink\n font-weight: 100\n user-select: none\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\ndl dt,\np.caption,\nfigcaption p,\ntable > caption,\n.code-block-caption\n > .headerlink\n margin-left: 0.5rem\n visibility: hidden\n &:hover > .headerlink\n visibility: visible\n\n // Don't change to link-like, if someone adds the contents directive.\n > .toc-backref\n color: inherit\n text-decoration-line: none\n\n// Figure and table captions are special.\nfigure:hover > figcaption > p > .headerlink,\ntable:hover > caption > .headerlink\n visibility: visible\n\n:target >, // Regular section[id] style anchors\nspan:target ~ // Non-regular span[id] style \"extra\" anchors\n h1,\n h2,\n h3,\n h4,\n h5,\n h6\n &:nth-of-type(1)\n background-color: var(--color-highlight-on-target)\n // .headerlink\n // visibility: visible\n code.literal\n background-color: transparent\n\ntable:target > caption,\nfigure:target\n background-color: var(--color-highlight-on-target)\n\n// Inline page contents\n.this-will-duplicate-information-and-it-is-still-useful-here li :target\n background-color: var(--color-highlight-on-target)\n\n// Code block permalinks\n.literal-block-wrapper:target .code-block-caption\n background-color: var(--color-highlight-on-target)\n\n// When a definition list item is selected\n//\n// There isn't really an alternative to !important here, due to the\n// high-specificity of API documentation's selector.\ndt:target\n background-color: var(--color-highlight-on-target) !important\n\n// When a footnote reference is selected\n.footnote > dt:target + dd,\n.footnote-reference:target\n background-color: var(--color-highlight-on-target)\n",".guilabel\n background-color: var(--color-guilabel-background)\n border: 1px solid var(--color-guilabel-border)\n color: var(--color-guilabel-text)\n\n padding: 0 0.3em\n border-radius: 0.5em\n font-size: 0.9em\n","// This file contains the styles used for stylizing the footer that's shown\n// below the content.\n@use \"../variables\" as *\n\nfooter\n font-size: var(--font-size--small)\n display: flex\n flex-direction: column\n\n margin-top: 2rem\n\n// Bottom of page information\n.bottom-of-page\n display: flex\n align-items: center\n justify-content: space-between\n\n margin-top: 1rem\n padding-top: 1rem\n padding-bottom: 1rem\n\n color: var(--color-foreground-secondary)\n border-top: 1px solid var(--color-background-border)\n\n line-height: 1.5\n\n @media (max-width: $content-width)\n text-align: center\n flex-direction: column-reverse\n gap: 0.25rem\n\n .left-details\n font-size: var(--font-size--small)\n\n .right-details\n display: flex\n flex-direction: column\n gap: 0.25rem\n text-align: right\n\n .icons\n display: flex\n justify-content: flex-end\n gap: 0.25rem\n font-size: 1rem\n\n a\n text-decoration: none\n\n svg,\n img\n font-size: 1.125rem\n height: 1em\n width: 1em\n\n// Next/Prev page information\n.related-pages\n a\n display: flex\n align-items: center\n\n text-decoration: none\n &:hover .page-info .title\n text-decoration: underline\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n svg.furo-related-icon,\n svg.furo-related-icon > use\n flex-shrink: 0\n\n color: var(--color-foreground-border)\n\n width: 0.75rem\n height: 0.75rem\n margin: 0 0.5rem\n\n &.next-page\n max-width: 50%\n\n float: right\n clear: right\n text-align: right\n\n &.prev-page\n max-width: 50%\n\n float: left\n clear: left\n\n svg\n transform: rotate(180deg)\n\n.page-info\n display: flex\n flex-direction: column\n overflow-wrap: anywhere\n\n .next-page &\n align-items: flex-end\n\n .context\n display: flex\n align-items: center\n\n padding-bottom: 0.1rem\n\n color: var(--color-foreground-muted)\n font-size: var(--font-size--small)\n text-decoration: none\n","// This file contains the styles for the contents of the left sidebar, which\n// contains the navigation tree, logo, search etc.\n\n////////////////////////////////////////////////////////////////////////////////\n// Brand on top of the scrollable tree.\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-brand\n display: flex\n flex-direction: column\n flex-shrink: 0\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n text-decoration: none\n\n.sidebar-brand-text\n color: var(--color-sidebar-brand-text)\n overflow-wrap: break-word\n margin: var(--sidebar-item-spacing-vertical) 0\n font-size: 1.5rem\n\n.sidebar-logo-container\n margin: var(--sidebar-item-spacing-vertical) 0\n\n.sidebar-logo\n margin: 0 auto\n display: block\n max-width: 100%\n\n////////////////////////////////////////////////////////////////////////////////\n// Search\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-search-container\n display: flex\n align-items: center\n margin-top: var(--sidebar-search-space-above)\n\n position: relative\n\n background: var(--color-sidebar-search-background)\n &:hover,\n &:focus-within\n background: var(--color-sidebar-search-background--focus)\n\n &::before\n content: \"\"\n position: absolute\n left: var(--sidebar-item-spacing-horizontal)\n width: var(--sidebar-search-icon-size)\n height: var(--sidebar-search-icon-size)\n\n background-color: var(--color-sidebar-search-icon)\n mask-image: var(--icon-search)\n\n.sidebar-search\n box-sizing: border-box\n\n border: none\n border-top: 1px solid var(--color-sidebar-search-border)\n border-bottom: 1px solid var(--color-sidebar-search-border)\n\n padding-top: var(--sidebar-search-input-spacing-vertical)\n padding-bottom: var(--sidebar-search-input-spacing-vertical)\n padding-right: var(--sidebar-search-input-spacing-horizontal)\n padding-left: calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size))\n\n width: 100%\n\n color: var(--color-sidebar-search-foreground)\n background: transparent\n z-index: 10\n\n &:focus\n outline: none\n\n &::placeholder\n font-size: var(--sidebar-search-input-font-size)\n\n//\n// Hide Search Matches link\n//\n#searchbox .highlight-link\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0\n margin: 0\n text-align: center\n\n a\n color: var(--color-sidebar-search-icon)\n font-size: var(--font-size--small--2)\n\n////////////////////////////////////////////////////////////////////////////////\n// Structure/Skeleton of the navigation tree (left)\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-tree\n font-size: var(--sidebar-item-font-size)\n margin-top: var(--sidebar-tree-space-above)\n margin-bottom: var(--sidebar-item-spacing-vertical)\n\n ul\n padding: 0\n margin-top: 0\n margin-bottom: 0\n\n display: flex\n flex-direction: column\n\n list-style: none\n\n li\n position: relative\n margin: 0\n\n > ul\n margin-left: var(--sidebar-item-spacing-horizontal)\n\n .icon\n color: var(--color-sidebar-link-text)\n\n .reference\n box-sizing: border-box\n color: var(--color-sidebar-link-text)\n\n // Fill the parent.\n display: inline-block\n line-height: var(--sidebar-item-line-height)\n text-decoration: none\n\n // Don't allow long words to cause wrapping.\n overflow-wrap: anywhere\n\n height: 100%\n width: 100%\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n &:hover\n color: var(--color-sidebar-link-text)\n background: var(--color-sidebar-item-background--hover)\n\n // Add a nice little \"external-link\" arrow here.\n &.external::after\n content: url('data:image/svg+xml,')\n margin: 0 0.25rem\n vertical-align: middle\n color: var(--color-sidebar-link-text)\n\n // Make the current page reference bold.\n .current-page > .reference\n font-weight: bold\n\n label\n position: absolute\n top: 0\n right: 0\n height: var(--sidebar-item-height)\n width: var(--sidebar-expander-width)\n\n cursor: pointer\n user-select: none\n\n display: flex\n justify-content: center\n align-items: center\n\n .caption, :not(.caption) > .caption-text\n font-size: var(--sidebar-caption-font-size)\n color: var(--color-sidebar-caption-text)\n\n font-weight: bold\n text-transform: uppercase\n\n margin: var(--sidebar-caption-space-above) 0 0 0\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n // If it has children, add a bit more padding to wrap the content to avoid\n // overlapping with the