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

359 lines
25 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>data 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" />
</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="Меню навигации">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">data package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-data.constants">data.constants module</a><ul>
<li><a class="reference internal" href="#data.constants.Constants"><code class="docutils literal notranslate"><span class="pre">Constants</span></code></a><ul>
<li><a class="reference internal" href="#data.constants.Constants.login"><code class="docutils literal notranslate"><span class="pre">Constants.login</span></code></a></li>
<li><a class="reference internal" href="#data.constants.Constants.password"><code class="docutils literal notranslate"><span class="pre">Constants.password</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-data.environment">data.environment module</a><ul>
<li><a class="reference internal" href="#data.environment.Environment"><code class="docutils literal notranslate"><span class="pre">Environment</span></code></a><ul>
<li><a class="reference internal" href="#data.environment.Environment.TEST"><code class="docutils literal notranslate"><span class="pre">Environment.TEST</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.DEVELOP"><code class="docutils literal notranslate"><span class="pre">Environment.DEVELOP</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.URLS"><code class="docutils literal notranslate"><span class="pre">Environment.URLS</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.__init__"><code class="docutils literal notranslate"><span class="pre">Environment.__init__()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_base_url"><code class="docutils literal notranslate"><span class="pre">Environment.get_base_url()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_env_name"><code class="docutils literal notranslate"><span class="pre">Environment.get_env_name()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_request_url"><code class="docutils literal notranslate"><span class="pre">Environment.get_request_url()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.set_current_user_credential"><code class="docutils literal notranslate"><span class="pre">Environment.set_current_user_credential()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_access_token"><code class="docutils literal notranslate"><span class="pre">Environment.get_access_token()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_current_user_name"><code class="docutils literal notranslate"><span class="pre">Environment.get_current_user_name()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_current_user_role"><code class="docutils literal notranslate"><span class="pre">Environment.get_current_user_role()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_current_user_id"><code class="docutils literal notranslate"><span class="pre">Environment.get_current_user_id()</span></code></a></li>
<li><a class="reference internal" href="#data.environment.Environment.get_current_user_credential"><code class="docutils literal notranslate"><span class="pre">Environment.get_current_user_credential()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#module-data.roles_dict">data.roles_dict module</a></li>
<li><a class="reference internal" href="#module-data">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</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 active">data package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/data.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="data-package">
<h1>data package<a class="headerlink" href="#data-package" title="Ссылка на этот заголовок"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Ссылка на этот заголовок"></a></h2>
</section>
<section id="module-data.constants">
<span id="data-constants-module"></span><h2>data.constants module<a class="headerlink" href="#module-data.constants" title="Ссылка на этот заголовок"></a></h2>
<p>Модуль constants содержит настройки и константы приложения.</p>
<p>Основной класс Constants предоставляет доступ к переменным окружения,
используемым для аутентификации и других настроек.</p>
<dl class="py class">
<dt class="sig sig-object py" id="data.constants.Constants">
<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">Constants</span></span><a class="reference internal" href="_modules/data/constants.html#Constants"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.constants.Constants" title="Ссылка на это определение"></a></dt>
<dd><p>Базовые классы: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Хранит константы и переменные окружения.</p>
<p>Получает значения из переменных окружения. Используется для аутентификации.</p>
<dl class="simple">
<dt>Атрибуты:</dt><dd><p>login (str): Логин для аутентификации.
password (str): Пароль для аутентификации.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="data.constants.Constants.login">
<span class="sig-name descname"><span class="pre">login</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'admin'</span></em><a class="headerlink" href="#data.constants.Constants.login" title="Ссылка на это определение"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="data.constants.Constants.password">
<span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'enodemon-admin'</span></em><a class="headerlink" href="#data.constants.Constants.password" title="Ссылка на это определение"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-data.environment">
<span id="data-environment-module"></span><h2>data.environment module<a class="headerlink" href="#module-data.environment" title="Ссылка на этот заголовок"></a></h2>
<p>Модуль environment содержит настройки окружения и URL-адресов.</p>
<p>Класс Environment предоставляет методы для работы с окружением,
токенами и URL-адресами API.</p>
<dl class="py class">
<dt class="sig sig-object py" id="data.environment.Environment">
<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">Environment</span></span><a class="reference internal" href="_modules/data/environment.html#Environment"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment" title="Ссылка на это определение"></a></dt>
<dd><p>Базовые классы: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Управление окружением, URL-адресами и токенами.</p>
<dl class="simple">
<dt>Атрибуты класса:</dt><dd><p>TEST (str): Константа для тестового окружения.
DEVELOP (str): Константа для dev-окружения.
URLS (Dict[str, str]): Словарь URL для разных окружений.</p>
</dd>
</dl>
<dl class="field-list simple">
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="data.environment.Environment.TEST">
<span class="sig-name descname"><span class="pre">TEST</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'test'</span></em><a class="headerlink" href="#data.environment.Environment.TEST" title="Ссылка на это определение"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="data.environment.Environment.DEVELOP">
<span class="sig-name descname"><span class="pre">DEVELOP</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'develop'</span></em><a class="headerlink" href="#data.environment.Environment.DEVELOP" title="Ссылка на это определение"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="data.environment.Environment.URLS">
<span class="sig-name descname"><span class="pre">URLS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'develop':</span> <span class="pre">'http://192.168.2.69/',</span> <span class="pre">'test':</span> <span class="pre">'http://192.168.2.76/'}</span></em><a class="headerlink" href="#data.environment.Environment.URLS" title="Ссылка на это определение"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.__init__"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.__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><em>None</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_base_url">
<span class="sig-name descname"><span class="pre">get_base_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_base_url"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_base_url" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает базовый URL для текущего окружения.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: Базовый URL с путем для теста или без него.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_env_name">
<span class="sig-name descname"><span class="pre">get_env_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_env_name"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_env_name" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает имя текущего окружения.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: имя текущего окружения.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_request_url">
<span class="sig-name descname"><span class="pre">get_request_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_request_url"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_request_url" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает URL для API-запросов.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: URL для API-запросов.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.set_current_user_credential">
<span class="sig-name descname"><span class="pre">set_current_user_credential</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">credential</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.set_current_user_credential"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.set_current_user_credential" title="Ссылка на это определение"></a></dt>
<dd><p>Сохраняет учетные данные текущего пользователя.</p>
<dl class="simple">
<dt>Аргументы:</dt><dd><p>credential ({}): Учетные данные текущего пользователя.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>credential</strong> (<em>{}</em>)</p>
</dd>
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
<dd class="field-even"><p><em>None</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_access_token">
<span class="sig-name descname"><span class="pre">get_access_token</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_access_token"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_access_token" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает текущий токен доступа.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: Текущий токен доступа.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_current_user_name">
<span class="sig-name descname"><span class="pre">get_current_user_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_current_user_name"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_current_user_name" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает имя текущего пользователя.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: Имя текущего пользователя.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_current_user_role">
<span class="sig-name descname"><span class="pre">get_current_user_role</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_current_user_role"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_current_user_role" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает роль текущего пользователя.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: Роль текущего пользователя.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_current_user_id">
<span class="sig-name descname"><span class="pre">get_current_user_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_current_user_id"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_current_user_id" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает id текущего пользователя.</p>
<dl class="simple">
<dt>Возвращает:</dt><dd><p>str: id текущего пользователя.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>str</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="data.environment.Environment.get_current_user_credential">
<span class="sig-name descname"><span class="pre">get_current_user_credential</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data/environment.html#Environment.get_current_user_credential"><span class="viewcode-link"><span class="pre">[исходный</span> <span class="pre">код]</span></span></a><a class="headerlink" href="#data.environment.Environment.get_current_user_credential" 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>{}</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-data.roles_dict">
<span id="data-roles-dict-module"></span><h2>data.roles_dict module<a class="headerlink" href="#module-data.roles_dict" title="Ссылка на этот заголовок"></a></h2>
<p>Модуль roles_dict содержит словарь соответствия ролей.</p>
<p>Содержит сопоставление системных названий ролей с их отображаемыми названиями.</p>
</section>
<section id="module-data">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-data" title="Ссылка на этот заголовок"></a></h2>
<p>Package initialization.</p>
</section>
</section>
</div>
</div>
<footer>
<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>