e-nms_qa_automation/docs/build/html/tools.html

581 lines
46 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 class="writer-html5" lang="ru" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tools package &mdash; документация e-nms-qa-automation 0.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=6ff560e8"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/translations.js?v=cd1d70c9"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
<link rel="search" title="Поиск" href="search.html" />
<link rel="next" title="Руководство по документации тестов с помощью Sphinx" href="sphinx_guide.html" />
<link rel="prev" title="pages package" href="pages.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
e-nms-qa-automation
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Меню навигации">
<p class="caption" role="heading"><span class="caption-text">Содержание:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">e-nms_qa_automation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="components.html">components package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="components.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.alert_component">components.alert_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.alert_component.AlertComponent"><code class="docutils literal notranslate"><span class="pre">AlertComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.base_component">components.base_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.base_component.BaseComponent"><code class="docutils literal notranslate"><span class="pre">BaseComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.card_component">components.card_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.card_component.CardComponent"><code class="docutils literal notranslate"><span class="pre">CardComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.confirm_component">components.confirm_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.confirm_component.ConfirmComponent"><code class="docutils literal notranslate"><span class="pre">ConfirmComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.date_picker_component">components.date_picker_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.date_picker_component.DatePickerComponent"><code class="docutils literal notranslate"><span class="pre">DatePickerComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.dropdown_list_component">components.dropdown_list_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.dropdown_list_component.DropdownList"><code class="docutils literal notranslate"><span class="pre">DropdownList</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.eventbar_component">components.eventbar_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.eventbar_component.EventPanelComponent"><code class="docutils literal notranslate"><span class="pre">EventPanelComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.events_container_component">components.events_container_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.events_container_component.EventsContainerComponent"><code class="docutils literal notranslate"><span class="pre">EventsContainerComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.json_container_component">components.json_container_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.json_container_component.JsonContainerComponent"><code class="docutils literal notranslate"><span class="pre">JsonContainerComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.modal_window_component">components.modal_window_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.modal_window_component.ModalWindowComponent"><code class="docutils literal notranslate"><span class="pre">ModalWindowComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.navbar_component">components.navbar_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.navbar_component.NavigationPanelComponent"><code class="docutils literal notranslate"><span class="pre">NavigationPanelComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.table_component">components.table_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.table_component.TableComponent"><code class="docutils literal notranslate"><span class="pre">TableComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components.toolbar_component">components.toolbar_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components.html#components.toolbar_component.ToolbarComponent"><code class="docutils literal notranslate"><span class="pre">ToolbarComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components.html#module-components">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="components_derived.html">components_derived package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.container_system_log_events">components_derived.container_system_log_events module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.container_system_log_events.SystemLogEventsContainer"><code class="docutils literal notranslate"><span class="pre">SystemLogEventsContainer</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.date_input_component">components_derived.date_input_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.date_input_component.DateInput"><code class="docutils literal notranslate"><span class="pre">DateInput</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.interactive_dropdown_list">components_derived.interactive_dropdown_list module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.interactive_dropdown_list.InteractiveDropdownList"><code class="docutils literal notranslate"><span class="pre">InteractiveDropdownList</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_add_AD_user">components_derived.modal_add_AD_user module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_add_AD_user.AddADUserModalWindow"><code class="docutils literal notranslate"><span class="pre">AddADUserModalWindow</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_add_local_user">components_derived.modal_add_local_user module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_add_local_user.AddLocalUserModalWindow"><code class="docutils literal notranslate"><span class="pre">AddLocalUserModalWindow</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_change_password">components_derived.modal_change_password module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_change_password.ChangePasswordModalWindow"><code class="docutils literal notranslate"><span class="pre">ChangePasswordModalWindow</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_edit_user">components_derived.modal_edit_user module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_edit_user.EditUserModalWindow"><code class="docutils literal notranslate"><span class="pre">EditUserModalWindow</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_view_template">components_derived.modal_view_template module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_view_template.ViewTemplateModalWindow"><code class="docutils literal notranslate"><span class="pre">ViewTemplateModalWindow</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.modal_view_ztp_template">components_derived.modal_view_ztp_template module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.modal_view_ztp_template.ViewZTPTemplateModalWindow"><code class="docutils literal notranslate"><span class="pre">ViewZTPTemplateModalWindow</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.selection_bar_component">components_derived.selection_bar_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.selection_bar_component.SelectionBarComponent"><code class="docutils literal notranslate"><span class="pre">SelectionBarComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.settings_form_component">components_derived.settings_form_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.settings_form_component.SettingsFormComponent"><code class="docutils literal notranslate"><span class="pre">SettingsFormComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.sidebar_filter_component">components_derived.sidebar_filter_component module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.sidebar_filter_component.SidebarFilterComponent"><code class="docutils literal notranslate"><span class="pre">SidebarFilterComponent</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived.user_card">components_derived.user_card module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="components_derived.html#components_derived.user_card.UserCard"><code class="docutils literal notranslate"><span class="pre">UserCard</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="components_derived.html#module-components_derived">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="conftest.html">conftest module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="conftest.html#conftest.pytest_sessionfinish"><code class="docutils literal notranslate"><span class="pre">pytest_sessionfinish()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="conftest.html#conftest.pytest_addoption"><code class="docutils literal notranslate"><span class="pre">pytest_addoption()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="data.html">data package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="data.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data.constants">data.constants module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="data.html#data.constants.Constants"><code class="docutils literal notranslate"><span class="pre">Constants</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data.environment">data.environment module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="data.html#data.environment.Environment"><code class="docutils literal notranslate"><span class="pre">Environment</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data.roles_dict">data.roles_dict module</a></li>
<li class="toctree-l3"><a class="reference internal" href="data.html#module-data">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="elements.html">elements package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="elements.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.base_element">elements.base_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.base_element.BaseElement"><code class="docutils literal notranslate"><span class="pre">BaseElement</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.button_element">elements.button_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.button_element.Button"><code class="docutils literal notranslate"><span class="pre">Button</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.checkbox_element">elements.checkbox_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.checkbox_element.Checkbox"><code class="docutils literal notranslate"><span class="pre">Checkbox</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.icon_element">elements.icon_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.icon_element.Icon"><code class="docutils literal notranslate"><span class="pre">Icon</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.tab_button_element">elements.tab_button_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.tab_button_element.TabButton"><code class="docutils literal notranslate"><span class="pre">TabButton</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.text_element">elements.text_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.text_element.Text"><code class="docutils literal notranslate"><span class="pre">Text</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.text_input_element">elements.text_input_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.text_input_element.TextInput"><code class="docutils literal notranslate"><span class="pre">TextInput</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements.tooltip_button_element">elements.tooltip_button_element module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="elements.html#elements.tooltip_button_element.TooltipButton"><code class="docutils literal notranslate"><span class="pre">TooltipButton</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="elements.html#module-elements">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="fixtures.html">fixtures package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="fixtures.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="fixtures.html#module-fixtures.pages">fixtures.pages module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.pytest_addoption"><code class="docutils literal notranslate"><span class="pre">pytest_addoption()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.browser"><code class="docutils literal notranslate"><span class="pre">browser()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_firefox_browser"><code class="docutils literal notranslate"><span class="pre">get_firefox_browser()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_chrome_browser"><code class="docutils literal notranslate"><span class="pre">get_chrome_browser()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_remote_chrome"><code class="docutils literal notranslate"><span class="pre">get_remote_chrome()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.get_context"><code class="docutils literal notranslate"><span class="pre">get_context()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="fixtures.html#fixtures.pages.return_back"><code class="docutils literal notranslate"><span class="pre">return_back()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="fixtures.html#module-fixtures">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pages.html">pages package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pages.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.base_page">pages.base_page module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.base_page.BasePage"><code class="docutils literal notranslate"><span class="pre">BasePage</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.current_session_tab">pages.current_session_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.current_session_tab.CurrentSessionsTab"><code class="docutils literal notranslate"><span class="pre">CurrentSessionsTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.license_tab">pages.license_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.license_tab.LicenseTab"><code class="docutils literal notranslate"><span class="pre">LicenseTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.login_page">pages.login_page module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.login_page.LoginPage"><code class="docutils literal notranslate"><span class="pre">LoginPage</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.main_page">pages.main_page module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.main_page.MainPage"><code class="docutils literal notranslate"><span class="pre">MainPage</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.push_notifications_settings_tab">pages.push_notifications_settings_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.push_notifications_settings_tab.PushNotificationsSettingsTab"><code class="docutils literal notranslate"><span class="pre">PushNotificationsSettingsTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.service_status_tab">pages.service_status_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.service_status_tab.ServiceStatusTab"><code class="docutils literal notranslate"><span class="pre">ServiceStatusTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.session_settings_tab">pages.session_settings_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.session_settings_tab.SessionSettingsTab"><code class="docutils literal notranslate"><span class="pre">SessionSettingsTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.templates_tab">pages.templates_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.templates_tab.TemplatesTab"><code class="docutils literal notranslate"><span class="pre">TemplatesTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.users_tab">pages.users_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.users_tab.UsersTab"><code class="docutils literal notranslate"><span class="pre">UsersTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.ztp_config_tab">pages.ztp_config_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.ztp_config_tab.ZTPConfigTab"><code class="docutils literal notranslate"><span class="pre">ZTPConfigTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages.ztp_templates_tab">pages.ztp_templates_tab module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pages.html#pages.ztp_templates_tab.ZTPTemplatesTab"><code class="docutils literal notranslate"><span class="pre">ZTPTemplatesTab</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pages.html#module-pages">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">tools package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-tools.fix_python_project">tools.fix_python_project module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#tools.fix_python_project.ProjectFixer"><code class="docutils literal notranslate"><span class="pre">ProjectFixer</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-tools.logger">tools.logger module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#tools.logger.get_logger"><code class="docutils literal notranslate"><span class="pre">get_logger()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-tools">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Документация и руководства:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="sphinx_guide.html">Руководство по документации тестов с помощью Sphinx</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#id2">1 Расположение документа</a></li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#id3">2 Первичная настройка для нового проекта</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id4">2.1 Подготовка зависимостей</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id5">2.2 Инициализация Sphinx</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id6">2.3 Настройка конфигурации</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id7">2.4 Настройка главной страницы</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#id8">3 Работа с существующим проектом</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id9">3.1 Установка зависимостей</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id10">3.2 Генерация документации</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id11">3.2.1 Базовая генерация</a></li>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id12">3.2.2 Генерация с исключениями</a></li>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id13">3.2.3 Принудительная перегенерация</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id14">3.3 Очистка документации</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id15">3.3.1 Команды очистки</a></li>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id16">3.3.2 Автоматизация очистки</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id17">3.4 Сборка и деплой</a><ul>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id18">3.4.1 Локальная сборка</a></li>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id19">3.4.2 Проверка качества</a></li>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#id20">3.4.3 Сборка для публикации</a></li>
<li class="toctree-l4"><a class="reference internal" href="sphinx_guide.html#ci-cd">3.4.4 Настройка для CI/CD</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#mkdocs-sphinx">4 Конвертация контента из MkDocs в Sphinx</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id21">4.1 Текст</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id22">4.2 Таблицы</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#id23">5 Особенности Sphinx</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#docstrings">5.1 Поддержка docstrings</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id24">5.2 Кастомные директивы</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#id25">6 Решение проблем</a><ul>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id26">6.1 Проблема: Модули не находятся</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id27">6.2 Проблема: Не генерируются docstrings</a></li>
<li class="toctree-l3"><a class="reference internal" href="sphinx_guide.html#id28">6.3 Проблема: Тема не применяется</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#id29">7 Дополнительные возможности</a></li>
<li class="toctree-l2"><a class="reference internal" href="sphinx_guide.html#version-history">История версий</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">e-nms-qa-automation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Навигация по страницам">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">e-nms_qa_automation</a></li>
<li class="breadcrumb-item active">tools package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tools.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="tools-package">
<h1>tools package<a class="headerlink" href="#tools-package" title="Ссылка на этот заголовок"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Ссылка на этот заголовок"></a></h2>
</section>
<section id="module-tools.fix_python_project">
<span id="tools-fix-python-project-module"></span><h2>tools.fix_python_project module<a class="headerlink" href="#module-tools.fix_python_project" title="Ссылка на этот заголовок"></a></h2>
<p>Модуль исправления структуры Python-проекта.</p>
<p>Автоматически выполняет:
1. Удаление BOM-маркеров из файлов
2. Создание недостающих __init__.py
3. Логирование всех операций</p>
<p>Использование: python fix_python_project.py [путь_к_проекту]</p>
<dl class="py class">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ProjectFixer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'.'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer" title="Ссылка на это определение"></a></dt>
<dd><p>Базовые классы: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Исправляет структуру Python-проекта.</p>
<dl class="simple">
<dt>Атрибуты:</dt><dd><p>root_dir: Корневая директория проекта.
log: Лог выполненных операций.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>root_dir</strong> (<em>str</em>)</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'.'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.__init__"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.__init__" title="Ссылка на это определение"></a></dt>
<dd><p>Инициализирует экземпляр ProjectFixer.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>root_dir</strong> (<em>str</em>) Корневая директория проекта. По умолчанию „.“.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.remove_bom">
<span class="sig-name descname"><span class="pre">remove_bom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.remove_bom"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.remove_bom" title="Ссылка на это определение"></a></dt>
<dd><p>Удаляет BOM-маркер из файла.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filepath</strong> (<em>str</em>) Путь к файлу.</p>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>True если BOM был удалён.</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool</em></p>
</dd>
<dt class="field-even">Исключение<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>Exception</strong> При ошибке чтения/записи.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.should_skip_init">
<span class="sig-name descname"><span class="pre">should_skip_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dir_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.should_skip_init"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.should_skip_init" title="Ссылка на это определение"></a></dt>
<dd><p>Проверяет нужно ли пропустить директорию.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dir_path</strong> (<em>str</em>) Путь к директории.</p>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>True если директорию нужно пропустить.</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.needs_init_py">
<span class="sig-name descname"><span class="pre">needs_init_py</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dir_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.needs_init_py"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.needs_init_py" title="Ссылка на это определение"></a></dt>
<dd><p>Проверяет нужно ли создать __init__.py.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dir_path</strong> (<em>str</em>) Путь к директории.</p>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>True если __init__.py требуется.</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.create_init_py">
<span class="sig-name descname"><span class="pre">create_init_py</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dir_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.create_init_py"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.create_init_py" title="Ссылка на это определение"></a></dt>
<dd><p>Создаёт файл __init__.py.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dir_path</strong> (<em>str</em>) Путь к директории.</p>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>True если файл создан.</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool</em></p>
</dd>
<dt class="field-even">Исключение<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>Exception</strong> При ошибке создания.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.process_directory">
<span class="sig-name descname"><span class="pre">process_directory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.process_directory"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.process_directory" title="Ссылка на это определение"></a></dt>
<dd><p>Рекурсивно обрабатывает проект.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tools.fix_python_project.ProjectFixer.save_log">
<span class="sig-name descname"><span class="pre">save_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">log_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'project_fix.log'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/fix_python_project.html#ProjectFixer.save_log"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.fix_python_project.ProjectFixer.save_log" title="Ссылка на это определение"></a></dt>
<dd><p>Сохраняет лог операций в файл.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>log_file</strong> (<em>str</em>) Имя файла лога. По умолчанию „project_fix.log“.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-tools.logger">
<span id="tools-logger-module"></span><h2>tools.logger module<a class="headerlink" href="#module-tools.logger" title="Ссылка на этот заголовок"></a></h2>
<p>Модуль настройки логгера.</p>
<p>Содержит функцию для создания и настройки логгера
с выводом в стандартный поток.</p>
<dl class="py function">
<dt class="sig sig-object py" id="tools.logger.get_logger">
<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools/logger.html#get_logger"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#tools.logger.get_logger" title="Ссылка на это определение"></a></dt>
<dd><p>Создаёт и настраивает логгер.</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) Имя логгера (обычно __name__ модуля).</p>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>Настроенный экземпляр логгера.</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p>logging.Logger</p>
</dd>
</dl>
<dl class="simple">
<dt>Пример:</dt><dd><p>logger = get_logger(__name__)
logger.debug(«Тестовое сообщение»)</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-tools">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-tools" title="Ссылка на этот заголовок"></a></h2>
<p>Package initialization.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
<a href="pages.html" class="btn btn-neutral float-left" title="pages package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
<a href="sphinx_guide.html" class="btn btn-neutral float-right" title="Руководство по документации тестов с помощью Sphinx" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Авторские права 2025, NPO KIS. </p>
</div>
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>