##// END OF EJS Templates
BUG: Don't index args unless we know we can...
farisachugthai -
Show More
@@ -1,104 +1,105
1 """Implementation of packaging-related magic functions.
1 """Implementation of packaging-related magic functions.
2 """
2 """
3 #-----------------------------------------------------------------------------
3 #-----------------------------------------------------------------------------
4 # Copyright (c) 2018 The IPython Development Team.
4 # Copyright (c) 2018 The IPython Development Team.
5 #
5 #
6 # Distributed under the terms of the Modified BSD License.
6 # Distributed under the terms of the Modified BSD License.
7 #
7 #
8 # The full license is in the file COPYING.txt, distributed with this software.
8 # The full license is in the file COPYING.txt, distributed with this software.
9 #-----------------------------------------------------------------------------
9 #-----------------------------------------------------------------------------
10
10
11 import re
11 import re
12 import shlex
12 import shlex
13 import sys
13 import sys
14 from pathlib import Path
14 from pathlib import Path
15
15
16 from IPython.core.magic import Magics, magics_class, line_magic
16 from IPython.core.magic import Magics, magics_class, line_magic
17
17
18
18
19 def _is_conda_environment():
19 def _is_conda_environment():
20 """Return True if the current Python executable is in a conda env"""
20 """Return True if the current Python executable is in a conda env"""
21 # TODO: does this need to change on windows?
21 # TODO: does this need to change on windows?
22 return Path(sys.prefix, "conda-meta", "history").exists()
22 return Path(sys.prefix, "conda-meta", "history").exists()
23
23
24
24
25 def _get_conda_executable():
25 def _get_conda_executable():
26 """Find the path to the conda executable"""
26 """Find the path to the conda executable"""
27 # Check if there is a conda executable in the same directory as the Python executable.
27 # Check if there is a conda executable in the same directory as the Python executable.
28 # This is the case within conda's root environment.
28 # This is the case within conda's root environment.
29 conda = Path(sys.executable).parent / "conda"
29 conda = Path(sys.executable).parent / "conda"
30 if conda.is_file():
30 if conda.is_file():
31 return str(conda)
31 return str(conda)
32
32
33 # Otherwise, attempt to extract the executable from conda history.
33 # Otherwise, attempt to extract the executable from conda history.
34 # This applies in any conda environment.
34 # This applies in any conda environment.
35 history = Path(sys.prefix, "conda-meta", "history").read_text()
35 history = Path(sys.prefix, "conda-meta", "history").read_text()
36 match = re.search(
36 match = re.search(
37 r"^#\s*cmd:\s*(?P<command>.*conda)\s[create|install]",
37 r"^#\s*cmd:\s*(?P<command>.*conda)\s[create|install]",
38 history,
38 history,
39 flags=re.MULTILINE,
39 flags=re.MULTILINE,
40 )
40 )
41 if match:
41 if match:
42 return match.groupdict()["command"]
42 return match.groupdict()["command"]
43
43
44 # Fallback: assume conda is available on the system path.
44 # Fallback: assume conda is available on the system path.
45 return "conda"
45 return "conda"
46
46
47
47
48 CONDA_COMMANDS_REQUIRING_PREFIX = {
48 CONDA_COMMANDS_REQUIRING_PREFIX = {
49 'install', 'list', 'remove', 'uninstall', 'update', 'upgrade',
49 'install', 'list', 'remove', 'uninstall', 'update', 'upgrade',
50 }
50 }
51 CONDA_COMMANDS_REQUIRING_YES = {
51 CONDA_COMMANDS_REQUIRING_YES = {
52 'install', 'remove', 'uninstall', 'update', 'upgrade',
52 'install', 'remove', 'uninstall', 'update', 'upgrade',
53 }
53 }
54 CONDA_ENV_FLAGS = {'-p', '--prefix', '-n', '--name'}
54 CONDA_ENV_FLAGS = {'-p', '--prefix', '-n', '--name'}
55 CONDA_YES_FLAGS = {'-y', '--y'}
55 CONDA_YES_FLAGS = {'-y', '--y'}
56
56
57
57
58 @magics_class
58 @magics_class
59 class PackagingMagics(Magics):
59 class PackagingMagics(Magics):
60 """Magics related to packaging & installation"""
60 """Magics related to packaging & installation"""
61
61
62 @line_magic
62 @line_magic
63 def pip(self, line):
63 def pip(self, line):
64 """Run the pip package manager within the current kernel.
64 """Run the pip package manager within the current kernel.
65
65
66 Usage:
66 Usage:
67 %pip install [pkgs]
67 %pip install [pkgs]
68 """
68 """
69 self.shell.system(' '.join([sys.executable, '-m', 'pip', line]))
69 self.shell.system(' '.join([sys.executable, '-m', 'pip', line]))
70 print("Note: you may need to restart the kernel to use updated packages.")
70 print("Note: you may need to restart the kernel to use updated packages.")
71
71
72 @line_magic
72 @line_magic
73 def conda(self, line):
73 def conda(self, line):
74 """Run the conda package manager within the current kernel.
74 """Run the conda package manager within the current kernel.
75
75
76 Usage:
76 Usage:
77 %conda install [pkgs]
77 %conda install [pkgs]
78 """
78 """
79 if not _is_conda_environment():
79 if not _is_conda_environment():
80 raise ValueError("The python kernel does not appear to be a conda environment. "
80 raise ValueError("The python kernel does not appear to be a conda environment. "
81 "Please use ``%pip install`` instead.")
81 "Please use ``%pip install`` instead.")
82
82
83 conda = _get_conda_executable()
83 conda = _get_conda_executable()
84 args = shlex.split(line)
84 args = shlex.split(line)
85 command = args[0]
85 command = args[0] if len(args) > 0 else ""
86 args = args[1:]
86 args = args[1:] if len(args) > 1 else [""]
87
87 extra_args = []
88 extra_args = []
88
89
89 # When the subprocess does not allow us to respond "yes" during the installation,
90 # When the subprocess does not allow us to respond "yes" during the installation,
90 # we need to insert --yes in the argument list for some commands
91 # we need to insert --yes in the argument list for some commands
91 stdin_disabled = getattr(self.shell, 'kernel', None) is not None
92 stdin_disabled = getattr(self.shell, 'kernel', None) is not None
92 needs_yes = command in CONDA_COMMANDS_REQUIRING_YES
93 needs_yes = command in CONDA_COMMANDS_REQUIRING_YES
93 has_yes = set(args).intersection(CONDA_YES_FLAGS)
94 has_yes = set(args).intersection(CONDA_YES_FLAGS)
94 if stdin_disabled and needs_yes and not has_yes:
95 if stdin_disabled and needs_yes and not has_yes:
95 extra_args.append("--yes")
96 extra_args.append("--yes")
96
97
97 # Add --prefix to point conda installation to the current environment
98 # Add --prefix to point conda installation to the current environment
98 needs_prefix = command in CONDA_COMMANDS_REQUIRING_PREFIX
99 needs_prefix = command in CONDA_COMMANDS_REQUIRING_PREFIX
99 has_prefix = set(args).intersection(CONDA_ENV_FLAGS)
100 has_prefix = set(args).intersection(CONDA_ENV_FLAGS)
100 if needs_prefix and not has_prefix:
101 if needs_prefix and not has_prefix:
101 extra_args.extend(["--prefix", sys.prefix])
102 extra_args.extend(["--prefix", sys.prefix])
102
103
103 self.shell.system(' '.join([conda, command] + extra_args + args))
104 self.shell.system(' '.join([conda, command] + extra_args + args))
104 print("\nNote: you may need to restart the kernel to use updated packages.")
105 print("\nNote: you may need to restart the kernel to use updated packages.")
General Comments 0
You need to be logged in to leave comments. Login now