Merge pull request #201 from JulienPalard/mdk-various

Various things while doodling around

Author: gawel

CONTRIBUTING.rst

@@ -7,6 +7,10 @@ First, if you want to add a cool plugin, consider submit a pull request to the
 
 Feel free to clone the project on `GitHub <https://github.com/gawel/irc3>`_.
 
+To test your change you can run irc3 in debug mode using::
+
+    $ irc3 --debug path-to-your-conf.ini
+
 Once you made a change, try to add a test for your feature/fix. At least assume
 that you have'nt broke anything by running tox::
 
@@ -40,9 +44,7 @@ And check the result::
 
     $ firefox .tox/docs/tmp/html/index.html
 
-The project is `buildout <https://github.com/buildout/buildout>`_ ready. You
-can generate binaries using it instead of virtualenv::
+The project uses ``setuptools``, you can test-install it using `pip`:
 
-    $ python bootstrap.py
-    $ bin/buildout
-    $ bin/irc3 -h
+    $ pip install .
+    $ irc3 -h

docs/conf.py

@@ -40,8 +40,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'irc3'
-copyright = u'2013, Gael Pasgrimaud'
+project = 'irc3'
+copyright = '2013, Gael Pasgrimaud'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -183,8 +183,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'irc3.tex', u'irc3 Documentation',
-   u'Gael Pasgrimaud', 'manual'),
+  ('index', 'irc3.tex', 'irc3 Documentation',
+   'Gael Pasgrimaud', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -213,8 +213,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'irc3', u'irc3 Documentation',
-     [u'Gael Pasgrimaud'], 1)
+    ('index', 'irc3', 'irc3 Documentation',
+     ['Gael Pasgrimaud'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -227,8 +227,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'irc3', u'irc3 Documentation',
-   u'Gael Pasgrimaud', 'irc3', 'One line description of project.',
+  ('index', 'irc3', 'irc3 Documentation',
+   'Gael Pasgrimaud', 'irc3', 'One line description of project.',
    'Miscellaneous'),
 ]
 

irc3/__init__.py

@@ -207,7 +207,7 @@ async def process_queue(self):
                     if self.queue.empty():
                         break
                 if lines:
-                    self.send(u'\r\n'.join(lines))
+                    self.send('\r\n'.join(lines))
                 while not self.queue.empty():
                     await asyncio.sleep(flood_rate, loop=self.loop)
                     future, data = await self.queue.get()

irc3/base.py

@@ -199,7 +199,7 @@ def include(self, *modules, **kwargs):
         scanner = self.venusian.Scanner(context=self)
         for module in modules:
             if module in reg.includes:
-                self.log.warn('%s included twice', module)
+                self.log.warning('%s included twice', module)
             else:
                 reg.includes.add(module)
                 try:

irc3/dec.py

@@ -15,7 +15,7 @@ def plugin(wrapped):
 class event:
     r"""register a method or function an irc event callback::
 
-        >>> @event('^:\S+ 353 [^&#]+(?P<channel>\S+) :(?P<nicknames>.*)')
+        >>> @event(r'^:\S+ 353 [^&#]+(?P<channel>\S+) :(?P<nicknames>.*)')
         ... def on_names(bot, channel=None, nicknames=None):
         ...     '''this will catch nickname when you enter a channel'''
         ...     print(channel, nicknames.split(':'))

irc3/plugins/asynchronious.py

@@ -77,7 +77,7 @@ class Whois(AsyncEvents):
         # (?i) is for IGNORECASE. This will match either NicK or nick
         {'match': r"(?i)^:\S+ 301 \S+ {nick} :(?P<away>.*)"},
         {'match': r"(?i)^:\S+ 311 \S+ {nick} (?P<username>\S+) "
-                  r"(?P<host>\S+) . :(?P<realname>.*)(?i)"},
+                  r"(?P<host>\S+) . :(?P<realname>.*)"},
         {'match': r"(?i)^:\S+ 312 \S+ {nick} (?P<server>\S+) "
                   r":(?P<server_desc>.*)"},
         {'match': r"(?i)^:\S+ 317 \S+ {nick} (?P<idle>[0-9]+).*"},

irc3/plugins/human.py

@@ -67,11 +67,11 @@ def initialize(self, amount):  # pragma: no cover
             quotes = [v['joke'] for v in quotes['value']]
         except Exception:
             self.bot.log.error('Failed to get quotes from api.icndb.com')
-            quotes = [u'Hi!', u'lol']
+            quotes = ['Hi!', 'lol']
         self.bot.log.info('Initialise %s with %s quotes',
                           self.db, len(quotes))
         with codecs.open(self.db, 'w', 'utf8') as fd:
-            fd.write(u'\n'.join(quotes))
+            fd.write('\n'.join(quotes))
 
     @irc3.event(irc3.rfc.MY_PRIVMSG)
     def on_message(self, mask=None, event=None, target=None, data=None, **kw):

irc3/plugins/shell_command.py

@@ -116,4 +116,4 @@ async def shell_command(self, command, mask, target, args, **kwargs):
         lines = await proc.stdout.read()
         if not isinstance(lines, str):
             lines = lines.decode('utf8')
-        return lines.split(u'\n')
+        return lines.split('\n')

tests/test_casefold.py

@@ -14,7 +14,7 @@ def test_ascii(self):
         self.assertEquals(bot.casefold('#tESt[]chAn'), '#test[]chan')
         self.assertEquals(bot.casefold('#TEsT\\CHaN'), '#test\\chan')
 
-        self.assertEquals(bot.casefold(u'#TEsT\\CHaN'), u'#test\\chan')
+        self.assertEquals(bot.casefold('#TEsT\\CHaN'), '#test\\chan')
 
     def test_rfc1459(self):
         bot = self.callFTU(server_config={'CASEMAPPING': 'rfc1459'})
@@ -24,4 +24,4 @@ def test_rfc1459(self):
         self.assertEquals(bot.casefold('#tESt[]chAn'), '#test{}chan')
         self.assertEquals(bot.casefold('#TEsT\\CHaN'), '#test|chan')
 
-        self.assertEquals(bot.casefold(u'#TEsT\\CHaN'), u'#test|chan')
+        self.assertEquals(bot.casefold('#TEsT\\CHaN'), '#test|chan')

tests/test_logger.py

@@ -30,7 +30,7 @@ def test_logger(self):
         filenames = os.listdir(self.logdir)
         self.assertEqual(len(filenames), 0, filenames)
 
-        bot.dispatch(u':server 332 foo #foo :topîc')
+        bot.dispatch(':server 332 foo #foo :topîc')
         filenames = glob.glob(os.path.join(self.logdir, '*.log'))
         self.assertEqual(len(filenames), 1, filenames)