2022-02-20 15:15:38 +01:00
<!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" >
2022-07-28 05:28:26 +02:00
< link rel = "stylesheet" href = "../../../../../static/styles.css?h=ae0cc228" >
2022-02-20 15:15:38 +01:00
< link rel = "stylesheet" href = "../../../../../static/pygments.css" >
< link rel = "shortcut icon" href = "../../../../../static/favicon.png?h=fa09bedd" >
< title > open | 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 > < a href = "../" > Artifact< / a >
< ul >
< li > < a href = "../artifact-name/" > artifact_name< / a >
< li > < a href = "../is-current/" > is_current< / a >
< li class = "active" > < a href = "./" > open()< / a >
< ul > < / ul >
< 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" >
2022-07-28 05:28:26 +02:00
< h1 > < i class = "glyphicon glyphicon-cog" > < / i > < code class = "obj" > open< / code >
< span class = "sig" > (< code > mode=' rb' ,< / code > < code > ensure_dir=None< / code > )< / span > < / h1 >
2022-02-20 15:15:38 +01:00
< ul class = page-meta >
< li > Method of < a href = "../" > Artifact< / a > < / li >
< / ul >
< p > This opens the artifact for reading or writing. The default behavior is that
if the artifact is opened for reading, the directory it's contained within
automatically is created. This can be disabled or enabled with the
< code > ensure_dir< / code > parameter.< / p >
< p > If the artifact is opened for writing, a copy will be created and only
committed when the entire build process goes through smoothly and the
changes are committed by the builder.< / p >
2022-05-03 00:53:59 +02:00
< 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 >
2022-02-20 15:15:38 +01:00
< 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 = "comment-box" >
< h2 > Comments< / h2 >
< div id = "disqus_thread" > < / div >
< script >
var disqus_config = function() { this.page.identifier = "/docs/api/build/artifact/open"; this.page.url = "https://www.getlektor.com/docs/api/build/artifact/open/"; };
(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/open/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 >
2022-02-23 01:34:48 +01:00
< script type = text/javascript src = "../../../../../static/app.js?h=bb1b933a" charset = "utf-8" > < / script >
2022-02-20 15:15:38 +01:00
< 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 >
