evennia/docs/latest/api/evennia.contrib.utils.debugpy.cmd.html
Evennia docbuilder action 39c2217887 Updated HTML docs.
2025-07-01 08:22:33 +00:00

212 lines
No EOL
11 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>evennia.contrib.utils.debugpy.cmd &#8212; Evennia latest documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.utils.fieldfill" href="evennia.contrib.utils.fieldfill.html" />
<link rel="prev" title="evennia.contrib.utils.debugpy" href="evennia.contrib.utils.debugpy.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.fieldfill.html" title="evennia.contrib.utils.fieldfill"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.debugpy.html" title="evennia.contrib.utils.debugpy"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.debugpy.html" accesskey="U">evennia.contrib.utils.debugpy</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.debugpy.cmd</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.utils.debugpy.html"
title="previous chapter">evennia.contrib.utils.debugpy</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.utils.fieldfill.html"
title="next chapter">evennia.contrib.utils.fieldfill</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.utils.debugpy.cmd.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li><a href="evennia.contrib.utils.debugpy.cmd.html">latest (main branch)</a></li>
<li><a href="../5.x/index.html">v5.0.0 branch (outdated)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.utils.debugpy.cmd">
<span id="evennia-contrib-utils-debugpy-cmd"></span><h1>evennia.contrib.utils.debugpy.cmd<a class="headerlink" href="#module-evennia.contrib.utils.debugpy.cmd" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.utils.debugpy.cmd.</code><code class="sig-name descname">CmdDebugPy</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/debugpy/cmd.html#CmdDebugPy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>Launch debugpy debugger and wait for attach on port 5678</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>debugpy</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.key">
<code class="sig-name descname">key</code><em class="property"> = 'debugpy'</em><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(debugpy) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/debugpy/cmd.html#CmdDebugPy.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.func" title="Permalink to this definition"></a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(debugpy) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.utils.debugpy.cmd.CmdDebugPy.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'debugpy', 'no_prefix': ' ', 'tags': '', 'text': '\n Launch debugpy debugger and wait for attach on port 5678\n\n Usage:\n debugpy\n '}</em><a class="headerlink" href="#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.fieldfill.html" title="evennia.contrib.utils.fieldfill"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.debugpy.html" title="evennia.contrib.utils.debugpy"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.debugpy.html" >evennia.contrib.utils.debugpy</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.debugpy.cmd</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>