venv --- 가상 환경 생성

버전 3.3에 추가.

소스 코드: Lib/venv/


venv 모듈은 자체 사이트 디렉터리를 갖는 경량 "가상 환경"을 만들고, 선택적으로 시스템 사이트 디렉터리에서 격리할 수 있도록 지원합니다. 각 가상 환경은 고유한 파이썬 바이너리(이 환경을 만드는 데 사용된 바이너리 버전과 일치함)를 가지며 자신의 사이트 디렉터리에 독립적으로 설치된 파이썬 패키지 집합을 가질 수 있습니다.

파이썬 가상 환경에 대한 자세한 내용은 PEP 405를 참조하십시오.

가상 환경 만들기

가상 환경venv 명령을 실행해서 만들어집니다:

python3 -m venv /path/to/new/virtual/environment

이 명령을 실행하면 대상 디렉터리가 만들어지고 (이미 존재하지 않는 부모 디렉터리도 만듭니다) 명령이 실행된 파이썬 설치를 가리키는 home 키가 있는 pyvenv.cfg 파일이 배치됩니다 (대상 디렉터리의 일반적인 이름은 .venv입니다). 또한 파이썬 바이너리/바이너리들의 사본/심볼릭 링크를 포함하는 bin (또는 윈도우의 경우 Scripts) 서브 디렉터리를 만듭니다 (플랫폼이나 환경 생성 시에 사용된 인자에 적절하게). 또한 (처음에는 비어있는) lib/pythonX.Y/site-packages (윈도우에서는, Lib\site-packages) 서브 디렉터리를 만듭니다. 기존 디렉터리가 지정되면 재사용됩니다.

버전 3.6부터 폐지: pyvenv는 파이썬 3.3 및 3.4 용 가상 환경을 만드는 데 권장되는 도구였으며, 파이썬 3.6 에서 폐지되었습니다.

버전 3.5에서 변경: 이제 가상 환경을 만들 때 venv를 사용하는 것이 좋습니다.

윈도우에서는, 다음과 같이 venv 명령을 호출하십시오:

c:\>c:\Python35\python -m venv c:\path\to\myenv

또는, 여러분의 파이썬 설치PATHPATHEXT 변수를 구성했으면:

c:\>python -m venv c:\path\to\myenv

명령에 -h를 사용하면 사용 가능한 옵션이 표시됩니다:

usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
            [--upgrade] [--without-pip] [--prompt PROMPT]
            ENV_DIR [ENV_DIR ...]

하나 이상의 대상 디렉터리에 가상 파이썬 환경을 만듭니다.

positional arguments:
  ENV_DIR               안에 환경을 만들 디렉터리.

optional arguments:
  -h, --help            이 도움말 메시지를 보여주고 종료합니다
  --system-site-packages
                        가상 환경이 시스템 site-packages 디렉터리를 액세스하도록 합니다.
  --symlinks            심볼릭 링크가 플랫폼의 기본값이 아닐 때, 복사본 대신 심볼릭 링크를
                        시도하도록 합니다.
  --copies              심볼릭 링크가 플랫폼의 기본값일 때조차, 심볼릭 링크 대신에 복사본을
                        사용하도록 합니다.
  --clear               환경을 만들기 전에, 환경 디렉터리에 내용이 이미 있으면 삭제합니다.
  --upgrade             파이썬이 그 자리에서 업그레이드되었다고 가정하고, 환경 디렉터리를 이
                        버전의 파이썬을 사용하도록 업그레이드합니다.
  --without-pip         가상 환경에 pip을 설치하거나 업그레이드하는 것을 건너뜁니다 (pip은
                        기본적으로 부트스트랩 됩니다)
  --prompt PROMPT       이 환경에 대한 대체 프롬프트 접두어를 제공합니다.

일단 환경이 만들어지면, 활성화할 수 있습니다. 예를 들어, bin 디렉터리의 activate 스크립트를
source 합니다.

버전 3.4에서 변경: 기본적으로 pip을 설치합니다. --without-pip--copies 옵션을 추가했습니다.

