Покрытие кода docstrings
This commit is contained in:
parent
4e92aba2a2
commit
8f48df2cf5
19 changed files with 2324 additions and 1839 deletions
|
|
@ -1,3 +1,20 @@
|
|||
"""
|
||||
Конфигурация 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
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,18 @@ logger = logging.getLogger(__name__)
|
|||
|
||||
|
||||
def init_config():
|
||||
"""Создаёт конфигурационный файл с SECRET_KEY"""
|
||||
"""
|
||||
Инициализация конфигурации приложения (JWT SECRET_KEY).
|
||||
|
||||
Назначение:
|
||||
- Создаёт файл `/etc/gonets/config.ini` с секцией `[JWT]` и случайным
|
||||
`secret_key`, если он отсутствует. Устанавливает права `0o600`.
|
||||
|
||||
Замечания:
|
||||
- Функция предназначена для однократного запуска (в инсталляторе/скрипте
|
||||
подготовки окружения) и безопасно пропускает работу, если файл уже существует.
|
||||
"""
|
||||
"""Создаёт конфигурационный файл с SECRET_KEY."""
|
||||
config_path = "/etc/gonets/config.ini"
|
||||
config_dir = os.path.dirname(config_path)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,13 @@ from typing import Dict, List
|
|||
|
||||
|
||||
class PortConfig:
|
||||
"""Конфигурация портов для сетевого сканирования."""
|
||||
"""Конфигурация известных портов для сетевого анализа.
|
||||
|
||||
Назначение:
|
||||
Предоставляет сопоставление распространённых портов с человекочитаемыми
|
||||
названиями сервисов для отображения в UI и логах. Поддерживает расширение
|
||||
пользовательским словарём.
|
||||
"""
|
||||
|
||||
_DEFAULT_PORTS: Dict[int, str] = {
|
||||
20: "FTP (Data)",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue