Snippets

Doug Freed Python IRCv3.2 Line Parser

Created by Doug Freed last modified
parse.py
Raw 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
from enum import Enum
from typing import Dict, List, Optional, Tuple

tag_replacements = (
    (r'\:', ';'),
    (r'\s', ' '),
    (r'\r', '\r'),
    (r'\n', '\n'),
    (r'\\', '\\'),
)


class ParseState(Enum):
    tags = 1
    prefix = 2
    command = 3
    params = 4
    trailing = 5


def parse(line: str) -> Tuple[str, Dict[str, str], Optional[str], Optional[str], Optional[str], Optional[str], Optional[str], List[str], Optional[str]]:
    state = ParseState.tags
    temp = line.split(' ')
    tags, prefix, command, params, rest, nick, user, host = {}, None, None, [], None, None, None, None
    for i in range(len(temp)):
        if not temp[i]:
            continue
        elif state == ParseState.tags and temp[i][0] == '@':
            temp2 = temp[i][1:].split(';')
            for tag in temp2:
                key, _, value = tag.partition('=')
                if '\\' in value:
                    for old, new in tag_replacements:
                        value = value.replace(old, new)
                tags[key] = value
            state = ParseState.prefix
        elif state in (ParseState.tags, ParseState.prefix) and temp[i][0] == ':':
            prefix = temp[i][1:]
            if '!' in prefix:
                nick, user = prefix.split('!')
                if '@' in user:
                    user, host = user.split('@')
            elif '@' in prefix:
                nick, host = prefix.split('@')
            else:
                nick = prefix
            state = ParseState.command
        elif state in (ParseState.tags, ParseState.prefix, ParseState.command):
            command = temp[i]
            state = ParseState.params
        elif state == ParseState.trailing or state == ParseState.params and temp[i][0] == ':':
            rest = ' '.join(temp[i:])
            if rest[0] == ':':
                rest = rest[1:]
            params.append(rest)
            break
        elif state == ParseState.params:
            params.append(temp[i])
            if len(params) == 14:
                state = ParseState.trailing
        else:
            raise NotImplementedError(repr(line))  # pragma: no cover
    return line, tags, prefix, nick, user, host, command, params, rest
test_parse.py
Raw 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
from parse import parse


class TestClass:
    def test_blank(self):
        line, tags, prefix, nick, user, host, command, params, rest = parse("")
        assert line == ""
        assert tags == {}
        assert prefix is None
        assert nick is None
        assert user is None
        assert host is None
        assert command is None
        assert params == []
        assert rest is None

    def test_no_tags(self):
        line = ":nick!user@host command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_tags_no_replacements(self):
        line = "@key1;key2=value :nick!user@host command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': '', 'key2': 'value'}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_tags_replacements(self):
        line = r"@key1=\:\s\r\n\\ :nick!user@host command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': '; \r\n\\'}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_tags_replacements_correct(self):
        line = r"@key1=\:\s\r\\\n :nick!user@host command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': '; \r\\\n'}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_no_user(self):
        line = ":nick@host command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix == "nick@host"
        assert nick == "nick"
        assert user is None
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_no_host(self):
        line = ":nick!user command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix == "nick!user"
        assert nick == "nick"
        assert user == "user"
        assert host is None
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_no_prefix(self):
        line = "command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix is None
        assert nick is None
        assert user is None
        assert host is None
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_tags_no_prefix(self):
        line = "@key1 command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': ''}
        assert prefix is None
        assert nick is None
        assert user is None
        assert host is None
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_no_middle(self):
        line = ":nick!user@host command :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['rest']
        assert rest == "rest"

    def test_no_trailing(self):
        line = ":nick!user@host command param"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param']
        assert rest is None

    def test_nick_only(self):
        line = ":nick command param :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {}
        assert prefix == "nick"
        assert nick == "nick"
        assert user is None
        assert host is None
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_spaces(self):
        line = r"@key1=\:\s\r\n\\     :nick!user@host   command   param    :rest"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': '; \r\n\\'}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest']
        assert rest == "rest"

    def test_spaces_in_trailing(self):
        line = r"@key1=\:\s\r\n\\     :nick!user@host   command   param    :rest     foobar"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': '; \r\n\\'}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest     foobar']
        assert rest == "rest     foobar"

    def test_colon_in_trailing(self):
        line = r"@key1=\:\s\r\n\\     :nick!user@host   command   param    :rest     :foobar"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert tags == {'key1': '; \r\n\\'}
        assert prefix == "nick!user@host"
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['param', 'rest     :foobar']
        assert rest == "rest     :foobar"

    def test_15_params(self):
        line = ":nick!user@host command 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15']
        assert rest == "15"

    def test_15_params_colon_trailing(self):
        line = ":nick!user@host command 1 2 3 4 5 6 7 8 9 10 11 12 13 14 :15"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15']
        assert rest == "15"

    def test_16_params(self):
        line = ":nick!user@host command 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15 16']
        assert rest == "15 16"

    def test_15_params_colon_trailing_multiword(self):
        line = ":nick!user@host command 1 2 3 4 5 6 7 8 9 10 11 12 13 14 :15 16"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15 16']
        assert rest == "15 16"

    def test_16th_param_colon(self):
        line = ":nick!user@host command 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 :16"
        line_return, tags, prefix, nick, user, host, command, params, rest = parse(line)
        assert line_return == line
        assert nick == "nick"
        assert user == "user"
        assert host == "host"
        assert command == "command"
        assert params == ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15 :16']
        assert rest == "15 :16"

Comments (2)

HTTPS SSH

You can clone a snippet to your computer for local editing. Learn more.