<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <link rel="stylesheet" href="../../../../static/styles.css?h=dff0aaad"> <link rel="stylesheet" href="../../../../static/pygments.css"> <link rel="shortcut icon" href="../../../../static/favicon.png?h=fa09bedd"> <title>Artifact | Documentation | Lektor Static Content Management System</title> </head> <body class="default"> <nav class="navbar navbar-inverse navbar-static-top"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="../../../../">Lektor</a> </div> <div id="navbar" class="collapse navbar-collapse"> <ul class="nav navbar-nav"> <li><a href="../../../../downloads/">Download</a></li> <li class="active"><a href="../../../">Documentation</a></li> <li><a href="../../../../showcase/">Showcase</a></li> <li><a href="../../../../plugins/">Plugins</a></li> <li><a href="../../../../community/">Community</a></li> <li><a href="../../../../blog/">Blog</a></li> </ul> </div> </div> </nav> <div class="body-wrapper"> <div class="container"> <div class="row"> <div class="col-sm-3"> <ul class="tree-nav nocontent"> <li><a href="../../../">Welcome</a></li> <li><a href="../../../what/">What is Lektor</a> <li><a href="../../../installation/">Installation</a> <li><a href="../../../quickstart/">Quickstart</a> <li><a href="../../../project/">Project</a> <li><a href="../../../content/">Content</a> <li><a href="../../../templates/">Templates</a> <li><a href="../../../themes/">Themes</a> <li><a href="../../../guides/">Guides</a> <li><a href="../../../deployment/">Deployment</a> <li><a href="../../../plugins/">Plugins</a> <li><a href="../../../models/">Data Modelling</a> <li><a href="../../../cli/">Command Line</a> <li><a href="../../">API</a> <ul> <li><a href="../">Build System</a> <ul> <li class="active"><a href="./">Artifact</a> <ul> <li><a href="artifact-name/">artifact_name</a> <li><a href="is-current/">is_current</a> <li><a href="open/">open()</a> <li><a href="render-template-into/">render_template_into()</a> <li><a href="replace-with-file/">replace_with_file()</a> <li><a href="source-obj/">source_obj</a> </ul> <li><a href="../program/">BuildProgram</a> <li><a href="../context/">Context</a> <li><a href="../get-ctx/">get_ctx()</a> </ul> <li><a href="../../databags/">Databags</a> <li><a href="../../db/">Database</a> <li><a href="../../environment/">Environment</a> <li><a href="../../plugins/">Plugins</a> <li><a href="../../project/">Project</a> <li><a href="../../publisher/">Publisher</a> <li><a href="../../templates/">Template API</a> <li><a href="../../utils/">Utilities</a> </ul> <li><a href="../../../search/">Search</a> </ul> <div class="visible-md-block visible-lg-block"> <h4>This Page</h4> <ul class="toc"> <li><a href="#example">Example</a></li> </ul> </div> </div> <div class="col-sm-9 doc-styling"> <h1><i class="glyphicon glyphicon-leaf"></i> <code class="mod">lektor.builder.</code><code class="obj">Artifact</code></h1> <ul class=page-meta> </ul> <p>During the build process Lektor creates artifact objects to represent final build artifacts. Generally each <a href="../../db/obj/" class="ref">Source Object</a> will generate one artifact for which it acts as a primary source.</p> <p>There are however many cases in which a source object will create sub-artifacts. For instance any thumbnail created in the context of a page will be creating its own artifact. To give plugins the same ability the artifact system is partially documented. See also <a href="../context/sub-artifact/" class="ref">sub_artifact</a> to see how to create your own artifact instances.</p> <p>The most important function of an artifact is <a href="open/" class="ref">open</a> which can open the artifact for reading or writing. If the build goes well, Lektor will commit those changes and persist them.</p> <h2 id="example">Example</h2><div class="hll"><pre><span></span><span class="n">ctx</span> <span class="o">=</span> <span class="n">get_ctx</span><span class="p">()</span> <span class="nd">@ctx</span><span class="o">.</span><span class="n">sub_artifact</span><span class="p">(</span><span class="s1">'artifact.txt'</span><span class="p">)</span> <span class="k">def</span> <span class="nf">build_stylesheet</span><span class="p">(</span><span class="n">artifact</span><span class="p">):</span> <span class="k">with</span> <span class="n">artifact</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'Hello World!</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> </pre></div> <div class="child-pages nocontent"> <div class="row"> <div class="col-md-6 child"> <h4> <i class="glyphicon glyphicon-info-sign"></i> <a href="artifact-name/">artifact_name</a> </h4> <p class="summary">The name of the artifact</p> </div> <div class="col-md-6 child"> <h4> <i class="glyphicon glyphicon-info-sign"></i> <a href="is-current/">is_current</a> </h4> <p class="summary">Indicates if the artifact is up to date or needs building.</p> </div> </div> <div class="row"> <div class="col-md-6 child"> <h4> <i class="glyphicon glyphicon-cog"></i> <a href="open/">open()</a> </h4> <p class="summary">Can open the artifact for reading or writing.</p> </div> <div class="col-md-6 child"> <h4> <i class="glyphicon glyphicon-cog"></i> <a href="render-template-into/">render_template_into()</a> </h4> <p class="summary">Renders a template into the artifact.</p> </div> </div> <div class="row"> <div class="col-md-6 child"> <h4> <i class="glyphicon glyphicon-cog"></i> <a href="replace-with-file/">replace_with_file()</a> </h4> <p class="summary">Replaces the artifact with a file from the file system.</p> </div> <div class="col-md-6 child"> <h4> <i class="glyphicon glyphicon-info-sign"></i> <a href="source-obj/">source_obj</a> </h4> <p class="summary">A reference to the source object if available.</p> </div> </div> </div> <div class="comment-box"> <h2>Comments</h2> <div id="disqus_thread"></div> <script> var disqus_config = function() { this.page.identifier = "/docs/api/build/artifact"; this.page.url = "https://www.getlektor.com/docs/api/build/artifact/"; }; (function() { var d = document, s = d.createElement('script'); s.src = '//lektordocumentation.disqus.com/embed.js'; s.setAttribute('data-timestamp', +new Date()); (d.head || d.body).appendChild(s); })(); </script> <noscript> Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a> </noscript> </div> </div> </div> </div> </div> <div class="bottomsummary"> <div class="container"> </div> </div> <footer> <div class="container"> <div class="row"> <div class="col-sm-4 icon-bar"> <a href="https://github.com/lektor/lektor/" title="Lektor on GitHub" ><i class="fa fa-github"></i></a> <a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor" ><i class="fa fa-bug"></i></a> <a href="https://twitter.com/getlektor" title="Find Lektor on Twitter" ><i class="fa fa-twitter"></i></a> <a href="https://gitter.im/lektor/lektor" title="Chat on Gitter" ><i class="fa fa-comment"></i></a> <a href="https://github.com/lektor/lektor-website/tree/master/content/docs/api/build/artifact/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a> </div> <div class="col-sm-8"> <a href="../../../../license/">License & Copyright</a> • <a href="../../../../contact/">Contact</a> • Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia </div> </div> </div> </footer> <script type=text/javascript src="../../../../static/app.js?h=8b801996" charset="utf-8"></script> <script> ((window.gitter = {}).chat = {}).options = { room: 'lektor/lektor', activationElement: null }; document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>'); var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack; if (dnt != "1" && dnt != "yes") { window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; ga('create', 'UA-70822533-1', 'auto'); ga('set', 'anonymizeIp', true); ga('send', 'pageview'); } else { console.debug("Respecting Do-Not-Track, not running analytics."); } </script> <script async src='https://www.google-analytics.com/analytics.js'></script> <script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script> </body> </html>