bolt-python/docs/reference/util/utils.html at main · https-saml-salesforce-com/bolt-python

History

262 lines (257 loc) · 14.8 KB

Raw

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

<!doctype html>

<head>

<title>slack_bolt.util.utils API documentation</title>

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>

<h1 class="title">Module <code>slack_bolt.util.utils</code></h1>

</header>

</section>

</section>

</section>

<h2 class="section-title" id="header-functions">Functions</h2>

<dl>

<span>def <span class="ident">convert_to_dict</span></span>(<span>obj: Dict | slack_sdk.models.basic_objects.JsonObject) ‑> Dict</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def convert_to_dict(obj: Union[Dict, JsonObject]) -> Dict:

if isinstance(obj, dict):

return obj

if isinstance(obj, JsonObject) or hasattr(obj, "to_dict"):

return obj.to_dict()

raise BoltError(f"{obj} (type: {type(obj)}) is unsupported")</code></pre>

</details>

</dd>

<span>def <span class="ident">convert_to_dict_list</span></span>(<span>objects: Sequence[Dict | slack_sdk.models.basic_objects.JsonObject]) ‑> Sequence[Dict]</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def convert_to_dict_list(objects: Sequence[Union[Dict, JsonObject]]) -> Sequence[Dict]:

return [convert_to_dict(elm) for elm in objects]</code></pre>

</details>

</dd>

<span>def <span class="ident">create_copy</span></span>(<span>original: Any) ‑> Any</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def create_copy(original: Any) -> Any:

return copy.deepcopy(original)</code></pre>

</details>

</dd>

<span>def <span class="ident">create_web_client</span></span>(<span>token: str | None = None, logger: logging.Logger | None = None) ‑> slack_sdk.web.client.WebClient</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def create_web_client(token: Optional[str] = None, logger: Optional[Logger] = None) -> WebClient:

return WebClient(

token=token,

logger=logger,

user_agent_prefix=f"Bolt/{bolt_version}",

)</code></pre>

</details>

</dd>

<span>def <span class="ident">get_arg_names_of_callable</span></span>(<span>func: Callable) ‑> List[str]</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def get_arg_names_of_callable(func: Callable) -> List[str]:

return inspect.getfullargspec(inspect.unwrap(func)).args</code></pre>

</details>

</dd>

<span>def <span class="ident">get_boot_message</span></span>(<span>development_server: bool = False) ‑> str</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def get_boot_message(development_server: bool = False) -> str:

if sys.platform == "win32":

# Some Windows environments may fail to parse this str value

# and result in UnicodeEncodeError

if development_server:

return "Bolt app is running! (development server)"

else:

return "Bolt app is running!"

try:

if development_server:

return "⚡️ Bolt app is running! (development server)"

else:

return "⚡️ Bolt app is running!"

except ValueError:

# ValueError is a runtime exception for a given value

# It's a super class of UnicodeEncodeError, which may be raised in the scenario

# see also: https://github.com/slackapi/bolt-python/issues/170

if development_server:

return "Bolt app is running! (development server)"

else:

return "Bolt app is running!"</code></pre>

</details>

</dd>

<span>def <span class="ident">get_name_for_callable</span></span>(<span>func: Callable) ‑> str</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def get_name_for_callable(func: Callable) -> str:

"""Returns the name for the given Callable function object.

Args:

func: Either a `Callable` instance or a function, which as `__name__`

Returns:

The name of the given Callable object

"""

if hasattr(func, "__name__"):

return func.__name__

else:

return f"{func.__class__.__module__}.{func.__class__.__name__}"</code></pre>

</details>

<div class="desc"><p>Returns the name for the given Callable function object.</p>

<dl>

<dd>Either a <code>Callable</code> instance or a function, which as <code>__name__</code></dd>

</dl>

<h2 id="returns">Returns</h2>

<p>The name of the given Callable object</p></div>

</dd>

<span>def <span class="ident">is_callable_coroutine</span></span>(<span>func: Any | None) ‑> bool</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def is_callable_coroutine(func: Optional[Any]) -> bool:

return func is not None and (

inspect.iscoroutinefunction(func) or (hasattr(func, "__call__") and inspect.iscoroutinefunction(func.__call__))

)</code></pre>

</details>

</dd>

<span>def <span class="ident">is_used_without_argument</span></span>(<span>args) ‑> bool</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">def is_used_without_argument(args) -> bool:

"""Tests if a decorator invocation is without () or (args).

Args:

args: arguments

Returns:

True if it's an invocation without args

"""

return len(args) == 1</code></pre>

</details>

<div class="desc"><p>Tests if a decorator invocation is without () or (args).</p>

<dl>

<dd>arguments</dd>

</dl>

<h2 id="returns">Returns</h2>

<p>True if it's an invocation without args</p></div>

</dd>

</dl>

</section>

</section>

</article>

</div>

<li><h3>Super-module</h3>

<ul>

<li><code><a title="slack_bolt.util" href="index.html">slack_bolt.util</a></code></li>

</ul>

</li>

<li><h3><a href="#header-functions">Functions</a></h3>

<li><code><a title="slack_bolt.util.utils.convert_to_dict" href="#slack_bolt.util.utils.convert_to_dict">convert_to_dict</a></code></li>

<li><code><a title="slack_bolt.util.utils.convert_to_dict_list" href="#slack_bolt.util.utils.convert_to_dict_list">convert_to_dict_list</a></code></li>

<li><code><a title="slack_bolt.util.utils.create_copy" href="#slack_bolt.util.utils.create_copy">create_copy</a></code></li>

<li><code><a title="slack_bolt.util.utils.create_web_client" href="#slack_bolt.util.utils.create_web_client">create_web_client</a></code></li>

<li><code><a title="slack_bolt.util.utils.get_arg_names_of_callable" href="#slack_bolt.util.utils.get_arg_names_of_callable">get_arg_names_of_callable</a></code></li>

<li><code><a title="slack_bolt.util.utils.get_boot_message" href="#slack_bolt.util.utils.get_boot_message">get_boot_message</a></code></li>

<li><code><a title="slack_bolt.util.utils.get_name_for_callable" href="#slack_bolt.util.utils.get_name_for_callable">get_name_for_callable</a></code></li>

<li><code><a title="slack_bolt.util.utils.is_callable_coroutine" href="#slack_bolt.util.utils.is_callable_coroutine">is_callable_coroutine</a></code></li>

<li><code><a title="slack_bolt.util.utils.is_used_without_argument" href="#slack_bolt.util.utils.is_used_without_argument">is_used_without_argument</a></code></li>

</ul>

</li>

</ul>

</nav>

</main>

<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>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

utils.html

Latest commit

History

utils.html

File metadata and controls