Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
ayon-core/1.7.0/autoapi/server/index.html

284 lines
No EOL
37 KiB
HTML
Raw Permalink Blame History

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link rel=prev href=../client/ayon_core/version.html><link rel=next href=settings/index.html><link rel=icon href=../../img/favicon.ico><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.1"><title>server - ayon-core</title><link rel=stylesheet href=../../assets/stylesheets/main.484c7ddc.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><script src=https://unpkg.com/iframe-worker/shim></script><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../assets/_mkdocstrings.css><link rel=stylesheet href=../../css/custom.css><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#server class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../index.html title=ayon-core class="md-header__button md-logo" aria-label=ayon-core data-md-component=logo> <img src=../../img/ay-symbol-blackw-full.png alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> ayon-core </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> server </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/ynput/ayon-core title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg> </div> <div class=md-source__repository> GitHub </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../../index.html title=ayon-core class="md-nav__button md-logo" aria-label=ayon-core data-md-component=logo> <img src=../../img/ay-symbol-blackw-full.png alt=logo> </a> ayon-core </label> <div class=md-nav__source> <a href=https://github.com/ynput/ayon-core title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg> </div> <div class=md-source__repository> GitHub </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../index.html class=md-nav__link> <span class=md-ellipsis> Home </span> </a> </li> <li class=md-nav__item> <a href=../../license.html class=md-nav__link> <span class=md-ellipsis> License </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3 checked> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=true> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=../client/ayon_core/__main__.html class=md-nav__link> <span class=md-ellipsis> client </span> <span class="md-nav__icon md-icon"></span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_2 checked> <label class=md-nav__link for=__nav_3_2 id=__nav_3_2_label tabindex=0> <span class=md-ellipsis> server </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_2_label aria-expanded=true> <label class=md-nav__title for=__nav_3_2> <span class="md-nav__icon md-icon"></span> server </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--pruned md-nav__item--nested"> <a href=settings/conversion.html class=md-nav__link> <span class=md-ellipsis> settings </span> <span class="md-nav__icon md-icon"></span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#server class=md-nav__link> <span class=md-ellipsis> server </span> </a> </li> <li class=md-nav__item> <a href=#server.CoreAddon class=md-nav__link> <span class=md-ellipsis> CoreAddon </span> </a> <nav class=md-nav aria-label=CoreAddon> <ul class=md-nav__list> <li class=md-nav__item> <a href=#server.CoreAddon.execute_action class=md-nav__link> <span class=md-ellipsis> execute_action </span> </a> </li> <li class=md-nav__item> <a href=#server.CoreAddon.get_simple_actions class=md-nav__link> <span class=md-ellipsis> get_simple_actions </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <nav class=md-path aria-label=Navigation> <ol class=md-path__list> <li class=md-path__item> <a href=../../index.html class=md-path__link> <span class=md-ellipsis> Home </span> </a> </li> <li class=md-path__item> <a href=../client/ayon_core/__main__.html class=md-path__link> <span class=md-ellipsis> Reference </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <h1>server</h1> <div class="doc doc-object doc-module"> <a id=server></a> <div class="doc doc-contents first"> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h2 id=server.CoreAddon class="doc doc-heading"> <code>CoreAddon</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.addons.BaseServerAddon>BaseServerAddon</span></code></p> <details class=mkdocstrings-source> <summary>Source code in <code>server/__init__.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal> 21</span>
<span class=normal> 22</span>
<span class=normal> 23</span>
<span class=normal> 24</span>
<span class=normal> 25</span>
<span class=normal> 26</span>
<span class=normal> 27</span>
<span class=normal> 28</span>
<span class=normal> 29</span>
<span class=normal> 30</span>
<span class=normal> 31</span>
<span class=normal> 32</span>
<span class=normal> 33</span>
<span class=normal> 34</span>
<span class=normal> 35</span>
<span class=normal> 36</span>
<span class=normal> 37</span>
<span class=normal> 38</span>
<span class=normal> 39</span>
<span class=normal> 40</span>
<span class=normal> 41</span>
<span class=normal> 42</span>
<span class=normal> 43</span>
<span class=normal> 44</span>
<span class=normal> 45</span>
<span class=normal> 46</span>
<span class=normal> 47</span>
<span class=normal> 48</span>
<span class=normal> 49</span>
<span class=normal> 50</span>
<span class=normal> 51</span>
<span class=normal> 52</span>
<span class=normal> 53</span>
<span class=normal> 54</span>
<span class=normal> 55</span>
<span class=normal> 56</span>
<span class=normal> 57</span>
<span class=normal> 58</span>
<span class=normal> 59</span>
<span class=normal> 60</span>
<span class=normal> 61</span>
<span class=normal> 62</span>
<span class=normal> 63</span>
<span class=normal> 64</span>
<span class=normal> 65</span>
<span class=normal> 66</span>
<span class=normal> 67</span>
<span class=normal> 68</span>
<span class=normal> 69</span>
<span class=normal> 70</span>
<span class=normal> 71</span>
<span class=normal> 72</span>
<span class=normal> 73</span>
<span class=normal> 74</span>
<span class=normal> 75</span>
<span class=normal> 76</span>
<span class=normal> 77</span>
<span class=normal> 78</span>
<span class=normal> 79</span>
<span class=normal> 80</span>
<span class=normal> 81</span>
<span class=normal> 82</span>
<span class=normal> 83</span>
<span class=normal> 84</span>
<span class=normal> 85</span>
<span class=normal> 86</span>
<span class=normal> 87</span>
<span class=normal> 88</span>
<span class=normal> 89</span>
<span class=normal> 90</span>
<span class=normal> 91</span>
<span class=normal> 92</span>
<span class=normal> 93</span>
<span class=normal> 94</span>
<span class=normal> 95</span>
<span class=normal> 96</span>
<span class=normal> 97</span>
<span class=normal> 98</span>
<span class=normal> 99</span>
<span class=normal>100</span>
<span class=normal>101</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>CoreAddon</span><span class=p>(</span><span class=n>BaseServerAddon</span><span class=p>):</span>
<span class=n>settings_model</span> <span class=o>=</span> <span class=n>CoreSettings</span>
<span class=k>async</span> <span class=k>def</span><span class=w> </span><span class=nf>get_default_settings</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=n>settings_model_cls</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>get_settings_model</span><span class=p>()</span>
<span class=k>return</span> <span class=n>settings_model_cls</span><span class=p>(</span><span class=o>**</span><span class=n>DEFAULT_VALUES</span><span class=p>)</span>
<span class=k>async</span> <span class=k>def</span><span class=w> </span><span class=nf>convert_settings_overrides</span><span class=p>(</span>
<span class=bp>self</span><span class=p>,</span>
<span class=n>source_version</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span>
<span class=n>overrides</span><span class=p>:</span> <span class=nb>dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=n>Any</span><span class=p>],</span>
<span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=n>Any</span><span class=p>]:</span>
<span class=n>convert_settings_overrides</span><span class=p>(</span><span class=n>source_version</span><span class=p>,</span> <span class=n>overrides</span><span class=p>)</span>
<span class=c1># Use super conversion</span>
<span class=k>return</span> <span class=k>await</span> <span class=nb>super</span><span class=p>()</span><span class=o>.</span><span class=n>convert_settings_overrides</span><span class=p>(</span>
<span class=n>source_version</span><span class=p>,</span> <span class=n>overrides</span>
<span class=p>)</span>
<span class=k>async</span> <span class=k>def</span><span class=w> </span><span class=nf>get_simple_actions</span><span class=p>(</span>
<span class=bp>self</span><span class=p>,</span>
<span class=n>project_name</span><span class=p>:</span> <span class=nb>str</span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
<span class=n>variant</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=s2>&quot;production&quot;</span><span class=p>,</span>
<span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=n>SimpleActionManifest</span><span class=p>]:</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Return a list of simple actions provided by the addon&quot;&quot;&quot;</span>
<span class=n>output</span> <span class=o>=</span> <span class=p>[]</span>
<span class=k>if</span> <span class=n>project_name</span><span class=p>:</span>
<span class=c1># Add &#39;Create Project Folder Structure&#39; action to folders.</span>
<span class=n>output</span><span class=o>.</span><span class=n>append</span><span class=p>(</span>
<span class=n>SimpleActionManifest</span><span class=p>(</span>
<span class=n>identifier</span><span class=o>=</span><span class=s2>&quot;core.createprojectstructure&quot;</span><span class=p>,</span>
<span class=n>label</span><span class=o>=</span><span class=s2>&quot;Create Project Folder Structure&quot;</span><span class=p>,</span>
<span class=n>icon</span><span class=o>=</span><span class=p>{</span>
<span class=s2>&quot;type&quot;</span><span class=p>:</span> <span class=s2>&quot;material-symbols&quot;</span><span class=p>,</span>
<span class=s2>&quot;name&quot;</span><span class=p>:</span> <span class=s2>&quot;create_new_folder&quot;</span><span class=p>,</span>
<span class=p>},</span>
<span class=n>order</span><span class=o>=</span><span class=mi>100</span><span class=p>,</span>
<span class=n>entity_type</span><span class=o>=</span><span class=s2>&quot;project&quot;</span><span class=p>,</span>
<span class=n>entity_subtypes</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
<span class=n>allow_multiselection</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
<span class=p>)</span>
<span class=p>)</span>
<span class=k>return</span> <span class=n>output</span>
<span class=k>async</span> <span class=k>def</span><span class=w> </span><span class=nf>execute_action</span><span class=p>(</span>
<span class=bp>self</span><span class=p>,</span>
<span class=n>executor</span><span class=p>:</span> <span class=n>ActionExecutor</span><span class=p>,</span>
<span class=p>)</span> <span class=o>-&gt;</span> <span class=n>ExecuteResponseModel</span><span class=p>:</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Execute webactions.&quot;&quot;&quot;</span>
<span class=n>project_name</span> <span class=o>=</span> <span class=n>executor</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>project_name</span>
<span class=k>if</span> <span class=n>executor</span><span class=o>.</span><span class=n>identifier</span> <span class=o>==</span> <span class=s2>&quot;core.createprojectstructure&quot;</span><span class=p>:</span>
<span class=k>if</span> <span class=ow>not</span> <span class=n>project_name</span><span class=p>:</span>
<span class=n>logger</span><span class=o>.</span><span class=n>error</span><span class=p>(</span>
<span class=sa>f</span><span class=s2>&quot;Can&#39;t execute </span><span class=si>{</span><span class=n>executor</span><span class=o>.</span><span class=n>identifier</span><span class=si>}</span><span class=s2> because&quot;</span>
<span class=s2>&quot; of missing project name.&quot;</span>
<span class=p>)</span>
<span class=c1># Works since AYON server 1.8.3</span>
<span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>executor</span><span class=p>,</span> <span class=s2>&quot;get_simple_response&quot;</span><span class=p>):</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_simple_response</span><span class=p>(</span>
<span class=s2>&quot;Missing project name&quot;</span><span class=p>,</span> <span class=n>success</span><span class=o>=</span><span class=kc>False</span>
<span class=p>)</span>
<span class=k>return</span>
<span class=n>args</span> <span class=o>=</span> <span class=p>[</span>
<span class=s2>&quot;create-project-structure&quot;</span><span class=p>,</span> <span class=s2>&quot;--project&quot;</span><span class=p>,</span> <span class=n>project_name</span><span class=p>,</span>
<span class=p>]</span>
<span class=c1># Works since AYON server 1.8.3</span>
<span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>executor</span><span class=p>,</span> <span class=s2>&quot;get_launcher_response&quot;</span><span class=p>):</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_launcher_response</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_launcher_action_response</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=n>logger</span><span class=o>.</span><span class=n>debug</span><span class=p>(</span><span class=sa>f</span><span class=s2>&quot;Unknown action: </span><span class=si>{</span><span class=n>executor</span><span class=o>.</span><span class=n>identifier</span><span class=si>}</span><span class=s2>&quot;</span><span class=p>)</span>
<span class=c1># Works since AYON server 1.8.3</span>
<span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>executor</span><span class=p>,</span> <span class=s2>&quot;get_simple_response&quot;</span><span class=p>):</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_simple_response</span><span class=p>(</span>
<span class=s2>&quot;Unknown action&quot;</span><span class=p>,</span> <span class=n>success</span><span class=o>=</span><span class=kc>False</span>
<span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h3 id=server.CoreAddon.execute_action class="doc doc-heading"> <code class="highlight language-python"><span class=n>execute_action</span><span class=p>(</span><span class=n>executor</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-async"><code>async</code></small> </span> </h3> <div class="doc doc-contents "> <p>Execute webactions.</p> <details class=mkdocstrings-source> <summary>Source code in <code>server/__init__.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal> 66</span>
<span class=normal> 67</span>
<span class=normal> 68</span>
<span class=normal> 69</span>
<span class=normal> 70</span>
<span class=normal> 71</span>
<span class=normal> 72</span>
<span class=normal> 73</span>
<span class=normal> 74</span>
<span class=normal> 75</span>
<span class=normal> 76</span>
<span class=normal> 77</span>
<span class=normal> 78</span>
<span class=normal> 79</span>
<span class=normal> 80</span>
<span class=normal> 81</span>
<span class=normal> 82</span>
<span class=normal> 83</span>
<span class=normal> 84</span>
<span class=normal> 85</span>
<span class=normal> 86</span>
<span class=normal> 87</span>
<span class=normal> 88</span>
<span class=normal> 89</span>
<span class=normal> 90</span>
<span class=normal> 91</span>
<span class=normal> 92</span>
<span class=normal> 93</span>
<span class=normal> 94</span>
<span class=normal> 95</span>
<span class=normal> 96</span>
<span class=normal> 97</span>
<span class=normal> 98</span>
<span class=normal> 99</span>
<span class=normal>100</span>
<span class=normal>101</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>async</span> <span class=k>def</span><span class=w> </span><span class=nf>execute_action</span><span class=p>(</span>
<span class=bp>self</span><span class=p>,</span>
<span class=n>executor</span><span class=p>:</span> <span class=n>ActionExecutor</span><span class=p>,</span>
<span class=p>)</span> <span class=o>-&gt;</span> <span class=n>ExecuteResponseModel</span><span class=p>:</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Execute webactions.&quot;&quot;&quot;</span>
<span class=n>project_name</span> <span class=o>=</span> <span class=n>executor</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>project_name</span>
<span class=k>if</span> <span class=n>executor</span><span class=o>.</span><span class=n>identifier</span> <span class=o>==</span> <span class=s2>&quot;core.createprojectstructure&quot;</span><span class=p>:</span>
<span class=k>if</span> <span class=ow>not</span> <span class=n>project_name</span><span class=p>:</span>
<span class=n>logger</span><span class=o>.</span><span class=n>error</span><span class=p>(</span>
<span class=sa>f</span><span class=s2>&quot;Can&#39;t execute </span><span class=si>{</span><span class=n>executor</span><span class=o>.</span><span class=n>identifier</span><span class=si>}</span><span class=s2> because&quot;</span>
<span class=s2>&quot; of missing project name.&quot;</span>
<span class=p>)</span>
<span class=c1># Works since AYON server 1.8.3</span>
<span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>executor</span><span class=p>,</span> <span class=s2>&quot;get_simple_response&quot;</span><span class=p>):</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_simple_response</span><span class=p>(</span>
<span class=s2>&quot;Missing project name&quot;</span><span class=p>,</span> <span class=n>success</span><span class=o>=</span><span class=kc>False</span>
<span class=p>)</span>
<span class=k>return</span>
<span class=n>args</span> <span class=o>=</span> <span class=p>[</span>
<span class=s2>&quot;create-project-structure&quot;</span><span class=p>,</span> <span class=s2>&quot;--project&quot;</span><span class=p>,</span> <span class=n>project_name</span><span class=p>,</span>
<span class=p>]</span>
<span class=c1># Works since AYON server 1.8.3</span>
<span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>executor</span><span class=p>,</span> <span class=s2>&quot;get_launcher_response&quot;</span><span class=p>):</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_launcher_response</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_launcher_action_response</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=n>logger</span><span class=o>.</span><span class=n>debug</span><span class=p>(</span><span class=sa>f</span><span class=s2>&quot;Unknown action: </span><span class=si>{</span><span class=n>executor</span><span class=o>.</span><span class=n>identifier</span><span class=si>}</span><span class=s2>&quot;</span><span class=p>)</span>
<span class=c1># Works since AYON server 1.8.3</span>
<span class=k>if</span> <span class=nb>hasattr</span><span class=p>(</span><span class=n>executor</span><span class=p>,</span> <span class=s2>&quot;get_simple_response&quot;</span><span class=p>):</span>
<span class=k>return</span> <span class=k>await</span> <span class=n>executor</span><span class=o>.</span><span class=n>get_simple_response</span><span class=p>(</span>
<span class=s2>&quot;Unknown action&quot;</span><span class=p>,</span> <span class=n>success</span><span class=o>=</span><span class=kc>False</span>
<span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=server.CoreAddon.get_simple_actions class="doc doc-heading"> <code class="highlight language-python"><span class=n>get_simple_actions</span><span class=p>(</span><span class=n>project_name</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=n>variant</span><span class=o>=</span><span class=s1>&#39;production&#39;</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-async"><code>async</code></small> </span> </h3> <div class="doc doc-contents "> <p>Return a list of simple actions provided by the addon</p> <details class=mkdocstrings-source> <summary>Source code in <code>server/__init__.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>39</span>
<span class=normal>40</span>
<span class=normal>41</span>
<span class=normal>42</span>
<span class=normal>43</span>
<span class=normal>44</span>
<span class=normal>45</span>
<span class=normal>46</span>
<span class=normal>47</span>
<span class=normal>48</span>
<span class=normal>49</span>
<span class=normal>50</span>
<span class=normal>51</span>
<span class=normal>52</span>
<span class=normal>53</span>
<span class=normal>54</span>
<span class=normal>55</span>
<span class=normal>56</span>
<span class=normal>57</span>
<span class=normal>58</span>
<span class=normal>59</span>
<span class=normal>60</span>
<span class=normal>61</span>
<span class=normal>62</span>
<span class=normal>63</span>
<span class=normal>64</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>async</span> <span class=k>def</span><span class=w> </span><span class=nf>get_simple_actions</span><span class=p>(</span>
<span class=bp>self</span><span class=p>,</span>
<span class=n>project_name</span><span class=p>:</span> <span class=nb>str</span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
<span class=n>variant</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=s2>&quot;production&quot;</span><span class=p>,</span>
<span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=n>SimpleActionManifest</span><span class=p>]:</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Return a list of simple actions provided by the addon&quot;&quot;&quot;</span>
<span class=n>output</span> <span class=o>=</span> <span class=p>[]</span>
<span class=k>if</span> <span class=n>project_name</span><span class=p>:</span>
<span class=c1># Add &#39;Create Project Folder Structure&#39; action to folders.</span>
<span class=n>output</span><span class=o>.</span><span class=n>append</span><span class=p>(</span>
<span class=n>SimpleActionManifest</span><span class=p>(</span>
<span class=n>identifier</span><span class=o>=</span><span class=s2>&quot;core.createprojectstructure&quot;</span><span class=p>,</span>
<span class=n>label</span><span class=o>=</span><span class=s2>&quot;Create Project Folder Structure&quot;</span><span class=p>,</span>
<span class=n>icon</span><span class=o>=</span><span class=p>{</span>
<span class=s2>&quot;type&quot;</span><span class=p>:</span> <span class=s2>&quot;material-symbols&quot;</span><span class=p>,</span>
<span class=s2>&quot;name&quot;</span><span class=p>:</span> <span class=s2>&quot;create_new_folder&quot;</span><span class=p>,</span>
<span class=p>},</span>
<span class=n>order</span><span class=o>=</span><span class=mi>100</span><span class=p>,</span>
<span class=n>entity_type</span><span class=o>=</span><span class=s2>&quot;project&quot;</span><span class=p>,</span>
<span class=n>entity_subtypes</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
<span class=n>allow_multiselection</span><span class=o>=</span><span class=kc>False</span><span class=p>,</span>
<span class=p>)</span>
<span class=p>)</span>
<span class=k>return</span> <span class=n>output</span>
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> </div> </div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"annotate": null, "base": "../..", "features": ["navigation.sections", "navigation.path", "navigation.prune"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.79ae519e.min.js></script> </body> </html>
Reference in a new issue View git blame Copy permalink