sh_cpl/docs/build/html/cpl_cli.live_server.html

283 lines
14 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_cli.live_server &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_cli.publish" href="cpl_cli.publish.html" />
<link rel="prev" title="cpl_cli.configuration" href="cpl_cli.configuration.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"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<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="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="cpl.html">CPL</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.command.html">cpl_cli.command</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.configuration.html">cpl_cli.configuration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_cli.live_server</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.live_server.live_server_service">cpl_cli.live_server.live_server_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_cli.live_server.live_server_thread">cpl_cli.live_server.live_server_thread module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl_cli.publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.source_creator.html">cpl_cli.source_creator</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli">cpl_cli.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings">cpl_cli.cli_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.cli_settings_name_enum">cpl_cli.cli_settings_name_enum</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_abc">cpl_cli.command_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_handler_service">cpl_cli.command_handler_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.command_model">cpl_cli.command_model</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.error">cpl_cli.error</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.main">cpl_cli.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli.startup">cpl_cli.startup</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.html#module-cpl_cli">Module contents</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="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CPL_CLI</a> &raquo;</li>
<li>cpl_cli.live_server</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.live_server.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl-cli-live-server">
<h1>cpl_cli.live_server<a class="headerlink" href="#cpl-cli-live-server" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl_cli.live_server.live_server_service">
<span id="cpl-cli-live-server-live-server-service-module"></span><h2>cpl_cli.live_server.live_server_service module<a class="headerlink" href="#module-cpl_cli.live_server.live_server_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.live_server.live_server_service.LiveServerService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.live_server.live_server_service.</span></code><code class="sig-name descname"><span class="pre">LiveServerService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">project_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.project_settings.ProjectSettings" title="cpl_cli.configuration.project_settings.ProjectSettings"><span class="pre">cpl_cli.configuration.project_settings.ProjectSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">watchdog.events.FileSystemEventHandler</span></code></p>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_service.LiveServerService.on_modified">
<code class="sig-name descname"><span class="pre">on_modified</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService.on_modified" title="Permalink to this definition"></a></dt>
<dd><p>Triggers when source file is modified
:param event:
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_service.LiveServerService.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_service.LiveServerService.start" title="Permalink to this definition"></a></dt>
<dd><p>Starts the CPL live development server
:param args:
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_cli.live_server.live_server_thread">
<span id="cpl-cli-live-server-live-server-thread-module"></span><h2>cpl_cli.live_server.live_server_thread module<a class="headerlink" href="#module-cpl_cli.live_server.live_server_thread" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_cli.live_server.live_server_thread.</span></code><code class="sig-name descname"><span class="pre">LiveServerThread</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">build_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_cli.configuration.html#cpl_cli.configuration.build_settings.BuildSettings" title="cpl_cli.configuration.build_settings.BuildSettings"><span class="pre">cpl_cli.configuration.build_settings.BuildSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Thread</span></code></p>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.command">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">command</span></code><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.command" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.main">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">main</span></code><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.main" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="cpl_cli.live_server.live_server_thread.LiveServerThread.run">
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_cli.live_server.live_server_thread.LiveServerThread.run" title="Permalink to this definition"></a></dt>
<dd><p>Starts the CPL project
:return:</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cpl_cli.publish.html" class="btn btn-neutral float-right" title="cpl_cli.publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.configuration.html" class="btn btn-neutral float-left" title="cpl_cli.configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>