Merge pull request #6 from TotallyNotRobots/update-0.3

Merge and release 0.3

Author: linuxdaemon

.coveragerc

@@ -0,0 +1,12 @@
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    raise AssertionError
+    raise NotImplementedError
+    if __name__ == .__main__.:
+
+[run]
+omit =
+    tests/data/*
+    tests/util/*

.travis.yml

@@ -1,16 +1,17 @@
 language: python
+dist: xenial
+sudo: true
 python:
-- '3.4'
 - '3.5'
 - '3.6'
-- nightly
+- '3.7'
 - pypy3
 install:
 - pip install -Ur requirements.txt
 script:
-- py.test . -v --cov . --cov-report term-missing
+- pytest
 after_success:
-- coveralls
+- codecov
 deploy:
   provider: pypi
   user: linuxdaemon
@@ -23,13 +24,3 @@ deploy:
     python: '3.6'
 env:
 - PYTHONPATH=.
-matrix:
-  allow_failures:
-    - python: "nightly"
-  include:
-    - python: '3.7'
-      dist: xenial
-      sudo: true
-    - python: '3.8-dev'
-      dist: xenial
-      sudo: true

irclib/__init__.py

@@ -0,0 +1 @@
+__all__ = ('commands', 'errors', 'parser', 'string', 'util')

irclib/commands.py

@@ -1,5 +1,7 @@
 from collections import Mapping
 
+__all__ = ('Command', 'client_commands')
+
 
 class Command:
     def __init__(self, name, args=None, min_args=0, max_args=None):

irclib/errors.py

@@ -1,2 +1,5 @@
+__all__ = ('ParseError',)
+
+
 class ParseError(ValueError):
     pass

irclib/parser.py

@@ -9,6 +9,10 @@
 
 from irclib.errors import ParseError
 
+__all__ = (
+    'Cap', 'CapList', 'MessageTag', 'TagList', 'Prefix', 'ParamList', 'Message'
+)
+
 TAGS_SENTINEL = '@'
 TAGS_SEP = ';'
 TAG_VALUE_SEP = '='
@@ -155,7 +159,15 @@ def parse(text):
         # Some networks (ie: freenode) send a trailing space in a CAP ACK
         stripped = text.strip()
 
-        return CapList(map(Cap.parse, stripped.split(CAP_SEP)))
+        if not text:
+            caps = []
+        else:
+            caps = (
+                Cap.parse(s)
+                for s in stripped.split(CAP_SEP)
+            )
+
+        return CapList(caps)
 
 
 class MessageTag(Parseable):
@@ -251,29 +263,44 @@ def parse(text):
 class TagList(Parseable, dict):
     """Object representing the list of message tags on a line"""
 
-    def __init__(self, tags):
+    def __init__(self, tags=()):
         super().__init__((tag.name, tag) for tag in tags)
 
     def __str__(self):
         return TAGS_SEP.join(map(str, self.values()))
 
-    def __eq__(self, other):
-        if isinstance(other, str):
-            return self == TagList.parse(other)
+    @staticmethod
+    def _cmp_type_map(obj):
+        if isinstance(obj, str):
+            return TagList.parse(obj)
+
+        if isinstance(obj, dict):
+            sample = next(iter(obj.values()), None)
+            if obj and (sample is None or isinstance(sample, str)):
+                # Handle str -> str dict
+                return TagList.from_dict(obj)
 
-        if isinstance(other, dict):
-            return dict(self) == dict(other)
+            # Handle str -> MessageTag dict
+            return dict(obj)
+
+        if isinstance(obj, list):
+            return TagList(obj)
 
         return NotImplemented
 
-    def __ne__(self, other):
-        if isinstance(other, str):
-            return self != TagList.parse(other)
+    def __eq__(self, other):
+        obj = self._cmp_type_map(other)
+        if obj is NotImplemented:
+            return NotImplemented
 
-        if isinstance(other, dict):
-            return dict(self) != dict(other)
+        return dict(self) == dict(obj)
 
-        return NotImplemented
+    def __ne__(self, other):
+        obj = self._cmp_type_map(other)
+        if obj is NotImplemented:
+            return NotImplemented
+
+        return dict(self) != dict(obj)
 
     @staticmethod
     def parse(text):
@@ -299,7 +326,7 @@ class Prefix(Parseable):
     Object representing the prefix of a line
     """
 
-    def __init__(self, nick, user=None, host=None):
+    def __init__(self, nick=None, user=None, host=None):
         self._nick = nick or ''
         self._user = user or ''
         self._host = host or ''
@@ -345,7 +372,7 @@ def __str__(self):
         return self.mask
 
     def __bool__(self):
-        return bool(self.nick)
+        return any(self)
 
     def __eq__(self, other):
         if isinstance(other, str):
@@ -374,10 +401,11 @@ def parse(text):
         :return: Parsed Object
         """
         if not text:
-            return Prefix('')
+            return Prefix()
 
         match = PREFIX_RE.match(text)
-        if not match:
+        if not match:  # pragma: no cover
+            # This should never trip, we are pretty lenient with prefixes
             raise ParseError("Invalid IRC prefix format")
 
         nick, user, host = match.groups()
@@ -401,7 +429,9 @@ def __str__(self):
         if not self:
             return ''
 
-        if self.has_trail or PARAM_SEP in self[-1]:
+        needs_trail = PARAM_SEP in self[-1] or self[-1].startswith(TRAIL_SENTINEL) or not self[-1]
+
+        if self.has_trail or needs_trail:
             return PARAM_SEP.join(self[:-1] + [TRAIL_SENTINEL + self[-1]])
 
         return PARAM_SEP.join(self)

irclib/string.py

@@ -5,6 +5,8 @@
 import operator
 from functools import wraps
 
+__all__ = ('Casemap', 'RFC1459', 'STRICT_RFC1459', 'ASCII', 'String')
+
 
 class Casemap(tuple):
     __slots__ = ()

irclib/util/__init__.py

@@ -0,0 +1 @@
+__all__ = ('compare', 'frozendict', 'numerics')

irclib/util/frozendict.py

@@ -1,3 +1,6 @@
+__all__ = ('FrozenDict',)
+
+
 class FrozenDict(dict):
     __slots__ = ("__hash",)
 

irclib/util/numerics.py

@@ -1,5 +1,7 @@
 from collections import namedtuple, Mapping
 
+__all__ = ('Numeric', 'numerics')
+
 Numeric = namedtuple('Numeric', 'name numeric')