Welcome to mork’s documentation!

mork: A project for installing packages across the virtualenv boundary.

Summary

Mork_ is a library designed for installing and querying python packages inside virtual environments.

🐉 See What’s Installed

>>> import mork
>>> venv = mork.VirtualEnv.from_project_path('/home/user/git/pipenv')
>>> dists = venv.get_distributions()
>>> [dist for dist in dists][:3]
[wheel 0.31.1 (/home/user/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages), Werkzeug 0.14.1 (/home/user/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages), vistir 0.1.4 (/home/user/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages)]

🐉 Install A Package

>>> from requirementslib.models.requirements import Requirement
>>> r = Requirement.from_line("requests")
>>> venv.install(r, editable=False)

🐉 Uninstall a Package

>>> pkg = "pytz"
>>> with venv.uninstall(pkg, auto_confirm=True) as uninstall:
        if uninstall.paths:
            cleaned = pkg
>>> print("Removed package: %s" % cleaned)

🐉 Display Information about Python

>>> venv.python
'/home/user/.virtualenvs/pipenv-MfOPs1lW/bin/python'
>>> venv.python_version
'3.7'

🐉 Run Commands Inside the Virtualenv

>>> cmd = venv.run("env")
>>> [line for line in cmd.out.splitlines() if line.startswith("VIRTUAL_ENV")]
['VIRTUAL_ENV=/user/hawk/.virtualenvs/pipenv-MfOPs1lW']
>>> cmd = venv.run_py(["import os; print(os.environ.get('VIRTUAL_ENV'))"])
Deactivating virtualenv...
>>> cmd.out
'/home/user/.virtualenvs/pipenv-MfOPs1lW\n'
>>> with venv.activated():
        print(os.environ["VIRTUAL_ENV"])
/home/hawk/.virtualenvs/pipenv-MfOPs1lW

Read the documentation.

mork package

class mork.VirtualEnv(prefix=None, base_working_set=None, is_venv=True)

Bases: object

activated(include_extras=True, extra_dists=[])

A context manager which activates the virtualenv.

Parameters:extra_dists (list) – Paths added to the context after the virtualenv is activated.

This context manager sets the following environment variables:

• PYTHONUSERBASE
• VIRTUAL_ENV
• PYTHONIOENCODING
• PYTHONDONTWRITEBYTECODE

In addition, it activates the virtualenv inline by calling activate_this.py.

add_dist(dist_name)

base_paths

Returns the context appropriate paths for the environment.

Returns:A dictionary of environment specific paths to be used for installation operations Return type:dict

Note

The implementation of this is borrowed from a combination of pip and virtualenv and is likely to change at some point in the future.

>>> from pipenv.core import project
>>> from pipenv.environment import Environment
>>> env = Environment(prefix=project.virtualenv_location, is_venv=True, sources=project.sources)
>>> import pprint
>>> pprint.pprint(env.base_paths)
{'PATH': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/bin::/bin:/usr/bin',
'PYTHONPATH': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'data': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW',
'include': '/home/hawk/.pyenv/versions/3.7.1/include/python3.7m',
'libdir': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'platinclude': '/home/hawk/.pyenv/versions/3.7.1/include/python3.7m',
'platlib': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'platstdlib': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7',
'prefix': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW',
'purelib': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'scripts': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/bin',
'stdlib': '/home/hawk/.pyenv/versions/3.7.1/lib/python3.7'}

dist_is_in_project(dist)

classmethod filter_sources(requirement, sources)

find_egg(egg_dist)

classmethod from_project_path(path)

Utility for finding a virtualenv location based on a project path

get_distributions()

Retrives the distributions installed on the library path of the virtualenv

Returns:A set of distributions found on the library path Return type:iterator

get_finder()

get_installed_packages()

get_monkeypatched_pathset()

Returns a monkeypatched UninstallPathset for using to uninstall packages from the virtualenv

Returns:A patched UninstallPathset which enables uninstallation of venv packages Return type:pip._internal.req.req_uninstall.UninstallPathset

get_outdated_packages()

get_package_info()

get_setup_install_args(pkgname, setup_py, develop=False)

Get setup.py install args for installing the supplied package in the virtualenv

Parameters:

• pkgname (str) – The name of the package to install
• setup_py (str) – The path to the setup file of the package
• develop (bool) – Whether the package is in development mode

Returns:

The installation arguments to pass to the interpreter when installing

Return type:

list

classmethod get_sys_path(python_path)

Get the sys.path data for a given python executable.

