Mercurial > p > roundup > code
annotate roundup/cgi/accept_language.py @ 5632:a29a8dae2095
Initial implementation of function to return data for / and /data
endpoints under /rest/.
/rest/ returns:
1) default_version of the interface and supported_version array
2) list of links with rel and uri properties that indicate
what assets are available under /rest. E.g. /rest/data
/data returns:
a list of possible assets (e.g. issue, user, keyword, status)
and links for accessing those assets.
E.G.
{
"data": {
"keyword": {
"link": "https://example.net/demo/rest/data/keyword"
},
"user": {
"link": "https://example.net/demo/rest/data/user"
}, ...
}
}
Both of these are currently hand coded. Others will be doing more
development on the rest interface. These two examples are meant to
spark discussion on what the payloads returned by the rest interface
should look like and give some ideas around HATEOAS.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 01 Mar 2019 23:24:40 -0500 |
| parents | b00cd44fea16 |
| children | 936275dfe1fa |
| rev | line source |
|---|---|
|
3426
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
1 """Parse the Accept-Language header as defined in RFC2616. |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
2 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
3 See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
4 for details. This module should follow the spec. |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
5 Author: Hernan M. Foffani (hfoffani@gmail.com) |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
6 Some use samples: |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
7 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
8 >>> parse("da, en-gb;q=0.8, en;q=0.7") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
9 ['da', 'en_gb', 'en'] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
10 >>> parse("en;q=0.2, fr;q=1") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
11 ['fr', 'en'] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
12 >>> parse("zn; q = 0.2 ,pt-br;q =1") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
13 ['pt_br', 'zn'] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
14 >>> parse("es-AR") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
15 ['es_AR'] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
16 >>> parse("es-es-cat") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
17 ['es_es_cat'] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
18 >>> parse("") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
19 [] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
20 >>> parse(None) |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
21 [] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
22 >>> parse(" ") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
23 [] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
24 >>> parse("en,") |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
25 ['en'] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
26 """ |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
27 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
28 import re |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
29 import heapq |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
30 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
31 # regexp for languange-range search |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
32 nqlre = "([A-Za-z]+[-[A-Za-z]+]*)$" |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
33 # regexp for languange-range search with quality value |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
34 qlre = "([A-Za-z]+[-[A-Za-z]+]*);q=([\d\.]+)" |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
35 # both |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
36 lre = re.compile(nqlre + "|" + qlre) |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
37 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
38 whitespace = ' \t\n\r\v\f' |
|
5439
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
39 try: |
|
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
40 # Python 3. |
|
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
41 remove_ws = (str.maketrans('', '', whitespace),) |
|
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
42 except AttributeError: |
|
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
43 # Python 2. |
|
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
44 remove_ws = (None, whitespace) |
|
3426
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
45 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
46 def parse(language_header): |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
47 """parse(string_with_accept_header_content) -> languages list""" |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
48 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
49 if language_header is None: return [] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
50 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
51 # strip whitespaces. |
|
5439
b00cd44fea16
Python 3 preparation: update string translate method call in cgi/accept_language.py.
Joseph Myers <jsm@polyomino.org.uk>
parents:
4362
diff
changeset
|
52 lh = language_header.translate(*remove_ws) |
|
3426
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
53 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
54 # if nothing, return |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
55 if lh == "": return [] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
56 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
57 # split by commas and parse the quality values. |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
58 pls = [lre.findall(x) for x in lh.split(',')] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
59 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
60 # drop uncomformant |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
61 qls = [x[0] for x in pls if len(x) > 0] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
62 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
63 # use a heap queue to sort by quality values. |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
64 # the value of each item is 1.0 complement. |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
65 pq = [] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
66 for l in qls: |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
67 if l[0] != '': |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
68 heapq.heappush(pq, (0.0, l[0])) |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
69 else: |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
70 heapq.heappush(pq, (1.0-float(l[2]), l[1])) |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
71 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
72 # get the languages ordered by quality |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
73 # and replace - by _ |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
74 return [x[1].replace('-','_') for x in pq] |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
75 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
76 if __name__ == "__main__": |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
77 import doctest |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
78 doctest.testmod() |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
79 |
|
52f89836d05b
Parse the Accept-Language header as defined in RFC2616.
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
diff
changeset
|
80 # vim: set et sts=4 sw=4 : |
