1 from __future__
import unicode_literals
16 import urllib
.request
as compat_urllib_request
17 except ImportError: # Python 2
18 import urllib2
as compat_urllib_request
21 import urllib
.error
as compat_urllib_error
22 except ImportError: # Python 2
23 import urllib2
as compat_urllib_error
26 import urllib
.parse
as compat_urllib_parse
27 except ImportError: # Python 2
28 import urllib
as compat_urllib_parse
31 from urllib
.parse
import urlparse
as compat_urllib_parse_urlparse
32 except ImportError: # Python 2
33 from urlparse
import urlparse
as compat_urllib_parse_urlparse
36 import urllib
.parse
as compat_urlparse
37 except ImportError: # Python 2
38 import urlparse
as compat_urlparse
41 import http
.cookiejar
as compat_cookiejar
42 except ImportError: # Python 2
43 import cookielib
as compat_cookiejar
46 import html
.entities
as compat_html_entities
47 except ImportError: # Python 2
48 import htmlentitydefs
as compat_html_entities
51 import http
.client
as compat_http_client
52 except ImportError: # Python 2
53 import httplib
as compat_http_client
56 from urllib
.error
import HTTPError
as compat_HTTPError
57 except ImportError: # Python 2
58 from urllib2
import HTTPError
as compat_HTTPError
61 from urllib
.request
import urlretrieve
as compat_urlretrieve
62 except ImportError: # Python 2
63 from urllib
import urlretrieve
as compat_urlretrieve
67 from subprocess
import DEVNULL
68 compat_subprocess_get_DEVNULL
= lambda: DEVNULL
70 compat_subprocess_get_DEVNULL
= lambda: open(os
.path
.devnull
, 'w')
73 import http
.server
as compat_http_server
75 import BaseHTTPServer
as compat_http_server
78 from urllib
.parse
import unquote_to_bytes
as compat_urllib_parse_unquote_to_bytes
79 from urllib
.parse
import unquote
as compat_urllib_parse_unquote
80 except ImportError: # Python 2
81 # HACK: The following are the correct unquote_to_bytes and unquote
82 # implementations from cpython 3.4.3's stdlib. Python 2's version
83 # is apparently broken (see https://github.com/rg3/youtube-dl/pull/6244)
85 def compat_urllib_parse_unquote_to_bytes(string
):
86 """unquote_to_bytes('abc%20def') -> b'abc def'."""
87 # Note: strings are encoded as UTF-8. This is only an issue if it contains
88 # unescaped non-ASCII characters, which URIs should not.
90 # Is it a string-like object?
93 if isinstance(string
, unicode):
94 string
= string
.encode('utf-8')
95 bits
= string
.split(b
'%')
100 for item
in bits
[1:]:
102 append(compat_urllib_parse
._hextochr
[item
[:2]])
109 def compat_urllib_parse_unquote(string
, encoding
='utf-8', errors
='replace'):
110 """Replace %xx escapes by their single-character equivalent. The optional
111 encoding and errors parameters specify how to decode percent-encoded
112 sequences into Unicode characters, as accepted by the bytes.decode()
114 By default, percent-encoded sequences are decoded with UTF-8, and invalid
115 sequences are replaced by a placeholder character.
117 unquote('abc%20def') -> 'abc def'.
119 if '%' not in string
:
126 bits
= compat_urllib_parse
._asciire
.split(string
)
129 for i
in range(1, len(bits
), 2):
130 append(compat_urllib_parse_unquote_to_bytes(bits
[i
]).decode(encoding
, errors
))
135 compat_str
= unicode # Python 2
140 compat_basestring
= basestring
# Python 2
142 compat_basestring
= str
145 compat_chr
= unichr # Python 2
150 from xml
.etree
.ElementTree
import ParseError
as compat_xml_parse_error
151 except ImportError: # Python 2.6
152 from xml
.parsers
.expat
import ExpatError
as compat_xml_parse_error
156 from urllib
.parse
import parse_qs
as compat_parse_qs
157 except ImportError: # Python 2
158 # HACK: The following is the correct parse_qs implementation from cpython 3's stdlib.
159 # Python 2's version is apparently totally broken
161 def _parse_qsl(qs
, keep_blank_values
=False, strict_parsing
=False,
162 encoding
='utf-8', errors
='replace'):
163 qs
, _coerce_result
= qs
, compat_str
164 pairs
= [s2
for s1
in qs
.split('&') for s2
in s1
.split(';')]
166 for name_value
in pairs
:
167 if not name_value
and not strict_parsing
:
169 nv
= name_value
.split('=', 1)
172 raise ValueError("bad query field: %r" % (name_value
,))
173 # Handle case of a control-name with no equal sign
174 if keep_blank_values
:
178 if len(nv
[1]) or keep_blank_values
:
179 name
= nv
[0].replace('+', ' ')
180 name
= compat_urllib_parse_unquote(
181 name
, encoding
=encoding
, errors
=errors
)
182 name
= _coerce_result(name
)
183 value
= nv
[1].replace('+', ' ')
184 value
= compat_urllib_parse_unquote(
185 value
, encoding
=encoding
, errors
=errors
)
186 value
= _coerce_result(value
)
187 r
.append((name
, value
))
190 def compat_parse_qs(qs
, keep_blank_values
=False, strict_parsing
=False,
191 encoding
='utf-8', errors
='replace'):
193 pairs
= _parse_qsl(qs
, keep_blank_values
, strict_parsing
,
194 encoding
=encoding
, errors
=errors
)
195 for name
, value
in pairs
:
196 if name
in parsed_result
:
197 parsed_result
[name
].append(value
)
199 parsed_result
[name
] = [value
]
203 from shlex
import quote
as shlex_quote
204 except ImportError: # Python < 3.3
206 if re
.match(r
'^[-_\w./]+$', s
):
209 return "'" + s
.replace("'", "'\"'\"'") + "'"
219 if sys
.version_info
>= (3, 0):
220 compat_getenv
= os
.getenv
221 compat_expanduser
= os
.path
.expanduser
223 # Environment variables should be decoded with filesystem encoding.
224 # Otherwise it will fail if any non-ASCII characters present (see #3854 #3217 #2918)
226 def compat_getenv(key
, default
=None):
227 from .utils
import get_filesystem_encoding
228 env
= os
.getenv(key
, default
)
230 env
= env
.decode(get_filesystem_encoding())
233 # HACK: The default implementations of os.path.expanduser from cpython do not decode
234 # environment variables with filesystem encoding. We will work around this by
235 # providing adjusted implementations.
236 # The following are os.path.expanduser implementations from cpython 2.7.8 stdlib
237 # for different platforms with correct environment variables decoding.
239 if os
.name
== 'posix':
240 def compat_expanduser(path
):
241 """Expand ~ and ~user constructions. If user or $HOME is unknown,
243 if not path
.startswith('~'):
245 i
= path
.find('/', 1)
249 if 'HOME' not in os
.environ
:
251 userhome
= pwd
.getpwuid(os
.getuid()).pw_dir
253 userhome
= compat_getenv('HOME')
257 pwent
= pwd
.getpwnam(path
[1:i
])
260 userhome
= pwent
.pw_dir
261 userhome
= userhome
.rstrip('/')
262 return (userhome
+ path
[i
:]) or '/'
263 elif os
.name
== 'nt' or os
.name
== 'ce':
264 def compat_expanduser(path
):
265 """Expand ~ and ~user constructs.
267 If user or $HOME is unknown, do nothing."""
271 while i
< n
and path
[i
] not in '/\\':
274 if 'HOME' in os
.environ
:
275 userhome
= compat_getenv('HOME')
276 elif 'USERPROFILE' in os
.environ
:
277 userhome
= compat_getenv('USERPROFILE')
278 elif 'HOMEPATH' not in os
.environ
:
282 drive
= compat_getenv('HOMEDRIVE')
285 userhome
= os
.path
.join(drive
, compat_getenv('HOMEPATH'))
288 userhome
= os
.path
.join(os
.path
.dirname(userhome
), path
[1:i
])
290 return userhome
+ path
[i
:]
292 compat_expanduser
= os
.path
.expanduser
295 if sys
.version_info
< (3, 0):
297 from .utils
import preferredencoding
298 print(s
.encode(preferredencoding(), 'xmlcharrefreplace'))
301 assert isinstance(s
, compat_str
)
306 subprocess_check_output
= subprocess
.check_output
307 except AttributeError:
308 def subprocess_check_output(*args
, **kwargs
):
309 assert 'input' not in kwargs
310 p
= subprocess
.Popen(*args
, stdout
=subprocess
.PIPE
, **kwargs
)
311 output
, _
= p
.communicate()
314 raise subprocess
.CalledProcessError(ret
, p
.args
, output
=output
)
317 if sys
.version_info
< (3, 0) and sys
.platform
== 'win32':
318 def compat_getpass(prompt
, *args
, **kwargs
):
319 if isinstance(prompt
, compat_str
):
320 from .utils
import preferredencoding
321 prompt
= prompt
.encode(preferredencoding())
322 return getpass
.getpass(prompt
, *args
, **kwargs
)
324 compat_getpass
= getpass
.getpass
326 # Old 2.6 and 2.7 releases require kwargs to be bytes
330 _testfunc(**{'x': 0}
)
332 def compat_kwargs(kwargs
):
333 return dict((bytes(k
), v
) for k
, v
in kwargs
.items())
335 compat_kwargs
= lambda kwargs
: kwargs
338 if sys
.version_info
< (2, 7):
339 def compat_socket_create_connection(address
, timeout
, source_address
=None):
342 for res
in socket
.getaddrinfo(host
, port
, 0, socket
.SOCK_STREAM
):
343 af
, socktype
, proto
, canonname
, sa
= res
346 sock
= socket
.socket(af
, socktype
, proto
)
347 sock
.settimeout(timeout
)
349 sock
.bind(source_address
)
352 except socket
.error
as _
:
359 raise socket
.error("getaddrinfo returns an empty list")
361 compat_socket_create_connection
= socket
.create_connection
364 # Fix https://github.com/rg3/youtube-dl/issues/4223
365 # See http://bugs.python.org/issue9161 for what is broken
366 def workaround_optparse_bug9161():
367 op
= optparse
.OptionParser()
368 og
= optparse
.OptionGroup(op
, 'foo')
372 real_add_option
= optparse
.OptionGroup
.add_option
374 def _compat_add_option(self
, *args
, **kwargs
):
376 v
.encode('ascii', 'replace') if isinstance(v
, compat_str
)
378 bargs
= [enc(a
) for a
in args
]
380 (k
, enc(v
)) for k
, v
in kwargs
.items())
381 return real_add_option(self
, *bargs
, **bkwargs
)
382 optparse
.OptionGroup
.add_option
= _compat_add_option
384 if hasattr(shutil
, 'get_terminal_size'): # Python >= 3.3
385 compat_get_terminal_size
= shutil
.get_terminal_size
387 _terminal_size
= collections
.namedtuple('terminal_size', ['columns', 'lines'])
389 def compat_get_terminal_size():
390 columns
= compat_getenv('COLUMNS', None)
392 columns
= int(columns
)
395 lines
= compat_getenv('LINES', None)
402 sp
= subprocess
.Popen(
404 stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
)
405 out
, err
= sp
.communicate()
406 lines
, columns
= map(int, out
.split())
409 return _terminal_size(columns
, lines
)
412 itertools
.count(start
=0, step
=1)
413 compat_itertools_count
= itertools
.count
414 except TypeError: # Python 2.6
415 def compat_itertools_count(start
=0, step
=1):
427 'compat_get_terminal_size',
430 'compat_html_entities',
431 'compat_http_client',
432 'compat_http_server',
433 'compat_itertools_count',
438 'compat_socket_create_connection',
440 'compat_subprocess_get_DEVNULL',
441 'compat_urllib_error',
442 'compat_urllib_parse',
443 'compat_urllib_parse_unquote',
444 'compat_urllib_parse_unquote_to_bytes',
445 'compat_urllib_parse_urlparse',
446 'compat_urllib_request',
448 'compat_urlretrieve',
449 'compat_xml_parse_error',
451 'subprocess_check_output',
452 'workaround_optparse_bug9161',