Parameters:python_path (str) – Path to a specific python executable. Returns:The system path information for that python runtime. Return type:list

get_working_set()

Retrieve the working set of installed packages for the virtualenv.

Returns:The working set for the virtualenv Return type:pkg_resources.WorkingSet

classmethod get_workon_home()

initial_working_set

install(req, editable=False, sources=[])

Install a package into the virtualenv

Parameters:

• req (requirementslib.models.requirement.Requirement) – A requirement to install
• editable (bool) – Whether the requirement is editable, defaults to False
• sources (list) – A list of pip sources to consult, defaults to []

Returns:

A return code, 0 if successful

Return type:

int

is_installed(pkgname)

Given a package name, returns whether it is installed in the virtual environment

Parameters:pkgname (str) – The name of a package Returns:Whether the supplied package is installed in the environment Return type:bool

libdir

locate_dist(dist)

classmethod normalize_path(path)

paths

python

Path to the environment python

python_version

pyversion

classmethod resolve_dist(dist, working_set)

Given a local distribution and a working set, returns all dependencies from the set.

Parameters:

• dist (pkg_resources.Distribution) – A single distribution to find the dependencies of
• working_set (pkg_resources.WorkingSet) – A working set to search for all packages

Returns:

A set of distributions which the package depends on, including the package

Return type:

set(pkg_resources.Distribution)

run(cmd, cwd='.')

Run a command with Popen in the context of the virtualenv

Parameters:

• cmd (str or list) – A command to run in the virtual environment
• cwd (str) – The working directory in which to execute the command, defaults to os.curdir

Returns:

A finished command object

Return type:

Popen

run_py(cmd, cwd='.')

Run a python command in the virtualenv context.

Parameters:

• cmd (str or list) – A command to run in the virtual environment - runs with python -c
• cwd (str) – The working directory in which to execute the command, defaults to os.curdir

Returns:

A finished command object

Return type:

Popen

safe_import(name)

Helper utility for reimporting previously imported modules while inside the venv

script_basedir

Path to the environment scripts dir

scripts_dir

setuptools_install(chdir_to, pkg_name, setup_py_path=None, editable=False)

Install an sdist or an editable package into the virtualenv

Parameters:

• chdir_to (str) – The location to change to
• setup_py_path (str) – The path to the setup.py, if applicable defaults to None
• editable (bool) – Whether the package is editable, defaults to False

sys_path

The system path inside the environment

Returns:The sys.path from the environment Return type:list

sys_prefix

The prefix run inside the context of the environment

Returns:The python prefix inside the environment Return type:sys.prefix

system_paths

uninstall(pkgname, *args, **kwargs)

A context manager which allows uninstallation of packages from the virtualenv

Parameters:pkgname (str) – The name of a package to uninstall

>>> venv = VirtualEnv("/path/to/venv/root")
>>> with venv.uninstall("pytz", auto_confirm=True, verbose=False) as uninstaller:
        cleaned = uninstaller.paths
>>> if cleaned:
        print("uninstalled packages: %s" % cleaned)

Submodules

mork.virtualenv module

class mork.virtualenv.PatchedUninstaller

Bases: object

class mork.virtualenv.VirtualEnv(prefix=None, base_working_set=None, is_venv=True)

Bases: object

activated(include_extras=True, extra_dists=[])

A context manager which activates the virtualenv.

Parameters:extra_dists (list) – Paths added to the context after the virtualenv is activated.

This context manager sets the following environment variables:

• PYTHONUSERBASE
• VIRTUAL_ENV
• PYTHONIOENCODING
• PYTHONDONTWRITEBYTECODE

In addition, it activates the virtualenv inline by calling activate_this.py.

add_dist(dist_name)

base_paths

Returns the context appropriate paths for the environment.

Returns:A dictionary of environment specific paths to be used for installation operations Return type:dict

Note

The implementation of this is borrowed from a combination of pip and virtualenv and is likely to change at some point in the future.

>>> from pipenv.core import project
>>> from pipenv.environment import Environment
>>> env = Environment(prefix=project.virtualenv_location, is_venv=True, sources=project.sources)
>>> import pprint
>>> pprint.pprint(env.base_paths)
{'PATH': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/bin::/bin:/usr/bin',
'PYTHONPATH': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'data': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW',
'include': '/home/hawk/.pyenv/versions/3.7.1/include/python3.7m',
'libdir': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'platinclude': '/home/hawk/.pyenv/versions/3.7.1/include/python3.7m',
'platlib': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'platstdlib': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7',
'prefix': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW',
'purelib': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/lib/python3.7/site-packages',
'scripts': '/home/hawk/.virtualenvs/pipenv-MfOPs1lW/bin',
'stdlib': '/home/hawk/.pyenv/versions/3.7.1/lib/python3.7'}

