yupix 7 months ago
parent 1167849d65
commit 14844ebbaa

@ -3873,12 +3873,21 @@ Missing
:members:
AuthClient
~~~~~~~~~~
IMiAuthPayload
~~~~~~~~~~~~~~
.. attributetable:: mipac.utils.auth.IMiAuthPayload
.. autoclass:: mipac.utils.auth.IMiAuthPayload
:members:
MiAuth
~~~~~~
.. attributetable:: mipac.utils.auth.AuthClient
.. attributetable:: mipac.utils.auth.MiAuth
.. autoclass:: mipac.utils.auth.AuthClient
.. autoclass:: mipac.utils.auth.MiAuth
:members:

@ -3873,12 +3873,21 @@ Missing
:members:
AuthClient
~~~~~~~~~~
IMiAuthPayload
~~~~~~~~~~~~~~
.. attributetable:: mipac.utils.auth.IMiAuthPayload
.. autoclass:: mipac.utils.auth.IMiAuthPayload
:members:
MiAuth
~~~~~~
.. attributetable:: mipac.utils.auth.AuthClient
.. attributetable:: mipac.utils.auth.MiAuth
.. autoclass:: mipac.utils.auth.AuthClient
.. autoclass:: mipac.utils.auth.MiAuth
:members:

Binary file not shown.

Binary file not shown.

