def generate_walker(d, detect_project=True):
walker = os.walk(d)
r, dirs, f = next(walker)
try:
if detect_project and is_project(d):
dirs.remove(get_venv_folder())
except ValueError:
pass
return itertools.chain(((r, dirs, f),), walker)
def test(package, local, path, cov, merge, test_args, cov_args, global_exe,
no_detect):
"""Runs tests using `pytest`, optionally checking coverage.
The path is derived in the following order:
\b
1. The optional argument, which should be the name of a package
that was installed via `hatch install -l` or `pip install -e`.
2. The --local flag.
3. The option --path, which can be a relative or absolute path.
4. The current directory.
If the path points to a package, it should have a `tests` directory.
If a project is detected but there is no dedicated virtual env, it
will be created and any dev requirements will be installed in it.
\b
$ git clone https://github.com/ofek/privy && cd privy
$ hatch test -c
========================= test session starts ==========================
platform linux -- Python 3.5.2, pytest-3.2.1, py-1.4.34, pluggy-0.4.0
rootdir: /home/ofek/privy, inifile:
plugins: xdist-1.20.0, mock-1.6.2, httpbin-0.0.7, forked-0.2, cov-2.5.1
collected 10 items
\b
tests/test_privy.py ..........
\b
====================== 10 passed in 4.34 seconds =======================
\b
Tests completed, checking coverage...
\b
Name Stmts Miss Branch BrPart Cover Missing
-----------------------------------------------------------------
privy/__init__.py 1 0 0 0 100%
privy/core.py 30 0 0 0 100%
privy/utils.py 13 0 4 0 100%
tests/__init__.py 0 0 0 0 100%
tests/test_privy.py 57 0 0 0 100%
-----------------------------------------------------------------
TOTAL 101 0 4 0 100%
"""
if package:
echo_waiting('Locating package...')
path = get_editable_package_location(package)
if not path:
echo_failure('`{}` is not an editable package.'.format(package))
sys.exit(1)
elif local:
echo_waiting('Locating package...')
name, path = get_editable_package_location()
if not name:
if path is None:
echo_failure('There are no local packages available.')
sys.exit(1)
else:
echo_failure(
'There are multiple local packages available. Select '
'one with the optional argument.')
sys.exit(1)
echo_info('Package `{}` has been selected.'.format(name))
elif path:
possible_path = resolve_path(path)
if not possible_path:
echo_failure('Directory `{}` does not exist.'.format(path))
sys.exit(1)
path = possible_path
else:
path = os.getcwd()
python_cmd = [sys.executable if global_exe else get_proper_python(), '-m']
command = python_cmd.copy()
if cov:
command.extend(['coverage', 'run'])
command.extend(cov_args.split() if cov_args is not None else (
['--parallel-mode'] if merge else []))
command.append('-m')
command.append('pytest')
command.extend(test_args.split())
try: # no cov
sys.stdout.fileno()
testing = False
except io.UnsupportedOperation: # no cov
testing = True
# For testing we need to pipe because Click changes stdio streams.
stdout = sys.stdout if not testing else subprocess.PIPE
stderr = sys.stderr if not testing else subprocess.PIPE
venv_dir = None
if not (package
or local) and not venv_active() and not no_detect and is_project():
venv_dir = os.path.join(path, get_venv_folder())
if not is_venv(venv_dir):
echo_info('A project has been detected!')
echo_waiting('Creating a dedicated virtual env... ', nl=False)
create_venv(venv_dir)
echo_success('complete!')
with venv(venv_dir):
echo_waiting('Installing this project in the virtual env...')
install_packages(['-e', '.'])
click.echo()
echo_waiting('Ensuring pytest and coverage are available...')
install_packages(['pytest', 'coverage'])
click.echo()
dev_requirements = get_requirements_file(path, dev=True)
if dev_requirements:
echo_waiting(
'Installing test dependencies in the virtual env...')
install_packages(['-r', dev_requirements])
click.echo()
with chdir(path):
echo_waiting('Testing...')
output = b''
if venv_dir:
with venv(venv_dir):
test_result = subprocess.run(command,
stdout=stdout,
stderr=stderr,
shell=NEED_SUBPROCESS_SHELL)
else:
test_result = subprocess.run(command,
stdout=stdout,
stderr=stderr,
shell=NEED_SUBPROCESS_SHELL)
output += test_result.stdout or b''
output += test_result.stderr or b''
if cov:
echo_waiting('\nTests completed, checking coverage...\n')
if merge:
if venv_dir:
with venv(venv_dir):
result = subprocess.run(
python_cmd + ['coverage', 'combine', '--append'],
stdout=stdout,
stderr=stderr,
shell=NEED_SUBPROCESS_SHELL)
else:
result = subprocess.run(
python_cmd + ['coverage', 'combine', '--append'],
stdout=stdout,
stderr=stderr,
shell=NEED_SUBPROCESS_SHELL)
output += result.stdout or b''
output += result.stderr or b''
if venv_dir:
with venv(venv_dir):
result = subprocess.run(
python_cmd + ['coverage', 'report', '--show-missing'],
stdout=stdout,
stderr=stderr,
shell=NEED_SUBPROCESS_SHELL)
else:
result = subprocess.run(
python_cmd + ['coverage', 'report', '--show-missing'],
stdout=stdout,
stderr=stderr,
shell=NEED_SUBPROCESS_SHELL)
output += result.stdout or b''
output += result.stderr or b''
if testing: # no cov
click.echo(output.decode())
sys.exit(test_result.returncode)
def shell(env_name, command, shell_name, temp_env, pyname, pypath, global_packages): # no cov
"""Activates or sends a command to a virtual environment. A default shell
name (or command) can be specified in the config file entry `shell` or the
environment variable `SHELL`. If there is no entry, env var, nor shell
option provided, a system default will be used: `cmd` on Windows, `bash`
otherwise.
Any arguments provided after the first will be sent to the virtual env as
a command without activating it. If there is only the env without args,
it will be activated similarly to how you are accustomed. The name of
the virtual env to use must be omitted if using the --temp env option.
If no env is chosen, this will attempt to detect a project and activate
its virtual env. To run a command in a project's virtual env, use `.` as
the env name.
Activation will not do anything to your current shell, but will rather
spawn a subprocess to avoid any unwanted strangeness occurring in your
current environment. If you would like to learn more about the benefits
of this approach, be sure to read https://gist.github.com/datagrok/2199506.
To leave a virtual env, type `exit`, or you can do `Ctrl+D` on non-Windows
machines.
`use` is an alias for this command.
\b
Activation:
$ hatch env -ll
Virtual environments found in `/home/ofek/.virtualenvs`:
\b
fast ->
Version: 3.5.3
Implementation: PyPy
my-app ->
Version: 3.5.2
Implementation: CPython
old ->
Version: 2.7.12
Implementation: CPython
$ which python
/usr/bin/python
$ hatch shell my-app
(my-app) $ which python
/home/ofek/.virtualenvs/my-app/bin/python
\b
Commands:
$ hatch shell my-app pip list --format=columns
Package Version
---------- -------
pip 9.0.1
setuptools 36.3.0
wheel 0.29.0
$ hatch shell my-app hatch install -q requests six
$ hatch shell my-app pip list --format=columns
Package Version
---------- -----------
certifi 2017.7.27.1
chardet 3.0.4
idna 2.6
pip 9.0.1
requests 2.18.4
setuptools 36.3.0
six 1.10.0
urllib3 1.22
wheel 0.29.0
\b
Temporary env:
$ hatch shell -t
Already using interpreter /usr/bin/python3
Using base prefix '/usr'
New python executable in /tmp/tmpzg73untp/Ihqd/bin/python3
Also creating executable in /tmp/tmpzg73untp/Ihqd/bin/python
Installing setuptools, pip, wheel...done.
$ which python
/tmp/tmpzg73untp/Ihqd/bin/python
"""
venv_dir = None
if resolve_path(env_name) == os.getcwd():
env_name = ''
if not (env_name or temp_env):
if is_project():
venv_dir = os.path.join(os.getcwd(), 'venv')
if not is_venv(venv_dir):
echo_info('A project has been detected!')
echo_waiting('Creating a dedicated virtual env... ', nl=False)
create_venv(venv_dir, use_global=global_packages)
echo_success('complete!')
with venv(venv_dir):
echo_waiting('Installing this project in the virtual env... ', nl=False)
install_packages(['-q', '-e', '.'])
echo_success('complete!')
else:
echo_failure('No project found.')
sys.exit(1)
if env_name and temp_env:
echo_failure('Cannot use more than one virtual env at a time!')
sys.exit(1)
if not command and '_HATCHING_' in os.environ:
echo_failure(
'Virtual environments cannot be nested, sorry! To leave '
'the current one type `exit` or press `Ctrl+D`.'
)
sys.exit(1)
if temp_env:
if pyname:
try:
settings = load_settings()
except FileNotFoundError:
echo_failure('Unable to locate config file. Try `hatch config --restore`.')
sys.exit(1)
pypath = settings.get('pypaths', {}).get(pyname, None)
if not pypath:
echo_failure('Unable to find a Python path named `{}`.'.format(pyname))
sys.exit(1)
temp_dir = TemporaryDirectory()
env_name = get_random_venv_name()
venv_dir = os.path.join(temp_dir.name, env_name)
echo_waiting('Creating a temporary virtual env named `{}`...'.format(env_name))
create_venv(venv_dir, pypath=pypath, use_global=global_packages, verbose=True)
else:
temp_dir = None
venv_dir = venv_dir or os.path.join(get_venv_dir(), env_name)
if not os.path.exists(venv_dir):
echo_failure('Virtual env named `{}` does not exist.'.format(env_name))
sys.exit(1)
result = None
try:
if command:
with venv(venv_dir):
echo_waiting('Running `{}` in {}...'.format(
' '.join(c if len(c.split()) == 1 else '"{}"'.format(c) for c in command),
'`{}`'.format(env_name) if env_name else "this project's env"
))
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL).returncode
else:
with venv(venv_dir) as exe_dir:
result = run_shell(exe_dir, shell_name)
finally:
result = 1 if result is None else result
if temp_dir is not None:
temp_dir.cleanup()
sys.exit(result)
def install(packages, no_detect, env_name, editable, global_install, admin,
quiet):
"""If the option --env is supplied, the install will be applied using
that named virtual env. Unless the option --global is selected, the
install will only affect the current user. Of course, this will have
no effect if a virtual env is in use. The desired name of the admin
user can be set with the `_DEFAULT_ADMIN_` environment variable.
With no packages selected, this will install using a `setup.py` in the
current directory.
If no --env is chosen, this will attempt to detect a project and use its
virtual env before resorting to the default pip. No project detection
will occur if a virtual env is active.
"""
packages = packages or ['.']
# Windows' `runas` allows only a single argument for the
# command so we catch this case and turn our command into
# a string later.
windows_admin_command = None
if editable:
packages = ['-e', *packages]
if env_name:
venv_dir = os.path.join(get_venv_dir(), env_name)
if not os.path.exists(venv_dir):
echo_failure(
'Virtual env named `{}` does not exist.'.format(env_name))
sys.exit(1)
with venv(venv_dir):
command = [get_proper_pip(), 'install', *packages
] + (['-q'] if quiet else [])
echo_waiting('Installing in virtual env `{}`...'.format(env_name))
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL)
elif not venv_active() and not no_detect and is_project():
venv_dir = os.path.join(os.getcwd(), 'venv')
if not is_venv(venv_dir):
echo_info('A project has been detected!')
echo_waiting('Creating a dedicated virtual env... ', nl=False)
create_venv(venv_dir)
echo_success('complete!')
with venv(venv_dir):
echo_waiting('Installing this project in the virtual env... ',
nl=False)
install_packages(['-q', '-e', '.'])
echo_success('complete!')
with venv(venv_dir):
command = [get_proper_pip(), 'install', *packages
] + (['-q'] if quiet else [])
echo_waiting('Installing for this project...')
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL)
else:
command = [get_proper_pip(), 'install'] + (['-q'] if quiet else [])
if not venv_active(): # no cov
if global_install:
if not admin:
if ON_WINDOWS:
windows_admin_command = get_admin_command()
else:
command = get_admin_command() + command
else:
command.append('--user')
command.extend(packages)
if windows_admin_command: # no cov
command = windows_admin_command + [' '.join(command)]
echo_waiting('Installing...')
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL)
sys.exit(result.returncode)
def update(packages, no_detect, env_name, eager, all_packages, infra, global_install,
admin, force, dev, as_module, self, quiet):
"""If the option --env is supplied, the update will be applied using
that named virtual env. Unless the option --global is selected, the
update will only affect the current user. Of course, this will have
no effect if a virtual env is in use. The desired name of the admin
user can be set with the `_DEFAULT_ADMIN_` environment variable.
When performing a global update, your system may use an older version
of pip that is incompatible with some features such as --eager. To
force the use of these features, use --force.
With no packages nor options selected, this will update packages by
looking for a `requirements.txt` or a dev version of that in the current
directory.
If no --env is chosen, this will attempt to detect a project and use its
virtual env before resorting to the default pip. No project detection
will occur if a virtual env is active.
To update this tool, use the --self flag. All other methods of updating will
ignore `hatch`. See: https://github.com/pypa/pip/issues/1299
"""
command = ['install', '--upgrade'] + (['-q'] if quiet else [])
if not global_install or force: # no cov
command.extend(['--upgrade-strategy', 'eager' if eager else 'only-if-needed'])
infra_packages = ['pip', 'setuptools', 'wheel']
temp_dir = None
# Windows' `runas` allows only a single argument for the
# command so we catch this case and turn our command into
# a string later.
windows_admin_command = None
if self: # no cov
as_module = True
if not self and env_name:
venv_dir = os.path.join(get_venv_dir(), env_name)
if not os.path.exists(venv_dir):
echo_failure('Virtual env named `{}` does not exist.'.format(env_name))
sys.exit(1)
with venv(venv_dir):
executable = (
[get_proper_python(), '-m', 'pip']
if as_module or (infra and ON_WINDOWS)
else [get_proper_pip()]
)
command = executable + command
if all_packages:
installed_packages = infra_packages if infra else get_installed_packages()
else:
installed_packages = None
elif not self and not venv_active() and not no_detect and is_project():
venv_dir = os.path.join(os.getcwd(), get_venv_folder())
if not is_venv(venv_dir):
echo_info('A project has been detected!')
echo_waiting('Creating a dedicated virtual env... ', nl=False)
create_venv(venv_dir)
echo_success('complete!')
with venv(venv_dir):
echo_waiting('Installing this project in the virtual env... ', nl=False)
install_packages(['-q', '-e', '.'])
echo_success('complete!')
with venv(venv_dir):
executable = (
[get_proper_python(), '-m', 'pip']
if as_module or (infra and ON_WINDOWS)
else [get_proper_pip()]
)
command = executable + command
if all_packages:
installed_packages = infra_packages if infra else get_installed_packages()
else:
installed_packages = None
else:
venv_dir = None
executable = (
[sys.executable if self else get_proper_python(), '-m', 'pip']
if as_module or (infra and ON_WINDOWS)
else [get_proper_pip()]
)
command = executable + command
if all_packages:
installed_packages = infra_packages if infra else get_installed_packages()
else:
installed_packages = None
if not venv_active(): # no cov
if global_install:
if not admin:
if ON_WINDOWS:
windows_admin_command = get_admin_command()
else:
command = get_admin_command() + command
else:
command.append('--user')
if self: # no cov
command.append('hatch')
if ON_WINDOWS:
echo_warning('After the update you may want to press Enter to flush stdout.')
subprocess.Popen(command, shell=NEED_SUBPROCESS_SHELL)
sys.exit()
else:
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL)
sys.exit(result.returncode)
elif infra:
command.extend(infra_packages)
elif all_packages:
installed_packages = [
package for package in installed_packages
if package not in infra_packages and package != 'hatch'
]
if not installed_packages:
echo_failure('No packages installed.')
sys.exit(1)
command.extend(installed_packages)
elif packages:
packages = [package for package in packages if package != 'hatch']
if not packages:
echo_failure('No packages to install.')
sys.exit(1)
command.extend(packages)
# When https://github.com/pypa/pipfile is finalized, we'll use it.
else:
reqs = get_requirements_file(os.getcwd(), dev=dev)
if not reqs:
echo_failure('Unable to locate a requirements file.')
sys.exit(1)
with open(reqs, 'r') as f:
lines = f.readlines()
matches = []
for line in lines:
match = re.match(r'^[^=<>]+', line.lstrip())
if match and match.group(0) == 'hatch':
matches.append(line)
if matches:
for line in matches:
lines.remove(line)
temp_dir = TemporaryDirectory()
reqs = os.path.join(temp_dir.name, basepath(reqs))
with open(reqs, 'w') as f:
f.writelines(lines)
command.extend(['-r', reqs])
if windows_admin_command: # no cov
command = windows_admin_command + [' '.join(command)]
if venv_dir:
with venv(venv_dir):
if env_name:
echo_waiting('Updating virtual env `{}`...'.format(env_name))
else:
echo_waiting('Updating for this project...')
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL)
else:
echo_waiting('Updating...')
result = subprocess.run(command, shell=NEED_SUBPROCESS_SHELL)
if temp_dir is not None:
temp_dir.cleanup()
sys.exit(result.returncode)