e-nms_qa_automation/site/config/add_docstring/index.html

2719 lines
48 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../mkdocs_guide/">
<link rel="next" href="../code_development_process/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.21">
<title>Требования при добавлении docstring - Документация тестов eNODE-Мониторинг</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#_1" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Документация тестов eNODE-Мониторинг" class="md-header__button md-logo" aria-label="Документация тестов eNODE-Мониторинг" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Документация тестов eNODE-Мониторинг
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Требования при добавлении docstring
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Документация тестов eNODE-Мониторинг" class="md-nav__button md-logo" aria-label="Документация тестов eNODE-Мониторинг" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Документация тестов eNODE-Мониторинг
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Главная
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Данные и конфигурации
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Данные и конфигурации
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../data/constants/" class="md-nav__link">
<span class="md-ellipsis">
Constants
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../data/environment/" class="md-nav__link">
<span class="md-ellipsis">
Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../data/roles_dict/" class="md-nav__link">
<span class="md-ellipsis">
Roles_dict
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Фикстуры Pytest
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Фикстуры Pytest
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../fixtures/pages/" class="md-nav__link">
<span class="md-ellipsis">
Browser Fixtures
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Элементы UI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Элементы UI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../elements/base_element/" class="md-nav__link">
<span class="md-ellipsis">
BaseElement
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/button_element/" class="md-nav__link">
<span class="md-ellipsis">
Button
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/checkbox_element/" class="md-nav__link">
<span class="md-ellipsis">
Checkbox
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/icon_element/" class="md-nav__link">
<span class="md-ellipsis">
Icon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/tab_button_element/" class="md-nav__link">
<span class="md-ellipsis">
TabButton
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/text_element/" class="md-nav__link">
<span class="md-ellipsis">
Text
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/text_input_element/" class="md-nav__link">
<span class="md-ellipsis">
TextInput
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../elements/tooltip_button_element/" class="md-nav__link">
<span class="md-ellipsis">
ToolbarButton
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Компоненты UI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Компоненты UI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../components/alert_component/" class="md-nav__link">
<span class="md-ellipsis">
AlertComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/base_component/" class="md-nav__link">
<span class="md-ellipsis">
BaseComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/card_component/" class="md-nav__link">
<span class="md-ellipsis">
CardComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/confirm_component/" class="md-nav__link">
<span class="md-ellipsis">
ConfirmComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/dropdown_list_component/" class="md-nav__link">
<span class="md-ellipsis">
DropdownList
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/eventbar_component/" class="md-nav__link">
<span class="md-ellipsis">
EventPanelComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/events_container_component/" class="md-nav__link">
<span class="md-ellipsis">
EventsContainerComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/json_container_component/" class="md-nav__link">
<span class="md-ellipsis">
JsonContainerComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/modal_window_component/" class="md-nav__link">
<span class="md-ellipsis">
ModalWindowComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/navbar_component/" class="md-nav__link">
<span class="md-ellipsis">
NavigationPanelComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/table_component/" class="md-nav__link">
<span class="md-ellipsis">
TableComponent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components/toolbar_component/" class="md-nav__link">
<span class="md-ellipsis">
ToolbarComponent
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Компоненты производные UI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Компоненты производные UI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../components_derived/container_system_log_events/" class="md-nav__link">
<span class="md-ellipsis">
SystemLogEventsContainer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/modal_add_AD_user/" class="md-nav__link">
<span class="md-ellipsis">
AddADUserModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/modal_add_local_user/" class="md-nav__link">
<span class="md-ellipsis">
AddLocalUserModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/modal_change_password/" class="md-nav__link">
<span class="md-ellipsis">
ChangePasswordModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/modal_edit_user/" class="md-nav__link">
<span class="md-ellipsis">
EditUserModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/modal_view_template/" class="md-nav__link">
<span class="md-ellipsis">
ViewTemplateModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/modal_view_ztp_template/" class="md-nav__link">
<span class="md-ellipsis">
ViewZTPTemplateModalWindow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../components_derived/user_card/" class="md-nav__link">
<span class="md-ellipsis">
UserCard
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Локаторы
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Локаторы
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../locators/button_locators/" class="md-nav__link">
<span class="md-ellipsis">
ButtonLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/confirm_locators/" class="md-nav__link">
<span class="md-ellipsis">
ConfirmLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/event_panel_locators/" class="md-nav__link">
<span class="md-ellipsis">
EventPanelLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/input_locators/" class="md-nav__link">
<span class="md-ellipsis">
InputLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/json_container_locators/" class="md-nav__link">
<span class="md-ellipsis">
JsonContainerLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/modal_window_locators/" class="md-nav__link">
<span class="md-ellipsis">
ModalWindowLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/navigation_panel_locators/" class="md-nav__link">
<span class="md-ellipsis">
NavigationPanelLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/rack_locators/" class="md-nav__link">
<span class="md-ellipsis">
RackLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/settings_form_locators/" class="md-nav__link">
<span class="md-ellipsis">
SettingsFormLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/table_locators/" class="md-nav__link">
<span class="md-ellipsis">
TableLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/text_input_locators/" class="md-nav__link">
<span class="md-ellipsis">
TextInputLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/text_locators/" class="md-nav__link">
<span class="md-ellipsis">
TextLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/toolbar_locators/" class="md-nav__link">
<span class="md-ellipsis">
ToolbarLocators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../locators/user_card_locators/" class="md-nav__link">
<span class="md-ellipsis">
UserCardLocators
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Страницы приложения
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Страницы приложения
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../pages/base_page/" class="md-nav__link">
<span class="md-ellipsis">
BasePage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/license_tab/" class="md-nav__link">
<span class="md-ellipsis">
LicenseTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/login_page/" class="md-nav__link">
<span class="md-ellipsis">
LoginPage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/main_page/" class="md-nav__link">
<span class="md-ellipsis">
MainPage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/service_status_tab/" class="md-nav__link">
<span class="md-ellipsis">
ServiceStatusTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/current_session_tab/" class="md-nav__link">
<span class="md-ellipsis">
CurrentSessionsTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/session_settings_tab/" class="md-nav__link">
<span class="md-ellipsis">
SessionSettingsTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/templates_tab/" class="md-nav__link">
<span class="md-ellipsis">
TemplatesTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/users_tab/" class="md-nav__link">
<span class="md-ellipsis">
UsersTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/ztp_config_tab/" class="md-nav__link">
<span class="md-ellipsis">
ZTPConfigTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../pages/ztp_templates_tab/" class="md-nav__link">
<span class="md-ellipsis">
ZTPTemplatesTab
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
<span class="md-ellipsis">
Тесты
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Тесты
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_1" >
<label class="md-nav__link" for="__nav_9_1" id="__nav_9_1_label" tabindex="0">
<span class="md-ellipsis">
End-to-End
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_9_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_1">
<span class="md-nav__icon md-icon"></span>
End-to-End
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_1_1" >
<label class="md-nav__link" for="__nav_9_1_1" id="__nav_9_1_1_label" tabindex="0">
<span class="md-ellipsis">
Sessions
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_9_1_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_1_1">
<span class="md-nav__icon md-icon"></span>
Sessions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tests/e2e/sessions/test_current_sessions_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestCurrentSessionsTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/sessions/test_session_settings_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestCurrentSettingsTab
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_1_2" >
<label class="md-nav__link" for="__nav_9_1_2" id="__nav_9_1_2_label" tabindex="0">
<span class="md-ellipsis">
Users
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_9_1_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_1_2">
<span class="md-nav__icon md-icon"></span>
Users
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tests/e2e/users/test_add_user/" class="md-nav__link">
<span class="md-ellipsis">
TestUsersTabAddUser
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/users/test_edit_user/" class="md-nav__link">
<span class="md-ellipsis">
TestUsersTabEditUser
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/users/test_user_card/" class="md-nav__link">
<span class="md-ellipsis">
TestUserCard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/users/test_users_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestUsersTab
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_event_panel/" class="md-nav__link">
<span class="md-ellipsis">
TestEventPanel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_expand_navigation_panel/" class="md-nav__link">
<span class="md-ellipsis">
TestNavigationPanel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_license_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestLicenseTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_login/" class="md-nav__link">
<span class="md-ellipsis">
TestLogin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_service_status_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestServiceStatusTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_system_log_events_container/" class="md-nav__link">
<span class="md-ellipsis">
TestSystemLogEventsContainer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_templates_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestTemplatesTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_ztp_config_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestZTPConfigTab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/e2e/test_ztp_templates_tab/" class="md-nav__link">
<span class="md-ellipsis">
TestZTPTemplatesTab
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_2" >
<label class="md-nav__link" for="__nav_9_2" id="__nav_9_2_label" tabindex="0">
<span class="md-ellipsis">
Компоненты
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_9_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_2">
<span class="md-nav__icon md-icon"></span>
Компоненты
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tests/components/test_json_container/" class="md-nav__link">
<span class="md-ellipsis">
TestJsonContainer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/components/test_navigation_panel/" class="md-nav__link">
<span class="md-ellipsis">
TestNavigationPanel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/components/test_services_table/" class="md-nav__link">
<span class="md-ellipsis">
TestServiceStatusTable
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tests/components/test_user_modal_window/" class="md-nav__link">
<span class="md-ellipsis">
TestUsersModalWindow
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
<span class="md-ellipsis">
Утилиты
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
Утилиты
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tools/logger/" class="md-nav__link">
<span class="md-ellipsis">
Logging
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tools/fix_python_project/" class="md-nav__link">
<span class="md-ellipsis">
Python Project Fixer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
<span class="md-ellipsis">
Инструкции
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
Инструкции
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../mkdocs_guide/" class="md-nav__link">
<span class="md-ellipsis">
Документация проекта MkDocs
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Требования при добавлении docstring
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Требования при добавлении docstring
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
Изменить соблюдая требования:
</span>
</a>
<nav class="md-nav" aria-label="Изменить соблюдая требования:">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docstring-deepseek" class="md-nav__link">
<span class="md-ellipsis">
Пример добавления Docstring с помощью ИИ "DeepSeek":
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../code_development_process/" class="md-nav__link">
<span class="md-ellipsis">
Процесс разработки кода
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
Изменить соблюдая требования:
</span>
</a>
<nav class="md-nav" aria-label="Изменить соблюдая требования:">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docstring-deepseek" class="md-nav__link">
<span class="md-ellipsis">
Пример добавления Docstring с помощью ИИ "DeepSeek":
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Требования при добавлении docstring</h1>
<p><strong>Добавление Docstring</strong></p>
<h2 id="_1">Изменить соблюдая требования:</h2>
<ol>
<li>
<p>Добавить недостающие и улучшить имеющиеся docstrings язык русский.</p>
</li>
<li>
<p>Сделать docstring более компактными, сохранив всю важную информацию.</p>
</li>
<li>
<p>Ограничить в docstring длину строк 79 символами.</p>
</li>
<li>
<p>Добавить docstring перед импортами.</p>
</li>
<li>
<p>Должна быть пустая строка после каждого docstring.</p>
</li>
<li>
<p>Сохранить все текущие комментарии.</p>
</li>
<li>
<p>Запрещено изменять код (изменять только docstring).</p>
</li>
<li>
<p>Не удалять пустые строки.</p>
</li>
<li>
<p>В конце кода должна быть одна пустая строка.</p>
</li>
</ol>
<h3 id="docstring-deepseek">Пример добавления Docstring с помощью ИИ "DeepSeek":</h3>
<ul>
<li>Загрузить: DeepSeek файл проекта my_name.py и docs/config/add_docstring.md.</li>
<li>Запросить: Изменить строго соблюдая требования,вывести полный изменённый код и отчет о выполнении требований.</li>
<li>Проверить результат сравнением изменений сделанными в коде ИИ "DeepSeek" с помощью notepad++.</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.a7c05c9e.min.js"></script>
</body>
</html>