1+
2+
3+
4+ <!DOCTYPE html>
5+ < html class ="writer-html5 " lang ="en " >
6+ < head >
7+ < meta charset ="utf-8 ">
8+
9+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
10+
11+ < title > ayon_api.events — ayon-python-api 1.2.4 documentation</ title >
12+
13+
14+
15+ < link rel ="stylesheet " href ="../../_static/css/theme.css " type ="text/css " />
16+ < link rel ="stylesheet " href ="../../_static/pygments.css " type ="text/css " />
17+ < link rel ="stylesheet " href ="../../_static/pygments.css " type ="text/css " />
18+ < link rel ="stylesheet " href ="../../_static/css/theme.css " type ="text/css " />
19+
20+
21+
22+ < link rel ="shortcut icon " href ="../../_static/favicon.ico "/>
23+
24+
25+
26+ < link rel ="canonical " href ="https://github.com/ynput/ayon-python-api_modules/ayon_api/events.html "/>
27+
28+
29+
30+ <!--[if lt IE 9]>
31+ <script src="../../_static/js/html5shiv.min.js"></script>
32+ <![endif]-->
33+
34+
35+ < script type ="text/javascript " id ="documentation_options " data-url_root ="../../ " src ="../../_static/documentation_options.js "> </ script >
36+ < script data-url_root ="../../ " id ="documentation_options " src ="../../_static/documentation_options.js "> </ script >
37+ < script src ="../../_static/jquery.js "> </ script >
38+ < script src ="../../_static/underscore.js "> </ script >
39+ < script src ="../../_static/_sphinx_javascript_frameworks_compat.js "> </ script >
40+ < script src ="../../_static/doctools.js "> </ script >
41+ < script src ="../../_static/sphinx_highlight.js "> </ script >
42+
43+ < script type ="text/javascript " src ="../../_static/js/theme.js "> </ script >
44+
45+
46+ < link rel ="index " title ="Index " href ="../../genindex.html " />
47+ < link rel ="search " title ="Search " href ="../../search.html " />
48+ </ head >
49+ < body class ="wy-body-for-nav ">
50+
51+
52+
53+ < div class ="wy-grid-for-nav ">
54+
55+ < nav data-toggle ="wy-nav-shift " class ="wy-nav-side ">
56+ < div class ="wy-side-scroll ">
57+ < div class ="wy-side-nav-search ">
58+
59+ < div class ="brand ">
60+ < a href ="../../index.html ">
61+
62+ < img src ="../../_static/AYON_blackG_dot.svg " class ="logo " alt ="Logo "/>
63+
64+ </ a >
65+ </ div >
66+
67+ < div role ="search ">
68+ < form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
69+ < input type ="text " name ="q " placeholder ="Search docs " />
70+ < input type ="hidden " name ="check_keywords " value ="yes " />
71+ < input type ="hidden " name ="area " value ="default " />
72+ </ form >
73+ </ div >
74+
75+ </ div >
76+
77+ < div class ="wy-menu wy-menu-vertical " data-spy ="affix " role ="navigation " aria-label ="main navigation ">
78+
79+
80+
81+
82+
83+
84+ < ul >
85+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../modules.html "> ayon_api</ a > </ li >
86+ </ ul >
87+
88+
89+
90+ </ div >
91+
92+ </ div >
93+ </ nav >
94+
95+ < section data-toggle ="wy-nav-shift " class ="wy-nav-content-wrap ">
96+
97+
98+ < nav class ="wy-nav-top " aria-label ="top navigation ">
99+
100+ < i data-toggle ="wy-nav-top " class ="fa fa-bars "> </ i >
101+ < a href ="../../index.html ">
102+
103+ < img src ="../../_static/AYON_blackG_dot.svg " class ="logo " alt ="Logo "/>
104+
105+ </ a >
106+
107+ </ nav >
108+
109+
110+ < div class ="wy-nav-content ">
111+
112+ < div class ="rst-content ">
113+
114+ < div role ="navigation " aria-label ="breadcrumbs navigation ">
115+
116+ < ul class ="wy-breadcrumbs ">
117+
118+
119+ < li > < a href ="../../index.html "> ayon-python-api</ a > ⁄ </ li >
120+
121+ < li > < a href ="../index.html "> Module code</ a > ⁄ </ li >
122+
123+ < li > < a href =""> ayon_api.events</ a > </ li >
124+
125+
126+
127+ < li class ="wy-breadcrumbs-aside ">
128+
129+ < a href ="https://github.com/ynput/ayon-python-api " class ="fa fa-github-alt "> </ a >
130+
131+ </ li >
132+
133+ </ ul >
134+
135+ </ div >
136+ < div role ="main " class ="document " itemscope ="itemscope " itemtype ="http://schema.org/Article ">
137+ < div itemprop ="articleBody ">
138+
139+ < h1 > Source code for ayon_api.events</ h1 > < div class ="highlight "> < pre >
140+ < span > </ span > < span class ="kn "> import</ span > < span class ="nn "> copy</ span >
141+
142+
143+ < div class ="viewcode-block " id ="ServerEvent "> < a class ="viewcode-back " href ="../../ayon_api.events.html#ayon_api.events.ServerEvent "> [docs]</ a > < span class ="k "> class</ span > < span class ="nc "> ServerEvent</ span > < span class ="p "> (</ span > < span class ="nb "> object</ span > < span class ="p "> ):</ span >
144+ < span class ="k "> def</ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span >
145+ < span class ="bp "> self</ span > < span class ="p "> ,</ span >
146+ < span class ="n "> topic</ span > < span class ="p "> ,</ span >
147+ < span class ="n "> sender</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
148+ < span class ="n "> event_hash</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
149+ < span class ="n "> project_name</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
150+ < span class ="n "> username</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
151+ < span class ="n "> dependencies</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
152+ < span class ="n "> description</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
153+ < span class ="n "> summary</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
154+ < span class ="n "> payload</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
155+ < span class ="n "> finished</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
156+ < span class ="n "> store</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class ="p "> ,</ span >
157+ < span class ="p "> ):</ span >
158+ < span class ="k "> if</ span > < span class ="n "> dependencies</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
159+ < span class ="n "> dependencies</ span > < span class ="o "> =</ span > < span class ="p "> []</ span >
160+ < span class ="k "> if</ span > < span class ="n "> payload</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
161+ < span class ="n "> payload</ span > < span class ="o "> =</ span > < span class ="p "> {}</ span >
162+ < span class ="k "> if</ span > < span class ="n "> summary</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
163+ < span class ="n "> summary</ span > < span class ="o "> =</ span > < span class ="p "> {}</ span >
164+
165+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> topic</ span > < span class ="o "> =</ span > < span class ="n "> topic</ span >
166+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> sender</ span > < span class ="o "> =</ span > < span class ="n "> sender</ span >
167+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> event_hash</ span > < span class ="o "> =</ span > < span class ="n "> event_hash</ span >
168+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> project_name</ span > < span class ="o "> =</ span > < span class ="n "> project_name</ span >
169+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> username</ span > < span class ="o "> =</ span > < span class ="n "> username</ span >
170+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> dependencies</ span > < span class ="o "> =</ span > < span class ="n "> dependencies</ span >
171+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> description</ span > < span class ="o "> =</ span > < span class ="n "> description</ span >
172+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> summary</ span > < span class ="o "> =</ span > < span class ="n "> summary</ span >
173+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> payload</ span > < span class ="o "> =</ span > < span class ="n "> payload</ span >
174+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> finished</ span > < span class ="o "> =</ span > < span class ="n "> finished</ span >
175+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> store</ span > < span class ="o "> =</ span > < span class ="n "> store</ span >
176+
177+ < div class ="viewcode-block " id ="ServerEvent.to_data "> < a class ="viewcode-back " href ="../../ayon_api.events.html#ayon_api.events.ServerEvent.to_data "> [docs]</ a > < span class ="k "> def</ span > < span class ="nf "> to_data</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ):</ span >
178+ < span class ="k "> return</ span > < span class ="p "> {</ span >
179+ < span class ="s2 "> "topic"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> topic</ span > < span class ="p "> ,</ span >
180+ < span class ="s2 "> "sender"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> sender</ span > < span class ="p "> ,</ span >
181+ < span class ="s2 "> "hash"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> event_hash</ span > < span class ="p "> ,</ span >
182+ < span class ="s2 "> "project"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> project_name</ span > < span class ="p "> ,</ span >
183+ < span class ="s2 "> "user"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> username</ span > < span class ="p "> ,</ span >
184+ < span class ="s2 "> "dependencies"</ span > < span class ="p "> :</ span > < span class ="n "> copy</ span > < span class ="o "> .</ span > < span class ="n "> deepcopy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> dependencies</ span > < span class ="p "> ),</ span >
185+ < span class ="s2 "> "description"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> description</ span > < span class ="p "> ,</ span >
186+ < span class ="s2 "> "summary"</ span > < span class ="p "> :</ span > < span class ="n "> copy</ span > < span class ="o "> .</ span > < span class ="n "> deepcopy</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> summary</ span > < span class ="p "> ),</ span >
187+ < span class ="s2 "> "payload"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> payload</ span > < span class ="p "> ,</ span >
188+ < span class ="s2 "> "finished"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> finished</ span > < span class ="p "> ,</ span >
189+ < span class ="s2 "> "store"</ span > < span class ="p "> :</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> store</ span >
190+ < span class ="p "> }</ span > </ div > </ div >
191+ </ pre > </ div >
192+
193+ </ div >
194+
195+ </ div >
196+ < footer >
197+
198+
199+ < div role ="contentinfo ">
200+ < p >
201+
202+ © Copyright 2024, ynput.io < info @ynput.io >
203+ < br >
204+
205+
206+
207+ Built with < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > using a
208+
209+ < a href ="https://github.com/revitron/revitron-sphinx-theme "> theme</ a >
210+
211+ provided by < a href ="https://github.com/revitron "> Revitron</ a > .
212+
213+ </ p >
214+ </ div >
215+
216+ </ footer >
217+
218+ </ div >
219+ </ div >
220+
221+ </ section >
222+
223+ </ div >
224+
225+
226+ < script type ="text/javascript ">
227+ jQuery ( function ( ) {
228+ SphinxRtdTheme . Navigation . enable ( true ) ;
229+ } ) ;
230+ </ script >
231+
232+
233+
234+
235+
236+
237+
238+ </ body >
239+ </ html >
0 commit comments