버전 3.4에서 변경: 이전 버전에서는, --clear--upgrade 옵션이 제공되지 않았을 때, 대상 디렉터리가 이미 존재하면 에러가 발생했습니다.

참고

심볼릭 링크가 윈도우에서 지원되지만, 추천하지는 않습니다. 특히 파일 탐색기에서 python.exe를 더블 클릭하면 심볼릭 링크를 열심히 따라가고(resolve) 가상 환경은 무시됩니다.

만들어진 pyvenv.cfg 파일에는 include-system-site-packages 키도 포함되어 있으며, venv--system-site-packages 옵션으로 실행되면 true로 설정되고, 그렇지 않으면 false로 설정됩니다.

--without-pip 옵션을 주지 않는 한, 가상 환경으로 pip을 부트스트랩 하기 위해 ensurepip가 호출됩니다.

venv에 여러 경로를 지정할 수 있습니다. 이때 지정된 옵션에 따라 제공된 각 경로에서 같은 가상 환경이 만들어집니다.

일단 가상 환경이 만들어지면, 가상 환경의 바이너리 디렉터리에 있는 스크립트를 사용하여 "활성화"할 수 있습니다. 스크립트의 호출은 플랫폼에 따라 다릅니다 (<venv>는 가상 환경을 포함하는 디렉터리의 경로로 대체되어야 합니다):

플랫폼

가상 환경을 활성화하는 명령

POSIX

bash/zsh

$ source <venv>/bin/activate

fish

$ . <venv>/bin/activate.fish

csh/tcsh

$ source <venv>/bin/activate.csh

PowerShell Core

$ <venv>/bin/Activate.ps1

윈도우

cmd.exe

C:\> <venv>\Scripts\activate.bat

PowerShell

PS C:\> <venv>\Scripts\Activate.ps1

환경을 구체적으로 활성화할 필요는 없습니다; 활성화는 단지 PATH의 처음에 가상 환경의 바이너리 디렉터리를 추가해서, "python"이 가상 환경의 파이썬 인터프리터를 호출하고 전체 경로를 사용하지 않고도 설치된 스크립트를 실행할 수 있도록 할 뿐입니다. 그러나, 가상 환경에 설치된 모든 스크립트는 활성화하지 않고도 실행 가능해야 하며, 자동으로 가상 환경의 파이썬을 사용하여 실행해야 합니다.

셸에서 "deactivate"를 입력하여 가상 환경을 비활성화할 수 있습니다. 정확한 메커니즘은 플랫폼에 따라 다르고 내부 구현 상세입니다 (보통 스크립트나 셸 함수가 사용됩니다).

버전 3.4에 추가: fishcsh 활성화 스크립트.

버전 3.8에 추가: PowerShell Core 지원을 위해 POSIX에 설치된 PowerShell 활성화 스크립트.

참고

가상 환경은 파이썬 인터프리터, 라이브러리 및 스크립트가 다른 가상 환경에 설치된 것과 (기본적으로) "시스템" 파이썬(즉, 여러분의 운영 체제 일부로 설치되어있는 것)에 설치된 모든 라이브러리와 격리되어있는 파이썬 환경입니다.

가상 환경은 파이썬 실행 파일과 가상 환경임을 나타내는 다른 파일을 포함하는 디렉터리 트리입니다.

setuptoolspip와 같은 일반적인 설치 도구는 가상 환경에서 예상대로 작동합니다. 즉, 가상 환경이 활성화되면, 명시적으로 그렇게 지정하지 않아도 파이썬 패키지를 가상 환경에 설치합니다.

가상 환경이 활성일 때 (즉, 가상 환경의 파이썬 인터프리터가 실행 중일 때), 어트리뷰트 sys.prefixsys.exec_prefix는 가상 환경의 베이스 디렉터리를 가리키지만, sys.base_prefixsys.base_exec_prefix는 가상 환경을 만들 때 사용한 가상이 아닌 환경의 파이썬을 가리킵니다. 가상 환경이 활성화되어 있지 않으면, sys.prefixsys.base_prefix와 같고, sys.exec_prefixsys.base_exec_prefix와 같습니다 (모두 가상 환경이 아닌 파이썬 설치를 가리킵니다).

