From 417c80057bed70a4e6a39c3f04c13615b4300f52 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Mon, 26 Oct 2015 17:12:29 -0400 Subject: [PATCH] Support unicode commands. Signed-off-by: Daniel Nephin --- docker/api/exec_api.py | 4 +--- docker/utils/__init__.py | 2 +- docker/utils/utils.py | 10 ++++++++-- tests/unit/utils_test.py | 15 ++++++++++++++- 4 files changed, 24 insertions(+), 7 deletions(-) diff --git a/docker/api/exec_api.py b/docker/api/exec_api.py index c66b9dd0..e64a40c8 100644 --- a/docker/api/exec_api.py +++ b/docker/api/exec_api.py @@ -1,5 +1,3 @@ -import shlex - import six from .. import errors @@ -20,7 +18,7 @@ class ExecApiMixin(object): 'User-specific exec is not supported in API < 1.19' ) if isinstance(cmd, six.string_types): - cmd = shlex.split(str(cmd)) + cmd = utils.split_command(cmd) data = { 'Container': container, diff --git a/docker/utils/__init__.py b/docker/utils/__init__.py index 92e03e9b..e27700e4 100644 --- a/docker/utils/__init__.py +++ b/docker/utils/__init__.py @@ -3,7 +3,7 @@ from .utils import ( mkbuildcontext, tar, exclude_paths, parse_repository_tag, parse_host, kwargs_from_env, convert_filters, create_host_config, create_container_config, parse_bytes, ping_registry, parse_env_file, - version_lt, version_gte, decode_json_header + version_lt, version_gte, decode_json_header, split_command, ) # flake8: noqa from .types import Ulimit, LogConfig # flake8: noqa diff --git a/docker/utils/utils.py b/docker/utils/utils.py index 89837b78..4d2968ad 100644 --- a/docker/utils/utils.py +++ b/docker/utils/utils.py @@ -673,6 +673,12 @@ def parse_env_file(env_file): return environment +def split_command(command): + if six.PY2: + command = command.encode('utf-8') + return shlex.split(command) + + def create_container_config( version, image, command, hostname=None, user=None, detach=False, stdin_open=False, tty=False, mem_limit=None, ports=None, environment=None, @@ -682,10 +688,10 @@ def create_container_config( labels=None, volume_driver=None ): if isinstance(command, six.string_types): - command = shlex.split(str(command)) + command = split_command(command) if isinstance(entrypoint, six.string_types): - entrypoint = shlex.split(str(entrypoint)) + entrypoint = split_command(entrypoint) if isinstance(environment, dict): environment = [ diff --git a/tests/unit/utils_test.py b/tests/unit/utils_test.py index fffa77ac..c20fa5f6 100644 --- a/tests/unit/utils_test.py +++ b/tests/unit/utils_test.py @@ -17,7 +17,8 @@ from docker.errors import DockerException from docker.utils import ( parse_repository_tag, parse_host, convert_filters, kwargs_from_env, create_host_config, Ulimit, LogConfig, parse_bytes, parse_env_file, - exclude_paths, convert_volume_binds, decode_json_header, tar + exclude_paths, convert_volume_binds, decode_json_header, tar, + split_command, ) from docker.utils.ports import build_port_bindings, split_port @@ -389,6 +390,18 @@ class UtilsTest(base.BaseTestCase): self.assertEqual(obj, decoded_data) +class SplitCommandTest(base.BaseTestCase): + + @pytest.mark.skipif(six.PY2, reason="shlex doesn't support unicode in py2") + def test_split_command_with_unicode(self): + self.assertEqual(split_command('echo μ'), ['echo', 'μ']) + + @pytest.mark.skipif(six.PY3, reason="shlex doesn't support unicode in py2") + def test_split_command_with_bytes(self): + expected = ['echo', u'μ'.encode('utf-8')] + self.assertEqual(split_command(u'echo μ'), expected) + + class PortsTest(base.BaseTestCase): def test_split_port_with_host_ip(self): internal_port, external_port = split_port("127.0.0.1:1000:2000")