dist_is_in_project(dist)

classmethod filter_sources(requirement, sources)

find_egg(egg_dist)

classmethod from_project_path(path)

Utility for finding a virtualenv location based on a project path

get_distributions()

Retrives the distributions installed on the library path of the virtualenv

Returns:A set of distributions found on the library path Return type:iterator

get_finder()

get_installed_packages()

get_monkeypatched_pathset()

Returns a monkeypatched UninstallPathset for using to uninstall packages from the virtualenv

Returns:A patched UninstallPathset which enables uninstallation of venv packages Return type:pip._internal.req.req_uninstall.UninstallPathset

get_outdated_packages()

get_package_info()

get_setup_install_args(pkgname, setup_py, develop=False)

Get setup.py install args for installing the supplied package in the virtualenv

Parameters:

• pkgname (str) – The name of the package to install
• setup_py (str) – The path to the setup file of the package
• develop (bool) – Whether the package is in development mode

Returns:

The installation arguments to pass to the interpreter when installing

Return type:

list

classmethod get_sys_path(python_path)

Get the sys.path data for a given python executable.

Parameters:python_path (str) – Path to a specific python executable. Returns:The system path information for that python runtime. Return type:list

get_working_set()

Retrieve the working set of installed packages for the virtualenv.

Returns:The working set for the virtualenv Return type:pkg_resources.WorkingSet

classmethod get_workon_home()

initial_working_set

install(req, editable=False, sources=[])

Install a package into the virtualenv

Parameters:

• req (requirementslib.models.requirement.Requirement) – A requirement to install
• editable (bool) – Whether the requirement is editable, defaults to False
• sources (list) – A list of pip sources to consult, defaults to []

Returns:

A return code, 0 if successful

Return type:

int

is_installed(pkgname)

Given a package name, returns whether it is installed in the virtual environment

Parameters:pkgname (str) – The name of a package Returns:Whether the supplied package is installed in the environment Return type:bool

libdir

locate_dist(dist)

classmethod normalize_path(path)

paths

python

Path to the environment python

python_version

pyversion

classmethod resolve_dist(dist, working_set)

Given a local distribution and a working set, returns all dependencies from the set.

Parameters:

• dist (pkg_resources.Distribution) – A single distribution to find the dependencies of
• working_set (pkg_resources.WorkingSet) – A working set to search for all packages

Returns:

A set of distributions which the package depends on, including the package

Return type:

set(pkg_resources.Distribution)

run(cmd, cwd='.')

Run a command with Popen in the context of the virtualenv

Parameters:

• cmd (str or list) – A command to run in the virtual environment
• cwd (str) – The working directory in which to execute the command, defaults to os.curdir

Returns:

A finished command object

Return type:

Popen

run_py(cmd, cwd='.')

Run a python command in the virtualenv context.

Parameters:

• cmd (str or list) – A command to run in the virtual environment - runs with python -c
• cwd (str) – The working directory in which to execute the command, defaults to os.curdir

Returns:

A finished command object

Return type:

Popen

safe_import(name)

Helper utility for reimporting previously imported modules while inside the venv

script_basedir

Path to the environment scripts dir

scripts_dir

setuptools_install(chdir_to, pkg_name, setup_py_path=None, editable=False)

Install an sdist or an editable package into the virtualenv

Parameters:

• chdir_to (str) – The location to change to
• setup_py_path (str) – The path to the setup.py, if applicable defaults to None
• editable (bool) – Whether the package is editable, defaults to False

sys_path

The system path inside the environment

Returns:The sys.path from the environment Return type:list

sys_prefix

The prefix run inside the context of the environment

Returns:The python prefix inside the environment Return type:sys.prefix

system_paths

uninstall(pkgname, *args, **kwargs)

A context manager which allows uninstallation of packages from the virtualenv

Parameters:pkgname (str) – The name of a package to uninstall

>>> venv = VirtualEnv("/path/to/venv/root")
>>> with venv.uninstall("pytz", auto_confirm=True, verbose=False) as uninstaller:
        cleaned = uninstaller.paths
>>> if cleaned:
        print("uninstalled packages: %s" % cleaned)

Indices and tables

• Index
• Module Index
• Search Page