가상 환경이 활성일 때, 설치 경로를 변경하는 모든 옵션이 모든 distutils 구성 파일에서 무시되어, 실수로 가상 환경 외부에 프로젝트가 설치되는 것을 방지합니다.

명령 셸에서 작업할 때, 사용자는 가상 환경의 실행 파일 디렉터리(정확한 파일 이름과 파일을 사용하는 명령은 셸 종속적입니다)에서 activate 스크립트를 실행하여 가상 환경을 활성화할 수 있습니다. 이 파일은 가상 환경의 실행 파일 디렉터리를 실행 중인 셸의 PATH 환경 변수 앞에 추가합니다. 다른 상황에서는 가상 환경을 활성화할 필요가 없습니다; 가상 환경에 설치된 스크립트에는 가상 환경의 파이썬 인터프리터를 가리키는 "셔뱅" 줄이 있습니다. 이는 스크립트가 PATH 값과 상관없이 해당 인터프리터로 실행됨을 뜻합니다. 윈도우에서는, Python Launcher for Windows를 설치하면 "셔뱅" 줄 처리가 지원됩니다 (이것은 파이썬 3.3에 추가되었습니다 - 자세한 내용은 PEP 397를 참조하십시오). 그래서, 윈도우 탐색기 창에서 설치된 스크립트를 더블 클릭하면 PATH에 가상 환경에 대한 참조가 없어도 올바른 인터프리터로 스크립트를 실행하게 됩니다.

API

위에서 설명한 고수준 메서드는 제삼자 가상 환경 작성자가 필요에 따라 환경을 사용자 정의할 수 있는 메커니즘을 제공하는 간단한 API를 사용합니다: EnvBuilder 클래스.

class venv.EnvBuilder(system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None)

EnvBuilder 클래스는 인스턴스를 만들 때 다음 키워드 인자를 받아들입니다:

  • system_site_packages -- 시스템 파이썬 site-packages가 환경에서 사용 가능해야 함을 나타내는 논릿값입니다 (기본값은 False).

  • clear -- 참이면, 환경을 만들기 전에, 대상 디렉터리에 존재하는 내용을 지우도록 하는 논릿값.

  • symlinks -- 파이썬 바이너리를 복사하는 대신 심볼릭 링크하려고 시도할지를 나타내는 논릿값입니다.

  • upgrade -- 참이면 실행 중인 파이썬으로 기존 환경을 업그레이드하도록 하는 논릿값 - 파이썬이 그 자리에서 업그레이드되었을 때 사용됩니다 (기본값은 False).

  • with_pip -- 참이면 가상 환경에 pip이 설치되도록 하는 논릿값입니다. --default-pip 옵션과 함께 ensurepip를 사용합니다.

  • prompt -- 가상 환경이 활성화된 후 사용할 문자열입니다 (기본값은 환경의 디렉터리 이름이 사용됨을 뜻하는 None입니다).

버전 3.4에서 변경: with_pip 매개 변수 추가

버전 3.6에 추가: prompt 매개 변수 추가

제삼자 가상 환경 도구 제작자는 제공된 EnvBuilder 클래스를 베이스 클래스로 자유롭게 사용할 수 있습니다.

반환된 객체에는 메서드 create가 있습니다:

create(env_dir)

가상 환경을 담을 대상 디렉터리(절대 또는 현재 디렉터리에 대한 상대)를 지정해서 가상 환경을 만듭니다. create 메서드는 지정된 디렉터리에 환경을 만들거나 적절한 예외를 발생시킵니다.

EnvBuilder 클래스의 create 메서드는 서브 클래스가 사용자 정의할 수 있는 훅을 보여줍니다:

