<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>pylorax.api.server — Lorax 28.14.21 documentation</title> <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> <script src="../../../_static/js/modernizr.min.js"></script> </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"> Lorax </a> <div class="version"> 28.14.21 </div> <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> <li class="toctree-l1"><a class="reference internal" href="../../../intro.html">Introduction to Lorax</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../modules.html">pylorax</a></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">Lorax</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">Docs</a> »</li> <li><a href="../../index.html">Module code</a> »</li> <li><a href="../../pylorax.html">pylorax</a> »</li> <li>pylorax.api.server</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>Source code for pylorax.api.server</h1><div class="highlight"><pre> <span></span><span class="c1">#</span> <span class="c1"># Copyright (C) 2017 Red Hat, Inc.</span> <span class="c1">#</span> <span class="c1"># This program is free software; you can redistribute it and/or modify</span> <span class="c1"># it under the terms of the GNU General Public License as published by</span> <span class="c1"># the Free Software Foundation; either version 2 of the License, or</span> <span class="c1"># (at your option) any later version.</span> <span class="c1">#</span> <span class="c1"># This program is distributed in the hope that it will be useful,</span> <span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <span class="c1"># GNU General Public License for more details.</span> <span class="c1">#</span> <span class="c1"># You should have received a copy of the GNU General Public License</span> <span class="c1"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span> <span class="c1">#</span> <span class="kn">import</span> <span class="nn">logging</span> <span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">"lorax-composer"</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">namedtuple</span> <span class="kn">from</span> <span class="nn">flask</span> <span class="k">import</span> <span class="n">Flask</span><span class="p">,</span> <span class="n">jsonify</span><span class="p">,</span> <span class="n">redirect</span><span class="p">,</span> <span class="n">send_from_directory</span> <span class="kn">from</span> <span class="nn">glob</span> <span class="k">import</span> <span class="n">glob</span> <span class="kn">import</span> <span class="nn">os</span> <span class="kn">from</span> <span class="nn">pylorax</span> <span class="k">import</span> <span class="n">vernum</span> <span class="kn">from</span> <span class="nn">pylorax.api.crossdomain</span> <span class="k">import</span> <span class="n">crossdomain</span> <span class="kn">from</span> <span class="nn">pylorax.api.v0</span> <span class="k">import</span> <span class="n">v0_api</span> <span class="kn">from</span> <span class="nn">pylorax.sysutils</span> <span class="k">import</span> <span class="n">joinpaths</span> <span class="n">GitLock</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s2">"GitLock"</span><span class="p">,</span> <span class="p">[</span><span class="s2">"repo"</span><span class="p">,</span> <span class="s2">"lock"</span><span class="p">,</span> <span class="s2">"dir"</span><span class="p">])</span> <span class="n">server</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span> <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"server"</span><span class="p">,</span> <span class="s2">"GitLock"</span><span class="p">]</span> <span class="nd">@server</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> <span class="k">def</span> <span class="nf">server_root</span><span class="p">():</span> <span class="n">redirect</span><span class="p">(</span><span class="s2">"/api/docs/"</span><span class="p">)</span> <span class="nd">@server</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/api/docs/"</span><span class="p">)</span> <span class="nd">@server</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/api/docs/<path:path>"</span><span class="p">)</span> <span class="k">def</span> <span class="nf">api_docs</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># Find the html docs</span> <span class="k">try</span><span class="p">:</span> <span class="c1"># This assumes it is running from the source tree</span> <span class="n">docs_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">joinpaths</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">),</span> <span class="s2">"../../../docs/html"</span><span class="p">))</span> <span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span> <span class="n">docs_path</span> <span class="o">=</span> <span class="n">glob</span><span class="p">(</span><span class="s2">"/usr/share/doc/lorax-*/html/"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">path</span><span class="p">:</span> <span class="n">path</span><span class="o">=</span><span class="s2">"index.html"</span> <span class="k">return</span> <span class="n">send_from_directory</span><span class="p">(</span><span class="n">docs_path</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span> <span class="nd">@server</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/api/status"</span><span class="p">)</span> <span class="nd">@crossdomain</span><span class="p">(</span><span class="n">origin</span><span class="o">=</span><span class="s2">"*"</span><span class="p">)</span> <span class="k">def</span> <span class="nf">v0_status</span><span class="p">():</span> <span class="sd">"""</span> <span class="sd"> `/api/v0/status`</span> <span class="sd"> ^^^^^^^^^^^^^^^^</span> <span class="sd"> Return the status of the API Server::</span> <span class="sd"> { "api": "0",</span> <span class="sd"> "build": "devel",</span> <span class="sd"> "db_supported": true,</span> <span class="sd"> "db_version": "0",</span> <span class="sd"> "schema_version": "0",</span> <span class="sd"> "backend": "lorax-composer",</span> <span class="sd"> "msgs": []}</span> <span class="sd"> The 'msgs' field can be a list of strings describing startup problems or status that</span> <span class="sd"> should be displayed to the user. eg. if the compose templates are not depsolving properly</span> <span class="sd"> the errors will be in 'msgs'.</span> <span class="sd"> """</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">(</span><span class="n">backend</span><span class="o">=</span><span class="s2">"lorax-composer"</span><span class="p">,</span> <span class="n">build</span><span class="o">=</span><span class="n">vernum</span><span class="p">,</span> <span class="n">api</span><span class="o">=</span><span class="s2">"0"</span><span class="p">,</span> <span class="n">db_version</span><span class="o">=</span><span class="s2">"0"</span><span class="p">,</span> <span class="n">schema_version</span><span class="o">=</span><span class="s2">"0"</span><span class="p">,</span> <span class="n">db_supported</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">msgs</span><span class="o">=</span><span class="n">server</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s2">"TEMPLATE_ERRORS"</span><span class="p">])</span> <span class="n">v0_api</span><span class="p">(</span><span class="n">server</span><span class="p">)</span> </pre></div> </div> </div> <footer> <hr/> <div role="contentinfo"> <p> © Copyright 2018, Red Hat, Inc. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', VERSION:'28.14.21', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> <script type="text/javascript" src="../../../_static/underscore.js"></script> <script type="text/javascript" src="../../../_static/doctools.js"></script> <script type="text/javascript" src="../../../_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>