[ { "path": ".coveragerc", "content": "[run]\ninclude =\n */irc3/*.py\n */irc3/*/*.py\nomit =\n conftest.py\n .tox/*\n tests/*\n docs/conf.py\n */examples/social*\n */examples/mycrons*\n */examples/mycommands*\n */examples/myextends*\n */examples/nickserv*\n */examples/freenode*\n */irc3/template/plugin*\n */irc3/_gen_doc*\n */irc3/_parse_rfc*\n */site-packages*\n */lib/python*\n */lib-python*\n */lib_pypy*\n\n[report]\nexclude_lines =\n pragma: no cover\n def __repr__\n raise NotImplementedError\n if __name__ == .__main__.:\n def parse_args\n" }, { "path": ".github/workflows/tox.yml", "content": "name: tox\n\non: [push, pull_request]\n\njobs:\n flake8-and-docs:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Setup Python\n uses: actions/setup-python@v4\n with:\n python-version: 3.12\n - name: Install Tox and any other packages\n run: pip install tox\n - name: Run flake8 / docs\n run: tox -e flake8,docs\n\n test:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python: [\"3.11\", \"3.12\", \"3.13\"]\n\n steps:\n - uses: actions/checkout@v4\n - name: Setup Python\n uses: actions/setup-python@v4\n with:\n python-version: ${{ matrix.python }}\n - name: Start Redis\n uses: supercharge/redis-github-action@1.8.1\n with:\n redis-version: 8\n - name: Install Tox and any other packages\n run: pip install tox\n - name: Run Tox\n run: tox -e py\n" }, { "path": ".gitignore", "content": "*~\n*.bck\nbin\nbuild\n_build\n.bzr\n.bzrignore\n.eggs\n.cache\n.chutifab\n.coverage\ncoverage*\ndevelop-eggs\ndist\ndownloads\n*.egg\n*.EGG\n*.egg-info\n*.EGG-INFO\neggs\nfake-eggs\n.hg\n.hgignore\n.idea\n.installed.cfg\nirssi_config\n*.jar\n*.mo\n.mr.developer.cfg\nnosetest*\n*.old\n*.orig\nparts\n*.pyc\n*.pyd\n*.pyo\n.ropeproject/\n*.so\nsrc\n.svn\n*.swp\n.tox\n*.tmp*\nvar\n*.wpr\n" }, { "path": "CHANGES.rst", "content": "1.1.11 (unreleased)\n===================\n\n- Nothing changed yet.\n\n\n1.1.10 (2023-04-17)\n===================\n\n- fix `shell_command` plugin\n\n\n1.1.9 (2023-02-27)\n==================\n\n- drop support for python 3.5\n\n- python 3.11 compat\n\n\n1.1.8 (2022-07-17)\n==================\n\n- Allow comma-separated chans in server userlist JOIN\n\n- python 3.10 compat\n\n- improve feeds plugin\n\n\n1.1.7 (2021-02-13)\n==================\n\n- Add sqlite storage.\n\n- Escape string that are interpolated into the regular expressions.\n\n\n1.1.6 (2020-05-13)\n==================\n\n- Allow to overrides config values via `os.environ`.\n\n\n1.1.5 (2020-01-18)\n==================\n\n- Allow to use `irc3.rfc.*` as `iotype='out'`\n\n- Use more pop in userlist to avoid bug when a weird event occurs\n\n1.1.4 (2019-11-22)\n==================\n\n- Use pop in userlist to avoid bug when a weird event occurs\n\n- Expend filename path in logger plugin\n\n- Force latest venusian version\n\n\n1.1.3 (2019-08-22)\n==================\n\n- Rename async plugin to asynchronious so we can use it with python3.7\n\n\n1.1.2 (2019-02-28)\n==================\n\n- Allow to have more than one `[bot]` section in config file\n\n- IrcString now allow to retrieve username/hostname from mask\n\n\n1.1.1 (2018-09-22)\n==================\n\n- Do not show builtins command in help. Fixed #167\n\n\n1.1.0 (2018-07-30)\n==================\n\n- Backward incompatibility: async is renamed to asynchronous for py37 compat\n (thanks to @JulienPalard)\n\n- Except a KeyError on missing twitter configuration in social plugin\n\n1.0.3 (2018-05-08)\n==================\n\n- Add web plugin to allow to POST messages to channel via http\n\n- Add slack plugin\n\n- Avoid bug in userlist when a user parts before join (twitch)\n\n- Drop py33, py34 support\n\n1.0.2 (2017-11-13)\n==================\n\n- Add `irc3.__main__` to allow `python -m irc3 config.ini`\n\n\n1.0.1 (2017-11-11)\n==================\n\n- Add `command(error_format=callable)` argument.\n\n- Add ${#} as a shorter alias for ${hash}.\n\n- Bug fix in fifo plugin. We now remove the file first if it's not a pipe.\n\n- Fix some irc3d issues with QUIT and KICK command\n\n\n1.0.0 (2017-02-05)\n==================\n\n- Added storage.getlist()/setlist()\n\n- Improve autocommands\n\n\n0.9.8 (2017-01-03)\n==================\n\n- Command aliases support (#121)\n\n- Add quakenet plugin (#99)\n\n- Allow dash character in command\n\n\n0.9.7 (2016-12-07)\n==================\n\n- Added ``bot.async_cmds.topic()``\n\n- Use shlex to parse command args by default\n\n\n0.9.6 (2016-10-24)\n==================\n\n- Fixed #118: ssl context.check_hostname must be False when using CERT_NONE\n\n\n0.9.5 (2016-10-15)\n==================\n\n- ``.privmsg(nowait=True)`` now really don't wait\n\n- clean up some old py2/3 compat code\n\n0.9.4 (2016-09-15)\n==================\n\n- Added SASL Auth support\n\n0.9.3 (2016-05-31)\n==================\n\n- New release due to release problem (broken pypi)\n\n\n0.9.2 (2016-05-31)\n==================\n\n- Fixed flood_burst sending one extra line (#92)\n\n0.9.1 (2016-05-22)\n==================\n\n- Added autojoin_delay option. Handle reload in autojoin plugin.\n\n- Added flood_rate_delay option.\n\n- Added --help and --version CLI options.\n\n- Fixed #91 bug with command arguments and spaces\n\n0.9.0 (2016-04-20)\n==================\n\n- WARNING: we do no longer support python2. python3.3+ is required.\n\n- WARNING: realname is now username and userinfo is now realname in config\n\n- Introduce some plugins: fifo, shell_commands, pager\n\n- Add ``flood_burst`` and ``flood_rate`` options. Queue outgoing messages in a\n single queue handle by ``send_line('...', nowait=False)``.\n\n- ``bot.async`` is now aliased to ``bot.async_cmds`` to be able to use ``await``\n\n0.8.9 (2016-02-23)\n==================\n\n- use re.escape to escape command char\n\n\n0.8.8 (2016-01-27)\n==================\n\n- logger plugin now take care of unicode\n\n\n0.8.7 (2016-01-16)\n==================\n\n- fixed 76: split large messages using textwrap.wrap(). This will avoid RevQ\n exceeded.\n\n\n0.8.6 (2016-01-07)\n==================\n\n- fix DCC stuff for python3.5\n\n- added DCC examples at https://github.com/gawel/irc3/tree/master/examples\n\n\n0.8.5 (2015-12-22)\n==================\n\n- ${hash} is now replaced by # in config files. This allow to set real channel\n names.\n\n\n0.8.4 (2015-11-29)\n==================\n\n- added basic support for IRCv3.2 tags\n\n- fixed #78: plugin can be old style classes\n\n- fixed #75: Ensure we send the PING and PONG data as trailing\n\n- fixed #71: need to pass host and ip to dcc\n\n\n0.8.3 (2015-11-04)\n==================\n\n- fix wheel metadata\n\n- public command was not public if you're using a guard\n\n\n0.8.2 (2015-11-01)\n==================\n\n- Added !help nonexistant error message\n\n- Allow to hide commands from !help\n\n- Don't reject commands with trailing spaces\n\n- Allow to use coroutine guards\n\n- Make commands case insensitive\n\n- Add basic casefolding plugin\n\n- Prevent keyerror when setting keys that don't exist in cache.\n\n0.8.1 (2015-05-14)\n==================\n\n- Fixes bug in userlist plugin `#59 `_\n\n- Strip out self.context.config.cmd from !help arg. Allow to use !help !cmd\n `#57 `_\n\n\n0.8.0 (2015-04-19)\n==================\n\n- Added dcc send/get/chat implementation\n\n- Improved storage: can now test the existence of a key\n\n- irc.plugins.storage: `db['foo']` now will raise a `KeyError` if the key does\n not exist to match dictionary behaviour. This will **break** existing\n implementations that make use of this.\n\n- irc.plugins.storage now supports `db.get(key)` that will return either `None`\n or the value of an optional `default` argument.\n\n- irc3.plugins.feeds is now full async\n\n\n0.7.1 (2015-02-26)\n==================\n\n- Storage plugin documentation\n\n- Support python 3.4.1 again\n\n\n0.7.0 (2015-02-24)\n==================\n\n- the cron plugin now require\n `aiocron `_\n\n- Add `irc3.plugins.async`; Allow to `yield from bot.async.whois('gawel')`\n\n- commands and events can now be coroutines\n\n\n0.6.0 (2015-02-15)\n==================\n\n- Allow to reload modules/plugins\n\n- Add storage plugin\n\n- Fixed #34 Avoid newline injection.\n\n\n0.5.3 (2014-12-09)\n==================\n\n- Bugfix release. Fixed #27 and #30\n\n\n0.5.2 (2014-11-16)\n==================\n\n- Basic irc3d server\n\n- Modules reorganisation\n\n- Add S3 logger\n\n\n0.5.1 (2014-07-21)\n==================\n\n- Fixed #13: venusian 1.0 compat\n\n- Add antiflood option for the command plugin\n\n- commands accept unicode\n\n\n0.5.0 (2014-06-01)\n==================\n\n- Added ``bot.kick()`` and ``bot.mode()``\n\n- Rewrite ctcp plugin so we can ignore flood requests\n\n- Trigger ``{plugin}.server_ready()`` at the end of MOTD\n\n- Fixed #9: The ``command`` plugin uses ``cmd``, not ``cmdchar``.\n\n- Fixed #10. Store server config. Use STATUSMSG config if any in ``userlist``\n\n- ``userlist`` plugin now also store user modes per channel.\n\n- Rename ``add_event`` to ``attach_events`` and added ``detach_events``. This\n allow to add/remove events on the fly.\n\n- The autojoin plugin now detach motd related events after triggering one of\n them.\n\n- Fix compatibility with trollius 0.3\n\n\n0.4.10 (2014-05-21)\n===================\n\n- Fixed #5: autojoin on no motd\n\n- allow to show date/times in console log\n\n\n0.4.9 (2014-05-08)\n==================\n\n- Allow to trigger event on output with ``event(iotype='out')``\n\n- Add a channel logger plugin\n\n- autojoins is now a separate plugin\n\n- userlist plugin take care of kicks\n\n- social plugin is now officially supported and tested\n\n\n0.4.7 (2014-04-03)\n==================\n\n- IrcString use unicode with py2\n\n\n0.4.6 (2014-03-11)\n==================\n\n- Bug fix. The cron need a loop sooner as possible.\n\n\n0.4.5 (2014-02-25)\n==================\n\n- Bug fix. An event was run twice if more than one where using the same regexp\n\n\n0.4.4 (2014-02-15)\n==================\n\n- Add cron plugin\n\n- Improve the command plugin. Fix some security issue.\n\n- Add ``--help-page`` option to generate commands help pages\n\n\n0.4.3 (2014-01-10)\n==================\n\n- Fix a bug on connection_lost.\n\n- Send realname in USER command instead of nickname\n\n\n0.4.2 (2014-01-09)\n==================\n\n- python2.7 support.\n\n- add some plugins (ctcp, uptime, feeds, search)\n\n- add some examples/ (twitter, asterisk)\n\n- improve some internals\n\n0.4.1 (2013-12-30)\n==================\n\n- Depends on venusian 1.0a8\n\n\n0.1 (2013-11-30)\n================\n\n- Initial release\n" }, { "path": "CONTRIBUTING.rst", "content": "Contribute\n==========\n\nFirst, if you want to add a cool plugin, consider submit a pull request to the\n`irc3_plugins `_ instead of irc3 itself.\n\n\nFeel free to clone the project on `GitHub `_.\n\nTo test your change you can run irc3 in debug mode using::\n\n $ irc3 --debug path-to-your-conf.ini\n\nOnce you made a change, try to add a test for your feature/fix. At least assume\nthat you have'nt broke anything by running tox::\n\n $ tox\n ...\n py27: commands succeeded\n py32: commands succeeded\n py33: commands succeeded\n py34: commands succeeded\n flake8: commands succeeded\n docs: commands succeeded\n congratulations :)\n\n You can run tests for a specific version::\n\n $ tox -e py34\n\nThe `irc3.rfc` module is auto generated from `irc3/rfc1459.txt`. If you want to\nhack this file, you need to hack the parser in `irc3/_parse_rfc.py` (warning,\nit's ugly)\n\nYou can regenerate the module and docs by running::\n\n $ tox -e build\n\nYou can also build the docs with::\n\n $ tox -e docs\n\nAnd check the result::\n\n $ firefox .tox/docs/tmp/html/index.html\n\nThe project uses ``setuptools``, you can test-install it using `pip`:\n\n $ pip install .\n $ irc3 -h\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2016 Gael Pasgrimaud\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n" }, { "path": "MANIFEST.in", "content": "graft docs\nprune docs/_build\nprune .github/\ngraft examples\ngraft irc3\ngraft irc3d\ngraft tests\ninclude Makefile *.rst *.cfg *.ini *.txt\nglobal-exclude *.pyc *.swp\nglobal-exclude __pycache__\ninclude conftest.py\nexclude .installed.cfg\nexclude .coveragerc\nexclude update.sh\nexclude Dockerfile\nexclude docker\nexclude docker/Dockerfile\nexclude docker/Makefile\ninclude LICENSE\n" }, { "path": "Makefile", "content": "APP:=$(shell basename `pwd`)\nHOSTNAME:=$(shell hostname)\nHOST:=amandine\nPYTHON?=$(HOME)/.venvs/py3/bin/python3\n\nbuild:\n\tdocker build -t gawel/irc3 .\n\nvenv:\n\t $(PYTHON) -m venv venv\n\t./venv/bin/pip install -e .[test,web]\n\nrun: venv\n\t./venv/bin/irc3 config.ini\n\nupgrade: venv\nifeq ($(HOSTNAME), $(HOST))\n\tgit pull origin master\n\t~/apps/bin/circusctl restart $(APP)\nelse\n\tgit push origin master\n\tssh $(HOST) \"cd ~/apps/$(APP) && make upgrade\"\nendif\n\n\n" }, { "path": "README.rst", "content": "============================================================\nirc3. pluggable irc client library based on python's asyncio\n============================================================\n\n.. image:: https://github.com/gawel/irc3/actions/workflows/tox.yml/badge.svg\n :target: https://github.com/gawel/irc3/actions/workflows/tox.yml\n.. image:: https://coveralls.io/repos/gawel/irc3/badge.png?branch=master\n :target: https://coveralls.io/r/gawel/irc3?branch=master\n\nA pluggable irc client library based on python's `asyncio\n`_.\n\n\n.. image:: https://raw.githubusercontent.com/gawel/irc3/master/docs/_static/logo.png\n :width: 100\n :height: 100\n :align: center\n :alt: Ceative Commons – Attribution (CC BY 3.0) - Hydra designed by Huu Nguyen from the Noun Project - http://thenounproject.com/term/hydra/46963/\n :target: http://thenounproject.com/term/hydra/46963/\n\n\nRequires python 3.11+\n\nPython 2 is no longer supported, but if you don't have a choice you can use\nan older version::\n\n $ pip install \"irc3<0.9\"\n\nSource: https://github.com/gawel/irc3/\n\nDocs: https://irc3.readthedocs.io/\n\nIrc: irc://irc.freenode.net/irc3 (`www\n`_)\n\n\nI've spent hours writing this software, with love.\nPlease consider tipping if you like it:\n\nBTC: 1PruQAwByDndFZ7vTeJhyWefAghaZx9RZg\n\nETH: 0xb6418036d8E06c60C4D91c17d72Df6e1e5b15CE6\n\nLTC: LY6CdZcDbxnBX9GFBJ45TqVj8NykBBqsmT\n" }, { "path": "conftest.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3 import testing\nimport pytest\nimport sys\nimport os\n\ntry:\n from redis.exceptions import ConnectionError\n from redis.client import StrictRedis\n StrictRedis().flushdb()\nexcept (ImportError, ConnectionError):\n import re\n req_redis = re.compile(r\".*#[^#]*\\s*require?\\s*redis\\s*$\", re.IGNORECASE)\n\n def pytest_runtest_setup(item):\n if getattr(item, 'dtest', None):\n if any(req_redis.match(e.source) for e in item.dtest.examples):\n pytest.skip(\"No redis server is running\")\n\ndirname = os.path.dirname(__file__)\nsys.path.append(os.path.join(dirname, 'examples'))\n\n\n@pytest.fixture(scope=\"function\")\ndef cls_event_loop(request, event_loop):\n request.cls.loop = event_loop\n request.cls.config['loop'] = event_loop\n yield\n request.cls.config.pop('loop')\n\n\n@pytest.fixture(scope=\"function\")\ndef irc3_bot_factory(request, event_loop):\n def _bot(**config):\n config['loop'] = event_loop\n _b['b'] = testing.IrcBot(**config)\n return _b['b']\n _b = {}\n yield _bot\n _b['b'].SIGINT()\n" }, { "path": "docker/Dockerfile", "content": "FROM python:3.7\n\nRUN adduser --disabled-password --gecos '' irc3\n\nRUN echo build \\\n && cd /usr/src && git clone https://github.com/gawel/irc3.git \\\n && cd /usr/src/irc3 && pip install ipython && pip install -e .[test] \\\n && mkdir -p /usr/src/bot && chown -R irc3:irc3 /usr/src/bot\n\nWORKDIR /usr/src/bot\n\nONBUILD COPY . /usr/src/bot\n\nUSER irc3\n\nCMD [\"/usr/local/bin/irc3\", \"config.ini\"]\n" }, { "path": "docker/Makefile", "content": "build:\n\tdocker build --rm=true -f Dockerfile -t irc3:latest .\n\nrun:\n\tdocker run -v $(PWD)/../:/usr/src/bot -v $(HOME)/.irc3:/home/irc3/.irc3 irc3:latest irc3 examples/dev.ini\n" }, { "path": "docs/Makefile", "content": "# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = ../bin/sphinx-build\nPAPER =\nBUILDDIR = _build\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make ' where is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\t-rm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/irc3.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/irc3.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/irc3\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/irc3\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n" }, { "path": "docs/conf.py", "content": "# -*- coding: utf-8 -*-\n#\n# irc3 documentation build configuration file, created by\n# sphinx-quickstart on Mon Nov 25 01:03:01 2013.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys, os\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#sys.path.insert(0, os.path.abspath('.'))\n\n# -- General configuration -----------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'irc3'\ncopyright = '2013, Gael Pasgrimaud'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = ''\n# The full version, including alpha/beta/rc tags.\nrelease = ''\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'nature'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \" v documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'irc3doc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'irc3.tex', 'irc3 Documentation',\n 'Gael Pasgrimaud', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output --------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('index', 'irc3', 'irc3 Documentation',\n ['Gael Pasgrimaud'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output ------------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n ('index', 'irc3', 'irc3 Documentation',\n 'Gael Pasgrimaud', 'irc3', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\nfrom importlib.metadata import version\nversion = version(\"irc3\")\nrelease = version\n" }, { "path": "docs/dcc.rst", "content": "========================\n:mod:`irc3.dcc` DCC\n========================\n\nSee :func:`~irc3.IrcBot.dcc_chat`, :func:`~irc3.IrcBot.dcc_get` and\n:func:`~irc3.IrcBot.dcc_send`\n\nHere is a simple plugin to send a generated file:\n\n.. literalinclude:: ../examples/dcc_send.py\n\nAPI\n===\n\n.. automodule:: irc3.dcc\n\n.. autoclass:: DCCManager\n :members:\n\n.. autoclass:: DCCChat\n :members:\n\n.. autoclass:: DCCSend\n :members:\n\n.. autoclass:: DCCGet\n :members:\n" }, { "path": "docs/dec.rst", "content": "============================\n:mod:`irc3.dec` decorators\n============================\n\n.. automodule:: irc3.dec\n\nplugin\n======\n\n.. autofunction:: plugin\n\nbot event\n=========\n\n.. autoclass:: event\n\nbot extend\n==========\n\n.. autofunction:: extend\n" }, { "path": "docs/hack.rst", "content": ".. include:: ../CONTRIBUTING.rst\n" }, { "path": "docs/index.rst", "content": ".. include:: ../README.rst\n\nInstallation\n==============\n\nUsing pip::\n\n $ pip install irc3\n\nQuick start\n===========\n\nirc3 provides a basic template to help you to quickly test a bot.\nHere is how to create a bot named ``mybot``.\n\nCreate a new directory and cd to it:\n\n.. code-block:: sh\n\n $ mkdir mybot\n $ cd mybot\n\nThen use the template:\n\n.. code-block:: sh\n\n $ python -m irc3.template mybot\n\nThis will create an almost ready to use ``config.ini`` file and a simple\nplugin named ``mybot_plugin.py`` that says «Hi» when the bot or someone else joins a\nchannel and includes an ``echo`` command.\n\nHere is what the config file will looks like:\n\n.. literalinclude:: ../examples/config.ini\n :language: ini\n\nAnd here is the plugin:\n\n.. literalinclude:: ../examples/mybot_plugin.py\n\nHave a look at those file and edit the config file for your needs.\nYou may have to edit:\n\n- the autojoin channel\n\n- your irc mask in the ``irc3.plugins.command.mask`` section\n\nOnce you're done with editing, run:\n\n.. code-block:: sh\n\n $ irc3 config.ini\n\nCheck the help of the ``irc3`` command.\n\n.. code-block:: sh\n\n $ irc3 -h\n\nIf you're enjoying it, you can check for more detailed docs below. And some\nmore examples here: https://github.com/gawel/irc3/tree/master/examples\n\nDocumentation\n=============\n\n.. toctree::\n :maxdepth: 2\n :glob:\n\n dec\n utils\n rfc\n dcc\n reloadable\n plugins/*\n hack\n\n\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n" }, { "path": "docs/irc3.rst", "content": "\n============================\n:mod:`irc3` Irc bot\n============================\n\n.. automodule:: irc3\n\nIrcBot\n======\n\n.. autoclass:: IrcBot\n :members:\n :inherited-members:\n\n .. autoattribute:: defaults\n\nIrcConnection\n=============\n\n.. autoclass:: IrcConnection\n :members:\n" }, { "path": "docs/plugins/asynchronious.rst", "content": ".. automodule:: irc3.plugins.asynchronious\n\n" }, { "path": "docs/plugins/autocommand.rst", "content": ".. automodule:: irc3.plugins.autocommand\n\n" }, { "path": "docs/plugins/autojoins.rst", "content": ".. automodule:: irc3.plugins.autojoins\n\n" }, { "path": "docs/plugins/casefold.rst", "content": ".. automodule:: irc3.plugins.casefold\n\n" }, { "path": "docs/plugins/command.rst", "content": ".. automodule:: irc3.plugins.command\n\n" }, { "path": "docs/plugins/core.rst", "content": ".. automodule:: irc3.plugins.core\n\n" }, { "path": "docs/plugins/cron.rst", "content": ".. automodule:: irc3.plugins.cron\n\n" }, { "path": "docs/plugins/ctcp.rst", "content": ".. automodule:: irc3.plugins.ctcp\n\n" }, { "path": "docs/plugins/dcc.rst", "content": ".. automodule:: irc3.plugins.dcc\n\n" }, { "path": "docs/plugins/feeds.rst", "content": ".. automodule:: irc3.plugins.feeds\n\n" }, { "path": "docs/plugins/fifo.rst", "content": ".. automodule:: irc3.plugins.fifo\n\n" }, { "path": "docs/plugins/human.rst", "content": ".. automodule:: irc3.plugins.human\n\n" }, { "path": "docs/plugins/log.rst", "content": ".. automodule:: irc3.plugins.log\n\n" }, { "path": "docs/plugins/logger.rst", "content": ".. automodule:: irc3.plugins.logger\n\n" }, { "path": "docs/plugins/pager.rst", "content": ".. automodule:: irc3.plugins.pager\n\n" }, { "path": "docs/plugins/quakenet.rst", "content": ".. automodule:: irc3.plugins.quakenet\n\n" }, { "path": "docs/plugins/sasl.rst", "content": ".. automodule:: irc3.plugins.sasl\n\n" }, { "path": "docs/plugins/search.rst", "content": ".. automodule:: irc3.plugins.search\n\n" }, { "path": "docs/plugins/shell_command.rst", "content": ".. automodule:: irc3.plugins.shell_command\n\n" }, { "path": "docs/plugins/slack.rst", "content": ".. automodule:: irc3.plugins.slack\n\n" }, { "path": "docs/plugins/social.rst", "content": ".. automodule:: irc3.plugins.social\n\n" }, { "path": "docs/plugins/storage.rst", "content": ".. automodule:: irc3.plugins.storage\n\n" }, { "path": "docs/plugins/uptime.rst", "content": ".. automodule:: irc3.plugins.uptime\n\n" }, { "path": "docs/plugins/userlist.rst", "content": ".. automodule:: irc3.plugins.userlist\n\n" }, { "path": "docs/plugins/web.rst", "content": ".. automodule:: irc3.plugins.web\n\n" }, { "path": "docs/reloadable.rst", "content": "Reloadable plugins\n==================\n\n.. note:: if you just want the bot to restart when you change a file during\n development you can use `hupper `_::\n\n $ pip install hupper\n $ hupper -m irc3 config.ini\n\nirc3 provides a way to reload plugins without restarting the bot.\n\nTo do that, your plugin should provide a ``reload`` class method::\n\n class Plugin(object):\n\n def __init__(self, bot):\n self.bot = bot\n\n @classmethod\n def reload(cls, old):\n \"\"\"this method should return a ready to use plugin instance.\n cls is the newly reloaded class. old is the old instance.\n \"\"\"\n return cls(old.bot)\n\nPlugins can also implement a few hooks to help take care of reloads::\n\n class Plugin(object):\n\n def __init__(self, bot):\n self.bot = bot\n\n def before_reload(self):\n \"\"\"Do stuff before reload\"\"\"\n\n def after_reload(self):\n \"\"\"Do stuff after reload\"\"\"\n\n..\n >>> from irc3.testing import IrcBot\n >>> bot = IrcBot(includes=['mycommands'])\n\nTo reload a plugin, just call the :func:`~irc3.IrcBot.reload` method with\nmodule name(s) to reload::\n\n >>> bot.reload('mycommands')\n" }, { "path": "docs/rfc.rst", "content": "========================\n:mod:`irc3.rfc` RFC1459\n========================\n\nReplies (REPL)\n==============\n\n259 - RPL_ADMINEMAIL\n--------------------\n\nFormat ``:{srv} 259 {nick} :{admin_info}``\n\nMatch ``^:(?P\\S+) 259 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ADMINEMAIL)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n257 - RPL_ADMINLOC1\n-------------------\n\nFormat ``:{srv} 257 {nick} :{admin_info}``\n\nMatch ``^:(?P\\S+) 257 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ADMINLOC1)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n258 - RPL_ADMINLOC2\n-------------------\n\nFormat ``:{srv} 258 {nick} :{admin_info}``\n\nMatch ``^:(?P\\S+) 258 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ADMINLOC2)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n256 - RPL_ADMINME\n-----------------\n\nFormat ``:{srv} 256 {nick} {server} :Administrative info``\n\nMatch ``^:(?P\\S+) 256 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ADMINME)\n def myevent(bot, srv=None, me=None, server=None, data=None):\n # do something\n\n301 - RPL_AWAY\n--------------\n\nFormat ``:{srv} 301 {nick} {nick} :{away_message}``\n\nMatch ``^:(?P\\S+) 301 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_AWAY)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n367 - RPL_BANLIST\n-----------------\n\nFormat ``:{srv} 367 {nick} {channel} {banid}``\n\nMatch ``^:(?P\\S+) 367 (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_BANLIST)\n def myevent(bot, srv=None, me=None, channel=None, banid=None):\n # do something\n\n324 - RPL_CHANNELMODEIS\n-----------------------\n\nFormat ``:{srv} 324 {nick} {channel} {mode} {mode_params}``\n\nMatch ``^:(?P\\S+) 324 (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_CHANNELMODEIS)\n def myevent(bot, srv=None, me=None, channel=None, mode=None, mode_params=None):\n # do something\n\n368 - RPL_ENDOFBANLIST\n----------------------\n\nFormat ``:{srv} 368 {nick} {channel} :End of channel ban list``\n\nMatch ``^:(?P\\S+) 368 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFBANLIST)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n374 - RPL_ENDOFINFO\n-------------------\n\nFormat ``:{srv} 374 {nick} :End of /INFO list``\n\nMatch ``^:(?P\\S+) 374 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFINFO)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n365 - RPL_ENDOFLINKS\n--------------------\n\nFormat ``:{srv} 365 {nick} {mask} :End of /LINKS list``\n\nMatch ``^:(?P\\S+) 365 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFLINKS)\n def myevent(bot, srv=None, me=None, mask=None, data=None):\n # do something\n\n376 - RPL_ENDOFMOTD\n-------------------\n\nFormat ``:{srv} 376 {nick} :End of /MOTD command``\n\nMatch ``^:(?P\\S+) 376 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFMOTD)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n366 - RPL_ENDOFNAMES\n--------------------\n\nFormat ``:{srv} 366 {nick} {channel} :End of /NAMES list``\n\nMatch ``^:(?P\\S+) 366 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFNAMES)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n219 - RPL_ENDOFSTATS\n--------------------\n\nFormat ``:{srv} 219 {nick} {stats_letter} :End of /STATS report``\n\nMatch ``^:(?P\\S+) 219 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFSTATS)\n def myevent(bot, srv=None, me=None, stats_letter=None, data=None):\n # do something\n\n394 - RPL_ENDOFUSERS\n--------------------\n\nFormat ``:{srv} 394 {nick} :End of users``\n\nMatch ``^:(?P\\S+) 394 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFUSERS)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n315 - RPL_ENDOFWHO\n------------------\n\nFormat ``:{srv} 315 {nick} {nick} :End of /WHO list``\n\nMatch ``^:(?P\\S+) 315 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFWHO)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n318 - RPL_ENDOFWHOIS\n--------------------\n\nFormat ``:{srv} 318 {nick} {nick} :End of /WHOIS list``\n\nMatch ``^:(?P\\S+) 318 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFWHOIS)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n369 - RPL_ENDOFWHOWAS\n---------------------\n\nFormat ``:{srv} 369 {nick} {nick} :End of WHOWAS``\n\nMatch ``^:(?P\\S+) 369 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ENDOFWHOWAS)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n371 - RPL_INFO\n--------------\n\nFormat ``:{srv} 371 {nick} :{string}``\n\nMatch ``^:(?P\\S+) 371 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_INFO)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n341 - RPL_INVITING\n------------------\n\nFormat ``:{srv} 341 {nick} {channel} {nick}``\n\nMatch ``^:(?P\\S+) 341 (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_INVITING)\n def myevent(bot, srv=None, me=None, channel=None, nick=None):\n # do something\n\n303 - RPL_ISON\n--------------\n\nFormat ``:{srv} 303 {nick} :{nicknames}``\n\nMatch ``^:(?P\\S+) 303 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_ISON)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n364 - RPL_LINKS\n---------------\n\nFormat ``:{srv} 364 {nick} {mask} {server} :{hopcount} {server_info}``\n\nMatch ``^:(?P\\S+) 364 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LINKS)\n def myevent(bot, srv=None, me=None, mask=None, server=None, data=None):\n # do something\n\n322 - RPL_LIST\n--------------\n\nFormat ``:{srv} 322 {nick} {channel} {visible} :{topic}``\n\nMatch ``^:(?P\\S+) 322 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LIST)\n def myevent(bot, srv=None, me=None, channel=None, visible=None, data=None):\n # do something\n\n323 - RPL_LISTEND\n-----------------\n\nFormat ``:{srv} 323 {nick} :End of /LIST``\n\nMatch ``^:(?P\\S+) 323 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LISTEND)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n321 - RPL_LISTSTART\n-------------------\n\nFormat ``:{srv} 321 {nick} Channel :Users Name``\n\nMatch ``^:(?P\\S+) 321 (?P\\S+) Channel :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LISTSTART)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n254 - RPL_LUSERCHANNELS\n-----------------------\n\nFormat ``:{srv} 254 {nick} {x} :channels formed``\n\nMatch ``^:(?P\\S+) 254 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LUSERCHANNELS)\n def myevent(bot, srv=None, me=None, x=None, data=None):\n # do something\n\n251 - RPL_LUSERCLIENT\n---------------------\n\nFormat ``:{srv} 251 {nick} :There are {x} users and {y} invisible on {z} servers``\n\nMatch ``^:(?P\\S+) 251 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LUSERCLIENT)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n255 - RPL_LUSERME\n-----------------\n\nFormat ``:{srv} 255 {nick} :I have {x} clients and {y}``\n\nMatch ``^:(?P\\S+) 255 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LUSERME)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n252 - RPL_LUSEROP\n-----------------\n\nFormat ``:{srv} 252 {nick} {x} :operator(s) online``\n\nMatch ``^:(?P\\S+) 252 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LUSEROP)\n def myevent(bot, srv=None, me=None, x=None, data=None):\n # do something\n\n253 - RPL_LUSERUNKNOWN\n----------------------\n\nFormat ``:{srv} 253 {nick} {x} :unknown connection(s)``\n\nMatch ``^:(?P\\S+) 253 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_LUSERUNKNOWN)\n def myevent(bot, srv=None, me=None, x=None, data=None):\n # do something\n\n372 - RPL_MOTD\n--------------\n\nFormat ``:{srv} 372 {nick} :- {text}``\n\nMatch ``^:(?P\\S+) 372 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_MOTD)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n375 - RPL_MOTDSTART\n-------------------\n\nFormat ``:{srv} 375 {nick} :- {server} Message of the day -``\n\nMatch ``^:(?P\\S+) 375 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_MOTDSTART)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n353 - RPL_NAMREPLY\n------------------\n\nFormat ``:{srv} 353 {nick} {m} {channel} :{nicknames}``\n\nMatch ``^:(?P\\S+) 353 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_NAMREPLY)\n def myevent(bot, srv=None, me=None, m=None, channel=None, data=None):\n # do something\n\n331 - RPL_NOTOPIC\n-----------------\n\nFormat ``:{srv} 331 {nick} {channel} :No topic is set``\n\nMatch ``^:(?P\\S+) 331 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_NOTOPIC)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n395 - RPL_NOUSERS\n-----------------\n\nFormat ``:{srv} 395 {nick} :Nobody logged in``\n\nMatch ``^:(?P\\S+) 395 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_NOUSERS)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n306 - RPL_NOWAWAY\n-----------------\n\nFormat ``:{srv} 306 {nick} :You have been marked as being away``\n\nMatch ``^:(?P\\S+) 306 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_NOWAWAY)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n382 - RPL_REHASHING\n-------------------\n\nFormat ``:{srv} 382 {nick} {config_file} :Rehashing``\n\nMatch ``^:(?P\\S+) 382 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_REHASHING)\n def myevent(bot, srv=None, me=None, config_file=None, data=None):\n # do something\n\n213 - RPL_STATSCLINE\n--------------------\n\nFormat ``:{srv} 213 {nick} C {host} * {nick} {port} {class}``\n\nMatch ``^:(?P\\S+) 213 (?P\\S+) C (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSCLINE)\n def myevent(bot, srv=None, me=None, host=None, nick=None, port=None, class=None):\n # do something\n\n212 - RPL_STATSCOMMANDS\n-----------------------\n\nFormat ``:{srv} 212 {nick} {cmd} {count}``\n\nMatch ``^:(?P\\S+) 212 (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSCOMMANDS)\n def myevent(bot, srv=None, me=None, cmd=None, count=None):\n # do something\n\n244 - RPL_STATSHLINE\n--------------------\n\nFormat ``:{srv} 244 {nick} H {hostmask} * {servername}``\n\nMatch ``^:(?P\\S+) 244 (?P\\S+) H (?P\\S+) . (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSHLINE)\n def myevent(bot, srv=None, me=None, hostmask=None, servername=None):\n # do something\n\n215 - RPL_STATSILINE\n--------------------\n\nFormat ``:{srv} 215 {nick} I {host} * {host1} {port} {class}``\n\nMatch ``^:(?P\\S+) 215 (?P\\S+) I (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSILINE)\n def myevent(bot, srv=None, me=None, host=None, host1=None, port=None, class=None):\n # do something\n\n216 - RPL_STATSKLINE\n--------------------\n\nFormat ``:{srv} 216 {nick} K {host} * {username} {port} {class}``\n\nMatch ``^:(?P\\S+) 216 (?P\\S+) K (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSKLINE)\n def myevent(bot, srv=None, me=None, host=None, username=None, port=None, class=None):\n # do something\n\n211 - RPL_STATSLINKINFO\n-----------------------\n\nFormat ``:{srv} 211 {nick} :{linkname} {sendq} {sent_messages} {received_bytes} {time_open}``\n\nMatch ``^:(?P\\S+) 211 (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSLINKINFO)\n def myevent(bot, srv=None, me=None, linkname=None, sendq=None, sent_messages=None, received_bytes=None, time_open=None):\n # do something\n\n241 - RPL_STATSLLINE\n--------------------\n\nFormat ``:{srv} 241 {nick} L {hostmask} * {servername} {maxdepth}``\n\nMatch ``^:(?P\\S+) 241 (?P\\S+) L (?P\\S+) . (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSLLINE)\n def myevent(bot, srv=None, me=None, hostmask=None, servername=None, maxdepth=None):\n # do something\n\n214 - RPL_STATSNLINE\n--------------------\n\nFormat ``:{srv} 214 {nick} N {host} * {nick} {port} {class}``\n\nMatch ``^:(?P\\S+) 214 (?P\\S+) N (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSNLINE)\n def myevent(bot, srv=None, me=None, host=None, nick=None, port=None, class=None):\n # do something\n\n243 - RPL_STATSOLINE\n--------------------\n\nFormat ``:{srv} 243 {nick} O {hostmask} * {nick}``\n\nMatch ``^:(?P\\S+) 243 (?P\\S+) O (?P\\S+) . (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSOLINE)\n def myevent(bot, srv=None, me=None, hostmask=None, nick=None):\n # do something\n\n242 - RPL_STATSUPTIME\n---------------------\n\nFormat ``:{srv} 242 {nick} :Server Up{days}days {hours}``\n\nMatch ``^:(?P\\S+) 242 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSUPTIME)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n218 - RPL_STATSYLINE\n--------------------\n\nFormat ``:{srv} 218 {nick} frequency> {max_sendq}``\n\nMatch ``^:(?P\\S+) 218 (?P\\S+) frequency> (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_STATSYLINE)\n def myevent(bot, srv=None, me=None, max_sendq=None):\n # do something\n\n342 - RPL_SUMMONING\n-------------------\n\nFormat ``:{srv} 342 {nick} {nick} :Summoning user to IRC``\n\nMatch ``^:(?P\\S+) 342 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_SUMMONING)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n391 - RPL_TIME\n--------------\n\nFormat ``:{srv} 391 {nick} {server} :{string_showing_server's_local_time}``\n\nMatch ``^:(?P\\S+) 391 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TIME)\n def myevent(bot, srv=None, me=None, server=None, data=None):\n # do something\n\n332 - RPL_TOPIC\n---------------\n\nFormat ``:{srv} 332 {nick} {channel} :{topic}``\n\nMatch ``^:(?P\\S+) 332 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TOPIC)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n201 - RPL_TRACECONNECTING\n-------------------------\n\nFormat ``:{srv} 201 {nick} Try. {class} {server}``\n\nMatch ``^:(?P\\S+) 201 (?P\\S+) Try. (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACECONNECTING)\n def myevent(bot, srv=None, me=None, class=None, server=None):\n # do something\n\n202 - RPL_TRACEHANDSHAKE\n------------------------\n\nFormat ``:{srv} 202 {nick} H.S. {class} {server}``\n\nMatch ``^:(?P\\S+) 202 (?P\\S+) H.S. (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACEHANDSHAKE)\n def myevent(bot, srv=None, me=None, class=None, server=None):\n # do something\n\n200 - RPL_TRACELINK\n-------------------\n\nFormat ``:{srv} 200 {nick} {next_server}``\n\nMatch ``^:(?P\\S+) 200 (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACELINK)\n def myevent(bot, srv=None, me=None, next_server=None):\n # do something\n\n261 - RPL_TRACELOG\n------------------\n\nFormat ``:{srv} 261 {nick} File {logfile} {debug_level}``\n\nMatch ``^:(?P\\S+) 261 (?P\\S+) File (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACELOG)\n def myevent(bot, srv=None, me=None, logfile=None, debug_level=None):\n # do something\n\n208 - RPL_TRACENEWTYPE\n----------------------\n\nFormat ``:{srv} 208 {nick} {newtype} 0 {client}``\n\nMatch ``^:(?P\\S+) 208 (?P\\S+) (?P\\S+) 0 (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACENEWTYPE)\n def myevent(bot, srv=None, me=None, newtype=None, client=None):\n # do something\n\n204 - RPL_TRACEOPERATOR\n-----------------------\n\nFormat ``:{srv} 204 {nick} Oper {class} {nick}``\n\nMatch ``^:(?P\\S+) 204 (?P\\S+) Oper (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACEOPERATOR)\n def myevent(bot, srv=None, me=None, class=None, nick=None):\n # do something\n\n206 - RPL_TRACESERVER\n---------------------\n\nFormat ``:{srv} 206 {nick} {mask}``\n\nMatch ``^:(?P\\S+) 206 (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACESERVER)\n def myevent(bot, srv=None, me=None, mask=None):\n # do something\n\n203 - RPL_TRACEUNKNOWN\n----------------------\n\nFormat ``:{srv} 203 {nick} ???? {class} [{clientip}]``\n\nMatch ``^:(?P\\S+) 203 (?P\\S+) \\S+ (?P\\S+) [(?P\\S+)]``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACEUNKNOWN)\n def myevent(bot, srv=None, me=None, class=None, clientip=None):\n # do something\n\n205 - RPL_TRACEUSER\n-------------------\n\nFormat ``:{srv} 205 {nick} User {class} {nick}``\n\nMatch ``^:(?P\\S+) 205 (?P\\S+) User (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_TRACEUSER)\n def myevent(bot, srv=None, me=None, class=None, nick=None):\n # do something\n\n221 - RPL_UMODEIS\n-----------------\n\nFormat ``:{srv} 221 {nick} {user_mode_string}``\n\nMatch ``^:(?P\\S+) 221 (?P\\S+) (?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_UMODEIS)\n def myevent(bot, srv=None, me=None, user_mode_string=None):\n # do something\n\n305 - RPL_UNAWAY\n----------------\n\nFormat ``:{srv} 305 {nick} :You are no longer marked as being away``\n\nMatch ``^:(?P\\S+) 305 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_UNAWAY)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n302 - RPL_USERHOST\n------------------\n\nFormat ``:{srv} 302 {nick} :[{reply}{{space}{reply}}]``\n\nMatch ``^:(?P\\S+) 302 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_USERHOST)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n393 - RPL_USERS\n---------------\n\nFormat ``:{srv} 393 {nick} {x} {y} {z}``\n\nMatch ``^:(?P\\S+) 393 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_USERS)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n392 - RPL_USERSSTART\n--------------------\n\nFormat ``:{srv} 392 {nick} :UserID Terminal Host``\n\nMatch ``^:(?P\\S+) 392 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_USERSSTART)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n351 - RPL_VERSION\n-----------------\n\nFormat ``:{srv} 351 {nick} {version}.{debuglevel} {server} :{comments}``\n\nMatch ``^:(?P\\S+) 351 (?P\\S+) (?P\\S+).(?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_VERSION)\n def myevent(bot, srv=None, me=None, version=None, debuglevel=None, server=None, data=None):\n # do something\n\n319 - RPL_WHOISCHANNELS\n-----------------------\n\nFormat ``:{srv} 319 {nick} :{channels}``\n\nMatch ``^:(?P\\S+) 319 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOISCHANNELS)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n317 - RPL_WHOISIDLE\n-------------------\n\nFormat ``:{srv} 317 {nick} {nick} {x} :seconds idle``\n\nMatch ``^:(?P\\S+) 317 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOISIDLE)\n def myevent(bot, srv=None, me=None, nick=None, x=None, data=None):\n # do something\n\n313 - RPL_WHOISOPERATOR\n-----------------------\n\nFormat ``:{srv} 313 {nick} {nick} :is an IRC operator``\n\nMatch ``^:(?P\\S+) 313 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOISOPERATOR)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n312 - RPL_WHOISSERVER\n---------------------\n\nFormat ``:{srv} 312 {nick} {nick} {server} :{server_info}``\n\nMatch ``^:(?P\\S+) 312 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOISSERVER)\n def myevent(bot, srv=None, me=None, nick=None, server=None, data=None):\n # do something\n\n311 - RPL_WHOISUSER\n-------------------\n\nFormat ``:{srv} 311 {nick} {nick} {username} {host} {m} :{realname}``\n\nMatch ``^:(?P\\S+) 311 (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOISUSER)\n def myevent(bot, srv=None, me=None, nick=None, username=None, host=None, m=None, data=None):\n # do something\n\n352 - RPL_WHOREPLY\n------------------\n\nFormat ``:{srv} 352 {nick} :{channel} {username} {host} {server} {nick} {modes} :{hopcount} {realname}``\n\nMatch ``^:(?P\\S+) 352 (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOREPLY)\n def myevent(bot, srv=None, me=None, channel=None, username=None, host=None, server=None, nick=None, modes=None, data=None):\n # do something\n\n314 - RPL_WHOWASUSER\n--------------------\n\nFormat ``:{srv} 314 {nick} {nick} {username} {host} * :{realname}``\n\nMatch ``^:(?P\\S+) 314 (?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) . :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_WHOWASUSER)\n def myevent(bot, srv=None, me=None, nick=None, username=None, host=None, data=None):\n # do something\n\n381 - RPL_YOUREOPER\n-------------------\n\nFormat ``:{srv} 381 {nick} :You are now an IRC operator``\n\nMatch ``^:(?P\\S+) 381 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.RPL_YOUREOPER)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\nErrors (ERR)\n============\n\n462 - ERR_ALREADYREGISTRED\n--------------------------\n\nFormat ``:{srv} 462 {nick} :You may not reregister``\n\nMatch ``^:(?P\\S+) 462 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_ALREADYREGISTRED)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n475 - ERR_BADCHANNELKEY\n-----------------------\n\nFormat ``:{srv} 475 {nick} {channel} :Cannot join channel (+k)``\n\nMatch ``^:(?P\\S+) 475 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_BADCHANNELKEY)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n474 - ERR_BANNEDFROMCHAN\n------------------------\n\nFormat ``:{srv} 474 {nick} {channel} :Cannot join channel (+b)``\n\nMatch ``^:(?P\\S+) 474 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_BANNEDFROMCHAN)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n404 - ERR_CANNOTSENDTOCHAN\n--------------------------\n\nFormat ``:{srv} 404 {nick} {channel} :Cannot send to channel``\n\nMatch ``^:(?P\\S+) 404 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_CANNOTSENDTOCHAN)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n483 - ERR_CANTKILLSERVER\n------------------------\n\nFormat ``:{srv} 483 {nick} :You cant kill a server!``\n\nMatch ``^:(?P\\S+) 483 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_CANTKILLSERVER)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n471 - ERR_CHANNELISFULL\n-----------------------\n\nFormat ``:{srv} 471 {nick} {channel} :Cannot join channel (+l)``\n\nMatch ``^:(?P\\S+) 471 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_CHANNELISFULL)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n482 - ERR_CHANOPRIVSNEEDED\n--------------------------\n\nFormat ``:{srv} 482 {nick} {channel} :You're not channel operator``\n\nMatch ``^:(?P\\S+) 482 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_CHANOPRIVSNEEDED)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n432 - ERR_ERRONEUSNICKNAME\n--------------------------\n\nFormat ``:{srv} 432 {nick} {nick} :Erroneus nickname``\n\nMatch ``^:(?P\\S+) 432 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_ERRONEUSNICKNAME)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n473 - ERR_INVITEONLYCHAN\n------------------------\n\nFormat ``:{srv} 473 {nick} {channel} :Cannot join channel (+i)``\n\nMatch ``^:(?P\\S+) 473 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_INVITEONLYCHAN)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n467 - ERR_KEYSET\n----------------\n\nFormat ``:{srv} 467 {nick} {channel} :Channel key already set``\n\nMatch ``^:(?P\\S+) 467 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_KEYSET)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n461 - ERR_NEEDMOREPARAMS\n------------------------\n\nFormat ``:{srv} 461 {nick} {cmd} :Not enough parameters``\n\nMatch ``^:(?P\\S+) 461 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NEEDMOREPARAMS)\n def myevent(bot, srv=None, me=None, cmd=None, data=None):\n # do something\n\nERR_NICK\n--------\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) (?P(432|433|436)) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NICK)\n def myevent(bot, srv=None, retcode=None, me=None, nick=None, data=None, tags=None):\n # do something\n\n436 - ERR_NICKCOLLISION\n-----------------------\n\nFormat ``:{srv} 436 {nick} {nick} :Nickname collision KILL``\n\nMatch ``^:(?P\\S+) 436 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NICKCOLLISION)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n433 - ERR_NICKNAMEINUSE\n-----------------------\n\nFormat ``:{srv} 433 {nick} {nick} :Nickname is already in use``\n\nMatch ``^:(?P\\S+) 433 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NICKNAMEINUSE)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n423 - ERR_NOADMININFO\n---------------------\n\nFormat ``:{srv} 423 {nick} {server} :No administrative info available``\n\nMatch ``^:(?P\\S+) 423 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOADMININFO)\n def myevent(bot, srv=None, me=None, server=None, data=None):\n # do something\n\n444 - ERR_NOLOGIN\n-----------------\n\nFormat ``:{srv} 444 {nick} {nick} :User not logged in``\n\nMatch ``^:(?P\\S+) 444 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOLOGIN)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n422 - ERR_NOMOTD\n----------------\n\nFormat ``:{srv} 422 {nick} :MOTD File is missing``\n\nMatch ``^:(?P\\S+) 422 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOMOTD)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n431 - ERR_NONICKNAMEGIVEN\n-------------------------\n\nFormat ``:{srv} 431 {nick} :No nickname given``\n\nMatch ``^:(?P\\S+) 431 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NONICKNAMEGIVEN)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n491 - ERR_NOOPERHOST\n--------------------\n\nFormat ``:{srv} 491 {nick} :No O-lines for your host``\n\nMatch ``^:(?P\\S+) 491 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOOPERHOST)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n409 - ERR_NOORIGIN\n------------------\n\nFormat ``:{srv} 409 {nick} :No origin specified``\n\nMatch ``^:(?P\\S+) 409 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOORIGIN)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n463 - ERR_NOPERMFORHOST\n-----------------------\n\nFormat ``:{srv} 463 {nick} :Your host isn't among the privileged``\n\nMatch ``^:(?P\\S+) 463 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOPERMFORHOST)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n481 - ERR_NOPRIVILEGES\n----------------------\n\nFormat ``:{srv} 481 {nick} :Permission Denied- You're not an IRC operator``\n\nMatch ``^:(?P\\S+) 481 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOPRIVILEGES)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n411 - ERR_NORECIPIENT\n---------------------\n\nFormat ``:{srv} 411 {nick} :No recipient given ({cmd})``\n\nMatch ``^:(?P\\S+) 411 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NORECIPIENT)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n403 - ERR_NOSUCHCHANNEL\n-----------------------\n\nFormat ``:{srv} 403 {nick} {channel} :No such channel``\n\nMatch ``^:(?P\\S+) 403 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOSUCHCHANNEL)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n401 - ERR_NOSUCHNICK\n--------------------\n\nFormat ``:{srv} 401 {nick} {nick} :No such nick/channel``\n\nMatch ``^:(?P\\S+) 401 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOSUCHNICK)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n402 - ERR_NOSUCHSERVER\n----------------------\n\nFormat ``:{srv} 402 {nick} {server} :No such server``\n\nMatch ``^:(?P\\S+) 402 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOSUCHSERVER)\n def myevent(bot, srv=None, me=None, server=None, data=None):\n # do something\n\n412 - ERR_NOTEXTTOSEND\n----------------------\n\nFormat ``:{srv} 412 {nick} :No text to send``\n\nMatch ``^:(?P\\S+) 412 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOTEXTTOSEND)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n442 - ERR_NOTONCHANNEL\n----------------------\n\nFormat ``:{srv} 442 {nick} {channel} :You're not on that channel``\n\nMatch ``^:(?P\\S+) 442 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOTONCHANNEL)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n413 - ERR_NOTOPLEVEL\n--------------------\n\nFormat ``:{srv} 413 {nick} {mask} :No toplevel domain specified``\n\nMatch ``^:(?P\\S+) 413 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOTOPLEVEL)\n def myevent(bot, srv=None, me=None, mask=None, data=None):\n # do something\n\n451 - ERR_NOTREGISTERED\n-----------------------\n\nFormat ``:{srv} 451 {nick} :You have not registered``\n\nMatch ``^:(?P\\S+) 451 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_NOTREGISTERED)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n464 - ERR_PASSWDMISMATCH\n------------------------\n\nFormat ``:{srv} 464 {nick} :Password incorrect``\n\nMatch ``^:(?P\\S+) 464 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_PASSWDMISMATCH)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n445 - ERR_SUMMONDISABLED\n------------------------\n\nFormat ``:{srv} 445 {nick} :SUMMON has been disabled``\n\nMatch ``^:(?P\\S+) 445 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_SUMMONDISABLED)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n405 - ERR_TOOMANYCHANNELS\n-------------------------\n\nFormat ``:{srv} 405 {nick} {channel} :You have joined too many channels``\n\nMatch ``^:(?P\\S+) 405 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_TOOMANYCHANNELS)\n def myevent(bot, srv=None, me=None, channel=None, data=None):\n # do something\n\n407 - ERR_TOOMANYTARGETS\n------------------------\n\nFormat ``:{srv} 407 {nick} {target} :Duplicate recipients. No message delivered``\n\nMatch ``^:(?P\\S+) 407 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_TOOMANYTARGETS)\n def myevent(bot, srv=None, me=None, target=None, data=None):\n # do something\n\n501 - ERR_UMODEUNKNOWNFLAG\n--------------------------\n\nFormat ``:{srv} 501 {nick} :Unknown MODE flag``\n\nMatch ``^:(?P\\S+) 501 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_UMODEUNKNOWNFLAG)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n421 - ERR_UNKNOWNCOMMAND\n------------------------\n\nFormat ``:{srv} 421 {nick} {cmd} :Unknown command``\n\nMatch ``^:(?P\\S+) 421 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_UNKNOWNCOMMAND)\n def myevent(bot, srv=None, me=None, cmd=None, data=None):\n # do something\n\n472 - ERR_UNKNOWNMODE\n---------------------\n\nFormat ``:{srv} 472 {nick} {char} :is unknown mode char to me``\n\nMatch ``^:(?P\\S+) 472 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_UNKNOWNMODE)\n def myevent(bot, srv=None, me=None, char=None, data=None):\n # do something\n\n441 - ERR_USERNOTINCHANNEL\n--------------------------\n\nFormat ``:{srv} 441 {nick} {nick} {channel} :They aren't on that channel``\n\nMatch ``^:(?P\\S+) 441 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_USERNOTINCHANNEL)\n def myevent(bot, srv=None, me=None, nick=None, channel=None, data=None):\n # do something\n\n443 - ERR_USERONCHANNEL\n-----------------------\n\nFormat ``:{srv} 443 {nick} {nick} {channel} :is already on channel``\n\nMatch ``^:(?P\\S+) 443 (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_USERONCHANNEL)\n def myevent(bot, srv=None, me=None, nick=None, channel=None, data=None):\n # do something\n\n446 - ERR_USERSDISABLED\n-----------------------\n\nFormat ``:{srv} 446 {nick} :USERS has been disabled``\n\nMatch ``^:(?P\\S+) 446 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_USERSDISABLED)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n502 - ERR_USERSDONTMATCH\n------------------------\n\nFormat ``:{srv} 502 {nick} :Cant change mode for other users``\n\nMatch ``^:(?P\\S+) 502 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_USERSDONTMATCH)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\n406 - ERR_WASNOSUCHNICK\n-----------------------\n\nFormat ``:{srv} 406 {nick} {nick} :There was no such nickname``\n\nMatch ``^:(?P\\S+) 406 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_WASNOSUCHNICK)\n def myevent(bot, srv=None, me=None, nick=None, data=None):\n # do something\n\n414 - ERR_WILDTOPLEVEL\n----------------------\n\nFormat ``:{srv} 414 {nick} {mask} :Wildcard in toplevel domain``\n\nMatch ``^:(?P\\S+) 414 (?P\\S+) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_WILDTOPLEVEL)\n def myevent(bot, srv=None, me=None, mask=None, data=None):\n # do something\n\n465 - ERR_YOUREBANNEDCREEP\n--------------------------\n\nFormat ``:{srv} 465 {nick} :You are banned from this server``\n\nMatch ``^:(?P\\S+) 465 (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.ERR_YOUREBANNEDCREEP)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\nMisc\n====\n\nCONNECTED\n---------\n\nMatch ``^:(?P\\S+) (376|422) (?P\\S+) :(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.CONNECTED)\n def myevent(bot, srv=None, me=None, data=None):\n # do something\n\nCTCP\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+!\\S+@\\S+) (?P(PRIVMSG|NOTICE)) {nick} :\u0001(?P.*)\u0001$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.CTCP)\n def myevent(bot, mask=None, event=None, ctcp=None, tags=None):\n # do something\n\nOut Match ``^(?P(PRIVMSG|NOTICE)) (?P\\S+) :\u0001(?P.*)\u0001$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.CTCP, iotype=\"out\")\n def myevent(bot, event=None, target=None, ctcp=None):\n # do something\n\nINVITE\n------\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+!\\S+@\\S+) INVITE {nick} :?(?P\\S+)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.INVITE)\n def myevent(bot, mask=None, channel=None, tags=None):\n # do something\n\nJOIN\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) JOIN :?(?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.JOIN)\n def myevent(bot, mask=None, channel=None, tags=None):\n # do something\n\nOut Match ``^JOIN :?(?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.JOIN, iotype=\"out\")\n def myevent(bot, channel=None):\n # do something\n\nJOIN_PART_QUIT\n--------------\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) (?PJOIN|PART|QUIT)\\s*:*(?P\\S*)(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.JOIN_PART_QUIT)\n def myevent(bot, mask=None, event=None, channel=None, data=None, tags=None):\n # do something\n\nOut Match ``^(?PJOIN|PART|QUIT)\\s*:*(?P\\S*)(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.JOIN_PART_QUIT, iotype=\"out\")\n def myevent(bot, event=None, channel=None, data=None):\n # do something\n\nKICK\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) (?PKICK)\\s+(?P\\S+)\\s*(?P\\S+)(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.KICK)\n def myevent(bot, mask=None, event=None, channel=None, target=None, data=None, tags=None):\n # do something\n\nOut Match ``^(?PKICK)\\s+(?P\\S+)\\s*(?P\\S+)(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.KICK, iotype=\"out\")\n def myevent(bot, event=None, channel=None, target=None, data=None):\n # do something\n\nMODE\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) (?PMODE)\\s+(?P\\S+)\\s+(?P\\S+)(\\s+(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.MODE)\n def myevent(bot, mask=None, event=None, target=None, modes=None, data=None, tags=None):\n # do something\n\nOut Match ``^(?PMODE)\\s+(?P\\S+)\\s+(?P\\S+)(\\s+(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.MODE, iotype=\"out\")\n def myevent(bot, event=None, target=None, modes=None, data=None):\n # do something\n\nMY_PRIVMSG\n----------\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+!\\S+@\\S+) (?P(PRIVMSG|NOTICE)) (?P(#\\S+|{nick})) :{nick}[:,\\s]\\s*(?P\\S+.*)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.MY_PRIVMSG)\n def myevent(bot, mask=None, event=None, target=None, data=None, tags=None):\n # do something\n\nOut Match ``^(?P(PRIVMSG|NOTICE)) (?P\\S+) :(?P.*)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.MY_PRIVMSG, iotype=\"out\")\n def myevent(bot, event=None, target=None, data=None):\n # do something\n\nNEW_NICK\n--------\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) NICK :?(?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.NEW_NICK)\n def myevent(bot, nick=None, new_nick=None, tags=None):\n # do something\n\nOut Match ``^NICK :?(?P\\S+)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.NEW_NICK, iotype=\"out\")\n def myevent(bot, new_nick=None):\n # do something\n\nPART\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) PART (?P\\S+)(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.PART)\n def myevent(bot, mask=None, channel=None, data=None, tags=None):\n # do something\n\nOut Match ``PART (?P\\S+)(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.PART, iotype=\"out\")\n def myevent(bot, channel=None, data=None):\n # do something\n\nPING\n----\n\nMatch ``^PING :?(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.PING)\n def myevent(bot, data=None):\n # do something\n\nPONG\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) PONG (?P=server) :?(?P.*)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.PONG)\n def myevent(bot, server=None, data=None, tags=None):\n # do something\n\nPRIVMSG\n-------\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+!\\S+@\\S+) (?P(PRIVMSG|NOTICE)) (?P\\S+) :(?P.*)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.PRIVMSG)\n def myevent(bot, mask=None, event=None, target=None, data=None, tags=None):\n # do something\n\nOut Match ``^(?P(PRIVMSG|NOTICE)) (?P\\S+) :(?P.*)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.PRIVMSG, iotype=\"out\")\n def myevent(bot, event=None, target=None, data=None):\n # do something\n\nQUIT\n----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+) QUIT(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.QUIT)\n def myevent(bot, mask=None, data=None, tags=None):\n # do something\n\nOut Match ``^QUIT(\\s+:(?P.*)|$)``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.QUIT, iotype=\"out\")\n def myevent(bot, data=None):\n # do something\n\nTOPIC\n-----\n\nMatch ``^(@(?P\\S+) )?:(?P\\S+!\\S+@\\S+) TOPIC (?P\\S+) :(?P.*)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.TOPIC)\n def myevent(bot, mask=None, channel=None, data=None, tags=None):\n # do something\n\nOut Match ``^TOPIC (?P\\S+) :(?P.*)$``\n\nExample:\n\n.. code-block:: python\n\n @irc3.event(rfc.TOPIC, iotype=\"out\")\n def myevent(bot, channel=None, data=None):\n # do something\n\n" }, { "path": "docs/utils.rst", "content": "========================\n:mod:`irc3.utils` Utils\n========================\n\n.. automodule:: irc3.utils\n\n.. autoclass:: IrcString\n :members:\n\n.. autofunction:: as_list\n\n.. autofunction:: as_channel\n\n.. autofunction:: split_message\n\n.. autoclass:: Logger\n :members:\n\n.. autoclass:: Config\n\n.. autofunction:: parse_config\n\n.. autofunction:: extract_config\n\n.. autofunction:: maybedotted\n\n" }, { "path": "examples/async_command.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.plugins.command import command\nfrom irc3.compat import Queue\nimport irc3\n\n\n@irc3.plugin\nclass AsyncCommands(object):\n \"\"\"Async commands example. This is what it's look like on irc::\n\n !get\n !put item\n items added to queue\n item\n \"\"\"\n\n def __init__(self, bot):\n self.bot = bot\n self.queue = Queue()\n\n @command\n def put(self, mask, target, args):\n \"\"\"Put items in queue\n\n %%put ...\n \"\"\"\n for w in args['']:\n self.queue.put_nowait(w)\n yield 'items added to queue'\n\n @command\n async def get(self, mask, target, args):\n \"\"\"Async get items from the queue\n\n %%get\n \"\"\"\n messages = []\n message = await self.queue.get()\n messages.append(message)\n while not self.queue.empty():\n message = await self.queue.get()\n messages.append(message)\n return messages\n" }, { "path": "examples/benches.ini", "content": "[bot]\nnick = malkovitch\nusername = malkovitch\nhost = localhost\nport = 6667\nname = malkovitch\nuser = malkovitch\nrealname = I'm the real John Malkovitch\nchannel = head\nincludes =\n benches\n\n[server]\nservername = malkovitch\nclient_amount = 500\nincludes =\n irc3d.plugins.core\n\n[opers]\ngawel=passwd\n" }, { "path": "examples/benches.py", "content": "# -*- coding: utf-8 -*-\nimport random\nfrom irc3.compat import asyncio\nfrom irc3d import IrcServer\nimport irc3\n\n\n@irc3.plugin\nclass Plugin(object):\n\n def __init__(self, context):\n self.log = context.log\n self.context = context\n self.name = context.config.name\n self.channel = '#' + context.config.channel\n\n @irc3.event(irc3.rfc.CONNECTED)\n def connected(self, **kw):\n self.context.join(self.channel)\n\n def msg(self):\n s = ' '.join([self.name for i in range(random.randint(1, 10))])\n s += random.choice([' ?', '', ' !', ' #@!', ' '])\n self.context.privmsg(self.channel, s)\n self.context.loop.call_later(\n random.randint(3, 20), self.msg)\n\n @irc3.event(irc3.rfc.JOIN)\n def join(self, mask=None, **kw):\n if mask.nick == self.context.nick:\n self.context.loop.call_later(\n random.randint(3, 20), self.msg)\n\n\ndef main():\n loop = asyncio.get_event_loop()\n\n server = IrcServer.from_argv(loop=loop)\n bot = irc3.IrcBot.from_argv(loop=loop)\n\n def factory(i):\n irc3.IrcBot.from_argv(\n loop=loop, i=i,\n nick=bot.nick + str(i),\n realname=bot.config.realname + str(i),\n )\n\n for i in range(1, server.config.client_amount):\n loop.call_later(.1 * i, factory, i)\n\n loop.run_forever()\n" }, { "path": "examples/bot.ini", "content": "[bot]\nnick = irc3\nusername = irc3\n\nhost = irc.freenode.net\nport = 7000\nssl = true\n\nincludes =\n irc3.plugins.core\n irc3.plugins.ctcp\n irc3.plugins.cron\n irc3.plugins.autojoins\n irc3.plugins.userlist\n irc3.plugins.command\n irc3.plugins.human\n irc3.plugins.search\n irc3.plugins.uptime\n irc3.plugins.feeds\n irc3.plugins.social\n irc3.plugins.fifo\n freenode_irc3\n nickserv\n\n# channels to join\nautojoins =\n irc3\n\n[irc3.plugins.command]\n# command plugin configuration\n\n# set command char\ncmd = !\n# enable antiflood on commands\nantiflood = true\n# set guard policy\nguard = irc3.plugins.command.mask_based_policy\n\n[irc3.plugins.command.masks]\n*!~gael@amandine.bearstech.com = all_permissions\n\n[irc3.plugins.feeds]\n# feeds plugin configuration\ndirectory = ~/.irc3/feeds/\nhook = freenode_irc3.FeedsHook\nchannels = irc3\ndelay = 5\n\ngithub/irc3 = https://github.com/gawel/irc3/commits/master.atom\ngithub/irc3.fmt = [{feed.name}] New commit by {entry.author}: {entry.title} - {entry.link}\ngithub/irc3.delay = 5\n\ntravis/irc3 = https://api.travis-ci.org/repos/gawel/irc3/builds.atom\ntravis/irc3.fmt = [{feed.name}] {entry.title} - {entry.link}\ntravis/irc3.channels = irc3\ntravis/irc3.delay = 10\n\npypi/irc3 = https://pypi.python.org/pypi?:action=rss\npypi/irc3.fmt = {entry.title} is out! - {entry.link}\npypi/irc3.delay = 60\n\n[irc3.plugins.fifo]\nrunpath = /tmp/run/irc3\n" }, { "path": "examples/commands.rst", "content": "===============================================\nAvailable Commands for irc3 at irc.freenode.net\n===============================================\n\n.. contents::\n\nirc3.plugins.command\n====================\n\nhelp\n----\n\nShow help\n\n ``!help []``\n\n\nping\n----\n\nping/pong\n\n ``!ping``\n\n*Require admin permission.*\n*Only available in private.*\n\nirc3.plugins.search\n===================\n\nddg\n---\n\nSearch using https://duckduckgo.com/api\n\n ``!ddg ...``\n\n*Require view permission.*\n\nirc3.plugins.social\n===================\n\nretweet\n-------\n\nRetweet\n\n ``!retweet [--id=] ``\n\n*Require edit permission.*\n\ntweet\n-----\n\nPost to social networks\n\n ``!tweet [--id=] ...``\n\n*Require edit permission.*\n\nirc3.plugins.uptime\n===================\n\nuptime\n------\n\nShow uptimes\n\n ``!uptime``\n\n*Require view permission.*\n\n" }, { "path": "examples/config.ini", "content": "[bot]\nnick = mybot\nusername = mybot\n\nhost = localhost\nport = 6667\n\n# uncomment this if you want ssl support\n# ssl = true\n# uncomment this if you don't want to check the certificate\n# ssl_verify = CERT_NONE\n\n# uncomment this if you want to use sasl authentication\n# sasl_username = mybot\n# sasl_password = yourpassword\n\nincludes =\n irc3.plugins.command\n# irc3.plugins.uptime\n# irc3.plugins.ctcp\n mybot_plugin\n\n# the bot will join #mybot_channel\n# ${#} is replaced by the # char\nautojoins =\n ${#}mybot_channel\n\n# Autojoin delay, disabled by default\n# float or int value\n# autojoin_delay = 3.1\n\n# The maximum amount of lines irc3 sends at once.\n# Default to 4, set to 0 to disable\n# flood_burst = 10\n\n# The number of lines per $flood_rate_delay seconds irc3 sends after reaching\n# the $flood_burst limit.\n# Default to 1\n# flood_rate = 2\n\n# The bot will send $flood_rate messages per $flood_rate_delay seconds\n# Default to 1\n# flood_rate_delay = 5\n\n[irc3.plugins.command]\n# command plugin configuration\n\n# set command char\ncmd = !\n\n# set guard policy\nguard = irc3.plugins.command.mask_based_policy\n\n[irc3.plugins.command.masks]\n# this section is used by the guard to secure the bot's command\n# change your nickname and uncomment the line below\n# mynick!*@* = all_permissions\n* = view\n" }, { "path": "examples/dcc_chat.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.compat import asyncio\nfrom irc3d import IrcServer\nimport irc3\n\n\n@irc3.plugin\nclass Plugin(object):\n\n def __init__(self, context):\n self.log = context.log\n self.context = context\n\n @irc3.event(irc3.rfc.CONNECTED)\n def connected(self, **kw):\n self.context.join('#dcc')\n\n @irc3.event(irc3.rfc.JOIN)\n async def join(self, mask=None, **kw):\n if mask.nick != self.context.nick and mask.nick == 'receiver':\n # receiver joined the chan. offer a chat\n conn = await self.context.dcc_chat(mask)\n # wait for my buddy\n await conn.started\n # say hi\n conn.send_line('Hi!')\n await conn.closed\n self.context.log.info('chat with %s closed', mask.nick)\n\n @irc3.event(irc3.rfc.CTCP)\n async def on_ctcp(self, mask=None, **kwargs):\n # parse ctcp message\n print(kwargs)\n host, port = kwargs['ctcp'].split()[3:]\n self.context.log.info('%s is offering a chat', mask.nick)\n # open the chat\n conn = await self.context.dcc_chat(mask, host, port)\n conn.send_line('youhou')\n # end the loop after a few seconds\n self.context.loop.call_later(1,\n self.context.config.end_chat.set_result,\n True)\n await conn.closed\n self.context.log.info('chat with %s closed', mask.nick)\n\n @irc3.dcc_event(r'(?P.*)')\n def on_dcc(self, client=None, data=None):\n \"\"\"event to catch everything in dcc chats\"\"\"\n self.context.log.info('%r sent %s', client, data)\n\n\ndef main():\n loop = asyncio.get_event_loop()\n\n # run a test server\n server = IrcServer.from_config(dict(\n loop=loop,\n servername='test',\n includes=['irc3d.plugins.core'],\n ))\n server.run(forever=False)\n\n end_chat = asyncio.Future()\n\n cfg = dict(\n host='localhost',\n port=6667,\n nick='sender',\n includes=['irc3.plugins.dcc', __name__],\n loop=loop,\n end_chat=end_chat,\n )\n # this bot will send the file\n sender = irc3.IrcBot.from_config(cfg)\n sender.run(forever=False)\n\n def f():\n # this bot will receive the file\n receiver.run(forever=False)\n # assume receiver is created *after* sender\n receiver = irc3.IrcBot.from_config(cfg, nick='receiver')\n loop.call_later(.2, receiver.run, False)\n\n loop.run_until_complete(end_chat)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "examples/dcc_send.py", "content": "# -*- coding: utf-8 -*-\nimport os\nimport string\nimport tempfile\nimport irc3\nfrom irc3.plugins.command import command\n\n\n@irc3.plugin\nclass DCC(object):\n\n filename = os.path.join(tempfile.gettempdir(), 'to_send')\n\n def __init__(self, bot):\n self.bot = bot\n if not os.path.isfile(self.filename):\n # create a file to send\n with open(self.filename, 'wb') as fd:\n for i in range(64 * 2048):\n fd.write(string.ascii_letters.encode('utf8'))\n\n @command\n async def send(self, mask, target, args):\n \"\"\" DCC SEND command\n\n %%send\n \"\"\"\n conn = await self.bot.dcc_send(mask, self.filename)\n self.bot.log.debug('%s ready', conn)\n" }, { "path": "examples/dcc_send_and_get.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.compat import asyncio\nfrom irc3d import IrcServer\nimport irc3\n\n\n@irc3.plugin\nclass Plugin(object):\n\n def __init__(self, context):\n self.log = context.log\n self.context = context\n\n @irc3.event(irc3.rfc.CONNECTED)\n def connected(self, **kw):\n self.context.join('#dcc')\n\n @irc3.event(irc3.rfc.JOIN)\n async def join(self, mask=None, **kw):\n if mask.nick != self.context.nick and mask.nick == 'receiver':\n # receiver joined the chan. offer a file\n conn = await self.context.dcc_send(mask, __file__)\n await conn.closed\n self.context.log.info('file sent to %s', mask.nick)\n\n @irc3.event(irc3.rfc.CTCP)\n async def on_ctcp(self, mask=None, **kwargs):\n # parse ctcp message\n name, host, port, size = kwargs['ctcp'].split()[2:]\n self.context.log.info('%s is offering %s', mask.nick, name)\n # get the file\n conn = await self.context.create_task(self.context.dcc_get(\n mask, host, port, '/tmp/sent.py', int(size)))\n await conn.closed\n self.context.log.info('file received from %s', mask.nick)\n\n # end loop by setting future's result\n self.context.config.file_received.set_result(True)\n\n\ndef main():\n loop = asyncio.get_event_loop()\n\n # run a test server\n server = IrcServer.from_config(dict(\n loop=loop,\n servername='test',\n includes=['irc3d.plugins.core'],\n ))\n server.run(forever=False)\n\n cfg = dict(\n host='localhost',\n port=6667,\n nick='sender',\n includes=[__name__],\n loop=loop,\n )\n # this bot will send the file\n sender = irc3.IrcBot.from_config(cfg)\n sender.run(forever=False)\n\n file_received = asyncio.Future()\n\n def f():\n # this bot will receive the file\n receiver.run(forever=False)\n # assume receiver is created *after* sender\n receiver = irc3.IrcBot.from_config(cfg,\n nick='receiver',\n file_received=file_received)\n loop.call_later(.2, receiver.run, False)\n\n loop.run_until_complete(file_received)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "examples/dev.ini", "content": "[bot]\nnick = irc3_dev\nusername = irc3\nhost = irc.freenode.net\nport = 7000\nssl = true\nincludes =\n irc3.plugins.core\n irc3.plugins.userlist\n irc3.plugins.ctcp\n irc3.plugins.autojoins\n irc3.plugins.log\n irc3.plugins.command\n irc3.plugins.human\n irc3.plugins.search\n irc3.plugins.uptime\n irc3.plugins.cron\n irc3.plugins.social\n irc3.plugins.feeds\n irc3.plugins.fifo\n freenode_irc3\n paginate\n topic\n mybot\n# nickserv\ncmd = .\nautojoins = #irc3_dev\n\n[irc3.plugins.command]\nantiflood = true\nguard = irc3.plugins.command.mask_based_policy\n\n[irc3.plugins.command.masks]\ngawel!*@*=all_permissions\n\n[irc3.plugins.feeds]\ndelay = 1\ndirectory = ~/.irc3/feeds/\nhook = freenode_irc3.FeedsHook\nchannels = irc3_dev\n\ngithub/irc3 = https://github.com/gawel/irc3/commits/master.atom\ngithub/irc3.fmt = [{feed.name}] New commit by {entry.author}: {entry.title} - {entry.link}\ngithub/irc3.delay = 1\n\ntravis/irc3 = https://api.travis-ci.org/repos/gawel/irc3/builds.atom\ntravis/irc3.fmt = [{feed.name}] {entry.title} - {entry.link}\ntravis/irc3.channels = #irc3-dev\ntravis/irc3.delay = 1\n\npypi/irc3 = https://pypi.python.org/pypi?:action=rss\npypi/irc3.fmt = {entry.title} is out! - {entry.link}\npypi/irc3.delay = 3\n\n[irc3.plugins.fifo]\nrunpath = /tmp/run/irc3\n" }, { "path": "examples/freenode_irc3.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.plugins.cron import cron\nimport os\n\n\nclass FeedsHook(object):\n \"\"\"Custom hook for irc3.plugins.feeds\"\"\"\n\n def __init__(self, bot):\n self.bot = bot\n self.packages = [\n 'asyncio', 'irc3', 'panoramisk',\n 'requests', 'trollius', 'webtest',\n 'pyramid',\n ]\n\n def filter_travis(self, entry):\n \"\"\"Only show the latest entry iif this entry is in a new state\"\"\"\n fstate = entry.filename + '.state'\n if os.path.isfile(fstate):\n with open(fstate) as fd:\n state = fd.read().strip()\n else:\n state = None\n if 'failed' in entry.summary:\n nstate = 'failed'\n else:\n nstate = 'success'\n with open(fstate, 'w') as fd:\n fd.write(nstate)\n if state != nstate:\n build = entry.title.split('#')[1]\n entry['title'] = 'Build #{0} {1}'.format(build, nstate)\n return True\n\n def filter_pypi(self, entry):\n \"\"\"Show only usefull packages\"\"\"\n for package in self.packages:\n if entry.title.lower().startswith(package):\n return entry\n\n def __call__(self, entries):\n travis = {}\n for entry in entries:\n if entry.feed.name.startswith('travis/'):\n travis[entry.feed.name] = entry\n elif entry.feed.name.startswith('pypi/'):\n yield self.filter_pypi(entry)\n else:\n yield entry\n for entry in travis.values():\n if self.filter_travis(entry):\n yield entry\n\n\n@cron('*/15 * * * *')\ndef auto_retweet(bot):\n \"\"\"retweet author tweets about irc3 and pypi releases\"\"\"\n conn = bot.get_social_connection(id='twitter')\n dirname = os.path.expanduser('~/.irc3/twitter/{nick}'.format(**bot.config))\n\n if not os.path.isdir(dirname):\n os.makedirs(dirname)\n\n filename = os.path.join(dirname, 'retweeted')\n if os.path.isfile(filename):\n with open(filename) as fd:\n retweeted = [i.strip() for i in fd.readlines()]\n else:\n retweeted = []\n\n for user in ('pypi', 'gawel_'):\n results = conn.search.tweets(\n q=user + ' AND irc3',\n result_type='recent')\n for item in results.get('statuses', []):\n if item['user']['screen_name'] == user:\n if item['id_str'] not in retweeted:\n res = conn(getattr(conn.statuses.retweet, item['id_str']))\n if 'id' in res:\n with open(filename, 'a+') as fd:\n fd.write(item['id_str'] + '\\n')\n\n\n@cron('*/2 * * * *', venusian_category='irc3.debug')\ndef test_cron(bot):\n bot.log.info('Running test_cron')\n\n\n@cron('*/3 * * * *', venusian_category='irc3.debug')\ndef test_cron_raise(bot):\n raise OSError('test_cron_raise')\n" }, { "path": "examples/humans.py", "content": "# -*- coding: utf-8 -*-\nimport asyncio\nimport irc3\n\n\n@irc3.event(irc3.rfc.JOIN)\ndef greetings(bot, mask=None, channel=None, **kw):\n if not mask.nick.startswith(bot.nick):\n bot.privmsg(channel, '%s: Hi dude!' % mask.nick)\n\n\ndef main():\n loop = asyncio.get_event_loop()\n\n config = dict(\n autojoins=['#irc3'],\n host='irc.freenode.net', port=7000, ssl=True,\n timeout=30,\n includes=[\n 'irc3.plugins.core',\n 'irc3.plugins.human',\n __name__, # this register this module\n ],\n loop=loop)\n\n # instanciate two bot\n irc3.IrcBot(nick='bobirc', **config).run(forever=False)\n irc3.IrcBot(nick='jackyrc', **config).run(forever=False)\n\n loop.run_forever()\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "examples/mybot.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.plugins.command import command\nimport irc3\n\n\n@irc3.plugin\nclass MyPlugin:\n \"\"\"A plugin is a class which take the IrcBot as argument\n \"\"\"\n\n requires = [\n 'irc3.plugins.core',\n 'irc3.plugins.userlist',\n 'irc3.plugins.command',\n 'irc3.plugins.human',\n ]\n\n def __init__(self, bot):\n self.bot = bot\n self.log = self.bot.log\n\n def connection_made(self):\n \"\"\"triggered when connection is up\"\"\"\n\n def server_ready(self):\n \"\"\"triggered after the server sent the MOTD (require core plugin)\"\"\"\n\n def connection_lost(self):\n \"\"\"triggered when connection is lost\"\"\"\n\n @irc3.event(irc3.rfc.JOIN)\n def welcome(self, mask, channel, **kw):\n \"\"\"Welcome people who join a channel\"\"\"\n if mask.nick != self.bot.nick:\n self.bot.call_with_human_delay(\n self.bot.privmsg, channel, 'Welcome %s!' % mask.nick)\n else:\n self.bot.call_with_human_delay(\n self.bot.privmsg, channel, \"Hi guys!\")\n\n @command\n def echo(self, mask, target, args):\n \"\"\"Echo command\n\n %%echo ...\n \"\"\"\n self.bot.privmsg(mask.nick, ' '.join(args['']))\n\n @command\n def stats(self, mask, target, args):\n \"\"\"Show stats of the channel using the userlist plugin\n\n %%stats []\n \"\"\"\n if args['']:\n channel = args['']\n target = mask.nick\n else:\n channel = target\n if channel in self.bot.channels:\n channel = self.bot.channels[channel]\n message = '{0} users'.format(len(channel))\n for mode, nicknames in sorted(channel.modes.items()):\n message += ' - {0}({1})'.format(mode, len(nicknames))\n self.bot.privmsg(target, message)\n\n @irc3.extend\n def my_usefull_method(self):\n \"\"\"The extend decorator will allow you to call::\n\n bot.my_usefull_method()\n\n \"\"\"\n\n\ndef main():\n # instanciate a bot\n config = dict(\n nick='irc3', autojoins=['#irc3'],\n host='irc.undernet.org', port=6667, ssl=False,\n includes=[\n 'irc3.plugins.core',\n 'irc3.plugins.command',\n 'irc3.plugins.human',\n __name__, # this register MyPlugin\n ]\n )\n bot = irc3.IrcBot.from_config(config)\n bot.run(forever=True)\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "examples/mybot_plugin.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.plugins.command import command\nimport irc3\n\n\n@irc3.plugin\nclass Plugin:\n\n def __init__(self, bot):\n self.bot = bot\n\n @irc3.event(irc3.rfc.JOIN)\n def say_hi(self, mask, channel, **kw):\n \"\"\"Say hi when someone join a channel\"\"\"\n if mask.nick != self.bot.nick:\n self.bot.privmsg(channel, 'Hi %s!' % mask.nick)\n else:\n self.bot.privmsg(channel, 'Hi!')\n\n @command(permission='view')\n def echo(self, mask, target, args):\n \"\"\"Echo\n\n %%echo ...\n \"\"\"\n yield ' '.join(args[''])\n" }, { "path": "examples/mycommands.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.plugins.command import command\n\n\n@command\ndef echo(bot, mask, target, args):\n \"\"\"Echo command\n\n %%echo ...\n \"\"\"\n yield ' '.join(args[''])\n\n\n@command(permission='admin', public=False)\ndef adduser(bot, mask, target, args):\n \"\"\"Add a user\n\n %%adduser \n \"\"\"\n bot.privmsg(mask.nick, 'User added')\n\n\n@command(show_in_help_list=False)\ndef my_secret_operation(bot, mask, target, args):\n \"\"\"Do something you don't want in !help all the time\n\n %%my_secret_operation\n \"\"\"\n yield \"I like turtles\"\n" }, { "path": "examples/mycrons.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.plugins.cron import cron\n\n\n@cron('30 8 * * *')\ndef wakeup(bot):\n bot.privmsg('#irc3', \"It's time to wake up!\")\n\n\n@cron('0 */2 * * *')\ndef take_a_break(bot):\n bot.privmsg('#irc3', \"It's time to take a break!\")\n" }, { "path": "examples/myextends.py", "content": "# -*- coding: utf-8 -*-\nimport irc3\n\n\n@irc3.extend\ndef my_usefull_function(bot, *args):\n return 'my_usefull_function(*%s)' % (args,)\n\n\n@irc3.plugin\nclass MyPlugin(object):\n\n def __init__(self, bot):\n self.bot = bot\n\n @irc3.extend\n def my_usefull_method(self, *args):\n return 'my_usefull_method(*%s)' % (args,)\n" }, { "path": "examples/nickserv.py", "content": "# -*- coding: utf-8 -*-\nimport irc3\n\n\n@irc3.event(r'(@(?P\\S+) )?:(?PNickServ)!NickServ@services.'\n r' NOTICE (?Pirc3) :This nickname is registered.*')\ndef register(bot, ns=None, nick=None, **kw):\n try:\n password = bot.config[bot.config.host][nick]\n except KeyError:\n pass\n else:\n bot.privmsg(ns, 'identify %s %s' % (nick, password))\n" }, { "path": "examples/paginate.py", "content": "# -*- coding: utf-8 -*-\nimport irc3\nimport requests\nfrom irc3.plugins.command import command\n\n\n@irc3.plugin\nclass SendFile(object):\n\n requires = [\n 'irc3.plugins.command',\n 'irc3.plugins.pager',\n ]\n\n def __init__(self, bot):\n self.bot = bot\n\n @command\n def cat(self, mask, target, args):\n \"\"\"Cat a file with pagination\n\n %%cat\n \"\"\"\n fd = open(__file__)\n for msg in self.bot.paginate(mask, fd, lines_per_page=10):\n yield msg\n\n @command\n def url(self, mask, target, args):\n \"\"\"Cat an url with pagination\n\n %%url \n \"\"\"\n def iterator(url):\n resp = requests.get(url)\n for chunk in resp.iter_content(255):\n yield chunk.decode('utf8')\n for msg in self.bot.paginate(mask, iterator(args[''])):\n yield msg\n" }, { "path": "examples/proxy.py", "content": "# -*- coding: utf-8 -*-\nimport socks\nimport irc3\n\n\ndef sock_factory(bot, host, port):\n sock = socks.socksocket()\n sock.set_proxy(socks.SOCKS5, \"localhost\", 6969)\n sock.connect((host, 6667))\n return sock\n\n\ndef main():\n bot = irc3.IrcBot.from_argv(sock_factory=sock_factory)\n bot.run()\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "examples/slack.ini", "content": "[bot]\nnick = \nhost = chat.freenode.net\nport = 6697\nssl = true\nsasl_username = \nsasl_password = \nincludes =\n irc3.plugins.slack\n[irc3.plugins.slack]\ntoken = \n[irc3.plugins.slack.channels]\n =\n ${#}\n ${#}\n =\n ${#}\n" }, { "path": "examples/spy.ini", "content": "[bot]\nnick = spyer\nusername = spyer\nhost = localhost\nport = 6667\nchannel = gov\nincludes =\n spy\n\n[bot_chater]\nnick = chater\nusername = chater\nchannel = irc3\n\n[server]\nservername = spy\n\n" }, { "path": "examples/spy.py", "content": "# -*- coding: utf-8 -*-\nimport irc3\n\n\n@irc3.plugin\nclass Plugin(object):\n\n chater = None\n\n def __init__(self, context):\n self.log = context.log\n self.context = context\n self.channel = context.config.channel\n\n @irc3.event(irc3.rfc.CONNECTED)\n def connected(self, **kw):\n chater = self.context.config.botnet['bot_chater']\n if chater is self.context:\n self.chater = None\n self.log.info(\"I'm a chater\")\n else:\n self.chater = chater\n self.log.info(\"I'm a spyer\")\n self.context.join(self.channel)\n\n @irc3.event(irc3.rfc.PRIVMSG)\n def on_privmsg(self, mask=None, data=None, **kw):\n print(self.chater, mask, data)\n if self.chater:\n self.chater.privmsg(self.chater.config.channel,\n '{0}: {1}'.format(mask.nick, data))\n" }, { "path": "examples/topic.py", "content": "# -*- coding: utf-8 -*-\nimport irc3\nfrom irc3.plugins.command import command\nfrom irc3.plugins.cron import cron\n\n\n@irc3.plugin\nclass TopicPlugin:\n\n requires = ['irc3.plugins.async']\n\n def __init__(self, bot):\n self.bot = bot\n\n @irc3.event(irc3.rfc.TOPIC)\n @irc3.event(irc3.rfc.RPL_TOPIC)\n def get_topic(self, channel=None, data=None, **kwargs):\n \"\"\"check the topic on join or on user action\"\"\"\n self.bot.log.warn('Topic for %s is %s', channel, data)\n\n @cron('* * * * *')\n async def cron_topic(self):\n \"\"\"check the topic each minute\"\"\"\n result = await self.bot.async_cmds.topic('#irc3_dev')\n self.bot.log.warn('Topic for #irc3_dev is %(topic)s', result)\n\n @command\n def topic(self, mask, target, args):\n \"\"\"Set topic\n\n %%topic ...\n \"\"\"\n if target.is_channel:\n self.bot.topic(target, ' '.join(args['']))\n\n @command\n async def aiotopic(self, mask, target, args):\n \"\"\"Set topic and get result the async way\n\n %%aiotopic [...]\n \"\"\"\n if target.is_channel:\n result = await self.bot.async_cmds.topic(\n target, ' '.join(args['']))\n return result['topic']\n" }, { "path": "examples/wsgiapp.py", "content": "# -*- coding: utf-8 -*-\nimport asyncio\nfrom aiohttp_wsgi import wsgi\nfrom irc3 import plugin\nimport json\n\n\n@plugin\nclass Webapp:\n\n requires = ['irc3.plugins.userlist']\n\n def __init__(self, bot):\n def server():\n return wsgi.WSGIServerHttpProtocol(self.wsgi)\n self.bot = bot\n loop = asyncio.get_event_loop()\n self.bot.log.info('Starting webapp')\n asyncio.Task(loop.create_server(\n server, '127.0.0.1', 5000))\n\n def wsgi(self, environ, start_response):\n start_response('200 OK', [('Content-Type', 'application/json')])\n plugin = self.bot.get_plugin('userlist')\n data = json.dumps(list(plugin.channels.keys()))\n return [data.encode('utf8')]\n" }, { "path": "irc3/__init__.py", "content": "# -*- coding: utf-8 -*-\nfrom urllib.request import urlopen\nfrom ipaddress import ip_address\nfrom collections import deque\nfrom .dcc import DCCManager\nfrom .dcc import DCCChat\nfrom .dec import dcc_event\nfrom .dec import event\nfrom .dec import extend\nfrom .dec import plugin\nfrom . import config\nfrom . import utils\nfrom . import rfc\nfrom . import base\nfrom .compat import asyncio\nfrom .compat import Queue\nimport venusian\nimport time\n\n\nclass IrcConnection(asyncio.Protocol):\n \"\"\"asyncio protocol to handle an irc connection\"\"\"\n\n def connection_made(self, transport):\n self.transport = transport\n self.closed = False\n self.queue = deque()\n\n def decode(self, data):\n \"\"\"Decode data with bot's encoding\"\"\"\n encoding = getattr(self, 'encoding', 'ascii')\n return data.decode(encoding, 'ignore')\n\n def data_received(self, data):\n data = self.decode(data)\n if self.queue:\n data = self.queue.popleft() + data\n lines = data.split('\\r\\n')\n self.queue.append(lines.pop(-1))\n for line in lines:\n self.factory.dispatch(line)\n\n def write(self, data):\n if data is not None:\n data = data.encode(self.encoding)\n if not data.endswith(b'\\r\\n'):\n data = data + b'\\r\\n'\n self.transport.write(data)\n\n def connection_lost(self, exc):\n self.factory.log.critical('connection lost (%s): %r',\n id(self.transport),\n exc)\n self.factory.notify('connection_lost')\n if not self.closed:\n self.close()\n # wait a few before reconnect\n self.factory.loop.call_later(\n 2, self.factory.create_connection)\n\n def close(self):\n if not self.closed:\n self.factory.log.critical('closing old transport (%r)',\n id(self.transport))\n try:\n self.transport.close()\n finally:\n self.closed = True\n\n\nclass IrcBot(base.IrcObject):\n \"\"\"An IRC bot\"\"\"\n\n _pep8 = [dcc_event, event, extend, plugin, rfc, config]\n venusian = venusian\n venusian_categories = [\n 'irc3',\n 'irc3.dcc',\n 'irc3.extend',\n 'irc3.rfc1459',\n 'irc3.plugins.cron',\n 'irc3.plugins.command',\n ]\n\n logging_config = config.LOGGING\n\n defaults = dict(\n base.IrcObject.defaults,\n nick='irc3',\n username='irc3',\n realname='Irc bot based on irc3 http://irc3.readthedocs.io',\n host='localhost',\n mode=0,\n url='https://irc3.readthedocs.io/',\n passwords={},\n flood_burst=4,\n flood_rate=1,\n flood_rate_delay=1,\n ctcp=dict(\n version='irc3 {version} - {url}',\n userinfo='{realname}',\n time='{now:%c}',\n ),\n # freenode config as default for testing\n server_config=dict(\n STATUSMSG='+@',\n PREFIX='(ov)@+',\n CHANTYPES='#',\n CHANMODES='eIbq,k,flj,CFLMPQScgimnprstz',\n ),\n connection=IrcConnection,\n )\n\n def __init__(self, *ini, **config):\n update_config_needed = False\n if 'userinfo' in config or \\\n ('realname' in config and 'username' not in config):\n update_config_needed = True # pragma: no cover\n super(IrcBot, self).__init__(*ini, **config)\n if update_config_needed: # pragma: no cover\n # Backward compat. Remove me in 2017\n self.log.fatal('realname has been renamed to username.')\n self.log.fatal('userinfo has been renamed to realname.')\n self.log.fatal('Please update your config with something like:.')\n if 'realname' in self.config:\n self.log.fatal('username = %(realname)s', self.config)\n if 'userinfo' in self.config:\n self.log.fatal('realname = %(userinfo)s', self.config)\n import sys\n sys.exit(-1)\n self.queue = None\n if self.config.asynchronous:\n self.queue = Queue(loop=self.loop)\n self.awaiting_queue = self.create_task(self.process_queue())\n self._ip = self._dcc = None\n # auto include the sasl plugin if needed\n if 'sasl_username' in self.config and \\\n 'irc3.plugins.sasl' not in self.registry.includes:\n self.include('irc3.plugins.sasl')\n # auto include the autojoins plugin if needed (for backward compat)\n if 'autojoins' in self.config and \\\n 'irc3.plugins.autojoins' not in self.registry.includes:\n self.include('irc3.plugins.autojoins')\n\n @property\n def server_config(self):\n \"\"\"return server configuration (rfc rpl 005)::\n\n >>> bot = IrcBot()\n >>> print(bot.server_config['STATUSMSG'])\n +@\n\n The real values are only available after the server sent them.\n \"\"\"\n return self.config.server_config\n\n def connection_made(self, f): # pragma: no cover\n if getattr(self, 'protocol', None):\n self.protocol.close()\n try:\n transport, protocol = f.result()\n except Exception as e:\n self.log.exception(e)\n self.loop.call_later(3, self.create_connection)\n else:\n self.log.debug('Connected')\n self.protocol = protocol\n self.protocol.queue = deque()\n self.protocol.factory = self\n self.protocol.encoding = self.encoding\n if self.config.get('password'):\n self._send('PASS {password}'.format(**self.config))\n self.notify('connection_ready')\n self.send((\n 'USER {username} {mode} * :{realname}\\r\\n'\n 'NICK {nick}\\r\\n'\n ).format(**self.config))\n self.notify('connection_made')\n\n def send_line(self, data, nowait=False):\n \"\"\"send a line to the server. replace CR by spaces\"\"\"\n data = data.replace('\\n', ' ').replace('\\r', ' ')\n f = self.loop.create_future()\n if self.queue is not None and nowait is False:\n self.queue.put_nowait((f, data))\n else:\n self.send(data.replace('\\n', ' ').replace('\\r', ' '))\n f.set_result(True)\n return f\n\n async def process_queue(self):\n flood_burst = self.config.flood_burst\n delay = float(self.config.flood_rate_delay)\n flood_rate = delay / float(self.config.flood_rate)\n while True:\n if flood_burst == 0:\n future, data = await self.queue.get()\n future.set_result(True)\n self.send(data)\n await asyncio.sleep(.001, loop=self.loop)\n else:\n lines = []\n for i in range(flood_burst):\n future, data = await self.queue.get()\n future.set_result(True)\n lines.append(data)\n if self.queue.empty():\n break\n if lines:\n self.send('\\r\\n'.join(lines))\n while not self.queue.empty():\n await asyncio.sleep(flood_rate, loop=self.loop)\n future, data = await self.queue.get()\n future.set_result(True)\n self.send(data)\n\n def send(self, data):\n \"\"\"send data to the server\"\"\"\n self._send(data)\n\n def _send(self, data):\n self.protocol.write(data)\n self.dispatch(data, iotype='out')\n\n def privmsg(self, target, message, nowait=False):\n \"\"\"send a privmsg to target\"\"\"\n if message:\n is_dcc = isinstance(target, DCCChat)\n prefix = '' if is_dcc else 'PRIVMSG %s :' % target\n messages = utils.split_message(\n message,\n self.config.max_length,\n self.encoding,\n prefix=prefix,\n )\n if is_dcc:\n for message in messages:\n target.send_line(message)\n elif target:\n f = None\n for message in messages:\n f = self.send_line(prefix + message,\n nowait=nowait)\n return f\n\n def action(self, target, message, nowait=False):\n return self.privmsg(target, '\\x01ACTION %s\\x01' % message,\n nowait=nowait)\n\n def notice(self, target, message, nowait=False):\n \"\"\"send a notice to target\"\"\"\n if message:\n is_dcc = isinstance(target, DCCChat)\n prefix = '' if is_dcc else 'NOTICE %s :' % target\n messages = utils.split_message(\n message,\n self.config.max_length,\n self.encoding,\n prefix=prefix,\n )\n if is_dcc:\n for message in messages:\n target.send_line(message)\n elif target:\n f = None\n for message in messages:\n f = self.send_line(prefix + message,\n nowait=nowait)\n return f\n\n def ctcp(self, target, message, nowait=False):\n \"\"\"send a ctcp to target\"\"\"\n if target and message:\n messages = utils.split_message(\n message,\n self.config.max_length,\n self.encoding,\n )\n f = None\n for message in messages:\n f = self.send_line('PRIVMSG %s :\\x01%s\\x01' % (target,\n message),\n nowait=nowait)\n return f\n\n def ctcp_reply(self, target, message, nowait=False):\n \"\"\"send a ctcp reply to target\"\"\"\n if target and message:\n messages = utils.split_message(\n message,\n self.config.max_length,\n self.encoding,\n )\n f = None\n for message in messages:\n f = self.send_line('NOTICE %s :\\x01%s\\x01' % (target, message),\n nowait=nowait)\n return f\n\n def mode(self, target, *data):\n \"\"\"set user or channel mode\"\"\"\n self.send_line('MODE %s %s' % (target, ' '.join(data)), nowait=True)\n\n def join(self, target):\n \"\"\"join a channel\"\"\"\n password = self.config.passwords.get(\n target.strip(self.server_config['CHANTYPES']))\n if password:\n target += ' ' + password\n self.send_line('JOIN %s' % target)\n\n def part(self, target, reason=None):\n \"\"\"quit a channel\"\"\"\n if reason:\n target += ' :' + reason\n self.send_line('PART %s' % target)\n\n def kick(self, channel, target, reason=None):\n \"\"\"kick target from channel\"\"\"\n if reason:\n target += ' :' + reason\n self.send_line('KICK %s %s' % (channel, target), nowait=True)\n\n def invite(self, target, channel):\n \"\"\"invite target to a channel\"\"\"\n self.send_line('INVITE %s %s' % (target, channel))\n\n def topic(self, channel, topic=None):\n \"\"\"change or request the topic of a channel\"\"\"\n if topic:\n channel += ' :' + topic\n self.send_line('TOPIC %s' % channel)\n\n def away(self, message=None):\n \"\"\"mark ourself as away\"\"\"\n cmd = 'AWAY'\n if message:\n cmd += ' :' + message\n self.send_line(cmd)\n\n def unaway(self):\n \"\"\"mask ourself as no longer away\"\"\"\n self.away()\n\n def quit(self, reason=None):\n \"\"\"disconnect\"\"\"\n if not reason:\n reason = 'bye'\n else:\n reason = reason\n self.send_line('QUIT :%s' % reason)\n\n def get_nick(self):\n return self.config.nick\n\n def set_nick(self, nick):\n self.send_line('NICK ' + nick, nowait=True)\n\n nick = property(get_nick, set_nick, doc='nickname get/set')\n\n @property\n def ip(self):\n \"\"\"return bot's ip as an ``ip_address`` object\"\"\"\n if not self._ip:\n if 'ip' in self.config:\n ip = self.config['ip']\n else:\n ip = self.protocol.transport.get_extra_info('sockname')[0]\n ip = ip_address(ip)\n if ip.version == 4:\n self._ip = ip\n else: # pragma: no cover\n response = urlopen('http://ipv4.icanhazip.com/')\n ip = response.read().strip().decode()\n ip = ip_address(ip)\n self._ip = ip\n return self._ip\n\n @property\n def dcc(self):\n \"\"\"return the :class:`~irc3.dcc.DCCManager`\"\"\"\n if self._dcc is None:\n self._dcc = DCCManager(self)\n return self._dcc\n\n async def dcc_chat(self, mask, host=None, port=None):\n \"\"\"Open a DCC CHAT whith mask. If host/port are specified then connect\n to a server. Else create a server\"\"\"\n conn = self.dcc.create(\n 'chat', mask, host=host, port=port)\n await conn.ready\n return conn\n\n async def dcc_get(self, mask, host, port, filepath, filesize=None):\n \"\"\"DCC GET a file from mask. filepath must be an absolute path with an\n existing directory. filesize is the expected file size.\"\"\"\n conn = self.dcc.create(\n 'get', mask, filepath=filepath, filesize=filesize,\n host=host, port=port)\n await conn.ready\n return conn\n\n async def dcc_send(self, mask, filepath):\n \"\"\"DCC SEND a file to mask. filepath must be an absolute path to\n existing file\"\"\"\n conn = self.dcc.create('send', mask, filepath=filepath)\n await conn.ready\n return conn\n\n async def dcc_accept(self, mask, filepath, port, pos):\n \"\"\"accept a DCC RESUME for an axisting DCC SEND. filepath is the\n filename to sent. port is the port opened on the server.\n pos is the expected offset\"\"\"\n return self.dcc.resume(mask, filepath, port, pos)\n\n def SIGHUP(self):\n self.reload()\n\n def SIGINT(self):\n self.notify('SIGINT')\n if getattr(self, 'protocol', None):\n self.quit('INT')\n time.sleep(1)\n self.loop.stop()\n\n\ndef run(argv=None):\n bots = {}\n bot = IrcBot.from_argv(argv, botnet=bots)\n bots['bot'] = bot\n for section in list(bot.config):\n if section.startswith('bot_'):\n config = bot.config.pop(section)\n bots[section] = IrcBot.from_argv(argv, botnet=bots, **config)\n bot.loop.run_forever()\n return bots\n" }, { "path": "irc3/__main__.py", "content": "from irc3 import run\n\nif __name__ == '__main__':\n run()\n" }, { "path": "irc3/_gen_doc.py", "content": "# -*- coding: utf-8 -*-\nfrom . import rfc\nfrom . import template\nimport os\n\n\ndef render_attrs(title, attrs, out):\n out.write(title + '\\n')\n out.write(len(title) * '=' + '\\n')\n out.write('\\n')\n for attr in attrs:\n name = attr.name\n title = name\n if isinstance(attr, int):\n title = '%s - %s' % (attr, title)\n out.write(title + '\\n')\n out.write(len(title) * '-' + '\\n\\n')\n if hasattr(attr, 'tpl'):\n out.write('Format ``%s``\\n\\n' % attr.tpl.replace('{c.', '{'))\n out.write('Match ``%s``\\n\\n' % attr.re)\n out.write('Example:\\n\\n')\n out.write('.. code-block:: python\\n\\n')\n out.write(' @irc3.event(rfc.%s)\\n' % name)\n params = getattr(attr, 'params', [])\n if params:\n params = '=None, '.join(params)\n out.write(' def myevent(bot, %s=None):\\n' % params)\n else:\n out.write(' def myevent(bot):\\n' % params)\n out.write(' # do something\\n')\n out.write('\\n')\n re_out = getattr(attr, 're_out', None)\n if re_out is not None:\n out.write('Out Match ``%s``\\n\\n' % re_out.re)\n out.write('Example:\\n\\n')\n out.write('.. code-block:: python\\n\\n')\n out.write(' @irc3.event(rfc.%s, iotype=\"out\")\\n' % name)\n params = getattr(re_out, 'params', [])\n if params:\n params = '=None, '.join(params)\n out.write(' def myevent(bot, %s=None):\\n' % params)\n else:\n raise RuntimeError('regexp %s as no params' % re_out)\n out.write(' # do something\\n')\n out.write('\\n')\n\n\ndef main():\n print('Generate docs...')\n\n attrs = [getattr(rfc, attr) for attr in dir(rfc)\n if attr.isupper() and attr not in ('RETCODES',)]\n repls = [attr for attr in attrs if attr.name.startswith('RPL_')]\n errs = [attr for attr in attrs if attr.name.startswith('ERR_')]\n misc = [attr for attr in attrs\n if not attr.name.startswith(('ERR_', 'RPL_'))]\n out = open('docs/rfc.rst', 'w')\n out.write('========================\\n')\n out.write(':mod:`irc3.rfc` RFC1459\\n')\n out.write('========================\\n\\n')\n render_attrs('Replies (REPL)', repls, out)\n render_attrs('Errors (ERR)', errs, out)\n render_attrs('Misc', misc, out)\n\n try:\n os.makedirs('docs/plugins')\n except OSError:\n pass\n\n for filename in os.listdir('irc3/plugins'):\n if filename.startswith('_'):\n continue\n if not filename.endswith('.py'):\n continue\n filename = filename.replace('.py', '')\n modname = 'irc3.plugins.%s' % filename\n out = open('docs/plugins/' + filename + '.rst', 'w')\n out.write('.. automodule:: ' + modname + '\\n')\n out.write('\\n')\n\n template.main(nick='mybot',\n dest=os.path.join(os.getcwd(), 'examples'))\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "irc3/_parse_rfc.py", "content": "# -*- coding: utf-8 -*-\nfrom collections import defaultdict\nimport pprint\nimport re\n\n_re_num = re.compile(r'\\s(?P\\d+)\\s+(?P(RPL|ERR)_\\w+)\\s*(?P<_>.*)')\n_re_mask = re.compile(r'^\\s{24,25}(?P<_>(\"(<|:).*|\\S.*\"$))')\n\n\ndef main():\n print('Parsing rfc file...')\n item = None\n items = []\n\n out = open('irc3/_rfc.py', 'w')\n\n with open('irc3/rfc1459.txt') as fd:\n for line in fd:\n line = line.replace(' * ', ' * ')\n line = line.replace('<# visible>', '')\n line = line.replace('[*][@|+]', '')\n line = line.replace('@', '')\n\n match = _re_num.search(line)\n if match is not None:\n if item:\n items.append((int(item['num']), item))\n item = defaultdict(list)\n match = match.groupdict()\n if '_' in match:\n match.pop('_')\n item.update(match)\n match = _re_mask.search(line)\n if match is not None:\n item['mask'].append(match.groupdict()['_'])\n\n _re_sub = re.compile('(?P<[^>]+>)')\n\n out.write('''\nclass retcode(int):\n name = None\n re = None\n\n'''.lstrip())\n\n valids = set()\n for i, item in sorted(items):\n mask = item['mask']\n if mask:\n num = item['num']\n valids.add(i)\n out.write('\\n')\n out.write('%(name)s = retcode(%(num)s)\\n' % item)\n out.write('%(name)s.name = \"%(name)s\"\\n' % item)\n mask = [s.strip('\"\\\\ ') for s in mask]\n omask = ' '.join(mask)\n\n params = []\n\n def repl(v):\n v = v.lower()\n v = v.replace('nickname', 'nick')\n v = v.replace('nicks', 'nicknames')\n for c in '!@*':\n v = v.replace(c, '')\n for c in '| ':\n v = v.replace(c, '_')\n v = v.strip(' _')\n if v.endswith('_name'):\n v = v[:-5]\n if v == 'client_ip_address_in_dot_form':\n v = 'clientip'\n if v == 'integer':\n for k in 'xyz':\n if k not in params:\n v = k\n break\n if v == 'command':\n v = 'cmd'\n if v == 'real':\n v = 'realname'\n if v == 'name' and 'nick' not in params:\n v = 'nick'\n if v == 'user':\n if 'nick' not in params and num not in ('352',):\n v = 'nick'\n else:\n v = 'username'\n return v\n\n def tsub(m):\n v = m.groupdict()['m'].strip('<>')\n v = repl(v)\n params.append(v)\n return '{%s}' % v\n\n if item['num'] == '303':\n omask = ':'\n elif item['num'] == '311':\n omask = omask.replace('*', '')\n elif item['num'] == '319':\n omask = ':'\n elif item['num'] == '353':\n omask = ' :'\n\n tpl = _re_sub.sub(tsub, omask)\n for v in ((' %d ', '{days}'),\n ('%d:%02d:%02d', '{hours}'),\n (':%-8s %-9s %-8s', '{x} {y} {z}')):\n tpl = tpl.replace(*v)\n tpl_ = [':{c.srv} ' + item['num'] + ' {c.nick} ']\n if len(tpl) > 60:\n tpl_.extend([':' + s for s in tpl.split(':', 1)])\n else:\n tpl_.append(tpl)\n tpl = '\\n '.join([repr(v) for v in tpl_])\n\n params = []\n\n def msub(m):\n v = m.groupdict()['m'].strip('<>')\n v = repl(v)\n params.append(v)\n return r'(?P<%s>\\S+)' % v\n\n mask = _re_sub.sub(msub, omask)\n if '???? ' in mask:\n mask = mask.replace('???? ', r'\\S+ ')\n if ' * ' in mask:\n mask = mask.replace(' * ', r' . ')\n if ':' in mask:\n mask = mask.split(':', 1)[0]\n mask += ':(?P.*)'\n mask = r'(?P\\S+) ' + str(i) + ' (?P\\\\S+) \"\\n r\"' + mask\n mask = mask.replace(\n r' (?P\\S+)',\n ' \"\\n r\"(?P\\\\S+)')\n mask = mask.replace(\n r' (?P\\S+)',\n ' \"\\n r\"(?P\\\\S+)')\n item['mask'] = mask\n params = [p for p in params if '<%s>' % p in mask]\n if '' in mask and 'data' not in params:\n params.append('data')\n out.write('%(name)s.re = (\\n r\"^:%(mask)s\")\\n' % item)\n params = pprint.pformat(\n ['srv', 'me'] + params, width=60, indent=4)\n if len(params) > 60:\n params = params.replace('[', '[\\n ')\n out.write('%(name)s.tpl = (\\n' % dict(item))\n out.write(' %s)\\n' % tpl)\n out.write('%(name)s.params = %(p)s\\n' % dict(item, p=params))\n\n out.write('\\n')\n out.write('RETCODES = {\\n')\n for i, item in sorted(items):\n if i in valids:\n out.write(' %(num)s: %(name)s,\\n' % item)\n out.write('}\\n')\n out.close()\n\n\nif __name__ == '__main__':\n main()\n" }, { "path": "irc3/_rfc.py", "content": "class retcode(int):\n name = None\n re = None\n\n\nRPL_TRACELINK = retcode(200)\nRPL_TRACELINK.name = \"RPL_TRACELINK\"\nRPL_TRACELINK.re = (\n r\"^:(?P\\S+) 200 (?P\\S+) \"\n r\"(?P\\S+)\")\nRPL_TRACELINK.tpl = (\n ':{c.srv} 200 {c.nick} '\n '{next_server}')\nRPL_TRACELINK.params = ['srv', 'me', 'next_server']\n\nRPL_TRACECONNECTING = retcode(201)\nRPL_TRACECONNECTING.name = \"RPL_TRACECONNECTING\"\nRPL_TRACECONNECTING.re = (\n r\"^:(?P\\S+) 201 (?P\\S+) \"\n r\"Try. (?P\\S+) \"\n r\"(?P\\S+)\")\nRPL_TRACECONNECTING.tpl = (\n ':{c.srv} 201 {c.nick} '\n 'Try. {class} {server}')\nRPL_TRACECONNECTING.params = ['srv', 'me', 'class', 'server']\n\nRPL_TRACEHANDSHAKE = retcode(202)\nRPL_TRACEHANDSHAKE.name = \"RPL_TRACEHANDSHAKE\"\nRPL_TRACEHANDSHAKE.re = (\n r\"^:(?P\\S+) 202 (?P\\S+) \"\n r\"H.S. (?P\\S+) \"\n r\"(?P\\S+)\")\nRPL_TRACEHANDSHAKE.tpl = (\n ':{c.srv} 202 {c.nick} '\n 'H.S. {class} {server}')\nRPL_TRACEHANDSHAKE.params = ['srv', 'me', 'class', 'server']\n\nRPL_TRACEUNKNOWN = retcode(203)\nRPL_TRACEUNKNOWN.name = \"RPL_TRACEUNKNOWN\"\nRPL_TRACEUNKNOWN.re = (\n r\"^:(?P\\S+) 203 (?P\\S+) \"\n r\"\\S+ (?P\\S+) [(?P\\S+)]\")\nRPL_TRACEUNKNOWN.tpl = (\n ':{c.srv} 203 {c.nick} '\n '???? {class} [{clientip}]')\nRPL_TRACEUNKNOWN.params = ['srv', 'me', 'class', 'clientip']\n\nRPL_TRACEOPERATOR = retcode(204)\nRPL_TRACEOPERATOR.name = \"RPL_TRACEOPERATOR\"\nRPL_TRACEOPERATOR.re = (\n r\"^:(?P\\S+) 204 (?P\\S+) \"\n r\"Oper (?P\\S+) (?P\\S+)\")\nRPL_TRACEOPERATOR.tpl = (\n ':{c.srv} 204 {c.nick} '\n 'Oper {class} {nick}')\nRPL_TRACEOPERATOR.params = ['srv', 'me', 'class', 'nick']\n\nRPL_TRACEUSER = retcode(205)\nRPL_TRACEUSER.name = \"RPL_TRACEUSER\"\nRPL_TRACEUSER.re = (\n r\"^:(?P\\S+) 205 (?P\\S+) \"\n r\"User (?P\\S+) (?P\\S+)\")\nRPL_TRACEUSER.tpl = (\n ':{c.srv} 205 {c.nick} '\n 'User {class} {nick}')\nRPL_TRACEUSER.params = ['srv', 'me', 'class', 'nick']\n\nRPL_TRACESERVER = retcode(206)\nRPL_TRACESERVER.name = \"RPL_TRACESERVER\"\nRPL_TRACESERVER.re = (\n r\"^:(?P\\S+) 206 (?P\\S+) \"\n r\"(?P\\S+)\")\nRPL_TRACESERVER.tpl = (\n ':{c.srv} 206 {c.nick} '\n '{mask}')\nRPL_TRACESERVER.params = ['srv', 'me', 'mask']\n\nRPL_TRACENEWTYPE = retcode(208)\nRPL_TRACENEWTYPE.name = \"RPL_TRACENEWTYPE\"\nRPL_TRACENEWTYPE.re = (\n r\"^:(?P\\S+) 208 (?P\\S+) \"\n r\"(?P\\S+) 0 (?P\\S+)\")\nRPL_TRACENEWTYPE.tpl = (\n ':{c.srv} 208 {c.nick} '\n '{newtype} 0 {client}')\nRPL_TRACENEWTYPE.params = ['srv', 'me', 'newtype', 'client']\n\nRPL_STATSLINKINFO = retcode(211)\nRPL_STATSLINKINFO.name = \"RPL_STATSLINKINFO\"\nRPL_STATSLINKINFO.re = (\n r\"^:(?P\\S+) 211 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+)\")\nRPL_STATSLINKINFO.tpl = (\n ':{c.srv} 211 {c.nick} '\n ':{linkname} {sendq} {sent_messages} {received_bytes} {time_open}')\nRPL_STATSLINKINFO.params = [\n 'srv',\n 'me',\n 'linkname',\n 'sendq',\n 'sent_messages',\n 'received_bytes',\n 'time_open']\n\nRPL_STATSCOMMANDS = retcode(212)\nRPL_STATSCOMMANDS.name = \"RPL_STATSCOMMANDS\"\nRPL_STATSCOMMANDS.re = (\n r\"^:(?P\\S+) 212 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+)\")\nRPL_STATSCOMMANDS.tpl = (\n ':{c.srv} 212 {c.nick} '\n '{cmd} {count}')\nRPL_STATSCOMMANDS.params = ['srv', 'me', 'cmd', 'count']\n\nRPL_STATSCLINE = retcode(213)\nRPL_STATSCLINE.name = \"RPL_STATSCLINE\"\nRPL_STATSCLINE.re = (\n r\"^:(?P\\S+) 213 (?P\\S+) \"\n r\"C (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)\")\nRPL_STATSCLINE.tpl = (\n ':{c.srv} 213 {c.nick} '\n 'C {host} * {nick} {port} {class}')\nRPL_STATSCLINE.params = ['srv', 'me', 'host', 'nick', 'port', 'class']\n\nRPL_STATSNLINE = retcode(214)\nRPL_STATSNLINE.name = \"RPL_STATSNLINE\"\nRPL_STATSNLINE.re = (\n r\"^:(?P\\S+) 214 (?P\\S+) \"\n r\"N (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)\")\nRPL_STATSNLINE.tpl = (\n ':{c.srv} 214 {c.nick} '\n 'N {host} * {nick} {port} {class}')\nRPL_STATSNLINE.params = ['srv', 'me', 'host', 'nick', 'port', 'class']\n\nRPL_STATSILINE = retcode(215)\nRPL_STATSILINE.name = \"RPL_STATSILINE\"\nRPL_STATSILINE.re = (\n r\"^:(?P\\S+) 215 (?P\\S+) \"\n r\"I (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)\")\nRPL_STATSILINE.tpl = (\n ':{c.srv} 215 {c.nick} '\n 'I {host} * {host1} {port} {class}')\nRPL_STATSILINE.params = ['srv', 'me', 'host', 'host1', 'port', 'class']\n\nRPL_STATSKLINE = retcode(216)\nRPL_STATSKLINE.name = \"RPL_STATSKLINE\"\nRPL_STATSKLINE.re = (\n r\"^:(?P\\S+) 216 (?P\\S+) \"\n r\"K (?P\\S+) . (?P\\S+) (?P\\S+) (?P\\S+)\")\nRPL_STATSKLINE.tpl = (\n ':{c.srv} 216 {c.nick} '\n 'K {host} * {username} {port} {class}')\nRPL_STATSKLINE.params = ['srv', 'me', 'host', 'username', 'port', 'class']\n\nRPL_STATSYLINE = retcode(218)\nRPL_STATSYLINE.name = \"RPL_STATSYLINE\"\nRPL_STATSYLINE.re = (\n r\"^:(?P\\S+) 218 (?P\\S+) \"\n r\"frequency> (?P\\S+)\")\nRPL_STATSYLINE.tpl = (\n ':{c.srv} 218 {c.nick} '\n 'frequency> {max_sendq}')\nRPL_STATSYLINE.params = ['srv', 'me', 'max_sendq']\n\nRPL_ENDOFSTATS = retcode(219)\nRPL_ENDOFSTATS.name = \"RPL_ENDOFSTATS\"\nRPL_ENDOFSTATS.re = (\n r\"^:(?P\\S+) 219 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFSTATS.tpl = (\n ':{c.srv} 219 {c.nick} '\n '{stats_letter} :End of /STATS report')\nRPL_ENDOFSTATS.params = ['srv', 'me', 'stats_letter', 'data']\n\nRPL_UMODEIS = retcode(221)\nRPL_UMODEIS.name = \"RPL_UMODEIS\"\nRPL_UMODEIS.re = (\n r\"^:(?P\\S+) 221 (?P\\S+) \"\n r\"(?P\\S+)\")\nRPL_UMODEIS.tpl = (\n ':{c.srv} 221 {c.nick} '\n '{user_mode_string}')\nRPL_UMODEIS.params = ['srv', 'me', 'user_mode_string']\n\nRPL_STATSLLINE = retcode(241)\nRPL_STATSLLINE.name = \"RPL_STATSLLINE\"\nRPL_STATSLLINE.re = (\n r\"^:(?P\\S+) 241 (?P\\S+) \"\n r\"L (?P\\S+) . (?P\\S+) (?P\\S+)\")\nRPL_STATSLLINE.tpl = (\n ':{c.srv} 241 {c.nick} '\n 'L {hostmask} * {servername} {maxdepth}')\nRPL_STATSLLINE.params = ['srv', 'me', 'hostmask', 'servername', 'maxdepth']\n\nRPL_STATSUPTIME = retcode(242)\nRPL_STATSUPTIME.name = \"RPL_STATSUPTIME\"\nRPL_STATSUPTIME.re = (\n r\"^:(?P\\S+) 242 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_STATSUPTIME.tpl = (\n ':{c.srv} 242 {c.nick} '\n ':Server Up{days}days {hours}')\nRPL_STATSUPTIME.params = ['srv', 'me', 'data']\n\nRPL_STATSOLINE = retcode(243)\nRPL_STATSOLINE.name = \"RPL_STATSOLINE\"\nRPL_STATSOLINE.re = (\n r\"^:(?P\\S+) 243 (?P\\S+) \"\n r\"O (?P\\S+) . (?P\\S+)\")\nRPL_STATSOLINE.tpl = (\n ':{c.srv} 243 {c.nick} '\n 'O {hostmask} * {nick}')\nRPL_STATSOLINE.params = ['srv', 'me', 'hostmask', 'nick']\n\nRPL_STATSHLINE = retcode(244)\nRPL_STATSHLINE.name = \"RPL_STATSHLINE\"\nRPL_STATSHLINE.re = (\n r\"^:(?P\\S+) 244 (?P\\S+) \"\n r\"H (?P\\S+) . (?P\\S+)\")\nRPL_STATSHLINE.tpl = (\n ':{c.srv} 244 {c.nick} '\n 'H {hostmask} * {servername}')\nRPL_STATSHLINE.params = ['srv', 'me', 'hostmask', 'servername']\n\nRPL_LUSERCLIENT = retcode(251)\nRPL_LUSERCLIENT.name = \"RPL_LUSERCLIENT\"\nRPL_LUSERCLIENT.re = (\n r\"^:(?P\\S+) 251 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_LUSERCLIENT.tpl = (\n ':{c.srv} 251 {c.nick} '\n ':There are {x} users and {y} invisible on {z} servers')\nRPL_LUSERCLIENT.params = ['srv', 'me', 'data']\n\nRPL_LUSEROP = retcode(252)\nRPL_LUSEROP.name = \"RPL_LUSEROP\"\nRPL_LUSEROP.re = (\n r\"^:(?P\\S+) 252 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_LUSEROP.tpl = (\n ':{c.srv} 252 {c.nick} '\n '{x} :operator(s) online')\nRPL_LUSEROP.params = ['srv', 'me', 'x', 'data']\n\nRPL_LUSERUNKNOWN = retcode(253)\nRPL_LUSERUNKNOWN.name = \"RPL_LUSERUNKNOWN\"\nRPL_LUSERUNKNOWN.re = (\n r\"^:(?P\\S+) 253 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_LUSERUNKNOWN.tpl = (\n ':{c.srv} 253 {c.nick} '\n '{x} :unknown connection(s)')\nRPL_LUSERUNKNOWN.params = ['srv', 'me', 'x', 'data']\n\nRPL_LUSERCHANNELS = retcode(254)\nRPL_LUSERCHANNELS.name = \"RPL_LUSERCHANNELS\"\nRPL_LUSERCHANNELS.re = (\n r\"^:(?P\\S+) 254 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_LUSERCHANNELS.tpl = (\n ':{c.srv} 254 {c.nick} '\n '{x} :channels formed')\nRPL_LUSERCHANNELS.params = ['srv', 'me', 'x', 'data']\n\nRPL_LUSERME = retcode(255)\nRPL_LUSERME.name = \"RPL_LUSERME\"\nRPL_LUSERME.re = (\n r\"^:(?P\\S+) 255 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_LUSERME.tpl = (\n ':{c.srv} 255 {c.nick} '\n ':I have {x} clients and {y}')\nRPL_LUSERME.params = ['srv', 'me', 'data']\n\nRPL_ADMINME = retcode(256)\nRPL_ADMINME.name = \"RPL_ADMINME\"\nRPL_ADMINME.re = (\n r\"^:(?P\\S+) 256 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ADMINME.tpl = (\n ':{c.srv} 256 {c.nick} '\n '{server} :Administrative info')\nRPL_ADMINME.params = ['srv', 'me', 'server', 'data']\n\nRPL_ADMINLOC1 = retcode(257)\nRPL_ADMINLOC1.name = \"RPL_ADMINLOC1\"\nRPL_ADMINLOC1.re = (\n r\"^:(?P\\S+) 257 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ADMINLOC1.tpl = (\n ':{c.srv} 257 {c.nick} '\n ':{admin_info}')\nRPL_ADMINLOC1.params = ['srv', 'me', 'data']\n\nRPL_ADMINLOC2 = retcode(258)\nRPL_ADMINLOC2.name = \"RPL_ADMINLOC2\"\nRPL_ADMINLOC2.re = (\n r\"^:(?P\\S+) 258 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ADMINLOC2.tpl = (\n ':{c.srv} 258 {c.nick} '\n ':{admin_info}')\nRPL_ADMINLOC2.params = ['srv', 'me', 'data']\n\nRPL_ADMINEMAIL = retcode(259)\nRPL_ADMINEMAIL.name = \"RPL_ADMINEMAIL\"\nRPL_ADMINEMAIL.re = (\n r\"^:(?P\\S+) 259 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ADMINEMAIL.tpl = (\n ':{c.srv} 259 {c.nick} '\n ':{admin_info}')\nRPL_ADMINEMAIL.params = ['srv', 'me', 'data']\n\nRPL_TRACELOG = retcode(261)\nRPL_TRACELOG.name = \"RPL_TRACELOG\"\nRPL_TRACELOG.re = (\n r\"^:(?P\\S+) 261 (?P\\S+) \"\n r\"File (?P\\S+) (?P\\S+)\")\nRPL_TRACELOG.tpl = (\n ':{c.srv} 261 {c.nick} '\n 'File {logfile} {debug_level}')\nRPL_TRACELOG.params = ['srv', 'me', 'logfile', 'debug_level']\n\nRPL_AWAY = retcode(301)\nRPL_AWAY.name = \"RPL_AWAY\"\nRPL_AWAY.re = (\n r\"^:(?P\\S+) 301 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_AWAY.tpl = (\n ':{c.srv} 301 {c.nick} '\n '{nick} :{away_message}')\nRPL_AWAY.params = ['srv', 'me', 'nick', 'data']\n\nRPL_USERHOST = retcode(302)\nRPL_USERHOST.name = \"RPL_USERHOST\"\nRPL_USERHOST.re = (\n r\"^:(?P\\S+) 302 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_USERHOST.tpl = (\n ':{c.srv} 302 {c.nick} '\n ':[{reply}{{space}{reply}}]')\nRPL_USERHOST.params = ['srv', 'me', 'data']\n\nRPL_ISON = retcode(303)\nRPL_ISON.name = \"RPL_ISON\"\nRPL_ISON.re = (\n r\"^:(?P\\S+) 303 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ISON.tpl = (\n ':{c.srv} 303 {c.nick} '\n ':{nicknames}')\nRPL_ISON.params = ['srv', 'me', 'data']\n\nRPL_UNAWAY = retcode(305)\nRPL_UNAWAY.name = \"RPL_UNAWAY\"\nRPL_UNAWAY.re = (\n r\"^:(?P\\S+) 305 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_UNAWAY.tpl = (\n ':{c.srv} 305 {c.nick} '\n ':You are no longer marked as being away')\nRPL_UNAWAY.params = ['srv', 'me', 'data']\n\nRPL_NOWAWAY = retcode(306)\nRPL_NOWAWAY.name = \"RPL_NOWAWAY\"\nRPL_NOWAWAY.re = (\n r\"^:(?P\\S+) 306 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_NOWAWAY.tpl = (\n ':{c.srv} 306 {c.nick} '\n ':You have been marked as being away')\nRPL_NOWAWAY.params = ['srv', 'me', 'data']\n\nRPL_WHOISUSER = retcode(311)\nRPL_WHOISUSER.name = \"RPL_WHOISUSER\"\nRPL_WHOISUSER.re = (\n r\"^:(?P\\S+) 311 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)\")\nRPL_WHOISUSER.tpl = (\n ':{c.srv} 311 {c.nick} '\n '{nick} {username} {host} {m} :{realname}')\nRPL_WHOISUSER.params = ['srv', 'me', 'nick', 'username', 'host', 'm', 'data']\n\nRPL_WHOISSERVER = retcode(312)\nRPL_WHOISSERVER.name = \"RPL_WHOISSERVER\"\nRPL_WHOISSERVER.re = (\n r\"^:(?P\\S+) 312 (?P\\S+) \"\n r\"(?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_WHOISSERVER.tpl = (\n ':{c.srv} 312 {c.nick} '\n '{nick} {server} :{server_info}')\nRPL_WHOISSERVER.params = ['srv', 'me', 'nick', 'server', 'data']\n\nRPL_WHOISOPERATOR = retcode(313)\nRPL_WHOISOPERATOR.name = \"RPL_WHOISOPERATOR\"\nRPL_WHOISOPERATOR.re = (\n r\"^:(?P\\S+) 313 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_WHOISOPERATOR.tpl = (\n ':{c.srv} 313 {c.nick} '\n '{nick} :is an IRC operator')\nRPL_WHOISOPERATOR.params = ['srv', 'me', 'nick', 'data']\n\nRPL_WHOWASUSER = retcode(314)\nRPL_WHOWASUSER.name = \"RPL_WHOWASUSER\"\nRPL_WHOWASUSER.re = (\n r\"^:(?P\\S+) 314 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+) . :(?P.*)\")\nRPL_WHOWASUSER.tpl = (\n ':{c.srv} 314 {c.nick} '\n '{nick} {username} {host} * :{realname}')\nRPL_WHOWASUSER.params = ['srv', 'me', 'nick', 'username', 'host', 'data']\n\nRPL_ENDOFWHO = retcode(315)\nRPL_ENDOFWHO.name = \"RPL_ENDOFWHO\"\nRPL_ENDOFWHO.re = (\n r\"^:(?P\\S+) 315 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFWHO.tpl = (\n ':{c.srv} 315 {c.nick} '\n '{nick} :End of /WHO list')\nRPL_ENDOFWHO.params = ['srv', 'me', 'nick', 'data']\n\nRPL_WHOISIDLE = retcode(317)\nRPL_WHOISIDLE.name = \"RPL_WHOISIDLE\"\nRPL_WHOISIDLE.re = (\n r\"^:(?P\\S+) 317 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) :(?P.*)\")\nRPL_WHOISIDLE.tpl = (\n ':{c.srv} 317 {c.nick} '\n '{nick} {x} :seconds idle')\nRPL_WHOISIDLE.params = ['srv', 'me', 'nick', 'x', 'data']\n\nRPL_ENDOFWHOIS = retcode(318)\nRPL_ENDOFWHOIS.name = \"RPL_ENDOFWHOIS\"\nRPL_ENDOFWHOIS.re = (\n r\"^:(?P\\S+) 318 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFWHOIS.tpl = (\n ':{c.srv} 318 {c.nick} '\n '{nick} :End of /WHOIS list')\nRPL_ENDOFWHOIS.params = ['srv', 'me', 'nick', 'data']\n\nRPL_WHOISCHANNELS = retcode(319)\nRPL_WHOISCHANNELS.name = \"RPL_WHOISCHANNELS\"\nRPL_WHOISCHANNELS.re = (\n r\"^:(?P\\S+) 319 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_WHOISCHANNELS.tpl = (\n ':{c.srv} 319 {c.nick} '\n ':{channels}')\nRPL_WHOISCHANNELS.params = ['srv', 'me', 'data']\n\nRPL_LISTSTART = retcode(321)\nRPL_LISTSTART.name = \"RPL_LISTSTART\"\nRPL_LISTSTART.re = (\n r\"^:(?P\\S+) 321 (?P\\S+) \"\n r\"Channel :(?P.*)\")\nRPL_LISTSTART.tpl = (\n ':{c.srv} 321 {c.nick} '\n 'Channel :Users Name')\nRPL_LISTSTART.params = ['srv', 'me', 'data']\n\nRPL_LIST = retcode(322)\nRPL_LIST.name = \"RPL_LIST\"\nRPL_LIST.re = (\n r\"^:(?P\\S+) 322 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) :(?P.*)\")\nRPL_LIST.tpl = (\n ':{c.srv} 322 {c.nick} '\n '{channel} {visible} :{topic}')\nRPL_LIST.params = ['srv', 'me', 'channel', 'visible', 'data']\n\nRPL_LISTEND = retcode(323)\nRPL_LISTEND.name = \"RPL_LISTEND\"\nRPL_LISTEND.re = (\n r\"^:(?P\\S+) 323 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_LISTEND.tpl = (\n ':{c.srv} 323 {c.nick} '\n ':End of /LIST')\nRPL_LISTEND.params = ['srv', 'me', 'data']\n\nRPL_CHANNELMODEIS = retcode(324)\nRPL_CHANNELMODEIS.name = \"RPL_CHANNELMODEIS\"\nRPL_CHANNELMODEIS.re = (\n r\"^:(?P\\S+) 324 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+)\")\nRPL_CHANNELMODEIS.tpl = (\n ':{c.srv} 324 {c.nick} '\n '{channel} {mode} {mode_params}')\nRPL_CHANNELMODEIS.params = ['srv', 'me', 'channel', 'mode', 'mode_params']\n\nRPL_NOTOPIC = retcode(331)\nRPL_NOTOPIC.name = \"RPL_NOTOPIC\"\nRPL_NOTOPIC.re = (\n r\"^:(?P\\S+) 331 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_NOTOPIC.tpl = (\n ':{c.srv} 331 {c.nick} '\n '{channel} :No topic is set')\nRPL_NOTOPIC.params = ['srv', 'me', 'channel', 'data']\n\nRPL_TOPIC = retcode(332)\nRPL_TOPIC.name = \"RPL_TOPIC\"\nRPL_TOPIC.re = (\n r\"^:(?P\\S+) 332 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_TOPIC.tpl = (\n ':{c.srv} 332 {c.nick} '\n '{channel} :{topic}')\nRPL_TOPIC.params = ['srv', 'me', 'channel', 'data']\n\nRPL_INVITING = retcode(341)\nRPL_INVITING.name = \"RPL_INVITING\"\nRPL_INVITING.re = (\n r\"^:(?P\\S+) 341 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+)\")\nRPL_INVITING.tpl = (\n ':{c.srv} 341 {c.nick} '\n '{channel} {nick}')\nRPL_INVITING.params = ['srv', 'me', 'channel', 'nick']\n\nRPL_SUMMONING = retcode(342)\nRPL_SUMMONING.name = \"RPL_SUMMONING\"\nRPL_SUMMONING.re = (\n r\"^:(?P\\S+) 342 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_SUMMONING.tpl = (\n ':{c.srv} 342 {c.nick} '\n '{nick} :Summoning user to IRC')\nRPL_SUMMONING.params = ['srv', 'me', 'nick', 'data']\n\nRPL_VERSION = retcode(351)\nRPL_VERSION.name = \"RPL_VERSION\"\nRPL_VERSION.re = (\n r\"^:(?P\\S+) 351 (?P\\S+) \"\n r\"(?P\\S+).(?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_VERSION.tpl = (\n ':{c.srv} 351 {c.nick} '\n '{version}.{debuglevel} {server} :{comments}')\nRPL_VERSION.params = ['srv', 'me', 'version', 'debuglevel', 'server', 'data']\n\nRPL_WHOREPLY = retcode(352)\nRPL_WHOREPLY.name = \"RPL_WHOREPLY\"\nRPL_WHOREPLY.re = (\n r\"^:(?P\\S+) 352 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+) :(?P.*)\")\nRPL_WHOREPLY.tpl = (\n ':{c.srv} 352 {c.nick} '\n ':{channel} {username} {host} {server} {nick} {modes} '\n ':{hopcount} {realname}')\nRPL_WHOREPLY.params = [\n 'srv',\n 'me',\n 'channel',\n 'username',\n 'host',\n 'server',\n 'nick',\n 'modes',\n 'data']\n\nRPL_NAMREPLY = retcode(353)\nRPL_NAMREPLY.name = \"RPL_NAMREPLY\"\nRPL_NAMREPLY.re = (\n r\"^:(?P\\S+) 353 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) :(?P.*)\")\nRPL_NAMREPLY.tpl = (\n ':{c.srv} 353 {c.nick} '\n '{m} {channel} :{nicknames}')\nRPL_NAMREPLY.params = ['srv', 'me', 'm', 'channel', 'data']\n\nRPL_LINKS = retcode(364)\nRPL_LINKS.name = \"RPL_LINKS\"\nRPL_LINKS.re = (\n r\"^:(?P\\S+) 364 (?P\\S+) \"\n r\"(?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_LINKS.tpl = (\n ':{c.srv} 364 {c.nick} '\n '{mask} {server} :{hopcount} {server_info}')\nRPL_LINKS.params = ['srv', 'me', 'mask', 'server', 'data']\n\nRPL_ENDOFLINKS = retcode(365)\nRPL_ENDOFLINKS.name = \"RPL_ENDOFLINKS\"\nRPL_ENDOFLINKS.re = (\n r\"^:(?P\\S+) 365 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFLINKS.tpl = (\n ':{c.srv} 365 {c.nick} '\n '{mask} :End of /LINKS list')\nRPL_ENDOFLINKS.params = ['srv', 'me', 'mask', 'data']\n\nRPL_ENDOFNAMES = retcode(366)\nRPL_ENDOFNAMES.name = \"RPL_ENDOFNAMES\"\nRPL_ENDOFNAMES.re = (\n r\"^:(?P\\S+) 366 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFNAMES.tpl = (\n ':{c.srv} 366 {c.nick} '\n '{channel} :End of /NAMES list')\nRPL_ENDOFNAMES.params = ['srv', 'me', 'channel', 'data']\n\nRPL_BANLIST = retcode(367)\nRPL_BANLIST.name = \"RPL_BANLIST\"\nRPL_BANLIST.re = (\n r\"^:(?P\\S+) 367 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+)\")\nRPL_BANLIST.tpl = (\n ':{c.srv} 367 {c.nick} '\n '{channel} {banid}')\nRPL_BANLIST.params = ['srv', 'me', 'channel', 'banid']\n\nRPL_ENDOFBANLIST = retcode(368)\nRPL_ENDOFBANLIST.name = \"RPL_ENDOFBANLIST\"\nRPL_ENDOFBANLIST.re = (\n r\"^:(?P\\S+) 368 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFBANLIST.tpl = (\n ':{c.srv} 368 {c.nick} '\n '{channel} :End of channel ban list')\nRPL_ENDOFBANLIST.params = ['srv', 'me', 'channel', 'data']\n\nRPL_ENDOFWHOWAS = retcode(369)\nRPL_ENDOFWHOWAS.name = \"RPL_ENDOFWHOWAS\"\nRPL_ENDOFWHOWAS.re = (\n r\"^:(?P\\S+) 369 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_ENDOFWHOWAS.tpl = (\n ':{c.srv} 369 {c.nick} '\n '{nick} :End of WHOWAS')\nRPL_ENDOFWHOWAS.params = ['srv', 'me', 'nick', 'data']\n\nRPL_INFO = retcode(371)\nRPL_INFO.name = \"RPL_INFO\"\nRPL_INFO.re = (\n r\"^:(?P\\S+) 371 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_INFO.tpl = (\n ':{c.srv} 371 {c.nick} '\n ':{string}')\nRPL_INFO.params = ['srv', 'me', 'data']\n\nRPL_MOTD = retcode(372)\nRPL_MOTD.name = \"RPL_MOTD\"\nRPL_MOTD.re = (\n r\"^:(?P\\S+) 372 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_MOTD.tpl = (\n ':{c.srv} 372 {c.nick} '\n ':- {text}')\nRPL_MOTD.params = ['srv', 'me', 'data']\n\nRPL_ENDOFINFO = retcode(374)\nRPL_ENDOFINFO.name = \"RPL_ENDOFINFO\"\nRPL_ENDOFINFO.re = (\n r\"^:(?P\\S+) 374 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ENDOFINFO.tpl = (\n ':{c.srv} 374 {c.nick} '\n ':End of /INFO list')\nRPL_ENDOFINFO.params = ['srv', 'me', 'data']\n\nRPL_MOTDSTART = retcode(375)\nRPL_MOTDSTART.name = \"RPL_MOTDSTART\"\nRPL_MOTDSTART.re = (\n r\"^:(?P\\S+) 375 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_MOTDSTART.tpl = (\n ':{c.srv} 375 {c.nick} '\n ':- {server} Message of the day -')\nRPL_MOTDSTART.params = ['srv', 'me', 'data']\n\nRPL_ENDOFMOTD = retcode(376)\nRPL_ENDOFMOTD.name = \"RPL_ENDOFMOTD\"\nRPL_ENDOFMOTD.re = (\n r\"^:(?P\\S+) 376 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ENDOFMOTD.tpl = (\n ':{c.srv} 376 {c.nick} '\n ':End of /MOTD command')\nRPL_ENDOFMOTD.params = ['srv', 'me', 'data']\n\nRPL_YOUREOPER = retcode(381)\nRPL_YOUREOPER.name = \"RPL_YOUREOPER\"\nRPL_YOUREOPER.re = (\n r\"^:(?P\\S+) 381 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_YOUREOPER.tpl = (\n ':{c.srv} 381 {c.nick} '\n ':You are now an IRC operator')\nRPL_YOUREOPER.params = ['srv', 'me', 'data']\n\nRPL_REHASHING = retcode(382)\nRPL_REHASHING.name = \"RPL_REHASHING\"\nRPL_REHASHING.re = (\n r\"^:(?P\\S+) 382 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_REHASHING.tpl = (\n ':{c.srv} 382 {c.nick} '\n '{config_file} :Rehashing')\nRPL_REHASHING.params = ['srv', 'me', 'config_file', 'data']\n\nRPL_TIME = retcode(391)\nRPL_TIME.name = \"RPL_TIME\"\nRPL_TIME.re = (\n r\"^:(?P\\S+) 391 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nRPL_TIME.tpl = (\n ':{c.srv} 391 {c.nick} '\n \"{server} :{string_showing_server's_local_time}\")\nRPL_TIME.params = ['srv', 'me', 'server', 'data']\n\nRPL_USERSSTART = retcode(392)\nRPL_USERSSTART.name = \"RPL_USERSSTART\"\nRPL_USERSSTART.re = (\n r\"^:(?P\\S+) 392 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_USERSSTART.tpl = (\n ':{c.srv} 392 {c.nick} '\n ':UserID Terminal Host')\nRPL_USERSSTART.params = ['srv', 'me', 'data']\n\nRPL_USERS = retcode(393)\nRPL_USERS.name = \"RPL_USERS\"\nRPL_USERS.re = (\n r\"^:(?P\\S+) 393 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_USERS.tpl = (\n ':{c.srv} 393 {c.nick} '\n '{x} {y} {z}')\nRPL_USERS.params = ['srv', 'me', 'data']\n\nRPL_ENDOFUSERS = retcode(394)\nRPL_ENDOFUSERS.name = \"RPL_ENDOFUSERS\"\nRPL_ENDOFUSERS.re = (\n r\"^:(?P\\S+) 394 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_ENDOFUSERS.tpl = (\n ':{c.srv} 394 {c.nick} '\n ':End of users')\nRPL_ENDOFUSERS.params = ['srv', 'me', 'data']\n\nRPL_NOUSERS = retcode(395)\nRPL_NOUSERS.name = \"RPL_NOUSERS\"\nRPL_NOUSERS.re = (\n r\"^:(?P\\S+) 395 (?P\\S+) \"\n r\":(?P.*)\")\nRPL_NOUSERS.tpl = (\n ':{c.srv} 395 {c.nick} '\n ':Nobody logged in')\nRPL_NOUSERS.params = ['srv', 'me', 'data']\n\nERR_NOSUCHNICK = retcode(401)\nERR_NOSUCHNICK.name = \"ERR_NOSUCHNICK\"\nERR_NOSUCHNICK.re = (\n r\"^:(?P\\S+) 401 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOSUCHNICK.tpl = (\n ':{c.srv} 401 {c.nick} '\n '{nick} :No such nick/channel')\nERR_NOSUCHNICK.params = ['srv', 'me', 'nick', 'data']\n\nERR_NOSUCHSERVER = retcode(402)\nERR_NOSUCHSERVER.name = \"ERR_NOSUCHSERVER\"\nERR_NOSUCHSERVER.re = (\n r\"^:(?P\\S+) 402 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOSUCHSERVER.tpl = (\n ':{c.srv} 402 {c.nick} '\n '{server} :No such server')\nERR_NOSUCHSERVER.params = ['srv', 'me', 'server', 'data']\n\nERR_NOSUCHCHANNEL = retcode(403)\nERR_NOSUCHCHANNEL.name = \"ERR_NOSUCHCHANNEL\"\nERR_NOSUCHCHANNEL.re = (\n r\"^:(?P\\S+) 403 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOSUCHCHANNEL.tpl = (\n ':{c.srv} 403 {c.nick} '\n '{channel} :No such channel')\nERR_NOSUCHCHANNEL.params = ['srv', 'me', 'channel', 'data']\n\nERR_CANNOTSENDTOCHAN = retcode(404)\nERR_CANNOTSENDTOCHAN.name = \"ERR_CANNOTSENDTOCHAN\"\nERR_CANNOTSENDTOCHAN.re = (\n r\"^:(?P\\S+) 404 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_CANNOTSENDTOCHAN.tpl = (\n ':{c.srv} 404 {c.nick} '\n '{channel} :Cannot send to channel')\nERR_CANNOTSENDTOCHAN.params = ['srv', 'me', 'channel', 'data']\n\nERR_TOOMANYCHANNELS = retcode(405)\nERR_TOOMANYCHANNELS.name = \"ERR_TOOMANYCHANNELS\"\nERR_TOOMANYCHANNELS.re = (\n r\"^:(?P\\S+) 405 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_TOOMANYCHANNELS.tpl = (\n ':{c.srv} 405 {c.nick} '\n '{channel} :You have joined too many channels')\nERR_TOOMANYCHANNELS.params = ['srv', 'me', 'channel', 'data']\n\nERR_WASNOSUCHNICK = retcode(406)\nERR_WASNOSUCHNICK.name = \"ERR_WASNOSUCHNICK\"\nERR_WASNOSUCHNICK.re = (\n r\"^:(?P\\S+) 406 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_WASNOSUCHNICK.tpl = (\n ':{c.srv} 406 {c.nick} '\n '{nick} :There was no such nickname')\nERR_WASNOSUCHNICK.params = ['srv', 'me', 'nick', 'data']\n\nERR_TOOMANYTARGETS = retcode(407)\nERR_TOOMANYTARGETS.name = \"ERR_TOOMANYTARGETS\"\nERR_TOOMANYTARGETS.re = (\n r\"^:(?P\\S+) 407 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_TOOMANYTARGETS.tpl = (\n ':{c.srv} 407 {c.nick} '\n '{target} :Duplicate recipients. No message delivered')\nERR_TOOMANYTARGETS.params = ['srv', 'me', 'target', 'data']\n\nERR_NOORIGIN = retcode(409)\nERR_NOORIGIN.name = \"ERR_NOORIGIN\"\nERR_NOORIGIN.re = (\n r\"^:(?P\\S+) 409 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOORIGIN.tpl = (\n ':{c.srv} 409 {c.nick} '\n ':No origin specified')\nERR_NOORIGIN.params = ['srv', 'me', 'data']\n\nERR_NORECIPIENT = retcode(411)\nERR_NORECIPIENT.name = \"ERR_NORECIPIENT\"\nERR_NORECIPIENT.re = (\n r\"^:(?P\\S+) 411 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NORECIPIENT.tpl = (\n ':{c.srv} 411 {c.nick} '\n ':No recipient given ({cmd})')\nERR_NORECIPIENT.params = ['srv', 'me', 'data']\n\nERR_NOTEXTTOSEND = retcode(412)\nERR_NOTEXTTOSEND.name = \"ERR_NOTEXTTOSEND\"\nERR_NOTEXTTOSEND.re = (\n r\"^:(?P\\S+) 412 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOTEXTTOSEND.tpl = (\n ':{c.srv} 412 {c.nick} '\n ':No text to send')\nERR_NOTEXTTOSEND.params = ['srv', 'me', 'data']\n\nERR_NOTOPLEVEL = retcode(413)\nERR_NOTOPLEVEL.name = \"ERR_NOTOPLEVEL\"\nERR_NOTOPLEVEL.re = (\n r\"^:(?P\\S+) 413 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOTOPLEVEL.tpl = (\n ':{c.srv} 413 {c.nick} '\n '{mask} :No toplevel domain specified')\nERR_NOTOPLEVEL.params = ['srv', 'me', 'mask', 'data']\n\nERR_WILDTOPLEVEL = retcode(414)\nERR_WILDTOPLEVEL.name = \"ERR_WILDTOPLEVEL\"\nERR_WILDTOPLEVEL.re = (\n r\"^:(?P\\S+) 414 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_WILDTOPLEVEL.tpl = (\n ':{c.srv} 414 {c.nick} '\n '{mask} :Wildcard in toplevel domain')\nERR_WILDTOPLEVEL.params = ['srv', 'me', 'mask', 'data']\n\nERR_UNKNOWNCOMMAND = retcode(421)\nERR_UNKNOWNCOMMAND.name = \"ERR_UNKNOWNCOMMAND\"\nERR_UNKNOWNCOMMAND.re = (\n r\"^:(?P\\S+) 421 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_UNKNOWNCOMMAND.tpl = (\n ':{c.srv} 421 {c.nick} '\n '{cmd} :Unknown command')\nERR_UNKNOWNCOMMAND.params = ['srv', 'me', 'cmd', 'data']\n\nERR_NOMOTD = retcode(422)\nERR_NOMOTD.name = \"ERR_NOMOTD\"\nERR_NOMOTD.re = (\n r\"^:(?P\\S+) 422 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOMOTD.tpl = (\n ':{c.srv} 422 {c.nick} '\n ':MOTD File is missing')\nERR_NOMOTD.params = ['srv', 'me', 'data']\n\nERR_NOADMININFO = retcode(423)\nERR_NOADMININFO.name = \"ERR_NOADMININFO\"\nERR_NOADMININFO.re = (\n r\"^:(?P\\S+) 423 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOADMININFO.tpl = (\n ':{c.srv} 423 {c.nick} '\n '{server} :No administrative info available')\nERR_NOADMININFO.params = ['srv', 'me', 'server', 'data']\n\nERR_NONICKNAMEGIVEN = retcode(431)\nERR_NONICKNAMEGIVEN.name = \"ERR_NONICKNAMEGIVEN\"\nERR_NONICKNAMEGIVEN.re = (\n r\"^:(?P\\S+) 431 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NONICKNAMEGIVEN.tpl = (\n ':{c.srv} 431 {c.nick} '\n ':No nickname given')\nERR_NONICKNAMEGIVEN.params = ['srv', 'me', 'data']\n\nERR_ERRONEUSNICKNAME = retcode(432)\nERR_ERRONEUSNICKNAME.name = \"ERR_ERRONEUSNICKNAME\"\nERR_ERRONEUSNICKNAME.re = (\n r\"^:(?P\\S+) 432 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_ERRONEUSNICKNAME.tpl = (\n ':{c.srv} 432 {c.nick} '\n '{nick} :Erroneus nickname')\nERR_ERRONEUSNICKNAME.params = ['srv', 'me', 'nick', 'data']\n\nERR_NICKNAMEINUSE = retcode(433)\nERR_NICKNAMEINUSE.name = \"ERR_NICKNAMEINUSE\"\nERR_NICKNAMEINUSE.re = (\n r\"^:(?P\\S+) 433 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NICKNAMEINUSE.tpl = (\n ':{c.srv} 433 {c.nick} '\n '{nick} :Nickname is already in use')\nERR_NICKNAMEINUSE.params = ['srv', 'me', 'nick', 'data']\n\nERR_NICKCOLLISION = retcode(436)\nERR_NICKCOLLISION.name = \"ERR_NICKCOLLISION\"\nERR_NICKCOLLISION.re = (\n r\"^:(?P\\S+) 436 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NICKCOLLISION.tpl = (\n ':{c.srv} 436 {c.nick} '\n '{nick} :Nickname collision KILL')\nERR_NICKCOLLISION.params = ['srv', 'me', 'nick', 'data']\n\nERR_USERNOTINCHANNEL = retcode(441)\nERR_USERNOTINCHANNEL.name = \"ERR_USERNOTINCHANNEL\"\nERR_USERNOTINCHANNEL.re = (\n r\"^:(?P\\S+) 441 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) :(?P.*)\")\nERR_USERNOTINCHANNEL.tpl = (\n ':{c.srv} 441 {c.nick} '\n \"{nick} {channel} :They aren't on that channel\")\nERR_USERNOTINCHANNEL.params = ['srv', 'me', 'nick', 'channel', 'data']\n\nERR_NOTONCHANNEL = retcode(442)\nERR_NOTONCHANNEL.name = \"ERR_NOTONCHANNEL\"\nERR_NOTONCHANNEL.re = (\n r\"^:(?P\\S+) 442 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOTONCHANNEL.tpl = (\n ':{c.srv} 442 {c.nick} '\n \"{channel} :You're not on that channel\")\nERR_NOTONCHANNEL.params = ['srv', 'me', 'channel', 'data']\n\nERR_USERONCHANNEL = retcode(443)\nERR_USERONCHANNEL.name = \"ERR_USERONCHANNEL\"\nERR_USERONCHANNEL.re = (\n r\"^:(?P\\S+) 443 (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) :(?P.*)\")\nERR_USERONCHANNEL.tpl = (\n ':{c.srv} 443 {c.nick} '\n '{nick} {channel} :is already on channel')\nERR_USERONCHANNEL.params = ['srv', 'me', 'nick', 'channel', 'data']\n\nERR_NOLOGIN = retcode(444)\nERR_NOLOGIN.name = \"ERR_NOLOGIN\"\nERR_NOLOGIN.re = (\n r\"^:(?P\\S+) 444 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NOLOGIN.tpl = (\n ':{c.srv} 444 {c.nick} '\n '{nick} :User not logged in')\nERR_NOLOGIN.params = ['srv', 'me', 'nick', 'data']\n\nERR_SUMMONDISABLED = retcode(445)\nERR_SUMMONDISABLED.name = \"ERR_SUMMONDISABLED\"\nERR_SUMMONDISABLED.re = (\n r\"^:(?P\\S+) 445 (?P\\S+) \"\n r\":(?P.*)\")\nERR_SUMMONDISABLED.tpl = (\n ':{c.srv} 445 {c.nick} '\n ':SUMMON has been disabled')\nERR_SUMMONDISABLED.params = ['srv', 'me', 'data']\n\nERR_USERSDISABLED = retcode(446)\nERR_USERSDISABLED.name = \"ERR_USERSDISABLED\"\nERR_USERSDISABLED.re = (\n r\"^:(?P\\S+) 446 (?P\\S+) \"\n r\":(?P.*)\")\nERR_USERSDISABLED.tpl = (\n ':{c.srv} 446 {c.nick} '\n ':USERS has been disabled')\nERR_USERSDISABLED.params = ['srv', 'me', 'data']\n\nERR_NOTREGISTERED = retcode(451)\nERR_NOTREGISTERED.name = \"ERR_NOTREGISTERED\"\nERR_NOTREGISTERED.re = (\n r\"^:(?P\\S+) 451 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOTREGISTERED.tpl = (\n ':{c.srv} 451 {c.nick} '\n ':You have not registered')\nERR_NOTREGISTERED.params = ['srv', 'me', 'data']\n\nERR_NEEDMOREPARAMS = retcode(461)\nERR_NEEDMOREPARAMS.name = \"ERR_NEEDMOREPARAMS\"\nERR_NEEDMOREPARAMS.re = (\n r\"^:(?P\\S+) 461 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_NEEDMOREPARAMS.tpl = (\n ':{c.srv} 461 {c.nick} '\n '{cmd} :Not enough parameters')\nERR_NEEDMOREPARAMS.params = ['srv', 'me', 'cmd', 'data']\n\nERR_ALREADYREGISTRED = retcode(462)\nERR_ALREADYREGISTRED.name = \"ERR_ALREADYREGISTRED\"\nERR_ALREADYREGISTRED.re = (\n r\"^:(?P\\S+) 462 (?P\\S+) \"\n r\":(?P.*)\")\nERR_ALREADYREGISTRED.tpl = (\n ':{c.srv} 462 {c.nick} '\n ':You may not reregister')\nERR_ALREADYREGISTRED.params = ['srv', 'me', 'data']\n\nERR_NOPERMFORHOST = retcode(463)\nERR_NOPERMFORHOST.name = \"ERR_NOPERMFORHOST\"\nERR_NOPERMFORHOST.re = (\n r\"^:(?P\\S+) 463 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOPERMFORHOST.tpl = (\n ':{c.srv} 463 {c.nick} '\n \":Your host isn't among the privileged\")\nERR_NOPERMFORHOST.params = ['srv', 'me', 'data']\n\nERR_PASSWDMISMATCH = retcode(464)\nERR_PASSWDMISMATCH.name = \"ERR_PASSWDMISMATCH\"\nERR_PASSWDMISMATCH.re = (\n r\"^:(?P\\S+) 464 (?P\\S+) \"\n r\":(?P.*)\")\nERR_PASSWDMISMATCH.tpl = (\n ':{c.srv} 464 {c.nick} '\n ':Password incorrect')\nERR_PASSWDMISMATCH.params = ['srv', 'me', 'data']\n\nERR_YOUREBANNEDCREEP = retcode(465)\nERR_YOUREBANNEDCREEP.name = \"ERR_YOUREBANNEDCREEP\"\nERR_YOUREBANNEDCREEP.re = (\n r\"^:(?P\\S+) 465 (?P\\S+) \"\n r\":(?P.*)\")\nERR_YOUREBANNEDCREEP.tpl = (\n ':{c.srv} 465 {c.nick} '\n ':You are banned from this server')\nERR_YOUREBANNEDCREEP.params = ['srv', 'me', 'data']\n\nERR_KEYSET = retcode(467)\nERR_KEYSET.name = \"ERR_KEYSET\"\nERR_KEYSET.re = (\n r\"^:(?P\\S+) 467 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_KEYSET.tpl = (\n ':{c.srv} 467 {c.nick} '\n '{channel} :Channel key already set')\nERR_KEYSET.params = ['srv', 'me', 'channel', 'data']\n\nERR_CHANNELISFULL = retcode(471)\nERR_CHANNELISFULL.name = \"ERR_CHANNELISFULL\"\nERR_CHANNELISFULL.re = (\n r\"^:(?P\\S+) 471 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_CHANNELISFULL.tpl = (\n ':{c.srv} 471 {c.nick} '\n '{channel} :Cannot join channel (+l)')\nERR_CHANNELISFULL.params = ['srv', 'me', 'channel', 'data']\n\nERR_UNKNOWNMODE = retcode(472)\nERR_UNKNOWNMODE.name = \"ERR_UNKNOWNMODE\"\nERR_UNKNOWNMODE.re = (\n r\"^:(?P\\S+) 472 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_UNKNOWNMODE.tpl = (\n ':{c.srv} 472 {c.nick} '\n '{char} :is unknown mode char to me')\nERR_UNKNOWNMODE.params = ['srv', 'me', 'char', 'data']\n\nERR_INVITEONLYCHAN = retcode(473)\nERR_INVITEONLYCHAN.name = \"ERR_INVITEONLYCHAN\"\nERR_INVITEONLYCHAN.re = (\n r\"^:(?P\\S+) 473 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_INVITEONLYCHAN.tpl = (\n ':{c.srv} 473 {c.nick} '\n '{channel} :Cannot join channel (+i)')\nERR_INVITEONLYCHAN.params = ['srv', 'me', 'channel', 'data']\n\nERR_BANNEDFROMCHAN = retcode(474)\nERR_BANNEDFROMCHAN.name = \"ERR_BANNEDFROMCHAN\"\nERR_BANNEDFROMCHAN.re = (\n r\"^:(?P\\S+) 474 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_BANNEDFROMCHAN.tpl = (\n ':{c.srv} 474 {c.nick} '\n '{channel} :Cannot join channel (+b)')\nERR_BANNEDFROMCHAN.params = ['srv', 'me', 'channel', 'data']\n\nERR_BADCHANNELKEY = retcode(475)\nERR_BADCHANNELKEY.name = \"ERR_BADCHANNELKEY\"\nERR_BADCHANNELKEY.re = (\n r\"^:(?P\\S+) 475 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_BADCHANNELKEY.tpl = (\n ':{c.srv} 475 {c.nick} '\n '{channel} :Cannot join channel (+k)')\nERR_BADCHANNELKEY.params = ['srv', 'me', 'channel', 'data']\n\nERR_NOPRIVILEGES = retcode(481)\nERR_NOPRIVILEGES.name = \"ERR_NOPRIVILEGES\"\nERR_NOPRIVILEGES.re = (\n r\"^:(?P\\S+) 481 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOPRIVILEGES.tpl = (\n ':{c.srv} 481 {c.nick} '\n \":Permission Denied- You're not an IRC operator\")\nERR_NOPRIVILEGES.params = ['srv', 'me', 'data']\n\nERR_CHANOPRIVSNEEDED = retcode(482)\nERR_CHANOPRIVSNEEDED.name = \"ERR_CHANOPRIVSNEEDED\"\nERR_CHANOPRIVSNEEDED.re = (\n r\"^:(?P\\S+) 482 (?P\\S+) \"\n r\"(?P\\S+) :(?P.*)\")\nERR_CHANOPRIVSNEEDED.tpl = (\n ':{c.srv} 482 {c.nick} '\n \"{channel} :You're not channel operator\")\nERR_CHANOPRIVSNEEDED.params = ['srv', 'me', 'channel', 'data']\n\nERR_CANTKILLSERVER = retcode(483)\nERR_CANTKILLSERVER.name = \"ERR_CANTKILLSERVER\"\nERR_CANTKILLSERVER.re = (\n r\"^:(?P\\S+) 483 (?P\\S+) \"\n r\":(?P.*)\")\nERR_CANTKILLSERVER.tpl = (\n ':{c.srv} 483 {c.nick} '\n ':You cant kill a server!')\nERR_CANTKILLSERVER.params = ['srv', 'me', 'data']\n\nERR_NOOPERHOST = retcode(491)\nERR_NOOPERHOST.name = \"ERR_NOOPERHOST\"\nERR_NOOPERHOST.re = (\n r\"^:(?P\\S+) 491 (?P\\S+) \"\n r\":(?P.*)\")\nERR_NOOPERHOST.tpl = (\n ':{c.srv} 491 {c.nick} '\n ':No O-lines for your host')\nERR_NOOPERHOST.params = ['srv', 'me', 'data']\n\nERR_UMODEUNKNOWNFLAG = retcode(501)\nERR_UMODEUNKNOWNFLAG.name = \"ERR_UMODEUNKNOWNFLAG\"\nERR_UMODEUNKNOWNFLAG.re = (\n r\"^:(?P\\S+) 501 (?P\\S+) \"\n r\":(?P.*)\")\nERR_UMODEUNKNOWNFLAG.tpl = (\n ':{c.srv} 501 {c.nick} '\n ':Unknown MODE flag')\nERR_UMODEUNKNOWNFLAG.params = ['srv', 'me', 'data']\n\nERR_USERSDONTMATCH = retcode(502)\nERR_USERSDONTMATCH.name = \"ERR_USERSDONTMATCH\"\nERR_USERSDONTMATCH.re = (\n r\"^:(?P\\S+) 502 (?P\\S+) \"\n r\":(?P.*)\")\nERR_USERSDONTMATCH.tpl = (\n ':{c.srv} 502 {c.nick} '\n ':Cant change mode for other users')\nERR_USERSDONTMATCH.params = ['srv', 'me', 'data']\n\nRETCODES = {\n 200: RPL_TRACELINK,\n 201: RPL_TRACECONNECTING,\n 202: RPL_TRACEHANDSHAKE,\n 203: RPL_TRACEUNKNOWN,\n 204: RPL_TRACEOPERATOR,\n 205: RPL_TRACEUSER,\n 206: RPL_TRACESERVER,\n 208: RPL_TRACENEWTYPE,\n 211: RPL_STATSLINKINFO,\n 212: RPL_STATSCOMMANDS,\n 213: RPL_STATSCLINE,\n 214: RPL_STATSNLINE,\n 215: RPL_STATSILINE,\n 216: RPL_STATSKLINE,\n 218: RPL_STATSYLINE,\n 219: RPL_ENDOFSTATS,\n 221: RPL_UMODEIS,\n 241: RPL_STATSLLINE,\n 242: RPL_STATSUPTIME,\n 243: RPL_STATSOLINE,\n 244: RPL_STATSHLINE,\n 251: RPL_LUSERCLIENT,\n 252: RPL_LUSEROP,\n 253: RPL_LUSERUNKNOWN,\n 254: RPL_LUSERCHANNELS,\n 255: RPL_LUSERME,\n 256: RPL_ADMINME,\n 257: RPL_ADMINLOC1,\n 258: RPL_ADMINLOC2,\n 259: RPL_ADMINEMAIL,\n 261: RPL_TRACELOG,\n 301: RPL_AWAY,\n 302: RPL_USERHOST,\n 303: RPL_ISON,\n 305: RPL_UNAWAY,\n 306: RPL_NOWAWAY,\n 311: RPL_WHOISUSER,\n 312: RPL_WHOISSERVER,\n 313: RPL_WHOISOPERATOR,\n 314: RPL_WHOWASUSER,\n 315: RPL_ENDOFWHO,\n 317: RPL_WHOISIDLE,\n 318: RPL_ENDOFWHOIS,\n 319: RPL_WHOISCHANNELS,\n 321: RPL_LISTSTART,\n 322: RPL_LIST,\n 323: RPL_LISTEND,\n 324: RPL_CHANNELMODEIS,\n 331: RPL_NOTOPIC,\n 332: RPL_TOPIC,\n 341: RPL_INVITING,\n 342: RPL_SUMMONING,\n 351: RPL_VERSION,\n 352: RPL_WHOREPLY,\n 353: RPL_NAMREPLY,\n 364: RPL_LINKS,\n 365: RPL_ENDOFLINKS,\n 366: RPL_ENDOFNAMES,\n 367: RPL_BANLIST,\n 368: RPL_ENDOFBANLIST,\n 369: RPL_ENDOFWHOWAS,\n 371: RPL_INFO,\n 372: RPL_MOTD,\n 374: RPL_ENDOFINFO,\n 375: RPL_MOTDSTART,\n 376: RPL_ENDOFMOTD,\n 381: RPL_YOUREOPER,\n 382: RPL_REHASHING,\n 391: RPL_TIME,\n 392: RPL_USERSSTART,\n 393: RPL_USERS,\n 394: RPL_ENDOFUSERS,\n 395: RPL_NOUSERS,\n 401: ERR_NOSUCHNICK,\n 402: ERR_NOSUCHSERVER,\n 403: ERR_NOSUCHCHANNEL,\n 404: ERR_CANNOTSENDTOCHAN,\n 405: ERR_TOOMANYCHANNELS,\n 406: ERR_WASNOSUCHNICK,\n 407: ERR_TOOMANYTARGETS,\n 409: ERR_NOORIGIN,\n 411: ERR_NORECIPIENT,\n 412: ERR_NOTEXTTOSEND,\n 413: ERR_NOTOPLEVEL,\n 414: ERR_WILDTOPLEVEL,\n 421: ERR_UNKNOWNCOMMAND,\n 422: ERR_NOMOTD,\n 423: ERR_NOADMININFO,\n 431: ERR_NONICKNAMEGIVEN,\n 432: ERR_ERRONEUSNICKNAME,\n 433: ERR_NICKNAMEINUSE,\n 436: ERR_NICKCOLLISION,\n 441: ERR_USERNOTINCHANNEL,\n 442: ERR_NOTONCHANNEL,\n 443: ERR_USERONCHANNEL,\n 444: ERR_NOLOGIN,\n 445: ERR_SUMMONDISABLED,\n 446: ERR_USERSDISABLED,\n 451: ERR_NOTREGISTERED,\n 461: ERR_NEEDMOREPARAMS,\n 462: ERR_ALREADYREGISTRED,\n 463: ERR_NOPERMFORHOST,\n 464: ERR_PASSWDMISMATCH,\n 465: ERR_YOUREBANNEDCREEP,\n 467: ERR_KEYSET,\n 471: ERR_CHANNELISFULL,\n 472: ERR_UNKNOWNMODE,\n 473: ERR_INVITEONLYCHAN,\n 474: ERR_BANNEDFROMCHAN,\n 475: ERR_BADCHANNELKEY,\n 481: ERR_NOPRIVILEGES,\n 482: ERR_CHANOPRIVSNEEDED,\n 483: ERR_CANTKILLSERVER,\n 491: ERR_NOOPERHOST,\n 501: ERR_UMODEUNKNOWNFLAG,\n 502: ERR_USERSDONTMATCH,\n}\n" }, { "path": "irc3/asynchronous.py", "content": "# -*- coding: utf-8 -*-\nfrom .compat import asyncio\nimport re\n\n\nclass event:\n\n iotype = 'in'\n iscoroutine = True\n\n def __init__(self, **kwargs):\n # kwargs get interpolated into the regex.\n # Any kwargs not ending in _re get escaped\n self.meta = kwargs.get('meta')\n regexp = self.meta['match'].format(**{\n k: v if k.endswith('_re') else re.escape(v)\n for (k, v) in kwargs.items()\n if k != 'meta'\n })\n self.regexp = regexp\n regexp = getattr(self.regexp, 're', self.regexp)\n self.cregexp = re.compile(regexp).match\n\n def compile(self, *args, **kwargs):\n return self.cregexp\n\n def __repr__(self):\n s = getattr(self.regexp, 'name', self.regexp)\n name = self.__class__.__name__\n return ''.format(name, s)\n\n def __call__(self, callback):\n async def wrapper(*args, **kwargs):\n return await callback(self, *args, **kwargs)\n self.callback = wrapper\n return self\n\n\ndef default_result_processor(self, results=None, **value): # pragma: no cover\n value['results'] = results\n if len(results) == 1:\n value.update(results[0])\n return value\n\n\ndef async_events(context, events, send_line=None,\n process_results=default_result_processor,\n timeout=30, **params):\n\n loop = context.loop\n task = loop.create_future() # async result\n results = [] # store events results\n events_ = [] # reference registered events\n\n # async timeout\n timeout = asyncio.ensure_future(\n asyncio.sleep(timeout, loop=loop), loop=loop)\n\n def end(t=None):\n \"\"\"t can be a future (timeout done) or False (result success)\"\"\"\n if not task.done():\n # cancel timeout if needed\n if t is False:\n timeout.cancel()\n # detach events\n context.detach_events(*events_)\n # clean refs\n events_[:] = []\n # set results\n task.set_result(process_results(results=results, timeout=bool(t)))\n\n # end on timeout\n timeout.add_done_callback(end)\n\n async def callback(e, **kw):\n \"\"\"common callback for all events\"\"\"\n results.append(kw)\n if e.meta.get('multi') is not True:\n context.detach_events(e)\n events_.remove(e)\n if e.meta.get('final') is True:\n # end on success\n end(False)\n\n events_.extend([event(meta=kw, **params)(callback) for kw in events])\n\n context.attach_events(*events_, insert=True)\n\n if send_line:\n context.send_line(send_line.format(**params))\n\n return task\n\n\nclass AsyncEvents:\n \"\"\"Asynchronious events\"\"\"\n\n timeout = 30\n send_line = None\n events = []\n\n def __init__(self, context):\n self.context = context\n\n def process_results(self, results=None, **value): # pragma: no cover\n \"\"\"Process results.\n results is a list of dict catched during event.\n value is a dict containing some metadata (like timeout=(True/False).\n \"\"\"\n return default_result_processor(results=results, **value)\n\n def __call__(self, **kwargs):\n \"\"\"Register events; and callbacks then return a `asyncio.Future`.\n Events regexp are compiled with `params`\"\"\"\n kwargs.setdefault('timeout', self.timeout)\n kwargs.setdefault('send_line', self.send_line)\n kwargs['process_results'] = self.process_results\n return async_events(self.context, self.events, **kwargs)\n" }, { "path": "irc3/base.py", "content": "# -*- coding: utf-8 -*-\nimport os\nimport sys\nimport ssl\nimport signal\nimport logging\nimport logging.config\nfrom importlib import metadata\nfrom . import utils\nfrom . import config\nfrom .compat import asyncio\nfrom .compat import reload_module\nfrom collections import defaultdict\n\n\nversion = metadata.version('irc3')\n\n\nclass Registry:\n \"\"\"Store (and hide from api) plugins events and stuff\"\"\"\n\n def __init__(self):\n self.reset(reloading=False)\n\n def reset(self, reloading=True):\n self.events_re = {\n 'in': [], 'out': [],\n 'dcc_in': [], 'dcc_out': [],\n }\n self.events = {\n 'in': defaultdict(list),\n 'out': defaultdict(list),\n 'dcc_in': defaultdict(list),\n 'dcc_out': defaultdict(list),\n }\n\n self.scanned = []\n self.includes = set()\n\n if reloading:\n self.reloading = self.plugins.copy()\n else:\n self.reloading = {}\n self.plugins = {}\n\n def get_event_matches(self, data, iotype='in'):\n events = self.events[iotype]\n for regexp, cregexp in self.events_re[iotype]:\n match = cregexp(data)\n if match is not None:\n yield match, events[regexp]\n\n\nclass IrcObject:\n\n nick = None\n server = False\n plugin_category = '__irc3_plugin__'\n logging_config = config.LOGGING\n\n defaults = dict(\n port=6667,\n timeout=320,\n max_lag=60,\n asynchronous=True,\n max_length=512,\n testing=False,\n ssl=False,\n ssl_verify=False,\n encoding='utf8',\n loop=None,\n )\n\n def __init__(self, *ini, **config):\n config['version'] = version\n self.config = utils.Config(dict(self.defaults, *ini, **config))\n logging.config.dictConfig(self.logging_config)\n if self.server:\n self.log = logging.getLogger('irc3d')\n else:\n self.log = logging.getLogger('irc3.' + (self.nick or 'd'))\n self.original_nick = self.nick\n if config.get('verbose') or config.get('debug'):\n logging.getLogger('irc3').setLevel(logging.DEBUG)\n logging.getLogger('irc3d').setLevel(logging.DEBUG)\n else:\n level = config.get('level')\n if level is not None:\n level = getattr(logging, str(level), level)\n self.log.setLevel(level)\n self.encoding = self.config['encoding']\n\n self.loop = self.config.loop\n if self.loop is None:\n try:\n self.loop = asyncio.get_event_loop()\n except RuntimeError:\n self.loop = asyncio.new_event_loop()\n asyncio.set_event_loop(self.loop)\n\n self.create_task = self.loop.create_task\n\n self.registry = Registry()\n\n self.include(*self.config.get('includes', []))\n\n def get_plugin(self, ob):\n plugins = self.registry.plugins\n includes = self.registry.includes\n reloading = self.registry.reloading\n\n if isinstance(ob, str):\n ob_name = ob\n ob = utils.maybedotted(ob_name)\n if ob_name not in plugins:\n names = list(plugins)\n raise LookupError(\n 'Plugin %s not found in %s' % (ob_name, names))\n else:\n ob_name = ob.__module__ + '.' + ob.__name__\n if ob_name not in plugins:\n self.log.debug(\"Register plugin '%s'\", ob_name)\n for dotted in getattr(ob, 'requires', []):\n if dotted not in includes:\n self.include(dotted)\n plugins[ob_name] = ob(self)\n elif ob_name in reloading and hasattr(ob, 'reload'):\n instance = reloading.pop(ob_name)\n if instance.__class__ is not ob:\n self.log.debug(\"Reloading plugin '%s'\", ob_name)\n plugins[ob_name] = ob.reload(instance)\n return plugins[ob_name]\n\n def recompile(self):\n events_re = self.registry.events_re\n for iotype in ('in', 'out'):\n events = self.registry.events[iotype]\n for i, (regexp, cregexp) in enumerate(events_re[iotype]):\n e = events[regexp][0]\n events_re[i] = (regexp, e.compile(self.config))\n\n def attach_events(self, *events, **kwargs):\n \"\"\"Attach one or more events to the bot instance\"\"\"\n reg = self.registry\n insert = 'insert' in kwargs\n for e in events:\n cregexp = e.compile(self.config)\n regexp = getattr(e.regexp, 're', e.regexp)\n if regexp not in reg.events[e.iotype]:\n if insert:\n reg.events_re[e.iotype].insert(0, (regexp, cregexp))\n else:\n reg.events_re[e.iotype].append((regexp, cregexp))\n if insert:\n reg.events[e.iotype][regexp].insert(0, e)\n else:\n reg.events[e.iotype][regexp].append(e)\n\n def detach_events(self, *events):\n \"\"\"Detach one or more events from the bot instance\"\"\"\n reg = self.registry\n delete = defaultdict(list)\n\n # remove from self.events\n all_events = reg.events\n for e in events:\n regexp = getattr(e.regexp, 're', e.regexp)\n iotype = e.iotype\n if e in all_events[iotype].get(regexp, []):\n all_events[iotype][regexp].remove(e)\n if not all_events[iotype][regexp]:\n del all_events[iotype][regexp]\n # need to delete from self.events_re\n delete[iotype].append(regexp)\n\n # delete from events_re\n for iotype, regexps in delete.items():\n reg.events_re[iotype] = [r for r in reg.events_re[iotype]\n if r[0] not in regexps]\n\n def include(self, *modules, **kwargs):\n reg = self.registry\n categories = kwargs.get('venusian_categories',\n self.venusian_categories)\n scanner = self.venusian.Scanner(context=self)\n for module in modules:\n if module in reg.includes:\n self.log.warning('%s included twice', module)\n else:\n reg.includes.add(module)\n try:\n module = utils.maybedotted(module)\n except LookupError as exc:\n try:\n (module,) = metadata.entry_points(group='irc3.loader',\n name=module)\n module = module.load()\n except (ImportError, ValueError):\n raise exc\n # we have to manualy check for plugins. venusian no longer\n # support to attach both a class and methods\n for klass in list(module.__dict__.values()):\n if not isinstance(klass, type):\n continue\n if klass.__module__ == module.__name__:\n if getattr(klass, self.plugin_category, False) is True:\n self.get_plugin(klass)\n reg.scanned.append((module.__name__, categories))\n scanner.scan(module, categories=categories)\n\n def reload(self, *modules):\n \"\"\"Reload one or more plugins\"\"\"\n self.notify('before_reload')\n\n if 'configfiles' in self.config:\n # reload configfiles\n self.log.info('Reloading configuration...')\n cfg = utils.parse_config(\n self.server and 'server' or 'bot', *self.config['configfiles'])\n self.config.update(cfg)\n\n self.log.info('Reloading python code...')\n if not modules:\n modules = self.registry.includes\n scanned = list(reversed(self.registry.scanned))\n\n # reset includes and events\n self.registry.reset()\n\n to_scan = []\n for module_name, categories in scanned:\n if module_name in modules:\n module = utils.maybedotted(module_name)\n reload_module(module)\n to_scan.append((module_name, categories))\n\n # rescan all modules\n for module_name, categories in to_scan:\n self.include(module_name, venusian_categories=categories)\n\n self.registry.reloading = {}\n\n self.notify('after_reload')\n\n def notify(self, event, exc=None, client=None):\n for p in self.registry.plugins.values():\n meth = getattr(p, event, None)\n if meth is not None:\n if client is not None:\n meth(client=client)\n else:\n meth()\n\n def dispatch(self, data, iotype='in', client=None):\n str = utils.IrcString\n create_task = self.create_task\n call_soon = self.loop.call_soon\n for match, events in self.registry.get_event_matches(data, iotype):\n match = match.groupdict()\n for key, value in match.items():\n if value is not None:\n match[key] = str(value)\n # backwards compatibility fix for IRCv3.2 tag support:\n # If no tags (None-value), exclude from dictionary\n if match.get(\"tags\", True) is None:\n del match[\"tags\"]\n if client is not None:\n # server / dcc chat\n match['client'] = client\n for e in events:\n if e.iscoroutine is True:\n create_task(e.callback(**match))\n else:\n call_soon(e.async_callback, match)\n\n def call_many(self, callback, args):\n \"\"\"callback is run with each arg but run a call per second\"\"\"\n if isinstance(callback, str):\n callback = getattr(self, callback)\n f = None\n for arg in args:\n f = callback(*arg)\n return f\n\n def get_ssl_context(self):\n if self.config.ssl: # pragma: no cover\n try:\n create_default_context = ssl.create_default_context\n except AttributeError: # py < 2.7.9\n return True\n else:\n if self.server:\n context = create_default_context(ssl.Purpose.CLIENT_AUTH)\n else:\n context = create_default_context(ssl.Purpose.SERVER_AUTH)\n verify_mode = self.config.ssl_verify\n if verify_mode is not False:\n if not isinstance(verify_mode, int):\n # CERT_NONE / CERT_OPTIONAL / CERT_REQUIRED\n verify_mode = getattr(ssl, verify_mode.upper())\n if verify_mode == ssl.CERT_NONE:\n context.check_hostname = False\n context.verify_mode = verify_mode\n return context\n return None\n\n def create_connection(self):\n protocol = utils.maybedotted(self.config.connection)\n protocol = type(protocol.__name__, (protocol,), {'factory': self})\n if self.server: # pragma: no cover\n self.log.debug('Starting {servername}...'.format(**self.config))\n factory = self.loop.create_server\n else:\n self.log.debug('Starting {nick}...'.format(**self.config))\n factory = self.loop.create_connection\n if self.config.get('sock_factory'):\n sock_factory = utils.maybedotted(self.config.sock_factory)\n args = dict(\n sock=sock_factory(self, self.config.host, self.config.port),\n ssl=self.get_ssl_context(),\n )\n if args.get('ssl'):\n args[\"server_hostname\"] = self.config.host\n else:\n args = dict(\n host=self.config.host,\n port=self.config.port,\n ssl=self.get_ssl_context()\n )\n if self.config.get('vhost'):\n args[\"local_addr\"] = (self.config.vhost, 0)\n t = asyncio.Task(factory(protocol, **args), loop=self.loop)\n t.add_done_callback(self.connection_made)\n return self.loop\n\n def add_signal_handlers(self):\n \"\"\"Register handlers for UNIX signals (SIGHUP/SIGINT)\"\"\"\n try:\n self.loop.add_signal_handler(signal.SIGHUP, self.SIGHUP)\n except (RuntimeError, AttributeError): # pragma: no cover\n # windows\n pass\n try:\n self.loop.add_signal_handler(signal.SIGINT, self.SIGINT)\n except (RuntimeError, NotImplementedError): # pragma: no cover\n # annaconda\n pass\n\n def run(self, forever=True):\n \"\"\"start the bot\"\"\"\n loop = self.create_connection()\n self.add_signal_handlers()\n if forever:\n loop.run_forever()\n\n @classmethod\n def from_config(cls, cfg, **kwargs):\n \"\"\"return an instance configured with the ``cfg`` dict\"\"\"\n cfg = dict(cfg, **kwargs)\n pythonpath = cfg.get('pythonpath', [])\n if 'here' in cfg:\n pythonpath.append(cfg['here'])\n for path in pythonpath:\n sys.path.append(os.path.expanduser(path))\n prog = cls.server and 'irc3d' or 'irc3'\n if cfg.get('debug'):\n cls.venusian_categories.append(prog + '.debug')\n if cfg.get('interactive'): # pragma: no cover\n import irc3.testing\n context = getattr(irc3.testing, cls.__name__)(**cfg)\n else:\n context = cls(**cfg)\n if cfg.get('raw'):\n context.include('irc3.plugins.log',\n venusian_categories=[prog + '.debug'])\n return context\n\n @classmethod\n def from_argv(cls, argv=None, **kwargs):\n prog = cls.server and 'irc3d' or 'irc3'\n doc = \"\"\"\n Run an {prog} instance from a config file\n\n Usage: {prog} [options] ...\n\n Options:\n\n -h, --help Display this help and exit\n --version Output version information and exit\n --logdir DIRECTORY Log directory to use instead of stderr\n --logdate Show datetimes in console output\n --host HOST Server name or ip\n --port PORT Server port\n -v,--verbose Increase verbosity\n -r,--raw Show raw irc log on the console\n -d,--debug Add some debug commands/utils\n -i,--interactive Load a ipython console with a bot instance\n \"\"\".format(prog=prog)\n if not cls.server:\n doc += \"\"\"\n --help-page Output a reST page containing commands help\n \"\"\".strip()\n import os\n import docopt\n import textwrap\n args = argv or sys.argv[1:]\n args = docopt.docopt(textwrap.dedent(doc), args, version=version)\n cfg = utils.parse_config(\n cls.server and 'server' or 'bot', *args[''])\n cfg.update(\n verbose=args['--verbose'],\n debug=args['--debug'],\n )\n cfg.update(kwargs)\n if args['--host']: # pragma: no cover\n host = args['--host']\n cfg['host'] = host\n if host in ('127.0.0.1', 'localhost'):\n cfg['ssl'] = False\n if args['--port']: # pragma: no cover\n cfg['port'] = args['--port']\n if args['--logdir'] or 'logdir' in cfg:\n logdir = os.path.expanduser(args['--logdir'] or cfg.get('logdir'))\n cls.logging_config = config.get_file_config(logdir)\n if args['--logdate']: # pragma: no cover\n fmt = cls.logging_config['formatters']['console']\n fmt['format'] = config.TIMESTAMPED_FMT\n if args.get('--help-page'): # pragma: no cover\n for v in cls.logging_config['handlers'].values():\n v['level'] = 'ERROR'\n if args['--raw']:\n cfg['raw'] = True\n context = cls.from_config(cfg)\n if args.get('--help-page'): # pragma: no cover\n context.print_help_page()\n elif args['--interactive']: # pragma: no cover\n import IPython\n IPython.embed()\n sys.exit(0)\n else:\n context.run(forever=not bool(kwargs))\n if kwargs or argv:\n return context\n" }, { "path": "irc3/compat.py", "content": "# -*- coding: utf-8 -*-\nimport sys\nimport types\n\nPY37 = bool(sys.version_info[0:2] >= (3, 7))\n\n\ntry: # pragma: no cover\n from importlib import reload as reload_module\nexcept ImportError: # pragma: no cover\n from imp import reload as reload_module # NOQA\n\nimport asyncio\nfrom asyncio.queues import Queue as BaseQueue\nfrom asyncio.queues import QueueFull # NOQA\nfrom asyncio import sleep as _original_sleep\nfrom asyncio import wait as _original_wait\n\n\ndef __sleep(*args, **kwargs):\n if PY37 and \"loop\" in kwargs:\n del kwargs[\"loop\"]\n return _original_sleep(*args, **kwargs)\n\n\ndef __wait(*args, **kwargs):\n if PY37 and \"loop\" in kwargs:\n del kwargs[\"loop\"]\n return _original_wait(*args, **kwargs)\n\n\nasyncio.sleep = __sleep\nasyncio.wait = __wait\n\nclass Queue(BaseQueue):\n def __init__(self, *args, **kwargs):\n if PY37 and \"loop\" in kwargs:\n del kwargs[\"loop\"]\n\n super().__init__(*args, **kwargs)\n" }, { "path": "irc3/config.py", "content": "# -*- coding: utf-8 -*-\n\nTIMESTAMPED_FMT = '%(asctime)s %(levelname)-4s %(name)-10s %(message)s'\n\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'formatters': {\n 'console': {\n 'format': '%(levelname)-4s %(name)-10s %(message)s',\n 'datefmt': '%Y-%m-%d %H:%M:%S',\n },\n 'console_plus': {\n 'datefmt': '%Y-%m-%d %H:%M:%S',\n },\n 'irc': {\n 'format': '%(levelname)-4s %(message)s',\n 'datefmt': '%Y-%m-%d %H:%M:%S',\n },\n 'file': {\n 'format': TIMESTAMPED_FMT,\n 'datefmt': '%Y-%m-%d %H:%M:%S',\n },\n },\n 'handlers': {\n 'console': {\n 'level': 'DEBUG',\n 'class': 'logging.StreamHandler',\n 'stream': 'ext://sys.stderr',\n 'formatter': 'console',\n },\n 'irc': {\n 'level': 'INFO',\n 'class': 'logging.NullHandler',\n 'formatter': 'irc',\n },\n 'logs': {\n 'level': 'DEBUG',\n 'class': 'logging.StreamHandler',\n 'stream': 'ext://sys.stderr',\n 'formatter': 'console',\n }\n },\n 'loggers': {\n 'asyncio': {\n 'handlers': ['console'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'trollius': {\n 'handlers': ['console'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'requests': {\n 'handlers': ['console'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'irc': {\n 'handlers': ['irc'],\n 'level': 'INFO',\n 'propagate': False,\n },\n 'irc3': {\n 'handlers': ['console'],\n 'level': 'INFO',\n 'propagate': False,\n },\n 'irc3d': {\n 'handlers': ['console'],\n 'level': 'INFO',\n 'propagate': False,\n },\n 'raw': {\n 'handlers': ['logs'],\n 'level': 'INFO',\n 'propagate': False,\n },\n }\n}\n\n\ndef get_file_config(logdir='~/.irc3/logs'):\n import os\n if not os.path.isdir(logdir):\n os.makedirs(logdir)\n config = LOGGING.copy()\n config['handlers'] = {\n 'console': {\n 'level': 'INFO',\n 'class': 'logging.handlers.RotatingFileHandler',\n 'filename': os.path.join(logdir, 'irc3.log'),\n 'backupCount': 5,\n 'maxBytes': 1024 * 5,\n 'formatter': 'file',\n },\n 'irc': {\n 'level': 'INFO',\n 'class': 'logging.NullHandler',\n 'formatter': 'irc',\n },\n 'logs': {\n 'level': 'INFO',\n 'class': 'logging.handlers.RotatingFileHandler',\n 'filename': os.path.join(logdir, 'logs.log'),\n 'backupCount': 5,\n 'maxBytes': 1024 * 5,\n 'formatter': 'file',\n }\n }\n return config\n" }, { "path": "irc3/dcc/__init__.py", "content": "# -*- coding: utf-8 -*-\nfrom .manager import DCCManager # NOQA\nfrom .manager import DCCChat # NOQA\nfrom .manager import DCCGet # NOQA\nfrom .manager import DCCSend # NOQA\n" }, { "path": "irc3/dcc/client.py", "content": "# -*- coding: utf-8 -*-\nimport os\nimport struct\nfrom collections import deque\nfrom functools import partial\nfrom irc3.compat import asyncio\n\n\nclass DCCBase(asyncio.Protocol):\n\n idle_handle = None\n idle_timeout = None\n fd = None\n\n def __init__(self, **kwargs):\n for k, v in kwargs.items():\n setattr(self, k, v)\n self.ready = self.loop.create_future()\n self.started = self.loop.create_future()\n self.closed = self.loop.create_future()\n self.timeout_handle = None\n\n def factory(self):\n return self\n\n def connection_made(self, transport):\n self.transport = transport\n self.started.set_result(self)\n\n def connection_lost(self, exc):\n self.close(exc)\n\n def close(self, result=None):\n if self.idle_handle is not None:\n self.idle_handle.cancel()\n if self.transport:\n self.transport.close()\n info = self.bot.dcc.connections[self.type]\n if self.port in info['masks'][self.mask]:\n info['total'] -= 1\n del info['masks'][self.mask][self.port]\n if not self.closed.done():\n self.closed.set_result(result)\n self.bot.log.debug('%s closed', self)\n\n def set_timeout(self):\n if self.idle_handle is not None:\n self.idle_handle.cancel()\n if self.idle_timeout:\n self.idle_handle = self.loop.call_later(\n self.idle_timeout, self.idle_timeout_reached)\n\n def idle_timeout_reached(self, *args):\n if self.type == 'chat':\n msg = \"Your idle is too high. Closing connection.\"\n self.send_line(msg)\n self.close()\n\n def __str__(self):\n return '%s with %s' % (self.__class__.__name__, self.mask)\n\n def __repr__(self):\n return '<%s with %s>' % (self.__class__.__name__, self.mask)\n\n\nclass DCCChat(DCCBase):\n \"\"\"DCC CHAT implementation\"\"\"\n\n type = 'chat'\n ctcp = 'DCC CHAT chat {0.ip} {0.port}'\n\n def connection_made(self, transport):\n super(DCCChat, self).connection_made(transport)\n self.encoding = getattr(self.bot, 'encoding', 'ascii')\n self.set_timeout()\n self.queue = deque()\n\n def decode(self, data):\n \"\"\"Decode data with bot's encoding\"\"\"\n return data.decode(self.encoding, 'ignore')\n\n def data_received(self, data):\n \"\"\"data received\"\"\"\n self.set_timeout()\n data = self.decode(data)\n if self.queue:\n data = self.queue.popleft() + data\n lines = data.replace('\\r', '').split('\\n')\n self.queue.append(lines.pop(-1))\n for line in lines:\n self.bot.dispatch(line, iotype='dcc_in', client=self)\n\n def write(self, data):\n if data is not None:\n data = data.encode(self.encoding)\n if not data.endswith(b'\\r\\n'):\n data = data + b'\\r\\n'\n self.transport.write(data)\n\n def send_line(self, message):\n self.write(message)\n self.bot.dispatch(message, iotype='dcc_out', client=self)\n\n def send(self, *messages):\n for message in messages:\n self.send_line(message)\n\n def action(self, message):\n message = '\\x01ACTION ' + message + '\\x01'\n self.send_line(message)\n\n def actions(self, *messages):\n for message in messages:\n self.action(message)\n\n\nclass DCCGet(DCCBase):\n \"\"\"DCC GET implementation\"\"\"\n type = 'get'\n ctcp = None\n\n def connection_made(self, transport):\n super(DCCGet, self).connection_made(transport)\n if self.resume:\n self.bytes_received = self.offset\n else:\n self.bytes_received = 0\n self.fd = open(self.filepath, 'ab')\n\n def data_received(self, data):\n self.set_timeout()\n self.fd.write(data)\n self.bytes_received += len(data)\n self.transport.write(struct.pack('!I', self.bytes_received))\n\n def close(self, *args, **kwargs):\n if self.fd:\n self.fd.close()\n self.fd = None\n super(DCCGet, self).close(*args, **kwargs)\n\n\nclass DCCSend(DCCBase):\n \"\"\"DCC SEND implementation\"\"\"\n\n type = 'send'\n ctcp = 'DCC SEND {0.filename_safe} {0.ip} {0.port} {0.filesize}'\n block_size = 1024 * 64\n limit_rate = None\n filepath = None\n\n def connection_made(self, transport):\n super(DCCSend, self).connection_made(transport)\n self.delay = 1. / (self.limit_rate / 64.) if self.limit_rate else None\n socket = self.transport.get_extra_info('socket')\n self.socket = socket\n self.sendfile = getattr(self.socket, 'sendfile', None)\n if self.sendfile:\n try:\n self.socket.setblocking(1)\n except ValueError:\n # py38 does not allow this. use it anyway\n self.socket._sock.setblocking(1)\n self.fd = open(self.filepath, 'rb')\n self.fd_fileno = self.fd.fileno()\n # remove existing transport ref. It shouldn't read/write anything\n transports = getattr(self.loop, '_transports', None)\n if transports is not None:\n del self.loop._transports[transport._sock_fd]\n self.loop.remove_writer(socket)\n self.loop.add_writer(socket, self.next_chunk)\n\n def write(self, *args): # pragma: no cover\n raise NotImplementedError('write is not available during DCCSend')\n\n def send_chunk(self):\n sent = os.sendfile(self.socket.fileno(), self.fd_fileno,\n self.offset, self.block_size)\n return sent\n\n def next_chunk(self):\n try:\n sent = self.send_chunk()\n except Exception as e: # pragma: no cover\n self.bot.log.exception(e)\n self.fd.close()\n sent = 0\n if sent != 0:\n self.offset += sent\n cb = partial(self.loop.add_writer, self.socket, self.next_chunk)\n if self.delay is not None:\n self.loop.call_later(self.delay, cb)\n else:\n cb()\n else:\n self.loop.remove_writer(self.socket)\n\n def data_received(self, data):\n self.set_timeout()\n bytes_received = (\n struct.unpack('!I', data[i:i + 4])[0]\n for i in range(0, len(data), 4))\n for recv in bytes_received:\n if recv == self.filesize:\n self.transport.close()\n\n def close(self, *args, **kwargs):\n if self.fd:\n self.fd.close()\n self.fd = None\n super(DCCSend, self).close(*args, **kwargs)\n" }, { "path": "irc3/dcc/manager.py", "content": "# -*- coding: utf-8 -*-\nimport os\nfrom functools import partial\nfrom collections import defaultdict\nfrom irc3.utils import slugify\nfrom irc3.utils import maybedotted\nfrom irc3.dcc.client import DCCChat\nfrom irc3.dcc.client import DCCGet\nfrom irc3.dcc.client import DCCSend\n\nDCC_TYPES = ('chat', 'get', 'send')\n\n\nclass DCCManager:\n \"\"\"Manage DCC connections\"\"\"\n\n def __init__(self, bot):\n self.bot = bot\n self.loop = bot.loop\n self.config = cfg = bot.config.get('dcc', {})\n self.config.update(\n send_limit_rate=int(cfg.get('send_limit_rate', 0)),\n send_block_size=int(cfg.get('send_block_size', DCCSend.block_size))\n )\n self.connections = {}\n self.protocols = {}\n for klass in (DCCChat, DCCGet, DCCSend):\n n = klass.type\n self.config.update({\n n + '_limit': int(cfg.get(n + '_limit', 100)),\n n + '_user_limit': int(cfg.get(n + '_user_limit', 1)),\n n + '_accept_timeout': int(cfg.get(n + '_accept_timeout', 60)),\n n + '_idle_timeout': int(cfg.get(n + '_idle_timeout', 60 * 5)),\n })\n klass = maybedotted(self.config.get(n + '_protocol', klass))\n self.connections[n] = {'total': 0, 'masks': defaultdict(dict)}\n self.protocols[n] = klass\n self.seeks = {}\n\n def created(self, protocol, future):\n if protocol.port is None:\n server = future.result()\n protocol.port = server.sockets[0].getsockname()[1]\n protocol.idle_handle = self.loop.call_later(\n self.config[protocol.type + '_accept_timeout'],\n server.close)\n ctcp_msg = protocol.ctcp.format(protocol)\n self.bot.ctcp(protocol.mask.nick, ctcp_msg)\n else:\n transport, protocol = future.result()\n protocol.idle_handle = self.loop.call_later(\n self.config[protocol.type + '_accept_timeout'],\n protocol.close)\n info = self.connections[protocol.type]\n info['total'] += 1\n info['masks'][protocol.mask][protocol.port] = protocol\n protocol.ready.set_result(protocol)\n\n def create(self, name_or_class, mask, filepath=None, **kwargs):\n \"\"\"Create a new DCC connection. Return an ``asyncio.Protocol``\"\"\"\n if isinstance(name_or_class, type):\n name = name_or_class.type\n protocol = name_or_class\n else:\n name = name_or_class\n protocol = self.protocols[name]\n assert name in DCC_TYPES\n if filepath:\n kwargs.setdefault('limit_rate',\n self.config['send_limit_rate'])\n kwargs['filepath'] = filepath\n if protocol.type == DCCSend.type:\n kwargs.setdefault('offset', 0)\n kwargs.update(\n filename_safe=slugify(os.path.basename(filepath)),\n filesize=os.path.getsize(filepath),\n )\n elif protocol.type == DCCGet.type:\n try:\n offset = os.path.getsize(filepath)\n except OSError:\n offset = 0\n kwargs.setdefault('offset', offset)\n kwargs.setdefault('resume', False)\n kwargs.setdefault('port', None)\n f = protocol(\n mask=mask, ip=int(self.bot.ip),\n bot=self.bot, loop=self.loop, **kwargs)\n\n if kwargs['port']:\n if self.bot.config.get('dcc_sock_factory'):\n sock_factory = maybedotted(self.bot.config.dcc_sock_factory)\n args = dict(sock=sock_factory(self.bot, f.host, f.port))\n else:\n args = dict(host=f.host, port=f.port)\n task = self.bot.create_task(\n self.loop.create_connection(f.factory, **args))\n task.add_done_callback(partial(self.created, f))\n else:\n task = self.bot.create_task(\n self.loop.create_server(\n f.factory, '0.0.0.0', 0, backlog=1))\n task.add_done_callback(partial(self.created, f))\n return f\n\n def resume(self, mask, filename, port, pos):\n \"\"\"Resume a DCC send\"\"\"\n self.connections['send']['masks'][mask][port].offset = pos\n message = 'DCC ACCEPT %s %d %d' % (filename, port, pos)\n self.bot.ctcp(mask, message)\n\n def is_allowed(self, name_or_class, mask): # pragma: no cover\n \"\"\"Return True is a new connection is allowed\"\"\"\n if isinstance(name_or_class, type):\n name = name_or_class.type\n else:\n name = name_or_class\n info = self.connections[name]\n limit = self.config[name + '_limit']\n if limit and info['total'] >= limit:\n msg = (\n \"Sorry, there is too much DCC %s active. Please try again \"\n \"later.\") % name.upper()\n self.bot.notice(mask, msg)\n return False\n if mask not in info['masks']:\n return True\n limit = self.config[name + '_user_limit']\n if limit and info['masks'][mask] >= limit:\n msg = (\n \"Sorry, you have too many DCC %s active. Close the other \"\n \"connection(s) or wait a few seconds and try again.\"\n ) % name.upper()\n self.bot.notice(mask, msg)\n return False\n return True\n" }, { "path": "irc3/dec.py", "content": "# -*- coding: utf-8 -*-\nfrom irc3.utils import wraps_with_context\nfrom irc3.compat import asyncio\nimport venusian\nimport re\n\n\ndef plugin(wrapped):\n \"\"\"register a class as plugin\"\"\"\n setattr(wrapped, '__irc3_plugin__', True)\n setattr(wrapped, '__irc3d_plugin__', False)\n return wrapped\n\n\nclass event:\n r\"\"\"register a method or function an irc event callback::\n\n >>> @event(r'^:\\S+ 353 [^&#]+(?P\\S+) :(?P.*)')\n ... def on_names(bot, channel=None, nicknames=None):\n ... '''this will catch nickname when you enter a channel'''\n ... print(channel, nicknames.split(':'))\n\n The callback can be either a function or a plugin method\n\n If you specify the `iotype` parameter to `\"out\"` then the event will be\n triggered when the regexp match something **sent** by the bot.\n\n For example this event will repeat private messages sent by the bot to the\n `#irc3` channel::\n\n >>> @event(r'PRIVMSG (?P[^#]+) :(?P.*)', iotype='out')\n ... def msg3(bot, target=None, data=None):\n ... bot.privmsg('#irc3',\n ... '<{0}> {1}: {2}'.format(bot.nick, target, data))\n \"\"\"\n\n venusian = venusian\n\n def __init__(self, regexp, callback=None, iotype='in',\n venusian_category='irc3.rfc1459'):\n if iotype == 'out':\n re_out = getattr(regexp, 're_out', None)\n if re_out is not None:\n regexp = re_out\n try:\n re.compile(getattr(regexp, 're', regexp))\n except Exception as e:\n raise e.__class__(str(e) + ' in ' + getattr(regexp, 're', regexp))\n self.regexp = regexp\n self.iotype = iotype\n self.callback = callback\n self.venusian_category = venusian_category\n self.iscoroutine = False\n if callback is not None:\n self.iscoroutine = asyncio.iscoroutinefunction(callback)\n\n def async_callback(self, kwargs): # pragma: no cover\n return self.callback(**kwargs)\n\n def compile(self, config):\n regexp = getattr(self.regexp, 're', self.regexp)\n if config:\n regexp = regexp.format(**config)\n return re.compile(regexp).match\n\n def __call__(self, func):\n def callback(context, name, ob):\n obj = context.context\n if info.scope == 'class':\n self.callback = getattr(obj.get_plugin(ob), func.__name__)\n else:\n self.callback = wraps_with_context(func, obj)\n # a new instance is needed to keep this related to *one* bot\n # instance\n e = self.__class__(self.regexp, self.callback,\n venusian_category=self.venusian_category,\n iotype=self.iotype)\n obj.attach_events(e)\n info = self.venusian.attach(func, callback,\n category=self.venusian_category)\n return func\n\n def __repr__(self):\n s = getattr(self.regexp, 'name', self.regexp)\n name = self.__class__.__name__\n return ''.format(name, s, self.callback)\n\n\ndef dcc_event(regexp, callback=None, iotype='in',\n venusian_category='irc3.dcc'):\n \"\"\"Work like :class:`~irc3.dec.event` but occurs during DCC CHATs\"\"\"\n return event(regexp, callback=callback, iotype='dcc_' + iotype,\n venusian_category=venusian_category)\n\n\ndef extend(func):\n \"\"\"Allow to extend a bot:\n\n Create a module with some useful routine:\n\n .. literalinclude:: ../examples/myextends.py\n ..\n >>> import sys\n >>> sys.path.append('examples')\n >>> from irc3 import IrcBot\n >>> IrcBot.defaults.update(asynchronous=False, testing=True)\n\n Now you can use those routine in your bot::\n\n >>> bot = IrcBot()\n >>> bot.include('myextends')\n >>> print(bot.my_usefull_function(1))\n my_usefull_function(*(1,))\n >>> print(bot.my_usefull_method(2))\n my_usefull_method(*(2,))\n\n \"\"\"\n def callback(context, name, ob):\n obj = context.context\n if info.scope == 'class':\n instance = obj.get_plugin(ob)\n f = getattr(instance, func.__name__)\n else:\n instance = obj\n f = func\n setattr(obj, f.__name__, f.__get__(instance, instance.__class__))\n info = venusian.attach(func, callback, category='irc3.extend')\n return func\n" }, { "path": "irc3/plugins/__init__.py", "content": "# -*- coding: utf-8 -*-\n" }, { "path": "irc3/plugins/asynchronious.py", "content": "# -*- coding: utf-8 -*-\nfrom collections import OrderedDict\nimport re\nfrom irc3.asynchronous import AsyncEvents\nfrom irc3 import utils\nfrom irc3 import dec\n__doc__ = \"\"\"\n======================================================\n:mod:`irc3.plugins.asynchronious` Asynchronious events\n======================================================\n\nThis module provide a way to catch data from various predefined events.\n\nUsage\n=====\n\nYou'll have to define a subclass of :class:`~irc3.asynchronous.AsyncEvents`:\n\n.. literalinclude:: ../../irc3/plugins/asynchronious.py\n :pyobject: Whois\n\nNotice that regexps and send_line contains some `{nick}`. This will be\nsubstitued later with the keyword arguments passed to the instance.\n\nThen you're able to use it in a plugin:\n\n.. code-block:: py\n\n class MyPlugin:\n\n def __init__(self, bot):\n self.bot = bot\n self.whois = Whois(bot)\n\n def do_whois(self):\n # remember {nick} in the regexp? Here it is\n whois = await self.whois(nick='gawel')\n if int(whois['idle']) / 60 > 10:\n self.bot.privmsg('gawel', 'Wake up dude')\n\n.. warning::\n\n Your code should always check if the result has been set before timeout by\n using `result['timeout']` which is True when the bot failed to get a result\n before 30s (you can override the default value per call)\n\n.. warning::\n\n Do not over use this feature. If you're making a lot of calls at the same\n time you should experience some weird behavior since irc do not allow\n to identify responses for a command. That's why the exemple use {nick} in\n the regexp to filter events efficiently. But two concurent call for the\n same nick can still fail.\n\nAPI\n===\n\n.. autoclass:: irc3.asynchronous.AsyncEvents\n :members: process_results, __call__\n\n.. autoclass:: Async\n :members:\n\n\"\"\"\n\n\nclass Whois(AsyncEvents):\n\n # the command will fail if we do not have a result after 30s\n timeout = 20\n\n # send this line before listening to events\n send_line = 'WHOIS {nick} {nick}'\n\n # when those events occurs, we can add them to the result list\n events = (\n # (?i) is for IGNORECASE. This will match either NicK or nick\n {'match': r\"(?i)^:\\S+ 301 \\S+ {nick} :(?P.*)\"},\n {'match': r\"(?i)^:\\S+ 311 \\S+ {nick} (?P\\S+) \"\n r\"(?P\\S+) . :(?P.*)\"},\n {'match': r\"(?i)^:\\S+ 312 \\S+ {nick} (?P\\S+) \"\n r\":(?P.*)\"},\n {'match': r\"(?i)^:\\S+ 317 \\S+ {nick} (?P[0-9]+).*\"},\n {'match': r\"(?i)^:\\S+ 319 \\S+ {nick} :(?P.*)\",\n 'multi': True},\n {'match': r\"(?i)^:\\S+ 330 \\S+ {nick} (?P\\S+) \"\n r\":(?P.*)\"},\n {'match': r\"(?i)^:\\S+ 671 \\S+ {nick} :(?P.*)\"},\n # if final=True then a result is returned when the event occurs\n {'match': r\"(?i)^:\\S+ (?P(318|401)) \\S+ (?P{nick}) :.*\",\n 'final': True},\n )\n\n def process_results(self, results=None, **value):\n \"\"\"take results list of all events and put them in a dict\"\"\"\n channels = []\n for res in results:\n channels.extend(res.pop('channels', '').split())\n value.update(res)\n value['channels'] = channels\n value['success'] = value.get('retcode') == '318'\n return value\n\n\nclass WhoChannel(AsyncEvents):\n\n send_line = 'WHO {channel}'\n\n events = (\n {\"match\": r\"(?i)^:\\S+ 352 \\S+ {channel} (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P\\S+) \"\n r\"(?P\\S+) :(?P\\S+) (?P.*)\",\n \"multi\": True},\n {\"match\": r\"(?i)^:\\S+ (?P(315|401)) \\S+ {channel} :.*\",\n \"final\": True},\n )\n\n def process_results(self, results=None, **value):\n users = []\n for res in results:\n if 'retcode' in res:\n value.update(res)\n else:\n res['mask'] = utils.IrcString(\n '{nick}!{user}@{host}'.format(**res))\n users.append(res)\n value['users'] = users\n value['success'] = value.get('retcode') == '315'\n return value\n\n\nclass WhoChannelFlags(AsyncEvents):\n\n flags = OrderedDict([\n (\"u\", r\"(?P\\S+)\"),\n (\"i\", r\"(?P\\S+)\"),\n (\"h\", r\"(?P\\S+)\"),\n (\"s\", r\"(?P\\S+)\"),\n (\"n\", r\"(?P\\S+)\"),\n (\"a\", r\"(?P\\S+)\"),\n (\"r\", r\":(?P.*)\"),\n ])\n\n send_line = \"WHO {channel} c%{flags}\"\n\n events = (\n {\"match\": r\"(?i)^:\\S+ (?P(315|401)) \\S+ {channel} :.*\",\n \"final\": True},\n )\n\n def process_results(self, results=None, **value):\n users = []\n for res in results:\n if 'retcode' in res:\n value.update(res)\n else:\n # Works in QuakeNet, don't know about other networks\n if res.get('account') == '0':\n res['account'] = None\n users.append(res)\n value['users'] = users\n value['success'] = value.get('retcode') == '315'\n return value\n\n\nclass WhoNick(AsyncEvents):\n\n send_line = 'WHO {nick}'\n\n events = (\n {\"match\": r\"(?i)^:\\S+ 352 \\S+ (?P\\S+) (?P\\S+) \"\n r\"(?P\\S+) (?P\\S+) (?P{nick}) \"\n r\"(?P\\S+) :(?P\\S+)\\s*(?P.*)\"},\n {\"match\": r\"(?i)^:\\S+ (?P(315|401)) \\S+ {nick} :.*\",\n \"final\": True},\n )\n\n def process_results(self, results=None, **value):\n for res in results:\n if 'retcode' not in res:\n res['mask'] = utils.IrcString(\n '{nick}!{user}@{host}'.format(**res))\n value.update(res)\n value['success'] = value.get('retcode') == '315'\n return value\n\n\nclass IsOn(AsyncEvents):\n\n events = (\n {\"match\": r\"(?i)^:\\S+ 303 \\S+ :(?P({nicknames_re}.*|$))\",\n \"final\": True},\n )\n\n def process_results(self, results=None, **value):\n nicknames = []\n for res in results:\n nicknames.extend(res.pop('nicknames', '').split())\n value['names'] = nicknames\n return value\n\n\nclass Topic(AsyncEvents):\n\n send_line = 'TOPIC {channel}{topic}'\n\n events = (\n {\"match\": (r\"(?i)^:\\S+ (?P(331|332|TOPIC))\"\n r\"(:?\\s+\\S+\\s+|\\s+){channel} :(?P.*)\"),\n \"final\": True},\n )\n\n def process_results(self, results=None, **value):\n for res in results:\n status = res.get('retcode', '')\n if status.upper() in ('332', 'TOPIC'):\n value['topic'] = res.get('topic')\n else:\n value['topic'] = None\n return value\n\n\nclass Names(AsyncEvents):\n\n send_line = 'NAMES {channel}'\n\n events = (\n {\"match\": r\"(?i)^:\\S+ 353 .*{channel} :(?P.*)\",\n 'multi': True},\n {'match': r\"(?i)^:\\S+ (?P(366|401)) \\S+ {channel} :.*\",\n 'final': True},\n )\n\n def process_results(self, results=None, **value):\n nicknames = []\n for res in results:\n nicknames.extend(res.pop('nicknames', '').split())\n value['names'] = nicknames\n value['success'] = value.get('retcode') == '366'\n return value\n\n\nclass ChannelBans(AsyncEvents):\n\n send_line = 'MODE {channel} +b'\n\n events = (\n {\"match\": r\"(?i)^:\\S+ 367 \\S+ {channel} (?P\\S+) (?P\\S+) \"\n r\"(?P\\d+)\",\n \"multi\": True},\n {\"match\": r\"(?i)^:\\S+ 368 \\S+ {channel} :.*\",\n \"final\": True},\n )\n\n def process_results(self, results=None, **value):\n bans = []\n for res in results:\n # TODO: fix event so this one isn't needed\n if not res:\n continue\n res['timestamp'] = int(res['timestamp'])\n bans.append(res)\n value['bans'] = bans\n return value\n\n\nclass CTCP(AsyncEvents):\n\n send_line = 'PRIVMSG {nick} :\\x01{ctcp}\\x01'\n\n events = (\n {\"match\": \"(?i):(?P\\\\S+) NOTICE \\\\S+ :\\x01(?P\\\\S+) \"\n \"(?P.*)\\x01\",\n \"final\": True},\n {\"match\": r\"(?i)^:\\S+ (?P486) \\S+ :(?P.*)\",\n \"final\": True}\n )\n\n def process_results(self, results=None, **value):\n \"\"\"take results list of all events and return first dict\"\"\"\n for res in results:\n if 'mask' in res:\n res['mask'] = utils.IrcString(res['mask'])\n value['success'] = res.pop('retcode', None) != '486'\n value.update(res)\n return value\n\n\n@dec.plugin\nclass Async:\n \"\"\"Asynchronious plugin.\n Extend the bot with some common commands using\n :class:`~irc3.asynchronous.AsyncEvents`\n \"\"\"\n\n def __init__(self, context):\n self.context = context\n self.context.async_cmds = self\n self.async_whois = Whois(context)\n self.async_who_channel = WhoChannel(context)\n self.async_who_nick = WhoNick(context)\n self.async_topic = Topic(context)\n self.async_ison = IsOn(context)\n self.async_names = Names(context)\n self.async_channel_bans = ChannelBans(context)\n self.async_ctcp = CTCP(context)\n\n def async_who_channel_flags(self, channel, flags, timeout):\n \"\"\"\n Creates and calls a class from WhoChannelFlags with needed match rule\n for WHO command on channels with flags.\n \"\"\"\n # Lowercase flags and sort based on WhoChannelFlags.flags, otherwise\n # resulting dict is wrong. Also join flags if it's a sequence.\n flags = ''.join([f.lower() for f in WhoChannelFlags.flags\n if f in flags])\n regex = [WhoChannelFlags.flags[f] for f in flags]\n channel = channel.lower()\n cls = type(\n WhoChannelFlags.__name__,\n (WhoChannelFlags,),\n {\"events\": WhoChannelFlags.events + (\n {\"match\": r\"(?i)^:\\S+ 354 \\S+ {0}\".format(' '.join(regex)),\n \"multi\": True},\n )}\n )\n return cls(self.context)(channel=channel, flags=flags, timeout=timeout)\n\n @dec.extend\n def whois(self, nick, timeout=20):\n \"\"\"Send a WHOIS and return a Future which will contain recieved data:\n\n .. code-block:: py\n\n result = await bot.async_cmds.whois('gawel')\n \"\"\"\n return self.async_whois(nick=nick.lower(), timeout=timeout)\n\n @dec.extend\n def who(self, target, flags=None, timeout=20):\n \"\"\"Send a WHO and return a Future which will contain recieved data:\n\n .. code-block:: py\n\n result = await bot.async_cmds.who('gawel')\n result = await bot.async_cmds.who('#irc3')\n result = await bot.async_cmds.who('#irc3', 'an')\n # or\n result = await bot.async_cmds.who('#irc3', ['a', 'n'])\n \"\"\"\n target = target.lower()\n if target.startswith('#'):\n if flags:\n return self.async_who_channel_flags(channel=target,\n flags=flags,\n timeout=timeout)\n return self.async_who_channel(channel=target, timeout=timeout)\n else:\n return self.async_who_nick(nick=target, timeout=timeout)\n\n def topic(self, channel, topic=None, timeout=20):\n if not topic:\n topic = ''\n else:\n topic = ' ' + topic.strip()\n return self.async_topic(channel=channel, topic=topic, timeout=timeout)\n\n @dec.extend\n def ison(self, *nicknames, **kwargs):\n \"\"\"Send a ISON and return a Future which will contain recieved data:\n\n .. code-block:: py\n\n result = await bot.async_cmds.ison('gawel', 'irc3')\n \"\"\"\n nicknames = [n.lower() for n in nicknames]\n self.context.send_line('ISON :{0}'.format(' '.join(nicknames)))\n nicknames = [re.escape(n) for n in nicknames]\n return self.async_ison(nicknames_re='(%s)' % '|'.join(nicknames),\n **kwargs)\n\n @dec.extend\n def names(self, channel, timeout=20):\n \"\"\"Send a NAMES and return a Future which will contain recieved data:\n\n .. code-block:: py\n\n result = await bot.async_cmds.names('#irc3')\n \"\"\"\n return self.async_names(channel=channel.lower(), timeout=timeout)\n\n @dec.extend\n def channel_bans(self, channel, timeout=20):\n \"\"\"Send a MODE +b and return a Future which will contain recieved data:\n .. code-block:: py\n result = await bot.async_cmds.channel_bans('#irc3')\n \"\"\"\n return self.async_channel_bans(channel=channel.lower(),\n timeout=timeout)\n\n @dec.extend\n def ctcp_async(self, nick, ctcp, timeout=20):\n \"\"\"Send a CTCP and return a Future which will contain recieved data:\n\n .. code-block:: py\n\n result = await bot.async_cmds.ctcp('irc3', 'version')\n \"\"\"\n return self.async_ctcp(nick=nick, ctcp=ctcp.upper(), timeout=timeout)\n" }, { "path": "irc3/plugins/autocommand.py", "content": "import irc3\nfrom irc3 import utils, asyncio\nimport re\n\n__doc__ = '''\n==================================================\n:mod:`irc3.plugins.autocommand` Autocommand plugin\n==================================================\n\nThis plugin allows to send IRC commands to the server after connecting.\nThis could be usable for authorization, cloaking, requesting invite to invite\nonly channel and other use cases.\nIt also allows to set delays between IRC commands via the ``/sleep`` command.\n\n..\n >>> from irc3.testing import IrcBot\n >>> from irc3.testing import ini2config\n\nUsage::\n\nThis example will authorize on Freenode:\n\n >>> config = ini2config(\"\"\"\n ... [bot]\n ... includes =\n ... irc3.plugins.autocommand\n ...\n ... autocommands =\n ... PRIVMSG NickServ :IDENTIFY nick password\n ... \"\"\")\n >>> bot = IrcBot(**config)\n\nHere's another, more complicated example:\n\n >>> config = ini2config(\"\"\"\n ... [bot]\n ... includes =\n ... irc3.plugins.autocommand\n ...\n ... autocommands =\n ... AUTH user password\n ... MODE {nick} +x\n ... /sleep 2\n ... PRIVMSG Q :INVITE #inviteonly\n ... \"\"\")\n >>> bot = IrcBot(**config)\n\nIt will authorize on QuakeNet, cloak and request an invite to ``#inviteonly``\nafter a 2 second delay.\n'''\n\n\nclass SimpleCommand:\n\n def __init__(self, cmd):\n self.cmd = cmd\n\n async def execute(self, bot):\n send_cmd = self.cmd.format(nick=bot.nick)\n bot.send_line(send_cmd)\n\n\nclass SleepCommand:\n\n SLEEP_RE = re.compile(r\"^/sleep\\s+(?P