2019-12-19 22:07:51 +00:00
<!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" >
2020-04-28 17:42:12 +00:00
< title > pylorax.api.workspace — Lorax 28.14.42 documentation< / title >
2019-12-19 22:07:51 +00:00
< script type = "text/javascript" src = "../../../_static/js/modernizr.min.js" > < / script >
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../../" src = "../../../_static/documentation_options.js" > < / 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/language_data.js" > < / script >
< script type = "text/javascript" src = "../../../_static/js/theme.js" > < / script >
< 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" / >
< / 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" >
2020-04-28 17:42:12 +00:00
28.14.42
2019-12-19 22:07:51 +00:00
< / 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.workspace< / 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.workspace< / 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" > os< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.api.recipes< / span > < span class = "k" > import< / span > < span class = "n" > recipe_filename< / span > < span class = "p" > ,< / span > < span class = "n" > recipe_from_toml< / span > < span class = "p" > ,< / span > < span class = "n" > RecipeFileError< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.sysutils< / span > < span class = "k" > import< / span > < span class = "n" > joinpaths< / span >
< div class = "viewcode-block" id = "workspace_dir" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.workspace.workspace_dir" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > workspace_dir< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Create the workspace' s path from a Repository and branch< / span >
< span class = "sd" > :param repo: Open repository< / span >
< span class = "sd" > :type repo: Git.Repository< / span >
< span class = "sd" > :param branch: Branch name< / span >
< span class = "sd" > :type branch: str< / span >
< span class = "sd" > :returns: The path to the branch' s workspace directory< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > repo_path< / span > < span class = "o" > =< / span > < span class = "n" > repo< / span > < span class = "o" > .< / span > < span class = "n" > get_location< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > get_path< / span > < span class = "p" > ()< / span >
< span class = "k" > return< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > repo_path< / span > < span class = "p" > ,< / span > < span class = "s2" > " workspace" < / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "workspace_read" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.workspace.workspace_read" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > workspace_read< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > ,< / span > < span class = "n" > recipe_name< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Read a Recipe from the branch' s workspace< / span >
< span class = "sd" > :param repo: Open repository< / span >
< span class = "sd" > :type repo: Git.Repository< / span >
< span class = "sd" > :param branch: Branch name< / span >
< span class = "sd" > :type branch: str< / span >
< span class = "sd" > :param recipe_name: The name of the recipe< / span >
< span class = "sd" > :type recipe_name: str< / span >
< span class = "sd" > :returns: The workspace copy of the recipe, or None if it doesn' t exist< / span >
< span class = "sd" > :rtype: Recipe or None< / span >
< span class = "sd" > :raises: RecipeFileError< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > ws_dir< / span > < span class = "o" > =< / span > < span class = "n" > workspace_dir< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > isdir< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > ):< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > makedirs< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > )< / span >
< span class = "n" > filename< / span > < span class = "o" > =< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > ,< / span > < span class = "n" > recipe_filename< / span > < span class = "p" > (< / span > < span class = "n" > recipe_name< / span > < span class = "p" > ))< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "kc" > None< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > f< / span > < span class = "o" > =< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ,< / span > < span class = "s1" > ' rb' < / span > < span class = "p" > )< / span >
< span class = "n" > recipe< / span > < span class = "o" > =< / span > < span class = "n" > recipe_from_toml< / span > < span class = "p" > (< / span > < span class = "n" > f< / span > < span class = "o" > .< / span > < span class = "n" > read< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " UTF-8" < / span > < span class = "p" > ))< / span >
< span class = "k" > except< / span > < span class = "ne" > IOError< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "n" > RecipeFileError< / span >
< span class = "k" > return< / span > < span class = "n" > recipe< / span > < / div >
< div class = "viewcode-block" id = "workspace_write" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.workspace.workspace_write" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > workspace_write< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > ,< / span > < span class = "n" > recipe< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Write a recipe to the workspace< / span >
< span class = "sd" > :param repo: Open repository< / span >
< span class = "sd" > :type repo: Git.Repository< / span >
< span class = "sd" > :param branch: Branch name< / span >
< span class = "sd" > :type branch: str< / span >
< span class = "sd" > :param recipe: The recipe to write to the workspace< / span >
< span class = "sd" > :type recipe: Recipe< / span >
< span class = "sd" > :returns: None< / span >
< span class = "sd" > :raises: IO related errors< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > ws_dir< / span > < span class = "o" > =< / span > < span class = "n" > workspace_dir< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > isdir< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > ):< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > makedirs< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > )< / span >
< span class = "n" > filename< / span > < span class = "o" > =< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > ,< / span > < span class = "n" > recipe< / span > < span class = "o" > .< / span > < span class = "n" > filename< / span > < span class = "p" > )< / span >
< span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ,< / span > < span class = "s1" > ' wb' < / span > < span class = "p" > )< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "n" > recipe< / span > < span class = "o" > .< / span > < span class = "n" > toml< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > encode< / span > < span class = "p" > (< / span > < span class = "s2" > " UTF-8" < / span > < span class = "p" > ))< / span > < / div >
< div class = "viewcode-block" id = "workspace_delete" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.workspace.workspace_delete" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > workspace_delete< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > ,< / span > < span class = "n" > recipe_name< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Delete the recipe from the workspace< / span >
< span class = "sd" > :param repo: Open repository< / span >
< span class = "sd" > :type repo: Git.Repository< / span >
< span class = "sd" > :param branch: Branch name< / span >
< span class = "sd" > :type branch: str< / span >
< span class = "sd" > :param recipe_name: The name of the recipe< / span >
< span class = "sd" > :type recipe_name: str< / span >
< span class = "sd" > :returns: None< / span >
< span class = "sd" > :raises: IO related errors< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > ws_dir< / span > < span class = "o" > =< / span > < span class = "n" > workspace_dir< / span > < span class = "p" > (< / span > < span class = "n" > repo< / span > < span class = "p" > ,< / span > < span class = "n" > branch< / span > < span class = "p" > )< / span >
< span class = "n" > filename< / span > < span class = "o" > =< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > ws_dir< / span > < span class = "p" > ,< / span > < span class = "n" > recipe_filename< / span > < span class = "p" > (< / span > < span class = "n" > recipe_name< / span > < span class = "p" > ))< / span >
< span class = "k" > if< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ):< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > unlink< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > )< / span > < / div >
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2018-2019, 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" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
