-
Notifications
You must be signed in to change notification settings - Fork 851
Expand file tree
/
Copy pathbasic_objects.html
More file actions
475 lines (450 loc) · 29.5 KB
/
basic_objects.html
File metadata and controls
475 lines (450 loc) · 29.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>slack_sdk.models.basic_objects API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>slack_sdk.models.basic_objects</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.models.basic_objects.BaseObject"><code class="flex name class">
<span>class <span class="ident">BaseObject</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class BaseObject:
"""The base class for all model objects in this module"""
def __str__(self):
return f"<slack_sdk.{self.__class__.__name__}>"</code></pre>
</details>
<div class="desc"><p>The base class for all model objects in this module</p></div>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.basic_objects.JsonObject" href="#slack_sdk.models.basic_objects.JsonObject">JsonObject</a></li>
<li><a title="slack_sdk.models.messages.Link" href="messages/index.html#slack_sdk.models.messages.Link">Link</a></li>
</ul>
</dd>
<dt id="slack_sdk.models.basic_objects.EnumValidator"><code class="flex name class">
<span>class <span class="ident">EnumValidator</span></span>
<span>(</span><span>attribute: str, enum: Iterable[str])</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class EnumValidator(JsonValidator):
def __init__(self, attribute: str, enum: Iterable[str]):
super().__init__(f"{attribute} attribute must be one of the following values: " f"{', '.join(enum)}")</code></pre>
</details>
<div class="desc"><p>Decorate a method on a class to mark it as a JSON validator. Validation
functions should return true if valid, false if not.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>message</code></strong></dt>
<dd>Message to be attached to the thrown SlackObjectFormationError</dd>
</dl></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.basic_objects.JsonValidator" href="#slack_sdk.models.basic_objects.JsonValidator">JsonValidator</a></li>
</ul>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonObject"><code class="flex name class">
<span>class <span class="ident">JsonObject</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class JsonObject(BaseObject, metaclass=ABCMeta):
"""The base class for JSON serializable class objects"""
@property
@abstractmethod
def attributes(self) -> Set[str]:
"""Provide a set of attributes of this object that will make up its JSON structure"""
return set()
def validate_json(self) -> None:
"""
Raises:
SlackObjectFormationError if the object was not valid
"""
for attribute in (func for func in dir(self) if not func.startswith("__")):
method = getattr(self, attribute, None)
if callable(method) and hasattr(method, "validator"):
method()
def get_object_attribute(self, key: str):
return getattr(self, key, None)
def get_non_null_attributes(self) -> dict:
"""
Construct a dictionary out of non-null keys (from attributes property)
present on this object
"""
def to_dict_compatible(value: Union[dict, list, object, tuple]) -> Union[dict, list, Any]:
if isinstance(value, (list, tuple)):
return [to_dict_compatible(v) for v in value]
else:
to_dict = getattr(value, "to_dict", None)
if to_dict and callable(to_dict):
return {k: to_dict_compatible(v) for k, v in value.to_dict().items()} # type: ignore[attr-defined]
else:
return value
def is_not_empty(self, key: str) -> bool:
value = self.get_object_attribute(key)
if value is None:
return False
# Usually, Block Kit components do not allow an empty array for a property value, but there are some exceptions.
# The following code deals with these exceptions:
type_value = getattr(self, "type", None)
for empty_allowed in EMPTY_ALLOWED_TYPE_AND_PROPERTY_LIST:
if type_value == empty_allowed["type"] and key == empty_allowed["property"]:
return True
has_len = getattr(value, "__len__", None) is not None
if has_len:
return len(value) > 0
else:
return value is not None
return {
key: to_dict_compatible(value=self.get_object_attribute(key))
for key in sorted(self.attributes)
if is_not_empty(self, key)
}
def to_dict(self, *args) -> dict:
"""
Extract this object as a JSON-compatible, Slack-API-valid dictionary
Args:
*args: Any specific formatting args (rare; generally not required)
Raises:
SlackObjectFormationError if the object was not valid
"""
self.validate_json()
return self.get_non_null_attributes()
def __repr__(self):
dict_value = self.get_non_null_attributes()
if dict_value:
return f"<slack_sdk.{self.__class__.__name__}: {dict_value}>"
else:
return self.__str__()
def __eq__(self, other: Any) -> bool:
if not isinstance(other, JsonObject):
return False
return self.to_dict() == other.to_dict()</code></pre>
</details>
<div class="desc"><p>The base class for JSON serializable class objects</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.basic_objects.BaseObject" href="#slack_sdk.models.basic_objects.BaseObject">BaseObject</a></li>
</ul>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.attachments.Action" href="attachments/index.html#slack_sdk.models.attachments.Action">Action</a></li>
<li><a title="slack_sdk.models.attachments.Attachment" href="attachments/index.html#slack_sdk.models.attachments.Attachment">Attachment</a></li>
<li><a title="slack_sdk.models.attachments.AttachmentField" href="attachments/index.html#slack_sdk.models.attachments.AttachmentField">AttachmentField</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.Option" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.Option">Option</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.SlackFile" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.SlackFile">SlackFile</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.TextObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.Workflow" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.Workflow">Workflow</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.WorkflowTrigger" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.WorkflowTrigger">WorkflowTrigger</a></li>
<li><a title="slack_sdk.models.blocks.block_elements.BlockElement" href="blocks/block_elements.html#slack_sdk.models.blocks.block_elements.BlockElement">BlockElement</a></li>
<li><a title="slack_sdk.models.blocks.block_elements.ConversationFilter" href="blocks/block_elements.html#slack_sdk.models.blocks.block_elements.ConversationFilter">ConversationFilter</a></li>
<li><a title="slack_sdk.models.blocks.blocks.Block" href="blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a></li>
<li><a title="slack_sdk.models.dialogs.AbstractDialogSelector" href="dialogs/index.html#slack_sdk.models.dialogs.AbstractDialogSelector">AbstractDialogSelector</a></li>
<li><a title="slack_sdk.models.dialogs.DialogBuilder" href="dialogs/index.html#slack_sdk.models.dialogs.DialogBuilder">DialogBuilder</a></li>
<li><a title="slack_sdk.models.dialogs.DialogTextComponent" href="dialogs/index.html#slack_sdk.models.dialogs.DialogTextComponent">DialogTextComponent</a></li>
<li><a title="slack_sdk.models.messages.chunk.Chunk" href="messages/chunk.html#slack_sdk.models.messages.chunk.Chunk">Chunk</a></li>
<li><a title="slack_sdk.models.messages.message.Message" href="messages/message.html#slack_sdk.models.messages.message.Message">Message</a></li>
<li><a title="slack_sdk.models.metadata.ContentItemEntityFields" href="metadata/index.html#slack_sdk.models.metadata.ContentItemEntityFields">ContentItemEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.EntityActionButton" href="metadata/index.html#slack_sdk.models.metadata.EntityActionButton">EntityActionButton</a></li>
<li><a title="slack_sdk.models.metadata.EntityActionProcessingState" href="metadata/index.html#slack_sdk.models.metadata.EntityActionProcessingState">EntityActionProcessingState</a></li>
<li><a title="slack_sdk.models.metadata.EntityActions" href="metadata/index.html#slack_sdk.models.metadata.EntityActions">EntityActions</a></li>
<li><a title="slack_sdk.models.metadata.EntityArrayItemField" href="metadata/index.html#slack_sdk.models.metadata.EntityArrayItemField">EntityArrayItemField</a></li>
<li><a title="slack_sdk.models.metadata.EntityAttributes" href="metadata/index.html#slack_sdk.models.metadata.EntityAttributes">EntityAttributes</a></li>
<li><a title="slack_sdk.models.metadata.EntityBooleanCheckboxField" href="metadata/index.html#slack_sdk.models.metadata.EntityBooleanCheckboxField">EntityBooleanCheckboxField</a></li>
<li><a title="slack_sdk.models.metadata.EntityBooleanTextField" href="metadata/index.html#slack_sdk.models.metadata.EntityBooleanTextField">EntityBooleanTextField</a></li>
<li><a title="slack_sdk.models.metadata.EntityCustomField" href="metadata/index.html#slack_sdk.models.metadata.EntityCustomField">EntityCustomField</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditNumberConfig" href="metadata/index.html#slack_sdk.models.metadata.EntityEditNumberConfig">EntityEditNumberConfig</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditSelectConfig" href="metadata/index.html#slack_sdk.models.metadata.EntityEditSelectConfig">EntityEditSelectConfig</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditSupport" href="metadata/index.html#slack_sdk.models.metadata.EntityEditSupport">EntityEditSupport</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditTextConfig" href="metadata/index.html#slack_sdk.models.metadata.EntityEditTextConfig">EntityEditTextConfig</a></li>
<li><a title="slack_sdk.models.metadata.EntityFullSizePreview" href="metadata/index.html#slack_sdk.models.metadata.EntityFullSizePreview">EntityFullSizePreview</a></li>
<li><a title="slack_sdk.models.metadata.EntityFullSizePreviewError" href="metadata/index.html#slack_sdk.models.metadata.EntityFullSizePreviewError">EntityFullSizePreviewError</a></li>
<li><a title="slack_sdk.models.metadata.EntityIconField" href="metadata/index.html#slack_sdk.models.metadata.EntityIconField">EntityIconField</a></li>
<li><a title="slack_sdk.models.metadata.EntityIconSlackFile" href="metadata/index.html#slack_sdk.models.metadata.EntityIconSlackFile">EntityIconSlackFile</a></li>
<li><a title="slack_sdk.models.metadata.EntityImageField" href="metadata/index.html#slack_sdk.models.metadata.EntityImageField">EntityImageField</a></li>
<li><a title="slack_sdk.models.metadata.EntityMetadata" href="metadata/index.html#slack_sdk.models.metadata.EntityMetadata">EntityMetadata</a></li>
<li><a title="slack_sdk.models.metadata.EntityPayload" href="metadata/index.html#slack_sdk.models.metadata.EntityPayload">EntityPayload</a></li>
<li><a title="slack_sdk.models.metadata.EntityRefField" href="metadata/index.html#slack_sdk.models.metadata.EntityRefField">EntityRefField</a></li>
<li><a title="slack_sdk.models.metadata.EntityStringField" href="metadata/index.html#slack_sdk.models.metadata.EntityStringField">EntityStringField</a></li>
<li><a title="slack_sdk.models.metadata.EntityTimestampField" href="metadata/index.html#slack_sdk.models.metadata.EntityTimestampField">EntityTimestampField</a></li>
<li><a title="slack_sdk.models.metadata.EntityTitle" href="metadata/index.html#slack_sdk.models.metadata.EntityTitle">EntityTitle</a></li>
<li><a title="slack_sdk.models.metadata.EntityTypedField" href="metadata/index.html#slack_sdk.models.metadata.EntityTypedField">EntityTypedField</a></li>
<li><a title="slack_sdk.models.metadata.EntityUserField" href="metadata/index.html#slack_sdk.models.metadata.EntityUserField">EntityUserField</a></li>
<li><a title="slack_sdk.models.metadata.EntityUserIDField" href="metadata/index.html#slack_sdk.models.metadata.EntityUserIDField">EntityUserIDField</a></li>
<li><a title="slack_sdk.models.metadata.EventAndEntityMetadata" href="metadata/index.html#slack_sdk.models.metadata.EventAndEntityMetadata">EventAndEntityMetadata</a></li>
<li><a title="slack_sdk.models.metadata.ExternalRef" href="metadata/index.html#slack_sdk.models.metadata.ExternalRef">ExternalRef</a></li>
<li><a title="slack_sdk.models.metadata.FileEntityFields" href="metadata/index.html#slack_sdk.models.metadata.FileEntityFields">FileEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.FileEntitySlackFile" href="metadata/index.html#slack_sdk.models.metadata.FileEntitySlackFile">FileEntitySlackFile</a></li>
<li><a title="slack_sdk.models.metadata.IncidentEntityFields" href="metadata/index.html#slack_sdk.models.metadata.IncidentEntityFields">IncidentEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.Metadata" href="metadata/index.html#slack_sdk.models.metadata.Metadata">Metadata</a></li>
<li><a title="slack_sdk.models.metadata.TaskEntityFields" href="metadata/index.html#slack_sdk.models.metadata.TaskEntityFields">TaskEntityFields</a></li>
<li><a title="slack_sdk.models.views.View" href="views/index.html#slack_sdk.models.views.View">View</a></li>
<li><a title="slack_sdk.models.views.ViewState" href="views/index.html#slack_sdk.models.views.ViewState">ViewState</a></li>
<li><a title="slack_sdk.models.views.ViewStateValue" href="views/index.html#slack_sdk.models.views.ViewStateValue">ViewStateValue</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="slack_sdk.models.basic_objects.JsonObject.attributes"><code class="name">prop <span class="ident">attributes</span> : Set[str]</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
@abstractmethod
def attributes(self) -> Set[str]:
"""Provide a set of attributes of this object that will make up its JSON structure"""
return set()</code></pre>
</details>
<div class="desc"><p>Provide a set of attributes of this object that will make up its JSON structure</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_sdk.models.basic_objects.JsonObject.get_non_null_attributes"><code class="name flex">
<span>def <span class="ident">get_non_null_attributes</span></span>(<span>self) ‑> dict</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_non_null_attributes(self) -> dict:
"""
Construct a dictionary out of non-null keys (from attributes property)
present on this object
"""
def to_dict_compatible(value: Union[dict, list, object, tuple]) -> Union[dict, list, Any]:
if isinstance(value, (list, tuple)):
return [to_dict_compatible(v) for v in value]
else:
to_dict = getattr(value, "to_dict", None)
if to_dict and callable(to_dict):
return {k: to_dict_compatible(v) for k, v in value.to_dict().items()} # type: ignore[attr-defined]
else:
return value
def is_not_empty(self, key: str) -> bool:
value = self.get_object_attribute(key)
if value is None:
return False
# Usually, Block Kit components do not allow an empty array for a property value, but there are some exceptions.
# The following code deals with these exceptions:
type_value = getattr(self, "type", None)
for empty_allowed in EMPTY_ALLOWED_TYPE_AND_PROPERTY_LIST:
if type_value == empty_allowed["type"] and key == empty_allowed["property"]:
return True
has_len = getattr(value, "__len__", None) is not None
if has_len:
return len(value) > 0
else:
return value is not None
return {
key: to_dict_compatible(value=self.get_object_attribute(key))
for key in sorted(self.attributes)
if is_not_empty(self, key)
}</code></pre>
</details>
<div class="desc"><p>Construct a dictionary out of non-null keys (from attributes property)
present on this object</p></div>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonObject.get_object_attribute"><code class="name flex">
<span>def <span class="ident">get_object_attribute</span></span>(<span>self, key: str)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_object_attribute(self, key: str):
return getattr(self, key, None)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonObject.to_dict"><code class="name flex">
<span>def <span class="ident">to_dict</span></span>(<span>self, *args) ‑> dict</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def to_dict(self, *args) -> dict:
"""
Extract this object as a JSON-compatible, Slack-API-valid dictionary
Args:
*args: Any specific formatting args (rare; generally not required)
Raises:
SlackObjectFormationError if the object was not valid
"""
self.validate_json()
return self.get_non_null_attributes()</code></pre>
</details>
<div class="desc"><p>Extract this object as a JSON-compatible, Slack-API-valid dictionary</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>*args</code></strong></dt>
<dd>Any specific formatting args (rare; generally not required)</dd>
</dl>
<h2 id="raises">Raises</h2>
<p>SlackObjectFormationError if the object was not valid</p></div>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonObject.validate_json"><code class="name flex">
<span>def <span class="ident">validate_json</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_json(self) -> None:
"""
Raises:
SlackObjectFormationError if the object was not valid
"""
for attribute in (func for func in dir(self) if not func.startswith("__")):
method = getattr(self, attribute, None)
if callable(method) and hasattr(method, "validator"):
method()</code></pre>
</details>
<div class="desc"><h2 id="raises">Raises</h2>
<p>SlackObjectFormationError if the object was not valid</p></div>
</dd>
</dl>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonValidator"><code class="flex name class">
<span>class <span class="ident">JsonValidator</span></span>
<span>(</span><span>message: str)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class JsonValidator:
def __init__(self, message: str):
"""
Decorate a method on a class to mark it as a JSON validator. Validation
functions should return true if valid, false if not.
Args:
message: Message to be attached to the thrown SlackObjectFormationError
"""
self.message = message
def __call__(self, func: Callable) -> Callable[..., None]:
@wraps(func)
def wrapped_f(*args, **kwargs):
if not func(*args, **kwargs):
raise SlackObjectFormationError(self.message)
wrapped_f.validator = True # type: ignore[attr-defined]
return wrapped_f</code></pre>
</details>
<div class="desc"><p>Decorate a method on a class to mark it as a JSON validator. Validation
functions should return true if valid, false if not.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>message</code></strong></dt>
<dd>Message to be attached to the thrown SlackObjectFormationError</dd>
</dl></div>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.basic_objects.EnumValidator" href="#slack_sdk.models.basic_objects.EnumValidator">EnumValidator</a></li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="slack_sdk.models" href="index.html">slack_sdk.models</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="slack_sdk.models.basic_objects.BaseObject" href="#slack_sdk.models.basic_objects.BaseObject">BaseObject</a></code></h4>
</li>
<li>
<h4><code><a title="slack_sdk.models.basic_objects.EnumValidator" href="#slack_sdk.models.basic_objects.EnumValidator">EnumValidator</a></code></h4>
</li>
<li>
<h4><code><a title="slack_sdk.models.basic_objects.JsonObject" href="#slack_sdk.models.basic_objects.JsonObject">JsonObject</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.attributes" href="#slack_sdk.models.basic_objects.JsonObject.attributes">attributes</a></code></li>
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.get_non_null_attributes" href="#slack_sdk.models.basic_objects.JsonObject.get_non_null_attributes">get_non_null_attributes</a></code></li>
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.get_object_attribute" href="#slack_sdk.models.basic_objects.JsonObject.get_object_attribute">get_object_attribute</a></code></li>
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.to_dict" href="#slack_sdk.models.basic_objects.JsonObject.to_dict">to_dict</a></code></li>
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.validate_json" href="#slack_sdk.models.basic_objects.JsonObject.validate_json">validate_json</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="slack_sdk.models.basic_objects.JsonValidator" href="#slack_sdk.models.basic_objects.JsonValidator">JsonValidator</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>