def create(self, env_dir):
    """
    디렉터리에 가상화된 파이썬 환경을 만듭니다.
    env_dir은 안에 환경을 만들 대상 디렉터리입니다.
    """
    env_dir = os.path.abspath(env_dir)
    context = self.ensure_directories(env_dir)
    self.create_configuration(context)
    self.setup_python(context)
    self.setup_scripts(context)
    self.post_setup(context)

메서드 ensure_directories(), create_configuration(), setup_python(), setup_scripts()post_setup() 각각을 재정의할 수 있습니다.

ensure_directories(env_dir)

환경 디렉터리와 필요한 모든 디렉터리를 만들고 문맥 객체를 돌려줍니다. 이것은 다른 메서드에서 사용하기 위한 어트리뷰트(가령 경로)를 담고 있을 뿐입니다. 기존 환경 디렉터리에 작동하도록 clearupgrade가 지정되어있는 한, 디렉터리는 이미 존재할 수 있습니다.

create_configuration(context)

환경에 pyvenv.cfg 구성 파일을 만듭니다.

setup_python(context)

환경에 파이썬 실행 파일의 복사본이나 심볼릭 링크를 만듭니다. POSIX 시스템에서, 특정 실행 파일 python3.x가 사용되면, 해당 이름의 파일이 이미 존재하지 않는 한 pythonpython3 심볼릭 링크가 해당 실행 파일을 가리키도록 만들어집니다.

flowdas

pip 는 이 메서드가 호출된 직후에 설치됩니다.

setup_scripts(context)

플랫폼에 적합한 활성화 스크립트를 가상 환경에 설치합니다.

flowdas

upgrade 가 지정되면 호출되지 않습니다.

upgrade_dependencies(context)

환경에서 핵심 venv 종속성 패키지(현재 pipsetuptools)를 업그레이드합니다. 이것은 환경에서 pip 실행 파일로 셸을 실행해서 수행됩니다.

버전 3.8에 추가.

post_setup(context)

제삼자 구현에서 재정의하여 가상 환경에 패키지를 사전 설치하거나 다른 생성 후 단계를 수행할 수 있는 메서드입니다.

flowdas

upgrade 가 지정되면 호출되지 않습니다.

버전 3.7.2에서 변경: 윈도우는 이제 실제 바이너리를 복사하는 대신 python[w].exe를 위한 리디렉터 스크립트를 사용합니다. 3.7.2 에서만, 소스 트리의 빌드에서 실행하지 않는 한 setup_python()아무 작업도 수행하지 않습니다.

버전 3.7.3에서 변경: 윈도우는 setup_scripts() 대신 setup_python()의 일부로 리디렉터 스크립트를 복사합니다. 이것은 3.7.2는 해당하지 않습니다. 심볼릭 링크를 사용하면, 원래 실행 파일이 링크됩니다.

또한, EnvBuilder는 가상 환경에 사용자 정의 스크립트를 설치하는 데 도움이 되는 유틸리티 메서드를 제공하는데, 서브 클래스의 setup_scripts()post_setup()에서 호출할 수 있습니다.

install_scripts(context, path)

path는 "common", "posix", "nt" 서브 디렉터리를 포함해야 하는 디렉터리 경로입니다. 각 디렉터리에는 환경의 bin 디렉터리로 들어갈 스크립트가 들어 있습니다. "common"과 os.name에 해당하는 디렉터리의 내용은 자리 표시자의 일부 텍스트 치환 후 복사됩니다:

  • __VENV_DIR__은 환경 디렉터리의 절대 경로로 치환됩니다.

  • __VENV_NAME__은 환경 이름(환경 디렉터리의 최종 경로 세그먼트)으로 치환됩니다.

  • __VENV_PROMPT__는 프롬프트(괄호로 묶인 환경 이름과 그 뒤의 스페이스)로 치환됩니다

  • __VENV_BIN_NAME__은 bin 디렉터리의 이름(bin 이나 Scripts)으로 치환됩니다.

  • __VENV_PYTHON__은 환경의 실행 파일의 절대 경로로 치환됩니다.

