python-slack-sdk/docs/reference/oauth/state_store/index.html at 5cac2e42465585dfcaade390bf7117c7d85f99ba · slackapi/python-slack-sdk · GitHub

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
<!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.oauth.state_store API documentation</title>
<meta name="description" content="OAuth state parameter data store …">
<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.oauth.state_store</code></h1>
</header>
<section id="section-intro">
<p>OAuth state parameter data store</p>
<p>Refer to <a href="https://slack.dev/python-slack-sdk/oauth/">https://slack.dev/python-slack-sdk/oauth/</a> for details.</p>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="slack_sdk.oauth.state_store.amazon_s3" href="amazon_s3/index.html">slack_sdk.oauth.state_store.amazon_s3</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_sdk.oauth.state_store.async_state_store" href="async_state_store.html">slack_sdk.oauth.state_store.async_state_store</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_sdk.oauth.state_store.file" href="file/index.html">slack_sdk.oauth.state_store.file</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_sdk.oauth.state_store.sqlalchemy" href="sqlalchemy/index.html">slack_sdk.oauth.state_store.sqlalchemy</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_sdk.oauth.state_store.sqlite3" href="sqlite3/index.html">slack_sdk.oauth.state_store.sqlite3</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_sdk.oauth.state_store.state_store" href="state_store.html">slack_sdk.oauth.state_store.state_store</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class FileOAuthStateStore(OAuthStateStore, AsyncOAuthStateStore):
    def __init__(
        self,
        *,
        expiration_seconds: int,
        base_dir: str = str(Path.home()) + &#34;/.bolt-app-oauth-state&#34;,
        client_id: Optional[str] = None,
        logger: Logger = logging.getLogger(__name__),
    ):
        self.expiration_seconds = expiration_seconds

        self.base_dir = base_dir
        self.client_id = client_id
        if self.client_id is not None:
            self.base_dir = f&#34;{self.base_dir}/{self.client_id}&#34;
        self._logger = logger

    @property
    def logger(self) -&gt; Logger:
        if self._logger is None:
            self._logger = logging.getLogger(__name__)
        return self._logger

    async def async_issue(self, *args, **kwargs) -&gt; str:
        return self.issue(*args, **kwargs)

    async def async_consume(self, state: str) -&gt; bool:
        return self.consume(state)

    def issue(self, *args, **kwargs) -&gt; str:
        state = str(uuid4())
        self._mkdir(self.base_dir)
        filepath = f&#34;{self.base_dir}/{state}&#34;
        with open(filepath, &#34;w&#34;) as f:
            content = str(time.time())
            f.write(content)
        return state

    def consume(self, state: str) -&gt; bool:
        filepath = f&#34;{self.base_dir}/{state}&#34;
        try:
            with open(filepath) as f:
                created = float(f.read())
                expiration = created + self.expiration_seconds
                still_valid: bool = time.time() &lt; expiration

            os.remove(filepath)  # consume the file by deleting it
            return still_valid

        except FileNotFoundError as e:
            message = f&#34;Failed to find any persistent data for state: {state} - {e}&#34;
            self.logger.warning(message)
            return False

    @staticmethod
    def _mkdir(path: Union[str, Path]):
        if isinstance(path, str):
            path = Path(path)
        path.mkdir(parents=True, exist_ok=True)</code></pre>
</details>
<div class="desc"></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_sdk.oauth.state_store.state_store.OAuthStateStore" href="state_store.html#slack_sdk.oauth.state_store.state_store.OAuthStateStore">OAuthStateStore</a></li>
<li><a title="slack_sdk.oauth.state_store.async_state_store.AsyncOAuthStateStore" href="async_state_store.html#slack_sdk.oauth.state_store.async_state_store.AsyncOAuthStateStore">AsyncOAuthStateStore</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore.logger"><code class="name">prop <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def logger(self) -&gt; Logger:
    if self._logger is None:
        self._logger = logging.getLogger(__name__)
    return self._logger</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore.async_consume"><code class="name flex">
<span>async def <span class="ident">async_consume</span></span>(<span>self, state: str) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def async_consume(self, state: str) -&gt; bool:
    return self.consume(state)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore.async_issue"><code class="name flex">
<span>async def <span class="ident">async_issue</span></span>(<span>self, *args, **kwargs) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def async_issue(self, *args, **kwargs) -&gt; str:
    return self.issue(*args, **kwargs)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore.consume"><code class="name flex">
<span>def <span class="ident">consume</span></span>(<span>self, state: str) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def consume(self, state: str) -&gt; bool:
    filepath = f&#34;{self.base_dir}/{state}&#34;
    try:
        with open(filepath) as f:
            created = float(f.read())
            expiration = created + self.expiration_seconds
            still_valid: bool = time.time() &lt; expiration

        os.remove(filepath)  # consume the file by deleting it
        return still_valid

    except FileNotFoundError as e:
        message = f&#34;Failed to find any persistent data for state: {state} - {e}&#34;
        self.logger.warning(message)
        return False</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore.issue"><code class="name flex">
<span>def <span class="ident">issue</span></span>(<span>self, *args, **kwargs) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def issue(self, *args, **kwargs) -&gt; str:
    state = str(uuid4())
    self._mkdir(self.base_dir)
    filepath = f&#34;{self.base_dir}/{state}&#34;
    with open(filepath, &#34;w&#34;) as f:
        content = str(time.time())
        f.write(content)
    return state</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</dd>
<dt id="slack_sdk.oauth.state_store.OAuthStateStore"><code class="flex name class">
<span>class <span class="ident">OAuthStateStore</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class OAuthStateStore:
    @property
    def logger(self) -&gt; Logger:
        raise NotImplementedError()

    def issue(self, *args, **kwargs) -&gt; str:
        raise NotImplementedError()

    def consume(self, state: str) -&gt; bool:
        raise NotImplementedError()</code></pre>
</details>
<div class="desc"></div>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_sdk.oauth.state_store.amazon_s3.AmazonS3OAuthStateStore" href="amazon_s3/index.html#slack_sdk.oauth.state_store.amazon_s3.AmazonS3OAuthStateStore">AmazonS3OAuthStateStore</a></li>
<li><a title="slack_sdk.oauth.state_store.file.FileOAuthStateStore" href="file/index.html#slack_sdk.oauth.state_store.file.FileOAuthStateStore">FileOAuthStateStore</a></li>
<li><a title="slack_sdk.oauth.state_store.sqlalchemy.SQLAlchemyOAuthStateStore" href="sqlalchemy/index.html#slack_sdk.oauth.state_store.sqlalchemy.SQLAlchemyOAuthStateStore">SQLAlchemyOAuthStateStore</a></li>
<li><a title="slack_sdk.oauth.state_store.sqlite3.SQLite3OAuthStateStore" href="sqlite3/index.html#slack_sdk.oauth.state_store.sqlite3.SQLite3OAuthStateStore">SQLite3OAuthStateStore</a></li>
</ul>
<h3>Instance variables</h3>
<dl>
<dt id="slack_sdk.oauth.state_store.OAuthStateStore.logger"><code class="name">prop <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def logger(self) -&gt; Logger:
    raise NotImplementedError()</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_sdk.oauth.state_store.OAuthStateStore.consume"><code class="name flex">
<span>def <span class="ident">consume</span></span>(<span>self, state: str) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def consume(self, state: str) -&gt; bool:
    raise NotImplementedError()</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.oauth.state_store.OAuthStateStore.issue"><code class="name flex">
<span>def <span class="ident">issue</span></span>(<span>self, *args, **kwargs) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def issue(self, *args, **kwargs) -&gt; str:
    raise NotImplementedError()</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</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.oauth" href="../index.html">slack_sdk.oauth</a></code></li>
</ul>
</li>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="slack_sdk.oauth.state_store.amazon_s3" href="amazon_s3/index.html">slack_sdk.oauth.state_store.amazon_s3</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.async_state_store" href="async_state_store.html">slack_sdk.oauth.state_store.async_state_store</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.file" href="file/index.html">slack_sdk.oauth.state_store.file</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.sqlalchemy" href="sqlalchemy/index.html">slack_sdk.oauth.state_store.sqlalchemy</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.sqlite3" href="sqlite3/index.html">slack_sdk.oauth.state_store.sqlite3</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.state_store" href="state_store.html">slack_sdk.oauth.state_store.state_store</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="slack_sdk.oauth.state_store.FileOAuthStateStore" href="#slack_sdk.oauth.state_store.FileOAuthStateStore">FileOAuthStateStore</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.oauth.state_store.FileOAuthStateStore.async_consume" href="#slack_sdk.oauth.state_store.FileOAuthStateStore.async_consume">async_consume</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.FileOAuthStateStore.async_issue" href="#slack_sdk.oauth.state_store.FileOAuthStateStore.async_issue">async_issue</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.FileOAuthStateStore.consume" href="#slack_sdk.oauth.state_store.FileOAuthStateStore.consume">consume</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.FileOAuthStateStore.issue" href="#slack_sdk.oauth.state_store.FileOAuthStateStore.issue">issue</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.FileOAuthStateStore.logger" href="#slack_sdk.oauth.state_store.FileOAuthStateStore.logger">logger</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="slack_sdk.oauth.state_store.OAuthStateStore" href="#slack_sdk.oauth.state_store.OAuthStateStore">OAuthStateStore</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.oauth.state_store.OAuthStateStore.consume" href="#slack_sdk.oauth.state_store.OAuthStateStore.consume">consume</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.OAuthStateStore.issue" href="#slack_sdk.oauth.state_store.OAuthStateStore.issue">issue</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store.OAuthStateStore.logger" href="#slack_sdk.oauth.state_store.OAuthStateStore.logger">logger</a></code></li>
</ul>
</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>