289 lines
19 KiB
HTML
289 lines
19 KiB
HTML
|
||
|
||
<!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 — документация 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="#">tools package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-tools.fix_python_project">tools.fix_python_project module</a><ul>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer"><code class="docutils literal notranslate"><span class="pre">ProjectFixer</span></code></a><ul>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.__init__"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.__init__()</span></code></a></li>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.remove_bom"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.remove_bom()</span></code></a></li>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.should_skip_init"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.should_skip_init()</span></code></a></li>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.needs_init_py"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.needs_init_py()</span></code></a></li>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.create_init_py"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.create_init_py()</span></code></a></li>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.process_directory"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.process_directory()</span></code></a></li>
|
||
<li><a class="reference internal" href="#tools.fix_python_project.ProjectFixer.save_log"><code class="docutils literal notranslate"><span class="pre">ProjectFixer.save_log()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#module-tools.logger">tools.logger module</a><ul>
|
||
<li><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><a class="reference internal" href="#module-tools">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">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>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Авторские права 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> |