디렉터리는 존재하는 것이 허용됩니다 (기존 환경이 업그레이드될 때).

모듈 수준의 편리 함수도 있습니다:

venv.create(env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None)

주어진 키워드 인자로 EnvBuilder를 만들고, env_dir 인자로 create() 메서드를 호출합니다.

버전 3.3에 추가.

버전 3.4에서 변경: with_pip 매개 변수 추가

버전 3.6에서 변경: prompt 매개 변수 추가

EnvBuilder 확장 예제

flowdas

파이썬 3.4 이후로는 setuptools와 pip가 기본 설치되기 때문에, 이 스크립트는 그 이전 버전에서만 쓸모있습니다. 단지 API 사용 예로만 활용하시기 바랍니다.

다음 스크립트는 생성된 가상 환경에 setuptools 와 pip을 설치하는 서브 클래스를 구현하여 EnvBuilder를 확장하는 방법을 보여줍니다:

import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlparse
from urllib.request import urlretrieve
import venv

class ExtendedEnvBuilder(venv.EnvBuilder):
    """
    이 빌더는 setuptools 와 pip을 설치하여 만들어진 가상 환경에 다른 패키지를 pip이나
    easy_install 할 수 있도록 합니다.

    :param nodist: True면, 만들어진 가상 환경에 setuptools와 pip를 설치하지 않습니다.
    :param nopip: True면, 만들어진 가상 환경에 pip를 설치하지 않습니다.
    :param progress: setuptools 나 pip 설치되면, progress 콜러블을 전달하여 설치 진행
                     상황을 감시할 수 있습니다. 지정하면, 두 개의 인자로 호출됩니다: 진행률을
                     나타내는 문자열과 문자열의 출처를 나타내는 context. context 인자는
                     세 가지 값 중 하나를 가질 수 있습니다: virtualize() 자체에서
                     호출되었음을 나타내는 'main'과, 앱 설치에 사용된 자식 프로세스의 출력
                     스트림에서 줄을 읽어서 얻었음을 나타내는 'stdout'과 'stderr'.

                     콜러블을 지정하지 않으면, sys.stderr에 기본 진행 정보가 출력됩니다.
    """

    def __init__(self, *args, **kwargs):
        self.nodist = kwargs.pop('nodist', False)
        self.nopip = kwargs.pop('nopip', False)
        self.progress = kwargs.pop('progress', None)
        self.verbose = kwargs.pop('verbose', False)
        super().__init__(*args, **kwargs)

    def post_setup(self, context):
        """
        만들어지는 가상 환경에 미리 설치될 필요가 있는 것들을 설정합니다.

        :param context: 처리 중인 가상 환경 생성 요청에 대한 정보.
        """
        os.environ['VIRTUAL_ENV'] = context.env_dir
        if not self.nodist:
            self.install_setuptools(context)
        # setuptools 없이 pip을 설치할 수 없습니다
        if not self.nopip and not self.nodist:
            self.install_pip(context)

    def reader(self, stream, context):
        """
        자식 프로세스의 출력 스트림에서 줄을 읽고 (지정되었으면) progress 콜러블로 전달하거나 진행
        정보를 sys.stderr에 씁니다.
        """
        progress = self.progress
        while True:
            s = stream.readline()
            if not s:
                break
            if progress is not None:
                progress(s, context)
            else:
                if not self.verbose:
                    sys.stderr.write('.')
                else:
                    sys.stderr.write(s.decode('utf-8'))
                sys.stderr.flush()
        stream.close()

    def install_script(self, context, name, url):
        _, _, path, _, _, _ = urlparse(url)
        fn = os.path.split(path)[-1]
        binpath = context.bin_path
        distpath = os.path.join(binpath, fn)
        # 가상 환경의 바이너리 폴더에 스크립트를 내려받습니다
        urlretrieve(url, distpath)
        progress = self.progress
        if self.verbose:
            term = '\n'
        else:
            term = ''
        if progress is not None:
            progress('Installing %s ...%s' % (name, term), 'main')
        else:
            sys.stderr.write('Installing %s ...%s' % (name, term))
            sys.stderr.flush()
        # 가상 환경에 설치합니다
        args = [context.env_exe, fn]
        p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
        t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))
        t1.start()
        t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))
        t2.start()
        p.wait()
        t1.join()
        t2.join()
        if progress is not None:
            progress('done.', 'main')
        else:
            sys.stderr.write('done.\n')
        # 정리 - 더는 필요 없습니다
        os.unlink(distpath)

    def install_setuptools(self, context):
        """
        가상 환경에 setuptools를 설치합니다.

        :param context: 처리 중인 가상 환경 생성 요청에 대한 정보.
        """
        url = 'https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py'
        self.install_script(context, 'setuptools', url)
        # 내려받은 setuptools 저장소를 지웁니다
        pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')
        files = filter(pred, os.listdir(context.bin_path))
        for f in files:
            f = os.path.join(context.bin_path, f)
            os.unlink(f)

    def install_pip(self, context):
        """
        가상 환경에 pip을 설치합니다.

        :param context: 처리 중인 가상 환경 생성 요청에 대한 정보.
        """
        url = 'https://raw.github.com/pypa/pip/master/contrib/get-pip.py'
        self.install_script(context, 'pip', url)

