Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-25 05:14:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
ayon-core/1.6.2/autoapi/server/settings/publish_plugins.html

448 lines
No EOL
58 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=main.html><link rel=next href=tools.html><link rel=icon href=../../../img/favicon.ico><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.6.21"><title>publish_plugins - ayon-core</title><link rel=stylesheet href=../../../assets/stylesheets/main.2a3383ac.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.06af60db.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.settings.publish_plugins 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> publish_plugins </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.0.1 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.0.1 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--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_2_1 checked> <label class=md-nav__link for=__nav_3_2_1 id=__nav_3_2_1_label tabindex=0> <span class=md-ellipsis> settings </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_3_2_1_label aria-expanded=true> <label class=md-nav__title for=__nav_3_2_1> <span class="md-nav__icon md-icon"></span> settings </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=conversion.html class=md-nav__link> <span class=md-ellipsis> conversion </span> </a> </li> <li class=md-nav__item> <a href=main.html class=md-nav__link> <span class=md-ellipsis> main </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> publish_plugins </span> <span class="md-nav__icon md-icon"></span> </label> <a href=publish_plugins.html class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> publish_plugins </span> </a> <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.settings.publish_plugins class=md-nav__link> <span class=md-ellipsis> publish_plugins </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.CollectUSDLayerContributionsProfileModel class=md-nav__link> <span class=md-ellipsis> CollectUSDLayerContributionsProfileModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractBurninDef class=md-nav__link> <span class=md-ellipsis> ExtractBurninDef </span> </a> <nav class=md-nav aria-label=ExtractBurninDef> <ul class=md-nav__list> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractBurninDef.validate_name class=md-nav__link> <span class=md-ellipsis> validate_name </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractReviewOutputDefModel class=md-nav__link> <span class=md-ellipsis> ExtractReviewOutputDefModel </span> </a> <nav class=md-nav aria-label=ExtractReviewOutputDefModel> <ul class=md-nav__list> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractReviewOutputDefModel.validate_name class=md-nav__link> <span class=md-ellipsis> validate_name </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.IntegrateProductGroupModel class=md-nav__link> <span class=md-ellipsis> IntegrateProductGroupModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.PreIntegrateThumbnailsModel class=md-nav__link> <span class=md-ellipsis> PreIntegrateThumbnailsModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ValidateIntentModel class=md-nav__link> <span class=md-ellipsis> ValidateIntentModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ensure_unique_resolution_option class=md-nav__link> <span class=md-ellipsis> ensure_unique_resolution_option </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=tools.html class=md-nav__link> <span class=md-ellipsis> tools </span> </a> </li> </ul> </nav> </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.settings.publish_plugins class=md-nav__link> <span class=md-ellipsis> publish_plugins </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.CollectUSDLayerContributionsProfileModel class=md-nav__link> <span class=md-ellipsis> CollectUSDLayerContributionsProfileModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractBurninDef class=md-nav__link> <span class=md-ellipsis> ExtractBurninDef </span> </a> <nav class=md-nav aria-label=ExtractBurninDef> <ul class=md-nav__list> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractBurninDef.validate_name class=md-nav__link> <span class=md-ellipsis> validate_name </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractReviewOutputDefModel class=md-nav__link> <span class=md-ellipsis> ExtractReviewOutputDefModel </span> </a> <nav class=md-nav aria-label=ExtractReviewOutputDefModel> <ul class=md-nav__list> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ExtractReviewOutputDefModel.validate_name class=md-nav__link> <span class=md-ellipsis> validate_name </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.IntegrateProductGroupModel class=md-nav__link> <span class=md-ellipsis> IntegrateProductGroupModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.PreIntegrateThumbnailsModel class=md-nav__link> <span class=md-ellipsis> PreIntegrateThumbnailsModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ValidateIntentModel class=md-nav__link> <span class=md-ellipsis> ValidateIntentModel </span> </a> </li> <li class=md-nav__item> <a href=#server.settings.publish_plugins.ensure_unique_resolution_option class=md-nav__link> <span class=md-ellipsis> ensure_unique_resolution_option </span> </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <h1>publish_plugins</h1> <div class="doc doc-object doc-module"> <a id=server.settings.publish_plugins></a> <div class="doc doc-contents first"> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h2 id=server.settings.publish_plugins.CollectUSDLayerContributionsProfileModel class="doc doc-heading"> <code>CollectUSDLayerContributionsProfileModel</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.settings.BaseSettingsModel>BaseSettingsModel</span></code></p> <p>Profiles to define instance attribute defaults for USD contribution.</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></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>
<span class=normal>102</span>
<span class=normal>103</span>
<span class=normal>104</span>
<span class=normal>105</span>
<span class=normal>106</span>
<span class=normal>107</span>
<span class=normal>108</span>
<span class=normal>109</span>
<span class=normal>110</span>
<span class=normal>111</span>
<span class=normal>112</span>
<span class=normal>113</span>
<span class=normal>114</span>
<span class=normal>115</span>
<span class=normal>116</span>
<span class=normal>117</span>
<span class=normal>118</span>
<span class=normal>119</span>
<span class=normal>120</span>
<span class=normal>121</span>
<span class=normal>122</span>
<span class=normal>123</span>
<span class=normal>124</span>
<span class=normal>125</span>
<span class=normal>126</span>
<span class=normal>127</span>
<span class=normal>128</span>
<span class=normal>129</span>
<span class=normal>130</span>
<span class=normal>131</span>
<span class=normal>132</span>
<span class=normal>133</span>
<span class=normal>134</span>
<span class=normal>135</span>
<span class=normal>136</span>
<span class=normal>137</span>
<span class=normal>138</span>
<span class=normal>139</span>
<span class=normal>140</span>
<span class=normal>141</span>
<span class=normal>142</span>
<span class=normal>143</span>
<span class=normal>144</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>CollectUSDLayerContributionsProfileModel</span><span class=p>(</span><span class=n>BaseSettingsModel</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Profiles to define instance attribute defaults for USD contribution.&quot;&quot;&quot;</span>
<span class=n>_layout</span> <span class=o>=</span> <span class=s2>&quot;expanded&quot;</span>
<span class=n>product_types</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Product types&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;The product types to match this profile to. When matched, the&quot;</span>
<span class=s2>&quot; settings below would apply to the instance as default&quot;</span>
<span class=s2>&quot; attributes.&quot;</span>
<span class=p>),</span>
<span class=n>section</span><span class=o>=</span><span class=s2>&quot;Filter&quot;</span>
<span class=p>)</span>
<span class=n>task_types</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Task Types&quot;</span><span class=p>,</span>
<span class=n>enum_resolver</span><span class=o>=</span><span class=n>task_types_enum</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;The current create context task type to filter against. This&quot;</span>
<span class=s2>&quot; allows to filter the profile to only be valid if currently &quot;</span>
<span class=s2>&quot; creating from within that task type.&quot;</span>
<span class=p>),</span>
<span class=p>)</span>
<span class=n>contribution_enabled</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=kc>True</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Contribution Enabled (default)&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;The default state for USD Contribution being marked enabled or&quot;</span>
<span class=s2>&quot; disabled for this profile.&quot;</span>
<span class=p>),</span>
<span class=n>section</span><span class=o>=</span><span class=s2>&quot;Instance attribute defaults&quot;</span><span class=p>,</span>
<span class=p>)</span>
<span class=n>contribution_layer</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=s2>&quot;&quot;</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Contribution Department Layer&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;The default contribution layer to apply the contribution to when&quot;</span>
<span class=s2>&quot; matching this profile. The layer name should be in the&quot;</span>
<span class=s2>&quot; &#39;Department Layer Orders&#39; list to get a sensible order.&quot;</span>
<span class=p>),</span>
<span class=p>)</span>
<span class=n>contribution_apply_as_variant</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=kc>True</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Apply as variant&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;The default &#39;Apply as variant&#39; state for instances matching this&quot;</span>
<span class=s2>&quot; profile. Usually enabled for asset contributions and disabled&quot;</span>
<span class=s2>&quot; for shot contributions.&quot;</span>
<span class=p>),</span>
<span class=p>)</span>
<span class=n>contribution_target_product</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=s2>&quot;usdAsset&quot;</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Target Product&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;The default destination product name to apply the contribution to&quot;</span>
<span class=s2>&quot; when matching this profile.&quot;</span>
<span class=s2>&quot; Usually e.g. &#39;usdAsset&#39; or &#39;usdShot&#39;.&quot;</span>
<span class=p>),</span>
<span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=server.settings.publish_plugins.ExtractBurninDef class="doc doc-heading"> <code>ExtractBurninDef</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.settings.BaseSettingsModel>BaseSettingsModel</span></code></p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>806</span>
<span class=normal>807</span>
<span class=normal>808</span>
<span class=normal>809</span>
<span class=normal>810</span>
<span class=normal>811</span>
<span class=normal>812</span>
<span class=normal>813</span>
<span class=normal>814</span>
<span class=normal>815</span>
<span class=normal>816</span>
<span class=normal>817</span>
<span class=normal>818</span>
<span class=normal>819</span>
<span class=normal>820</span>
<span class=normal>821</span>
<span class=normal>822</span>
<span class=normal>823</span>
<span class=normal>824</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>ExtractBurninDef</span><span class=p>(</span><span class=n>BaseSettingsModel</span><span class=p>):</span>
<span class=n>_isGroup</span> <span class=o>=</span> <span class=kc>True</span>
<span class=n>_layout</span> <span class=o>=</span> <span class=s2>&quot;expanded&quot;</span>
<span class=n>name</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>)</span>
<span class=n>TOP_LEFT</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Top Left&quot;</span><span class=p>)</span>
<span class=n>TOP_CENTERED</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Top Centered&quot;</span><span class=p>)</span>
<span class=n>TOP_RIGHT</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Top Right&quot;</span><span class=p>)</span>
<span class=n>BOTTOM_LEFT</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Bottom Left&quot;</span><span class=p>)</span>
<span class=n>BOTTOM_CENTERED</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Bottom Centered&quot;</span><span class=p>)</span>
<span class=n>BOTTOM_RIGHT</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Bottom Right&quot;</span><span class=p>)</span>
<span class=nb>filter</span><span class=p>:</span> <span class=n>ExtractBurninDefFilter</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=n>ExtractBurninDefFilter</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Additional filtering&quot;</span>
<span class=p>)</span>
<span class=nd>@validator</span><span class=p>(</span><span class=s2>&quot;name&quot;</span><span class=p>)</span>
<span class=k>def</span><span class=w> </span><span class=nf>validate_name</span><span class=p>(</span><span class=bp>cls</span><span class=p>,</span> <span class=n>value</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Ensure name does not contain weird characters&quot;&quot;&quot;</span>
<span class=k>return</span> <span class=n>normalize_name</span><span class=p>(</span><span class=n>value</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.settings.publish_plugins.ExtractBurninDef.validate_name class="doc doc-heading"> <code class="highlight language-python"><span class=n>validate_name</span><span class=p>(</span><span class=n>value</span><span class=p>)</span></code> </h3> <div class="doc doc-contents "> <p>Ensure name does not contain weird characters</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>821</span>
<span class=normal>822</span>
<span class=normal>823</span>
<span class=normal>824</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@validator</span><span class=p>(</span><span class=s2>&quot;name&quot;</span><span class=p>)</span>
<span class=k>def</span><span class=w> </span><span class=nf>validate_name</span><span class=p>(</span><span class=bp>cls</span><span class=p>,</span> <span class=n>value</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Ensure name does not contain weird characters&quot;&quot;&quot;</span>
<span class=k>return</span> <span class=n>normalize_name</span><span class=p>(</span><span class=n>value</span><span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=server.settings.publish_plugins.ExtractReviewOutputDefModel class="doc doc-heading"> <code>ExtractReviewOutputDefModel</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.settings.BaseSettingsModel>BaseSettingsModel</span></code></p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>652</span>
<span class=normal>653</span>
<span class=normal>654</span>
<span class=normal>655</span>
<span class=normal>656</span>
<span class=normal>657</span>
<span class=normal>658</span>
<span class=normal>659</span>
<span class=normal>660</span>
<span class=normal>661</span>
<span class=normal>662</span>
<span class=normal>663</span>
<span class=normal>664</span>
<span class=normal>665</span>
<span class=normal>666</span>
<span class=normal>667</span>
<span class=normal>668</span>
<span class=normal>669</span>
<span class=normal>670</span>
<span class=normal>671</span>
<span class=normal>672</span>
<span class=normal>673</span>
<span class=normal>674</span>
<span class=normal>675</span>
<span class=normal>676</span>
<span class=normal>677</span>
<span class=normal>678</span>
<span class=normal>679</span>
<span class=normal>680</span>
<span class=normal>681</span>
<span class=normal>682</span>
<span class=normal>683</span>
<span class=normal>684</span>
<span class=normal>685</span>
<span class=normal>686</span>
<span class=normal>687</span>
<span class=normal>688</span>
<span class=normal>689</span>
<span class=normal>690</span>
<span class=normal>691</span>
<span class=normal>692</span>
<span class=normal>693</span>
<span class=normal>694</span>
<span class=normal>695</span>
<span class=normal>696</span>
<span class=normal>697</span>
<span class=normal>698</span>
<span class=normal>699</span>
<span class=normal>700</span>
<span class=normal>701</span>
<span class=normal>702</span>
<span class=normal>703</span>
<span class=normal>704</span>
<span class=normal>705</span>
<span class=normal>706</span>
<span class=normal>707</span>
<span class=normal>708</span>
<span class=normal>709</span>
<span class=normal>710</span>
<span class=normal>711</span>
<span class=normal>712</span>
<span class=normal>713</span>
<span class=normal>714</span>
<span class=normal>715</span>
<span class=normal>716</span>
<span class=normal>717</span>
<span class=normal>718</span>
<span class=normal>719</span>
<span class=normal>720</span>
<span class=normal>721</span>
<span class=normal>722</span>
<span class=normal>723</span>
<span class=normal>724</span>
<span class=normal>725</span>
<span class=normal>726</span>
<span class=normal>727</span>
<span class=normal>728</span>
<span class=normal>729</span>
<span class=normal>730</span>
<span class=normal>731</span>
<span class=normal>732</span>
<span class=normal>733</span>
<span class=normal>734</span>
<span class=normal>735</span>
<span class=normal>736</span>
<span class=normal>737</span>
<span class=normal>738</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>ExtractReviewOutputDefModel</span><span class=p>(</span><span class=n>BaseSettingsModel</span><span class=p>):</span>
<span class=n>_layout</span> <span class=o>=</span> <span class=s2>&quot;expanded&quot;</span>
<span class=n>name</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Name&quot;</span><span class=p>)</span>
<span class=n>ext</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=s2>&quot;&quot;</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Output extension&quot;</span><span class=p>)</span>
<span class=c1># TODO use some different source of tags</span>
<span class=n>tags</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Tags&quot;</span><span class=p>)</span>
<span class=n>burnins</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>,</span> <span class=n>title</span><span class=o>=</span><span class=s2>&quot;Link to a burnin by name&quot;</span>
<span class=p>)</span>
<span class=n>ffmpeg_args</span><span class=p>:</span> <span class=n>ExtractReviewFFmpegModel</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=n>ExtractReviewFFmpegModel</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;FFmpeg arguments&quot;</span>
<span class=p>)</span>
<span class=nb>filter</span><span class=p>:</span> <span class=n>ExtractReviewFilterModel</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=n>ExtractReviewFilterModel</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Additional output filtering&quot;</span>
<span class=p>)</span>
<span class=n>overscan_crop</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=s2>&quot;&quot;</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Overscan crop&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;Crop input overscan. See the documentation for more information.&quot;</span>
<span class=p>)</span>
<span class=p>)</span>
<span class=n>overscan_color</span><span class=p>:</span> <span class=n>ColorRGBA_uint8</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=p>(</span><span class=mi>0</span><span class=p>,</span> <span class=mi>0</span><span class=p>,</span> <span class=mi>0</span><span class=p>,</span> <span class=mf>0.0</span><span class=p>),</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Overscan color&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;Overscan color is used when input aspect ratio is not&quot;</span>
<span class=s2>&quot; same as output aspect ratio.&quot;</span>
<span class=p>)</span>
<span class=p>)</span>
<span class=c1># overscan_color: ColorRGB_uint8 = SettingsField(</span>
<span class=c1># (0, 0, 0),</span>
<span class=c1># title=&quot;Overscan color&quot;,</span>
<span class=c1># description=(</span>
<span class=c1># &quot;Overscan color is used when input aspect ratio is not&quot;</span>
<span class=c1># &quot; same as output aspect ratio.&quot;</span>
<span class=c1># )</span>
<span class=c1># )</span>
<span class=n>width</span><span class=p>:</span> <span class=nb>int</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=mi>0</span><span class=p>,</span>
<span class=n>ge</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
<span class=n>le</span><span class=o>=</span><span class=mi>100000</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Output width&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;Width and Height must be both set to higher&quot;</span>
<span class=s2>&quot; value than 0 else source resolution is used.&quot;</span>
<span class=p>)</span>
<span class=p>)</span>
<span class=n>height</span><span class=p>:</span> <span class=nb>int</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=mi>0</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Output height&quot;</span><span class=p>,</span>
<span class=n>ge</span><span class=o>=</span><span class=mi>0</span><span class=p>,</span>
<span class=n>le</span><span class=o>=</span><span class=mi>100000</span><span class=p>,</span>
<span class=p>)</span>
<span class=n>scale_pixel_aspect</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=kc>True</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Scale pixel aspect&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;Rescale input when it&#39;s pixel aspect ratio is not 1.&quot;</span>
<span class=s2>&quot; Useful for anamorphic reviews.&quot;</span>
<span class=p>)</span>
<span class=p>)</span>
<span class=n>bg_color</span><span class=p>:</span> <span class=n>ColorRGBA_uint8</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=p>(</span><span class=mi>0</span><span class=p>,</span> <span class=mi>0</span><span class=p>,</span> <span class=mi>0</span><span class=p>,</span> <span class=mf>0.0</span><span class=p>),</span>
<span class=n>description</span><span class=o>=</span><span class=p>(</span>
<span class=s2>&quot;Background color is used only when input have transparency&quot;</span>
<span class=s2>&quot; and Alpha is higher than 0.&quot;</span>
<span class=p>),</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Background color&quot;</span><span class=p>,</span>
<span class=p>)</span>
<span class=n>letter_box</span><span class=p>:</span> <span class=n>ExtractReviewLetterBox</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=n>ExtractReviewLetterBox</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Letter Box&quot;</span>
<span class=p>)</span>
<span class=n>fill_missing_frames</span><span class=p>:</span> <span class=nb>str</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Handle missing frames&quot;</span><span class=p>,</span>
<span class=n>default</span><span class=o>=</span><span class=s2>&quot;closest_existing&quot;</span><span class=p>,</span>
<span class=n>description</span><span class=o>=</span><span class=s2>&quot;How to handle gaps in sequence frame ranges.&quot;</span><span class=p>,</span>
<span class=n>enum_resolver</span><span class=o>=</span><span class=n>_handle_missing_frames_enum</span>
<span class=p>)</span>
<span class=nd>@validator</span><span class=p>(</span><span class=s2>&quot;name&quot;</span><span class=p>)</span>
<span class=k>def</span><span class=w> </span><span class=nf>validate_name</span><span class=p>(</span><span class=bp>cls</span><span class=p>,</span> <span class=n>value</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Ensure name does not contain weird characters&quot;&quot;&quot;</span>
<span class=k>return</span> <span class=n>normalize_name</span><span class=p>(</span><span class=n>value</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.settings.publish_plugins.ExtractReviewOutputDefModel.validate_name class="doc doc-heading"> <code class="highlight language-python"><span class=n>validate_name</span><span class=p>(</span><span class=n>value</span><span class=p>)</span></code> </h3> <div class="doc doc-contents "> <p>Ensure name does not contain weird characters</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>735</span>
<span class=normal>736</span>
<span class=normal>737</span>
<span class=normal>738</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@validator</span><span class=p>(</span><span class=s2>&quot;name&quot;</span><span class=p>)</span>
<span class=k>def</span><span class=w> </span><span class=nf>validate_name</span><span class=p>(</span><span class=bp>cls</span><span class=p>,</span> <span class=n>value</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Ensure name does not contain weird characters&quot;&quot;&quot;</span>
<span class=k>return</span> <span class=n>normalize_name</span><span class=p>(</span><span class=n>value</span><span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=server.settings.publish_plugins.IntegrateProductGroupModel class="doc doc-heading"> <code>IntegrateProductGroupModel</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.settings.BaseSettingsModel>BaseSettingsModel</span></code></p> <p>Group published products by filtering logic.</p> <p>Set all published instances as a part of specific group named according to 'Template'.</p> <p>Implemented all variants of placeholders '{task}', '{product[type]}', '{host}', '{product[name]}', '{renderlayer}'.</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>928</span>
<span class=normal>929</span>
<span class=normal>930</span>
<span class=normal>931</span>
<span class=normal>932</span>
<span class=normal>933</span>
<span class=normal>934</span>
<span class=normal>935</span>
<span class=normal>936</span>
<span class=normal>937</span>
<span class=normal>938</span>
<span class=normal>939</span>
<span class=normal>940</span>
<span class=normal>941</span>
<span class=normal>942</span>
<span class=normal>943</span>
<span class=normal>944</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>IntegrateProductGroupModel</span><span class=p>(</span><span class=n>BaseSettingsModel</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Group published products by filtering logic.</span>
<span class=sd> Set all published instances as a part of specific group named according</span>
<span class=sd> to &#39;Template&#39;.</span>
<span class=sd> Implemented all variants of placeholders &#39;{task}&#39;, &#39;{product[type]}&#39;,</span>
<span class=sd> &#39;{host}&#39;, &#39;{product[name]}&#39;, &#39;{renderlayer}&#39;.</span>
<span class=sd> &quot;&quot;&quot;</span>
<span class=n>_isGroup</span> <span class=o>=</span> <span class=kc>True</span>
<span class=n>product_grouping_profiles</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=n>IntegrateProductGroupProfile</span><span class=p>]</span> <span class=o>=</span> <span class=p>(</span>
<span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Product group profiles&quot;</span>
<span class=p>)</span>
<span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=server.settings.publish_plugins.PreIntegrateThumbnailsModel class="doc doc-heading"> <code>PreIntegrateThumbnailsModel</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.settings.BaseSettingsModel>BaseSettingsModel</span></code></p> <p>Explicitly set if Thumbnail representation should be integrated.</p> <p>If no matching profile set, existing state from Host implementation is kept.</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>898</span>
<span class=normal>899</span>
<span class=normal>900</span>
<span class=normal>901</span>
<span class=normal>902</span>
<span class=normal>903</span>
<span class=normal>904</span>
<span class=normal>905</span>
<span class=normal>906</span>
<span class=normal>907</span>
<span class=normal>908</span>
<span class=normal>909</span>
<span class=normal>910</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>PreIntegrateThumbnailsModel</span><span class=p>(</span><span class=n>BaseSettingsModel</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Explicitly set if Thumbnail representation should be integrated.</span>
<span class=sd> If no matching profile set, existing state from Host implementation</span>
<span class=sd> is kept.</span>
<span class=sd> &quot;&quot;&quot;</span>
<span class=n>_isGroup</span> <span class=o>=</span> <span class=kc>True</span>
<span class=n>enabled</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=kc>True</span><span class=p>)</span>
<span class=n>integrate_profiles</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=n>PreIntegrateThumbnailsProfile</span><span class=p>]</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span>
<span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>,</span>
<span class=n>title</span><span class=o>=</span><span class=s2>&quot;Integrate profiles&quot;</span>
<span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=server.settings.publish_plugins.ValidateIntentModel class="doc doc-heading"> <code>ValidateIntentModel</code> </h2> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><span title=ayon_server.settings.BaseSettingsModel>BaseSettingsModel</span></code></p> <p>Validate if Publishing intent was selected.</p> <p>It is possible to disable validation for specific publishing context with profiles.</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>289</span>
<span class=normal>290</span>
<span class=normal>291</span>
<span class=normal>292</span>
<span class=normal>293</span>
<span class=normal>294</span>
<span class=normal>295</span>
<span class=normal>296</span>
<span class=normal>297</span>
<span class=normal>298</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>ValidateIntentModel</span><span class=p>(</span><span class=n>BaseSettingsModel</span><span class=p>):</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Validate if Publishing intent was selected.</span>
<span class=sd> It is possible to disable validation for specific publishing context</span>
<span class=sd> with profiles.</span>
<span class=sd> &quot;&quot;&quot;</span>
<span class=n>_isGroup</span> <span class=o>=</span> <span class=kc>True</span>
<span class=n>enabled</span><span class=p>:</span> <span class=nb>bool</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=kc>False</span><span class=p>)</span>
<span class=n>profiles</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=n>ValidateIntentProfile</span><span class=p>]</span> <span class=o>=</span> <span class=n>SettingsField</span><span class=p>(</span><span class=n>default_factory</span><span class=o>=</span><span class=nb>list</span><span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-function"> <h2 id=server.settings.publish_plugins.ensure_unique_resolution_option class="doc doc-heading"> <code class="highlight language-python"><span class=n>ensure_unique_resolution_option</span><span class=p>(</span><span class=n>objects</span><span class=p>,</span> <span class=n>field_name</span><span class=o>=</span><span class=kc>None</span><span class=p>)</span></code> </h2> <div class="doc doc-contents "> <p>Ensure a list of objects have unique option attributes.</p> <p>This function checks if the list of objects has unique 'width', 'height' and 'pixel_aspect' properties.</p> <details class=quote> <summary>Source code in <code>server/settings/publish_plugins.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>202</span>
<span class=normal>203</span>
<span class=normal>204</span>
<span class=normal>205</span>
<span class=normal>206</span>
<span class=normal>207</span>
<span class=normal>208</span>
<span class=normal>209</span>
<span class=normal>210</span>
<span class=normal>211</span>
<span class=normal>212</span>
<span class=normal>213</span>
<span class=normal>214</span>
<span class=normal>215</span>
<span class=normal>216</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>def</span><span class=w> </span><span class=nf>ensure_unique_resolution_option</span><span class=p>(</span>
<span class=n>objects</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=n>Any</span><span class=p>],</span> <span class=n>field_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=o>-&gt;</span> <span class=kc>None</span><span class=p>:</span> <span class=c1># noqa: C901</span>
<span class=w> </span><span class=sd>&quot;&quot;&quot;Ensure a list of objects have unique option attributes.</span>
<span class=sd> This function checks if the list of objects has unique &#39;width&#39;,</span>
<span class=sd> &#39;height&#39; and &#39;pixel_aspect&#39; properties.</span>
<span class=sd> &quot;&quot;&quot;</span>
<span class=n>options</span> <span class=o>=</span> <span class=nb>set</span><span class=p>()</span>
<span class=k>for</span> <span class=n>obj</span> <span class=ow>in</span> <span class=n>objects</span><span class=p>:</span>
<span class=n>item_test_text</span> <span class=o>=</span> <span class=sa>f</span><span class=s2>&quot;</span><span class=si>{</span><span class=n>obj</span><span class=o>.</span><span class=n>width</span><span class=si>}</span><span class=s2>x</span><span class=si>{</span><span class=n>obj</span><span class=o>.</span><span class=n>height</span><span class=si>}</span><span class=s2>x</span><span class=si>{</span><span class=n>obj</span><span class=o>.</span><span class=n>pixel_aspect</span><span class=si>}</span><span class=s2>&quot;</span>
<span class=k>if</span> <span class=n>item_test_text</span> <span class=ow>in</span> <span class=n>options</span><span class=p>:</span>
<span class=k>raise</span> <span class=n>BadRequestException</span><span class=p>(</span>
<span class=sa>f</span><span class=s2>&quot;Duplicate option &#39;</span><span class=si>{</span><span class=n>item_test_text</span><span class=si>}</span><span class=s2>&#39;&quot;</span><span class=p>)</span>
<span class=n>options</span><span class=o>.</span><span class=n>add</span><span class=p>(</span><span class=n>item_test_text</span><span class=p>)</span>
</code></pre></div></td></tr></table></div> </details> </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>{"base": "../../..", "features": ["navigation.sections", "navigation.path", "navigation.prune"], "search": "../../../assets/javascripts/workers/search.973d3a69.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.f55a23d4.min.js></script> </body> </html>
Reference in a new issue View git blame Copy permalink