@ -270,11 +270,11 @@
<li><a href="index.html#mipac.manager.admins.roles.AdminRolesManager">AdminRolesManager (class in mipac.manager.admins.roles)</a>
</li>
<li><a href="index.html#mipac.manager.admins.roles.AdminRolesModelManager">AdminRolesModelManager (class in mipac.manager.admins.roles)</a>
</li>
<li><a href="index.html#mipac.actions.admins.user.AdminUserActions">AdminUserActions (class in mipac.actions.admins.user)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.admins.user.AdminUserActions">AdminUserActions (class in mipac.actions.admins.user)</a>
</li>
<li><a href="index.html#mipac.manager.admins.user.AdminUserManager">AdminUserManager (class in mipac.manager.admins.user)</a>
</li>
<li><a href="index.html#mipac.models.channel.Channel.allow_renote_to_external">allow_renote_to_external (mipac.models.channel.Channel property)</a>
@ -336,8 +336,6 @@
<li><a href="index.html#mipac.actions.admins.roles.AdminRoleModelActions.assign">assign() (mipac.actions.admins.roles.AdminRoleModelActions method)</a>
</li>
<li><a href="index.html#mipac.types.page.AttachedFilePayload">AttachedFilePayload (class in mipac.types.page)</a>
</li>
<li><a href="index.html#mipac.utils.auth.AuthClient">AuthClient (class in mipac.utils.auth)</a>
</li>
<li><a href="index.html#mipac.models.note.Note.author">author (mipac.models.note.Note property)</a>
</li>
@ -442,8 +440,6 @@
<li><a href="index.html#mipac.actions.chart.ChartActions">ChartActions (class in mipac.actions.chart)</a>
</li>
<li><a href="index.html#mipac.manager.chart.ChartManager">ChartManager (class in mipac.manager.chart)</a>
</li>
<li><a href="index.html#mipac.utils.auth.AuthClient.check_auth">check_auth() (mipac.utils.auth.AuthClient method)</a>
</li>
<li><a href="index.html#mipac.actions.drive.files.FileActions.check_existence">check_existence() (mipac.actions.drive.files.FileActions method)</a>
</li>
@ -905,8 +901,6 @@
<li><a href="index.html#mipac.actions.drive.files.SharedFileActions.get_attached_notes">(mipac.actions.drive.files.SharedFileActions method)</a>
</li>
</ul></li>
<li><a href="index.html#mipac.utils.auth.AuthClient.get_auth_url">get_auth_url() (mipac.utils.auth.AuthClient method)</a>
</li>
<li><a href="index.html#mipac.utils.cache.get_cache_key">get_cache_key() (in module mipac.utils.cache)</a>
</li>
<li><a href="index.html#mipac.actions.my.MyActions.get_claim_achievement">get_claim_achievement() (mipac.actions.my.MyActions method)</a>
@ -943,14 +937,14 @@
<li><a href="index.html#mipac.actions.user.SharedUserActions.get_followers">(mipac.actions.user.SharedUserActions method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.user.ClientUserActions.get_following">get_following() (mipac.actions.user.ClientUserActions method)</a>
<ul>
<li><a href="index.html#mipac.actions.user.SharedUserActions.get_following">(mipac.actions.user.SharedUserActions method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.user.ClientUserActions.get_frequently_replied_users">get_frequently_replied_users() (mipac.actions.user.ClientUserActions method)</a>
<ul>
@ -1176,6 +1170,8 @@
<li><a href="index.html#mipac.types.roles.IMeRole">IMeRole (class in mipac.types.roles)</a>
</li>
<li><a href="index.html#mipac.types.meta.IMeta">IMeta (class in mipac.types.meta)</a>
</li>
<li><a href="index.html#mipac.utils.auth.IMiAuthPayload">IMiAuthPayload (class in mipac.utils.auth)</a>
</li>
<li><a href="index.html#mipac.types.admin.IModerationLog">IModerationLog (class in mipac.types.admin)</a>
</li>
@ -1196,11 +1192,11 @@
<li><a href="index.html#mipac.types.note.INoteState">INoteState (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteTranslateResult">INoteTranslateResult (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdated">INoteUpdated (class in mipac.types.note)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.types.note.INoteUpdated">INoteUpdated (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdatedDelete">INoteUpdatedDelete (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdatedDeleteBody">INoteUpdatedDeleteBody (class in mipac.types.note)</a>
@ -1388,6 +1384,8 @@
<li><a href="index.html#mipac.models.roles.MeRole">MeRole (class in mipac.models.roles)</a>
</li>
<li><a href="index.html#mipac.models.meta.Meta">Meta (class in mipac.models.meta)</a>
</li>
<li><a href="index.html#mipac.utils.auth.MiAuth">MiAuth (class in mipac.utils.auth)</a>
</li>
<li><a href="index.html#mipac.file.MiFile">MiFile (class in mipac.file)</a>
</li>
@ -1396,11 +1394,11 @@
<li><a href="index.html#mipac.utils.util.Missing">Missing (class in mipac.utils.util)</a>
</li>
<li><a href="index.html#mipac.http.MisskeyClientWebSocketResponse">MisskeyClientWebSocketResponse (class in mipac.http)</a>
</li>
<li><a href="index.html#mipac.utils.util.MiTime">MiTime (class in mipac.utils.util)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.utils.util.MiTime">MiTime (class in mipac.utils.util)</a>
</li>
<li><a href="index.html#mipac.models.admin.ModerationLog">ModerationLog (class in mipac.models.admin)</a>
</li>
<li><a href="index.html#mipac.errors.errors.MoSuchFileError">MoSuchFileError (class in mipac.errors.errors)</a>

@ -3873,12 +3873,21 @@ Missing
:members:
AuthClient
~~~~~~~~~~
IMiAuthPayload
~~~~~~~~~~~~~~
.. attributetable:: mipac.utils.auth.IMiAuthPayload
.. autoclass:: mipac.utils.auth.IMiAuthPayload
:members:
MiAuth
~~~~~~
.. attributetable:: mipac.utils.auth.AuthClient
.. attributetable:: mipac.utils.auth.MiAuth
.. autoclass:: mipac.utils.auth.AuthClient
.. autoclass:: mipac.utils.auth.MiAuth
:members:

@ -270,11 +270,11 @@
<li><a href="index.html#mipac.manager.admins.roles.AdminRolesManager">AdminRolesManager (class in mipac.manager.admins.roles)</a>
</li>
<li><a href="index.html#mipac.manager.admins.roles.AdminRolesModelManager">AdminRolesModelManager (class in mipac.manager.admins.roles)</a>
</li>
<li><a href="index.html#mipac.actions.admins.user.AdminUserActions">AdminUserActions (class in mipac.actions.admins.user)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.admins.user.AdminUserActions">AdminUserActions (class in mipac.actions.admins.user)</a>
</li>
<li><a href="index.html#mipac.manager.admins.user.AdminUserManager">AdminUserManager (class in mipac.manager.admins.user)</a>
</li>
<li><a href="index.html#mipac.models.channel.Channel.allow_renote_to_external">allow_renote_to_external (mipac.models.channel.Channel property)</a>
@ -336,8 +336,6 @@
<li><a href="index.html#mipac.actions.admins.roles.AdminRoleModelActions.assign">assign() (mipac.actions.admins.roles.AdminRoleModelActions method)</a>
</li>
<li><a href="index.html#mipac.types.page.AttachedFilePayload">AttachedFilePayload (class in mipac.types.page)</a>
</li>
<li><a href="index.html#mipac.utils.auth.AuthClient">AuthClient (class in mipac.utils.auth)</a>
</li>
<li><a href="index.html#mipac.models.note.Note.author">author (mipac.models.note.Note property)</a>
</li>
@ -442,8 +440,6 @@
<li><a href="index.html#mipac.actions.chart.ChartActions">ChartActions (class in mipac.actions.chart)</a>
</li>
<li><a href="index.html#mipac.manager.chart.ChartManager">ChartManager (class in mipac.manager.chart)</a>
</li>
<li><a href="index.html#mipac.utils.auth.AuthClient.check_auth">check_auth() (mipac.utils.auth.AuthClient method)</a>
</li>
<li><a href="index.html#mipac.actions.drive.files.FileActions.check_existence">check_existence() (mipac.actions.drive.files.FileActions method)</a>
</li>
@ -905,8 +901,6 @@
<li><a href="index.html#mipac.actions.drive.files.SharedFileActions.get_attached_notes">(mipac.actions.drive.files.SharedFileActions method)</a>
</li>
</ul></li>
<li><a href="index.html#mipac.utils.auth.AuthClient.get_auth_url">get_auth_url() (mipac.utils.auth.AuthClient method)</a>
</li>
<li><a href="index.html#mipac.utils.cache.get_cache_key">get_cache_key() (in module mipac.utils.cache)</a>
</li>
<li><a href="index.html#mipac.actions.my.MyActions.get_claim_achievement">get_claim_achievement() (mipac.actions.my.MyActions method)</a>
@ -943,14 +937,14 @@
<li><a href="index.html#mipac.actions.user.SharedUserActions.get_followers">(mipac.actions.user.SharedUserActions method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.user.ClientUserActions.get_following">get_following() (mipac.actions.user.ClientUserActions method)</a>
<ul>
<li><a href="index.html#mipac.actions.user.SharedUserActions.get_following">(mipac.actions.user.SharedUserActions method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.user.ClientUserActions.get_frequently_replied_users">get_frequently_replied_users() (mipac.actions.user.ClientUserActions method)</a>
<ul>
@ -1176,6 +1170,8 @@
<li><a href="index.html#mipac.types.roles.IMeRole">IMeRole (class in mipac.types.roles)</a>
</li>
<li><a href="index.html#mipac.types.meta.IMeta">IMeta (class in mipac.types.meta)</a>
</li>
<li><a href="index.html#mipac.utils.auth.IMiAuthPayload">IMiAuthPayload (class in mipac.utils.auth)</a>
</li>
<li><a href="index.html#mipac.types.admin.IModerationLog">IModerationLog (class in mipac.types.admin)</a>
</li>
@ -1196,11 +1192,11 @@
<li><a href="index.html#mipac.types.note.INoteState">INoteState (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteTranslateResult">INoteTranslateResult (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdated">INoteUpdated (class in mipac.types.note)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.types.note.INoteUpdated">INoteUpdated (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdatedDelete">INoteUpdatedDelete (class in mipac.types.note)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdatedDeleteBody">INoteUpdatedDeleteBody (class in mipac.types.note)</a>
@ -1388,6 +1384,8 @@
<li><a href="index.html#mipac.models.roles.MeRole">MeRole (class in mipac.models.roles)</a>
</li>
<li><a href="index.html#mipac.models.meta.Meta">Meta (class in mipac.models.meta)</a>
</li>
<li><a href="index.html#mipac.utils.auth.MiAuth">MiAuth (class in mipac.utils.auth)</a>
</li>
<li><a href="index.html#mipac.file.MiFile">MiFile (class in mipac.file)</a>
</li>
@ -1396,11 +1394,11 @@
<li><a href="index.html#mipac.utils.util.Missing">Missing (class in mipac.utils.util)</a>
</li>
<li><a href="index.html#mipac.http.MisskeyClientWebSocketResponse">MisskeyClientWebSocketResponse (class in mipac.http)</a>
</li>
<li><a href="index.html#mipac.utils.util.MiTime">MiTime (class in mipac.utils.util)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.utils.util.MiTime">MiTime (class in mipac.utils.util)</a>
</li>
<li><a href="index.html#mipac.models.admin.ModerationLog">ModerationLog (class in mipac.models.admin)</a>
</li>
<li><a href="index.html#mipac.errors.errors.MoSuchFileError">MoSuchFileError (class in mipac.errors.errors)</a>

@ -9958,48 +9958,20 @@ when the function is used.</p>
<dd></dd></dl>
</section>
<section id="authclient">
<h3>AuthClient<a class="headerlink" href="#authclient" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.AuthClient"><div class="py-attribute-table-column">
<span>
Methods</span><ul>
<li class="py-attribute-table-entry">
<span class="py-attribute-table-badge" title="coroutine">
async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.check_auth">check_auth</a></li><li class="py-attribute-table-entry">
<span class="py-attribute-table-badge" title="coroutine">
async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.get_auth_url">get_auth_url</a></li></ul>
</div></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">AuthClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_uri</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_miauth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.AuthClient" title="Link to this definition">#</a></dt>
<dd><p>Tokenの取得を手助けするクラス</p>
<dl class="py method">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient.check_auth">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_auth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.auth.AuthClient.check_auth" title="Link to this definition">#</a></dt>
<dd><p>認証が完了するまで待機し、完了した場合はTokenを返します</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Token</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient.get_auth_url">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_auth_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.auth.AuthClient.get_auth_url" title="Link to this definition">#</a></dt>
<dd><p>認証に使用するURLを取得します</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>認証に使用するURL</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<section id="imiauthpayload">
<h3>IMiAuthPayload<a class="headerlink" href="#imiauthpayload" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.IMiAuthPayload"></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.IMiAuthPayload">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">IMiAuthPayload</span></span><a class="headerlink" href="#mipac.utils.auth.IMiAuthPayload" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</section>
<section id="miauth">
<h3>MiAuth<a class="headerlink" href="#miauth" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.MiAuth"></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.MiAuth">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">MiAuth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'http'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'https'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.MiAuth" title="Link to this definition">#</a></dt>
<dd><p>Misskey v12以降のインスタンスで使用可能な認証方式です</p>
</dd></dl>
</section>
@ -12398,12 +12370,12 @@ async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.get
<li><a class="reference internal" href="#mipac.utils.util.Missing"><code class="docutils literal notranslate"><span class="pre">Missing</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#authclient">AuthClient</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient"><code class="docutils literal notranslate"><span class="pre">AuthClient</span></code></a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient.check_auth"><code class="docutils literal notranslate"><span class="pre">AuthClient.check_auth()</span></code></a></li>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient.get_auth_url"><code class="docutils literal notranslate"><span class="pre">AuthClient.get_auth_url()</span></code></a></li>
<li><a class="reference internal" href="#imiauthpayload">IMiAuthPayload</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.IMiAuthPayload"><code class="docutils literal notranslate"><span class="pre">IMiAuthPayload</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#miauth">MiAuth</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.MiAuth"><code class="docutils literal notranslate"><span class="pre">MiAuth</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#setup-logging">setup_logging</a><ul>

Binary file not shown.

File diff suppressed because one or more lines are too long

@ -9958,48 +9958,20 @@ when the function is used.</p>
<dd></dd></dl>
</section>
<section id="authclient">
<h3>AuthClient<a class="headerlink" href="#authclient" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.AuthClient"><div class="py-attribute-table-column">
<span>
Methods</span><ul>
<li class="py-attribute-table-entry">
<span class="py-attribute-table-badge" title="coroutine">
async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.check_auth">check_auth</a></li><li class="py-attribute-table-entry">
<span class="py-attribute-table-badge" title="coroutine">
async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.get_auth_url">get_auth_url</a></li></ul>
</div></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">AuthClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_uri</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_miauth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.AuthClient" title="Link to this definition">#</a></dt>
<dd><p>Tokenの取得を手助けするクラス</p>
<dl class="py method">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient.check_auth">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_auth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.auth.AuthClient.check_auth" title="Link to this definition">#</a></dt>
<dd><p>認証が完了するまで待機し、完了した場合はTokenを返します</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Token</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient.get_auth_url">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_auth_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.auth.AuthClient.get_auth_url" title="Link to this definition">#</a></dt>
<dd><p>認証に使用するURLを取得します</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>認証に使用するURL</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<section id="imiauthpayload">
<h3>IMiAuthPayload<a class="headerlink" href="#imiauthpayload" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.IMiAuthPayload"></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.IMiAuthPayload">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">IMiAuthPayload</span></span><a class="headerlink" href="#mipac.utils.auth.IMiAuthPayload" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</section>
<section id="miauth">
<h3>MiAuth<a class="headerlink" href="#miauth" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.MiAuth"></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.MiAuth">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">MiAuth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'http'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'https'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.MiAuth" title="Link to this definition">#</a></dt>
<dd><p>Misskey v12以降のインスタンスで使用可能な認証方式です</p>
</dd></dl>
</section>
@ -12398,12 +12370,12 @@ async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.get
<li><a class="reference internal" href="#mipac.utils.util.Missing"><code class="docutils literal notranslate"><span class="pre">Missing</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#authclient">AuthClient</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient"><code class="docutils literal notranslate"><span class="pre">AuthClient</span></code></a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient.check_auth"><code class="docutils literal notranslate"><span class="pre">AuthClient.check_auth()</span></code></a></li>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient.get_auth_url"><code class="docutils literal notranslate"><span class="pre">AuthClient.get_auth_url()</span></code></a></li>
<li><a class="reference internal" href="#imiauthpayload">IMiAuthPayload</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.IMiAuthPayload"><code class="docutils literal notranslate"><span class="pre">IMiAuthPayload</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#miauth">MiAuth</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.MiAuth"><code class="docutils literal notranslate"><span class="pre">MiAuth</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#setup-logging">setup_logging</a><ul>

Binary file not shown.

File diff suppressed because one or more lines are too long

@ -270,11 +270,11 @@
<li><a href="index.html#mipac.manager.admins.roles.AdminRolesManager">AdminRolesManager (mipac.manager.admins.roles のクラス)</a>
</li>
<li><a href="index.html#mipac.manager.admins.roles.AdminRolesModelManager">AdminRolesModelManager (mipac.manager.admins.roles のクラス)</a>
</li>
<li><a href="index.html#mipac.actions.admins.user.AdminUserActions">AdminUserActions (mipac.actions.admins.user のクラス)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.admins.user.AdminUserActions">AdminUserActions (mipac.actions.admins.user のクラス)</a>
</li>
<li><a href="index.html#mipac.manager.admins.user.AdminUserManager">AdminUserManager (mipac.manager.admins.user のクラス)</a>
</li>
<li><a href="index.html#mipac.models.channel.Channel.allow_renote_to_external">allow_renote_to_external (mipac.models.channel.Channel のプロパティ)</a>
@ -336,8 +336,6 @@
<li><a href="index.html#mipac.actions.admins.roles.AdminRoleModelActions.assign">assign() (mipac.actions.admins.roles.AdminRoleModelActions のメソッド)</a>
</li>
<li><a href="index.html#mipac.types.page.AttachedFilePayload">AttachedFilePayload (mipac.types.page のクラス)</a>
</li>
<li><a href="index.html#mipac.utils.auth.AuthClient">AuthClient (mipac.utils.auth のクラス)</a>
</li>
<li><a href="index.html#mipac.models.note.Note.author">author (mipac.models.note.Note のプロパティ)</a>
</li>
@ -442,8 +440,6 @@
<li><a href="index.html#mipac.actions.chart.ChartActions">ChartActions (mipac.actions.chart のクラス)</a>
</li>
<li><a href="index.html#mipac.manager.chart.ChartManager">ChartManager (mipac.manager.chart のクラス)</a>
</li>
<li><a href="index.html#mipac.utils.auth.AuthClient.check_auth">check_auth() (mipac.utils.auth.AuthClient のメソッド)</a>
</li>
<li><a href="index.html#mipac.actions.drive.files.FileActions.check_existence">check_existence() (mipac.actions.drive.files.FileActions のメソッド)</a>
</li>
@ -905,8 +901,6 @@
<li><a href="index.html#mipac.actions.drive.files.SharedFileActions.get_attached_notes">(mipac.actions.drive.files.SharedFileActions のメソッド)</a>
</li>
</ul></li>
<li><a href="index.html#mipac.utils.auth.AuthClient.get_auth_url">get_auth_url() (mipac.utils.auth.AuthClient のメソッド)</a>
</li>
<li><a href="index.html#mipac.utils.cache.get_cache_key">get_cache_key() (mipac.utils.cache モジュール)</a>
</li>
<li><a href="index.html#mipac.actions.my.MyActions.get_claim_achievement">get_claim_achievement() (mipac.actions.my.MyActions のメソッド)</a>
@ -943,14 +937,14 @@
<li><a href="index.html#mipac.actions.user.SharedUserActions.get_followers">(mipac.actions.user.SharedUserActions のメソッド)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.user.ClientUserActions.get_following">get_following() (mipac.actions.user.ClientUserActions のメソッド)</a>
<ul>
<li><a href="index.html#mipac.actions.user.SharedUserActions.get_following">(mipac.actions.user.SharedUserActions のメソッド)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.actions.user.ClientUserActions.get_frequently_replied_users">get_frequently_replied_users() (mipac.actions.user.ClientUserActions のメソッド)</a>
<ul>
@ -1176,6 +1170,8 @@
<li><a href="index.html#mipac.types.roles.IMeRole">IMeRole (mipac.types.roles のクラス)</a>
</li>
<li><a href="index.html#mipac.types.meta.IMeta">IMeta (mipac.types.meta のクラス)</a>
</li>
<li><a href="index.html#mipac.utils.auth.IMiAuthPayload">IMiAuthPayload (mipac.utils.auth のクラス)</a>
</li>
<li><a href="index.html#mipac.types.admin.IModerationLog">IModerationLog (mipac.types.admin のクラス)</a>
</li>
@ -1196,11 +1192,11 @@
<li><a href="index.html#mipac.types.note.INoteState">INoteState (mipac.types.note のクラス)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteTranslateResult">INoteTranslateResult (mipac.types.note のクラス)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdated">INoteUpdated (mipac.types.note のクラス)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.types.note.INoteUpdated">INoteUpdated (mipac.types.note のクラス)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdatedDelete">INoteUpdatedDelete (mipac.types.note のクラス)</a>
</li>
<li><a href="index.html#mipac.types.note.INoteUpdatedDeleteBody">INoteUpdatedDeleteBody (mipac.types.note のクラス)</a>
@ -1388,6 +1384,8 @@
<li><a href="index.html#mipac.models.roles.MeRole">MeRole (mipac.models.roles のクラス)</a>
</li>
<li><a href="index.html#mipac.models.meta.Meta">Meta (mipac.models.meta のクラス)</a>
</li>
<li><a href="index.html#mipac.utils.auth.MiAuth">MiAuth (mipac.utils.auth のクラス)</a>
</li>
<li><a href="index.html#mipac.file.MiFile">MiFile (mipac.file のクラス)</a>
</li>
@ -1396,11 +1394,11 @@
<li><a href="index.html#mipac.utils.util.Missing">Missing (mipac.utils.util のクラス)</a>
</li>
<li><a href="index.html#mipac.http.MisskeyClientWebSocketResponse">MisskeyClientWebSocketResponse (mipac.http のクラス)</a>
</li>
<li><a href="index.html#mipac.utils.util.MiTime">MiTime (mipac.utils.util のクラス)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#mipac.utils.util.MiTime">MiTime (mipac.utils.util のクラス)</a>
</li>
<li><a href="index.html#mipac.models.admin.ModerationLog">ModerationLog (mipac.models.admin のクラス)</a>
</li>
<li><a href="index.html#mipac.errors.errors.MoSuchFileError">MoSuchFileError (mipac.errors.errors のクラス)</a>

@ -9958,48 +9958,20 @@ when the function is used.</p>
<dd></dd></dl>
</section>
<section id="authclient">
<h3>AuthClient<a class="headerlink" href="#authclient" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.AuthClient"><div class="py-attribute-table-column">
<span>
Methods</span><ul>
<li class="py-attribute-table-entry">
<span class="py-attribute-table-badge" title="coroutine">
async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.check_auth">check_auth</a></li><li class="py-attribute-table-entry">
<span class="py-attribute-table-badge" title="coroutine">
async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.get_auth_url">get_auth_url</a></li></ul>
</div></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">AuthClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_uri</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_miauth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.AuthClient" title="Link to this definition">#</a></dt>
<dd><p>Tokenの取得を手助けするクラス</p>
<dl class="py method">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient.check_auth">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_auth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.auth.AuthClient.check_auth" title="Link to this definition">#</a></dt>
<dd><p>認証が完了するまで待機し、完了した場合はTokenを返します</p>
<dl class="field-list simple">
<dt class="field-odd">戻り値<span class="colon">:</span></dt>
<dd class="field-odd"><p>Token</p>
</dd>
<dt class="field-even">戻り値の型<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mipac.utils.auth.AuthClient.get_auth_url">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_auth_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.auth.AuthClient.get_auth_url" title="Link to this definition">#</a></dt>
<dd><p>認証に使用するURLを取得します</p>
<dl class="field-list simple">
<dt class="field-odd">戻り値<span class="colon">:</span></dt>
<dd class="field-odd"><p>認証に使用するURL</p>
</dd>
<dt class="field-even">戻り値の型<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<section id="imiauthpayload">
<h3>IMiAuthPayload<a class="headerlink" href="#imiauthpayload" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.IMiAuthPayload"></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.IMiAuthPayload">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">IMiAuthPayload</span></span><a class="headerlink" href="#mipac.utils.auth.IMiAuthPayload" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</section>
<section id="miauth">
<h3>MiAuth<a class="headerlink" href="#miauth" title="Link to this heading">#</a></h3>
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.MiAuth"></div><dl class="py class">
<dt class="sig sig-object py" id="mipac.utils.auth.MiAuth">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">MiAuth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'http'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'https'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.MiAuth" title="Link to this definition">#</a></dt>
<dd><p>Misskey v12以降のインスタンスで使用可能な認証方式です</p>
</dd></dl>
</section>
@ -12398,12 +12370,12 @@ async</span><a class="reference internal" href="#mipac.utils.auth.AuthClient.get
<li><a class="reference internal" href="#mipac.utils.util.Missing"><code class="docutils literal notranslate"><span class="pre">Missing</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#authclient">AuthClient</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient"><code class="docutils literal notranslate"><span class="pre">AuthClient</span></code></a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient.check_auth"><code class="docutils literal notranslate"><span class="pre">AuthClient.check_auth()</span></code></a></li>
<li><a class="reference internal" href="#mipac.utils.auth.AuthClient.get_auth_url"><code class="docutils literal notranslate"><span class="pre">AuthClient.get_auth_url()</span></code></a></li>
<li><a class="reference internal" href="#imiauthpayload">IMiAuthPayload</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.IMiAuthPayload"><code class="docutils literal notranslate"><span class="pre">IMiAuthPayload</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#miauth">MiAuth</a><ul>
<li><a class="reference internal" href="#mipac.utils.auth.MiAuth"><code class="docutils literal notranslate"><span class="pre">MiAuth</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#setup-logging">setup_logging</a><ul>

Binary file not shown.

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save