def main(args=None):
    compatible = True
    if sys.version_info < (3, 3):
        compatible = False
    elif not hasattr(sys, 'base_prefix'):
        compatible = False
    if not compatible:
        raise ValueError('This script is only for use with '
                         'Python 3.3 or later')
    else:
        import argparse

        parser = argparse.ArgumentParser(prog=__name__,
                                         description='Creates virtual Python '
                                                     'environments in one or '
                                                     'more target '
                                                     'directories.')
        parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',
                            help='A directory in which to create the
                                 'virtual environment.')
        parser.add_argument('--no-setuptools', default=False,
                            action='store_true', dest='nodist',
                            help="Don't install setuptools or pip in the "
                                 "virtual environment.")
        parser.add_argument('--no-pip', default=False,
                            action='store_true', dest='nopip',
                            help="Don't install pip in the virtual "
                                 "environment.")
        parser.add_argument('--system-site-packages', default=False,
                            action='store_true', dest='system_site',
                            help='Give the virtual environment access to the '
                                 'system site-packages dir.')
        if os.name == 'nt':
            use_symlinks = False
        else:
            use_symlinks = True
        parser.add_argument('--symlinks', default=use_symlinks,
                            action='store_true', dest='symlinks',
                            help='Try to use symlinks rather than copies, '
                                 'when symlinks are not the default for '
                                 'the platform.')
        parser.add_argument('--clear', default=False, action='store_true',
                            dest='clear', help='Delete the contents of the '
                                               'virtual environment '
                                               'directory if it already '
                                               'exists, before virtual '
                                               'environment creation.')
        parser.add_argument('--upgrade', default=False, action='store_true',
                            dest='upgrade', help='Upgrade the virtual '
                                                 'environment directory to '
                                                 'use this version of '
                                                 'Python, assuming Python '
                                                 'has been upgraded '
                                                 'in-place.')
        parser.add_argument('--verbose', default=False, action='store_true',
                            dest='verbose', help='Display the output '
                                               'from the scripts which '
                                               'install setuptools and pip.')
        options = parser.parse_args(args)
        if options.upgrade and options.clear:
            raise ValueError('you cannot supply --upgrade and --clear together.')
        builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
                                       clear=options.clear,
                                       symlinks=options.symlinks,
                                       upgrade=options.upgrade,
                                       nodist=options.nodist,
                                       nopip=options.nopip,
                                       verbose=options.verbose)
        for d in options.dirs:
            builder.create(d)

if __name__ == '__main__':
    rc = 1
    try:
        main()
        rc = 0
    except Exception as e:
        print('Error: %s' % e, file=sys.stderr)
    sys.exit(rc)

이 스크립트는 온라인에서 내려받을 수도 있습니다.