to_text, to_bytes, and to_native now have surrogate_or_strict error handler (#4630)

On python3, we want to use the surrogateescape error handler if
available for filesystem paths and the like.  On python2, have to use
strict in these circumstances.  Use the new error strategy for to_text,
to_bytes, and to_native that allows this.
This commit is contained in:
Toshio Kuratomi 2016-09-01 04:19:15 -07:00 committed by GitHub
parent ceddebaf28
commit 7e79c59d38
2 changed files with 16 additions and 14 deletions

View file

@ -164,13 +164,15 @@ def write_changes(module, b_lines, dest):
if validate: if validate:
if "%s" not in validate: if "%s" not in validate:
module.fail_json(msg="validate must contain %%s: %s" % (validate)) module.fail_json(msg="validate must contain %%s: %s" % (validate))
(rc, out, err) = module.run_command(to_bytes(validate % tmpfile)) (rc, out, err) = module.run_command(to_bytes(validate % tmpfile, errors='surrogate_or_strict'))
valid = rc == 0 valid = rc == 0
if rc != 0: if rc != 0:
module.fail_json(msg='failed to validate: ' module.fail_json(msg='failed to validate: '
'rc:%s error:%s' % (rc, err)) 'rc:%s error:%s' % (rc, err))
if valid: if valid:
module.atomic_move(tmpfile, os.path.realpath(dest), unsafe_writes=module.params['unsafe_writes']) module.atomic_move(tmpfile,
to_native(os.path.realpath(to_bytes(dest, errors='surrogate_or_strict')), errors='surrogate_or_strict'),
unsafe_writes=module.params['unsafe_writes'])
def check_file_attrs(module, changed, message, diff): def check_file_attrs(module, changed, message, diff):
@ -194,7 +196,7 @@ def present(module, dest, regexp, line, insertafter, insertbefore, create,
'before_header': '%s (content)' % dest, 'before_header': '%s (content)' % dest,
'after_header': '%s (content)' % dest} 'after_header': '%s (content)' % dest}
b_dest = to_bytes(dest) b_dest = to_bytes(dest, errors='surrogate_or_strict')
if not os.path.exists(b_dest): if not os.path.exists(b_dest):
if not create: if not create:
module.fail_json(rc=257, msg='Destination %s does not exist !' % dest) module.fail_json(rc=257, msg='Destination %s does not exist !' % dest)
@ -211,12 +213,12 @@ def present(module, dest, regexp, line, insertafter, insertbefore, create,
diff['before'] = to_native(b('').join(b_lines)) diff['before'] = to_native(b('').join(b_lines))
if regexp is not None: if regexp is not None:
bre_m = re.compile(to_bytes(regexp)) bre_m = re.compile(to_bytes(regexp, errors='surrogate_or_strict'))
if insertafter not in (None, 'BOF', 'EOF'): if insertafter not in (None, 'BOF', 'EOF'):
bre_ins = re.compile(to_bytes(insertafter)) bre_ins = re.compile(to_bytes(insertafter, errors='surrogate_or_strict'))
elif insertbefore not in (None, 'BOF'): elif insertbefore not in (None, 'BOF'):
bre_ins = re.compile(to_bytes(insertbefore)) bre_ins = re.compile(to_bytes(insertbefore, errors='surrogate_or_strict'))
else: else:
bre_ins = None bre_ins = None
@ -224,7 +226,7 @@ def present(module, dest, regexp, line, insertafter, insertbefore, create,
# index[1] is the line num where insertafter/inserbefore has been found # index[1] is the line num where insertafter/inserbefore has been found
index = [-1, -1] index = [-1, -1]
m = None m = None
b_line = to_bytes(line) b_line = to_bytes(line, errors='surrogate_or_strict')
for lineno, b_cur_line in enumerate(b_lines): for lineno, b_cur_line in enumerate(b_lines):
if regexp is not None: if regexp is not None:
match_found = bre_m.search(b_cur_line) match_found = bre_m.search(b_cur_line)
@ -244,7 +246,7 @@ def present(module, dest, regexp, line, insertafter, insertbefore, create,
msg = '' msg = ''
changed = False changed = False
# Regexp matched a line in the file # Regexp matched a line in the file
b_linesep = to_bytes(os.linesep) b_linesep = to_bytes(os.linesep, errors='surrogate_or_strict')
if index[0] != -1: if index[0] != -1:
if backrefs: if backrefs:
b_new_line = m.expand(b_line) b_new_line = m.expand(b_line)
@ -310,7 +312,7 @@ def present(module, dest, regexp, line, insertafter, insertbefore, create,
def absent(module, dest, regexp, line, backup): def absent(module, dest, regexp, line, backup):
b_dest = to_bytes(dest) b_dest = to_bytes(dest, errors='surrogate_or_strict')
if not os.path.exists(b_dest): if not os.path.exists(b_dest):
module.exit_json(changed=False, msg="file not present") module.exit_json(changed=False, msg="file not present")
@ -328,10 +330,10 @@ def absent(module, dest, regexp, line, backup):
diff['before'] = to_native(b('').join(b_lines)) diff['before'] = to_native(b('').join(b_lines))
if regexp is not None: if regexp is not None:
bre_c = re.compile(to_bytes(regexp)) bre_c = re.compile(to_bytes(regexp, errors='surrogate_or_strict'))
found = [] found = []
b_line = to_bytes(line) b_line = to_bytes(line, errors='surrogate_or_strict')
def matcher(b_cur_line): def matcher(b_cur_line):
if regexp is not None: if regexp is not None:
match_found = bre_c.search(b_cur_line) match_found = bre_c.search(b_cur_line)
@ -392,7 +394,7 @@ def main():
backrefs = params['backrefs'] backrefs = params['backrefs']
dest = params['dest'] dest = params['dest']
b_dest = to_bytes(dest) b_dest = to_bytes(dest, errors='surrogate_or_strict')
if os.path.isdir(b_dest): if os.path.isdir(b_dest):
module.fail_json(rc=256, msg='Destination %s is a directory !' % dest) module.fail_json(rc=256, msg='Destination %s is a directory !' % dest)

View file

@ -483,7 +483,7 @@ def get_remote_head(git_path, module, dest, version, remote, bare):
def is_remote_tag(git_path, module, dest, remote, version): def is_remote_tag(git_path, module, dest, remote, version):
cmd = '%s ls-remote %s -t refs/tags/%s' % (git_path, remote, version) cmd = '%s ls-remote %s -t refs/tags/%s' % (git_path, remote, version)
(rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest) (rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest)
if to_bytes(version) in out: if to_bytes(version, errors='surrogate_or_strict') in out:
return True return True
else: else:
return False return False
@ -513,7 +513,7 @@ def get_tags(git_path, module, dest):
def is_remote_branch(git_path, module, dest, remote, version): def is_remote_branch(git_path, module, dest, remote, version):
cmd = '%s ls-remote %s -h refs/heads/%s' % (git_path, remote, version) cmd = '%s ls-remote %s -h refs/heads/%s' % (git_path, remote, version)
(rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest) (rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest)
if to_bytes(version) in out: if to_bytes(version, errors='surrogate_or_strict') in out:
return True return True
else: else:
return False return False