AlexL
/
e-nms_qa_automation
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e-nms_qa_automation/docs/build/html/_modules/data/environment.html

251 lines
18 KiB
HTML
Raw Permalink 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.0" />
<title>data.environment &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"></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"><a href="../index.html">Код модуля</a></li>
<li class="breadcrumb-item active">data.environment</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Исходный код data.environment</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Модуль environment содержит настройки окружения и URL-адресов.</span>
<span class="sd">Класс Environment предоставляет методы для работы с окружением,</span>
<span class="sd">токенами и URL-адресами API.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span>
<div class="viewcode-block" id="Environment">
<a class="viewcode-back" href="../../data.html#data.environment.Environment">[документация]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Environment</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Управление окружением, URL-адресами и токенами.</span>
<span class="sd"> Атрибуты класса:</span>
<span class="sd"> TEST (str): Константа для тестового окружения.</span>
<span class="sd"> DEVELOP (str): Константа для dev-окружения.</span>
<span class="sd"> URLS (Dict[str, str]): Словарь URL для разных окружений.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">TEST</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;test&#39;</span>
<span class="n">DEVELOP</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;develop&#39;</span>
<span class="n">URLS</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">TEST</span><span class="p">:</span> <span class="s1">&#39;http://192.168.2.76/&#39;</span><span class="p">,</span>
<span class="n">DEVELOP</span><span class="p">:</span> <span class="s1">&#39;http://192.168.2.69/&#39;</span>
<span class="p">}</span>
<div class="viewcode-block" id="Environment.__init__">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.__init__">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Инициализирует объект окружения и токены.&quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s1">&#39;ENV&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">TEST</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">TEST</span></div>
<div class="viewcode-block" id="Environment.get_base_url">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_base_url">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_base_url</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает базовый URL для текущего окружения.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: Базовый URL с путем для теста или без него.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">URLS</span><span class="p">:</span>
<span class="c1"># if self.env == self.TEST:</span>
<span class="c1"># return self.URLS[self.env] + &quot;e-nms-ui/&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">URLS</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">]</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unknown value of ENV variable </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environment.get_env_name">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_env_name">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_env_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает имя текущего окружения.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: имя текущего окружения.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span></div>
<div class="viewcode-block" id="Environment.get_request_url">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_request_url">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_request_url</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает URL для API-запросов.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: URL для API-запросов.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">URLS</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">URLS</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">]</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unknown value of ENV variable </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environment.set_current_user_credential">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.set_current_user_credential">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">set_current_user_credential</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credential</span><span class="p">:</span> <span class="p">{})</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Сохраняет учетные данные текущего пользователя.</span>
<span class="sd"> Аргументы:</span>
<span class="sd"> credential ({}): Учетные данные текущего пользователя.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span> <span class="o">=</span> <span class="n">credential</span></div>
<div class="viewcode-block" id="Environment.get_access_token">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_access_token">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_access_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает текущий токен доступа.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: Текущий токен доступа.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;access_token&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environment.get_current_user_name">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_current_user_name">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_current_user_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает имя текущего пользователя.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: Имя текущего пользователя.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;login&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environment.get_current_user_role">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_current_user_role">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_current_user_role</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает роль текущего пользователя.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: Роль текущего пользователя.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;role&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environment.get_current_user_id">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_current_user_id">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_current_user_id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает id текущего пользователя.</span>
<span class="sd"> Возвращает:</span>
<span class="sd"> str: id текущего пользователя.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;$id&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="Environment.get_current_user_credential">
<a class="viewcode-back" href="../../data.html#data.environment.Environment.get_current_user_credential">[документация]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_current_user_credential</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">{}:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Возвращает учетные данные текущего пользователя.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">current_user_credential</span></div>
</div>
<span class="n">host</span><span class="p">:</span> <span class="n">Environment</span> <span class="o">=</span> <span class="n">Environment</span><span class="p">()</span>
</pre></div>
</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>
Reference in New Issue View Git Blame Copy Permalink