초기화, 파이널리제이션 및 스레드

파이썬 초기화 구성도 참조하십시오.

파이썬 초기화 전

파이썬을 내장한 응용 프로그램에서는, 다른 파이썬/C API 함수를 사용하기 전에 Py_Initialize() 함수를 호출해야 합니다; 몇 가지 함수와 전역 구성 변수는 예외입니다.

파이썬이 초기화되기 전에 다음 함수를 안전하게 호출할 수 있습니다:

• 구성 함수:

  • PyImport_AppendInittab()

  • PyImport_ExtendInittab()

  • PyInitFrozenExtensions()

  • PyMem_SetAllocator()

  • PyMem_SetupDebugHooks()

  • PyObject_SetArenaAllocator()

  • Py_SetPath()

  • Py_SetProgramName()

  • Py_SetPythonHome()

  • Py_SetStandardStreamEncoding()

  • PySys_AddWarnOption()

  • PySys_AddXOption()

  • PySys_ResetWarnOptions()

• 정보 함수:

  • Py_IsInitialized()

  • PyMem_GetAllocator()

  • PyObject_GetArenaAllocator()

  • Py_GetBuildInfo()

  • Py_GetCompiler()

  • Py_GetCopyright()

  • Py_GetPlatform()

  • Py_GetVersion()

• 유틸리티:

  • Py_DecodeLocale()

• 메모리 할당자:

  • PyMem_RawMalloc()

  • PyMem_RawRealloc()

  • PyMem_RawCalloc()

  • PyMem_RawFree()

참고

다음 함수는 Py_Initialize() 전에 호출하면 안 됩니다: Py_EncodeLocale(), Py_GetPath(), Py_GetPrefix(), Py_GetExecPrefix(), Py_GetProgramFullPath(), Py_GetPythonHome(), Py_GetProgramName() 및 PyEval_InitThreads().

전역 구성 변수

파이썬에는 다양한 기능과 옵션을 제어하기 위한 전역 구성 변수가 있습니다. 기본적으로, 이러한 플래그는 명령 줄 옵션에 의해 제어됩니다.

옵션에 의해 플래그가 설정되면, 플래그 값은 옵션이 설정된 횟수입니다. 예를 들어, -b는 Py_BytesWarningFlag 를 1로 설정하고 -bb는 Py_BytesWarningFlag 를 2로 설정합니다.

int Py_BytesWarningFlag

bytes나 bytearray와 str을, 또는 bytes를 int와 비교할 때 경고를 발행합니다. 2보다 크거나 같으면 에러를 발행합니다.

-b 옵션으로 설정합니다.

int Py_DebugFlag

구문 분석기 디버깅 출력을 켭니다 (전문가 전용, 컴파일 옵션에 의존합니다).

-d 옵션과 PYTHONDEBUG 환경 변수로 설정됩니다.

int Py_DontWriteBytecodeFlag

0이 아닌 값으로 설정하면, 파이썬은 소스 모듈을 임포트 할 때 .pyc 파일을 쓰려고 하지 않습니다.

-B 옵션과 PYTHONDONTWRITEBYTECODE 환경 변수로 설정됩니다.

int Py_FrozenFlag

Py_GetPath()에서 모듈 검색 경로를 계산할 때 에러 메시지를 표시하지 않습니다.

_freeze_importlib와 frozenmain 프로그램에서 사용하는 개인 플래그입니다.

int Py_HashRandomizationFlag

PYTHONHASHSEED 환경 변수가 비어 있지 않은 문자열로 설정되면 1로 설정합니다.

플래그가 0이 아니면, PYTHONHASHSEED 환경 변수를 읽어 비밀 해시 시드를 초기화합니다.

int Py_IgnoreEnvironmentFlag

설정될 수 있는 모든 PYTHON* 환경 변수 (예를 들어 PYTHONPATH와 PYTHONHOME)를 무시합니다.

-E와 -I 옵션으로 설정됩니다.

int Py_InspectFlag

스크립트가 첫 번째 인자로 전달되거나 -c 옵션을 사용할 때, sys.stdin가 터미널로 보이지 않더라도 스크립트나 명령을 실행한 후 대화 형 모드로 들어갑니다.

-i 옵션과 PYTHONINSPECT 환경 변수로 설정됩니다.

int Py_InteractiveFlag

-i 옵션으로 설정됩니다.

int Py_IsolatedFlag

격리 모드로 파이썬을 실행합니다. 격리 모드에서 sys.path는 스크립트의 디렉터리도 사용자의 site-packages 디렉터리도 포함하지 않습니다.

-I 옵션으로 설정됩니다.

버전 3.4에 추가.

int Py_LegacyWindowsFSEncodingFlag

플래그가 0이 아니면, 파일 시스템 인코딩에 UTF-8 인코딩 대신 mbcs 인코딩을 사용합니다.

PYTHONLEGACYWINDOWSFSENCODING 환경 변수가 비어 있지 않은 문자열로 설정되면 1로 설정합니다.

자세한 내용은 PEP 529를 참조하십시오.

가용성: 윈도우.

int Py_LegacyWindowsStdioFlag

플래그가 0이 아니면, sys 표준 스트림을 위해 WindowsConsoleIO 대신 io.FileIO를 사용합니다.

PYTHONLEGACYWINDOWSSTDIO 환경 변수가 비어 있지 않은 문자열로 설정되면 1로 설정합니다.

자세한 내용은 PEP 528을 참조하십시오.

가용성: 윈도우.

int Py_NoSiteFlag

모듈 site 임포트와 이에 수반되는 sys.path의 사이트 종속적인 조작을 비활성화합니다. 또한 나중에 site를 명시적으로 임포트 할 때도 이러한 조작을 비활성화합니다 (트리거 하려면 site.main()을 호출하십시오).

-S 옵션으로 설정됩니다.

int Py_NoUserSiteDirectory

사용자 site-packages 디렉터리를 sys.path에 추가하지 않습니다.

-s와 -I 옵션, 그리고 PYTHONNOUSERSITE 환경 변수로 설정됩니다.

int Py_OptimizeFlag

-O 옵션과 PYTHONOPTIMIZE 환경 변수로 설정됩니다.

int Py_QuietFlag

대화형 모드에서도 저작권과 버전 메시지를 표시하지 않습니다.

-q 옵션으로 설정됩니다.

버전 3.2에 추가.

int Py_UnbufferedStdioFlag

stdout과 stderr 스트림을 버퍼링 해제하도록 강제합니다.

-u 옵션과 PYTHONUNBUFFERED 환경 변수로 설정됩니다.

int Py_VerboseFlag

모듈이 초기화될 때마다, 로드된 위치(파일명이나 내장 모듈)를 표시하는 메시지를 인쇄합니다. 2보다 크거나 같으면, 모듈을 검색할 때 검사되는 각 파일에 대한 메시지를 인쇄합니다. 또한 종료 시 모듈 정리에 대한 정보를 제공합니다.

-v 옵션과 PYTHONVERBOSE 환경 변수로 설정됩니다.

인터프리터 초기화와 파이널리제이션

void Py_Initialize()

파이썬 인터프리터를 초기화합니다. 파이썬을 내장하는 응용 프로그램에서는, 다른 파이썬/C API 함수를 사용하기 전에 호출해야 합니다; 몇 가지 예외는 파이썬 초기화 전을 참조하십시오.

이것은 로드된 모듈의 테이블(sys.modules)을 초기화하고, 기반 모듈 builtins, __main__ 및 sys를 만듭니다. 또한, 모듈 검색 경로(sys.path)를 초기화합니다. sys.argv는 설정하지 않습니다; 이를 위해서는 PySys_SetArgvEx() 를 사용하십시오. (Py_FinalizeEx() 를 먼저 호출하지 않고) 두 번째로 호출하면 아무런 일도 하지 않습니다. 반환 값이 없습니다; 초기화에 실패하면 치명적인 에러입니다.

참고

윈도우에서, 콘솔 모드를 O_TEXT에서 O_BINARY로 변경합니다, C 런타임을 사용하는 콘솔의 비 파이썬 사용에도 영향을 미칩니다.

void Py_InitializeEx(int initsigs)

이 함수는 initsigs가 1이면 Py_Initialize()처럼 작동합니다. initsigs가 0이면, 시그널 처리기의 초기화 등록을 건너뛰는데, 파이썬이 내장될 때 유용할 수 있습니다.

int Py_IsInitialized()

파이썬 인터프리터가 초기화되었으면 참(0이 아님)을 반환하고, 그렇지 않으면 거짓(0)을 반환합니다. Py_FinalizeEx() 가 호출된 후, Py_Initialize()가 다시 호출될 때까지 거짓을 반환합니다.

int Py_FinalizeEx()

Py_Initialize()와 후속 파이썬/C API 함수 사용에 의해 수행된 모든 초기화를 실행 취소하고, Py_Initialize()에 대한 마지막 호출 이후 만들어졌지만, 아직 삭제되지 않은 모든 서브 인터프리터(아래 Py_NewInterpreter()를 참조하십시오)를 제거합니다. 이상적으로, 이것은 파이썬 인터프리터가 할당한 모든 메모리를 해제합니다. (먼저 Py_Initialize()를 다시 호출하지 않고) 두 번째로 호출하면 아무런 일도 하지 않습니다. 일반적으로 반환 값은 0입니다. 파이널리제이션 도중 에러가 발생하면 (버퍼링 된 데이터 플러시) -1이 반환됩니다.

이 함수는 여러 가지 이유로 제공됩니다. 내장 응용 프로그램이 응용 프로그램 자체를 다시 시작하지 않고 파이썬을 다시 시작하고 싶을 수 있습니다. 동적으로 로드할 수 있는 라이브러리(또는 DLL)에서 파이썬 인터프리터를 로드한 응용 프로그램은 DLL을 언로드 하기 전에 파이썬이 할당한 모든 메모리를 해제하고 싶을 수 있습니다. 응용 프로그램에서 메모리 누수를 찾는 동안 개발자는 응용 프로그램을 종료하기 전에 파이썬에서 할당한 모든 메모리를 해제하고 싶을 것입니다.

버그와 주의 사항: 모듈의 모듈과 객체 파괴는 임의의 순서로 수행됩니다; 이로 인해 파괴자(__del__() 메서드)가 다른 객체(함수조차)나 모듈에 의존할 때 실패할 수 있습니다. 파이썬에서 로드한 동적으로 로드된 확장 모듈은 언로드 되지 않습니다. 파이썬 인터프리터가 할당한 소량의 메모리는 해제되지 않을 수 있습니다 (누수를 발견하면, 보고해 주십시오). 객체 간의 순환 참조에 묶여있는 메모리는 해제되지 않습니다. 확장 모듈이 할당한 일부 메모리는 해제되지 않을 수 있습니다. 일부 확장은 초기화 루틴이 두 번 이상 호출되면 제대로 작동하지 않을 수 있습니다; 응용 프로그램이 Py_Initialize()와 Py_FinalizeEx()를 두 번 이상 호출하면 이 문제가 발생할 수 있습니다.

인자 없이 감사 이벤트 cpython._PySys_ClearAuditHooks 를 발생시킵니다.

버전 3.6에 추가.

void Py_Finalize()

이것은 Py_FinalizeEx()의 이전 버전과 호환되는 반환 값을 무시하는 버전입니다.

프로세스 전체 매개 변수

int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)

이 함수는 (호출한다면) Py_Initialize() 전에 호출해야 합니다. str.encode()에서와 같은 의미로, 표준 IO에 사용할 인코딩과 에러 처리를 지정합니다.

PYTHONIOENCODING 값을 재정의(overrides)하고, 환경 변수가 작동하지 않을 때 내장(embedding) 코드가 IO 인코딩을 제어할 수 있도록 합니다.

encoding 및/또는 errors는 PYTHONIOENCODING 및/또는 기본값(다른 설정에 따라 다릅니다)을 사용하기 위해 NULL일 수 있습니다.

sys.stderr은 이 (또는 다른) 설정과 관계없이 항상 “backslashreplace” 에러 처리기를 사용함에 유의하십시오.

Py_FinalizeEx()가 호출되면, 이 함수는 Py_Initialize()에 대한 후속 호출에 영향을 미치기 위해 다시 호출되어야 합니다.

성공하면 0을 반환하고, 에러 시 (예를 들어 인터프리터가 이미 초기화된 후 호출) 0이 아닌 값을 반환합니다.

버전 3.4에 추가.

void Py_SetProgramName(const wchar_t *name)

(호출된다면) 이 함수는 Py_Initialize()가 처음으로 호출되기 전에 호출되어야 합니다. 인터프리터에게 프로그램의 main() 함수에 대한 argv[0] 인자의 값을 알려줍니다 (와이드 문자로 변환됩니다). 이것은 Py_GetPath()와 아래의 다른 함수에서 인터프리터 실행 파일과 관련된 파이썬 런타임 라이브러리를 찾는 데 사용됩니다. 기본값은 'python'입니다. 인자는 프로그램을 실행하는 동안 내용이 변경되지 않는 정적 저장소의 0으로 끝나는 와이드 문자열을 가리켜야 합니다. 파이썬 인터프리터의 코드는 이 저장소의 내용을 변경하지 않습니다.

바이트 문자열을 디코딩하여 wchar_* 문자열을 얻는데 Py_DecodeLocale()을 사용합니다.

wchar* Py_GetProgramName()

Py_SetProgramName() 으로 설정된 프로그램 이름이나 기본값을 반환합니다. 반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다.

wchar_t* Py_GetPrefix()

설치된 플랫폼 독립적 파일에 대한 prefix를 반환합니다. 이것은 Py_SetProgramName() 으로 설정된 프로그램 이름과 일부 환경 변수의 여러 복잡한 규칙을 통해 파생됩니다; 예를 들어, 프로그램 이름이 '/usr/local/bin/python'이면, prefix는 '/usr/local'입니다. 반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다. 이는 최상위 수준 Makefile의 prefix 변수와 빌드 시 configure 스크립트의 --prefix 인자에 해당합니다. 이 값은 파이썬 코드에서 sys.prefix로 사용할 수 있습니다. 유닉스에서만 유용합니다. 다음 함수도 참조하십시오.

wchar_t* Py_GetExecPrefix()

설치된 플랫폼-종속적 파일에 대한 exec-prefix를 반환합니다. 이것은 Py_SetProgramName() 으로 설정된 프로그램 이름과 일부 환경 변수의 여러 복잡한 규칙을 통해 파생됩니다; 예를 들어 프로그램 이름이 '/usr/local/bin/python'이면, exec-prefix는 '/usr/local'입니다. 반환된 문자열은 정적 저장소를 가리 킵니다; 호출자는 값을 수정해서는 안 됩니다. 이는 최상위 수준 Makefile의 exec_prefix 변수와 빌드 시 configure 스크립트의 --exec-prefix 인자에 해당합니다. 이 값은 파이썬 코드에서 sys.exec_prefix로 사용할 수 있습니다. 유닉스에서만 유용합니다.

배경: exec-prefix는 플랫폼 종속적 파일(가령 실행 파일과 공유 라이브러리)이 다른 디렉터리 트리에 설치될 때 prefix와 다릅니다. 일반 설치에서, 플랫폼 종속적 파일은 /usr/local/plat 서브 트리에 설치되고 플랫폼 독립적 파일은 /usr/local에 설치될 수 있습니다.

일반적으로 말해서, 플랫폼은 하드웨어와 소프트웨어 제품군의 조합입니다, 예를 들어 Solaris 2.x 운영 체제를 실행하는 Sparc 기계들은 같은 플랫폼으로 간주하지만, Solaris 2.x를 실행하는 Intel 기계는 다른 플랫폼이며, 리눅스를 실행하는 Intel 기계는 또 다른 플랫폼입니다. 같은 운영 체제의 서로 다른 주 개정판도 일반적으로 다른 플랫폼을 형성합니다. 비 유닉스 운영 체제는 다른 이야기입니다; 이러한 시스템의 설치 전략이 너무 다르기 때문에 prefix와 exec-prefix는 의미가 없으며, 빈 문자열로 설정됩니다. 컴파일된 파이썬 바이트 코드 파일은 플랫폼 독립적임에 유의하십시오 (그러나 이들을 컴파일하는데 사용된 파이썬 버전에는 종속적입니다!).

시스템 관리자는 /usr/local/plat을 각 플랫폼에 대해 다른 파일 시스템으로 사용하면서 플랫폼 간에 /usr/local을 공유하도록 mount나 automount 프로그램을 구성하는 방법을 알 것입니다.

wchar_t* Py_GetProgramFullPath()

파이썬 실행 파일의 전체 프로그램 이름을 반환합니다; 이것은 프로그램 이름(위의 Py_SetProgramName() 으로 설정됩니다)에서 기본 모듈 검색 경로를 파생하는 부작용으로 계산됩니다. 반환된 문자열은 정적 저장소를 가리 킵니다; 호출자는 값을 수정해서는 안 됩니다. 이 값은 파이썬 코드에서 sys.executable로 사용할 수 있습니다.

wchar_t* Py_GetPath()

기본 모듈 검색 경로를 반환합니다; 이것은 프로그램 이름(위의 Py_SetProgramName() 으로 설정됩니다)과 일부 환경 변수에서 계산됩니다. 반환된 문자열은 플랫폼 종속적 구분자로 분할된 일련의 디렉터리 이름으로 구성됩니다. 구분자는 유닉스와 Mac OS X에서는 ':', 윈도우에서는 ';'입니다. 반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다. 리스트 sys.path는 인터프리터 시작 시 이 값으로 초기화됩니다; 모듈을 로드하기 위한 검색 경로를 변경하기 위해 나중에 수정할 수 있습니다 (그리고 보통 그렇게 합니다).

void Py_SetPath(const wchar_t *)

기본 모듈 검색 경로를 설정합니다. 이 함수가 Py_Initialize() 이전에 호출되면, Py_GetPath()는 기본 검색 경로를 계산하지 않고 대신 제공된 경로를 사용합니다. 이는 모든 모듈의 위치를 완전히 알고 있는 응용 프로그램에 파이썬이 내장된 경우 유용합니다. 경로 구성 요소는 플랫폼 종속적 구분자 문자(유닉스에서는 ':', 윈도우에서는 ';')로 구분해야 합니다.

또한 sys.executable이 프로그램 전체 경로 (Py_GetProgramFullPath() 를 참조하십시오)로 설정되고 sys.prefix와 sys.exec_prefix가 비어있도록 합니다. Py_Initialize()를 호출한 후 필요할 때 이를 수정하는 것은 호출자에게 달려 있습니다.

바이트 문자열을 디코딩하여 wchar_* 문자열을 얻는데 Py_DecodeLocale()을 사용합니다.

경로 인자는 내부적으로 복사되므로, 호출이 완료된 후 호출자가 할당 해제할 수 있습니다.

버전 3.8에서 변경: 이제 프로그램 이름 대신 프로그램 전체 경로가 sys.executable에 사용됩니다.

const char* Py_GetVersion()

이 파이썬 인터프리터의 버전을 반환합니다. 이것은 다음과 같은 문자열입니다

"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"

첫 번째 단어(첫 번째 스페이스 문자까지)는 현재 파이썬 버전입니다; 처음 세 문자는 마침표로 구분된 주 버전과 부 버전입니다. 반환된 문자열은 정적 저장소를 가리 킵니다; 호출자는 값을 수정해서는 안 됩니다. 이 값은 파이썬 코드에서 sys.version으로 사용할 수 있습니다.

const char* Py_GetPlatform()

현재 플랫폼의 플랫폼 식별자를 반환합니다. 유닉스에서, 이것은 운영 체제의 “공식적인” 이름으로 구성되며, 소문자로 변환되고, 그 뒤에 주 개정 번호가 붙습니다; 예를 들어, SunOS 5.x라고도 하는 Solaris 2.x의 경우, 값은 'sunos5'입니다. Mac OS X에서는, 'darwin'입니다. 윈도우에서는, 'win'입니다. 반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다. 이 값은 파이썬 코드에서 sys.platform으로 사용할 수 있습니다.

const char* Py_GetCopyright()

현재 파이썬 버전에 대한 공식 저작권 문자열을 반환합니다, 예를 들어

'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'

반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다. 이 값은 파이썬 코드에서 sys.copyright로 사용할 수 있습니다.

const char* Py_GetCompiler()

현재 파이썬 버전을 빌드하는 데 사용된 컴파일러 표시를 대괄호 감싸서 반환합니다, 예를 들면:

"[GCC 2.7.2.2]"

반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다. 이 값은 파이썬 코드에서 변수 sys.version의 일부로 제공됩니다.

const char* Py_GetBuildInfo()

현재 파이썬 인터프리터 인스턴스의 시퀀스 번호와 빌드 날짜 및 시간에 대한 정보를 반환합니다, 예를 들어

"#67, Aug  1 1997, 22:34:28"

반환된 문자열은 정적 저장소를 가리킵니다; 호출자는 값을 수정해서는 안 됩니다. 이 값은 파이썬 코드에서 변수 sys.version의 일부로 제공됩니다.

void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)

argc 및 argv에 기반해서 sys.argv를 설정합니다. 이 매개 변수는 프로그램의 main() 함수에 전달된 것과 유사하지만, 첫 번째 항목이 파이썬 인터프리터를 호스팅하는 실행 파일이 아니라 실행될 스크립트 파일을 참조해야 한다는 차이점이 있습니다. 실행할 스크립트가 없으면, argv의 첫 번째 항목은 빈 문자열일 수 있습니다. 이 함수가 sys.argv 초기화에 실패하면, Py_FatalError()를 사용하여 치명적인 조건을 표시합니다.

updatepath가 0이면, 여기까지가 이 함수가 하는 모든 일입니다. updatepath가 0이 아니면, 함수는 다음 알고리즘에 따라 sys.path도 수정합니다:

• 기존 스크립트의 이름이 argv[0]으로 전달되면, 스크립트가 있는 디렉터리의 절대 경로가 sys.path 앞에 추가됩니다.

• 그렇지 않으면 (즉, argc가 0이거나 argv[0]이 기존 파일 이름을 가리키지 않으면), sys.path 앞에 빈 문자열이 추가됩니다, 이는 현재 작업 디렉터리(".")를 앞에 추가하는 것과 같습니다.

바이트 문자열을 디코딩하여 wchar_* 문자열을 얻는데 Py_DecodeLocale()을 사용합니다.

참고

단일 스크립트 실행 이외의 목적으로 파이썬 인터프리터를 내장하는 응용 프로그램은 0을 updatepath로 전달하고, 원하는 대로 sys.path를 스스로 갱신하는 것이 좋습니다. CVE-2008-5983을 참조하십시오.

3.1.3 이전 버전에서는, PySys_SetArgv()를 호출한 후 첫 번째 sys.path 요소를 수동으로 제거하여 같은 효과를 얻을 수 있습니다, 예를 들어 다음을 사용하여:

PyRun_SimpleString("import sys; sys.path.pop(0)\n");

버전 3.1.3에 추가.

void PySys_SetArgv(int argc, wchar_t **argv)

이 함수는 python 인터프리터가 -I로 시작되지 않는 한 updatepath가 1로 설정된 PySys_SetArgvEx()처럼 작동합니다.

바이트 문자열을 디코딩하여 wchar_* 문자열을 얻는데 Py_DecodeLocale()을 사용합니다.

버전 3.4에서 변경: updatepath 값은 -I에 따라 다릅니다.

void Py_SetPythonHome(const wchar_t *home)

기본 “홈” 디렉터리, 즉 표준 파이썬 라이브러리의 위치를 설정합니다. 인자 문자열의 의미는 PYTHONHOME 을 참조하십시오.

인자는 프로그램을 실행하는 동안 내용이 변경되지 않는 정적 저장소에 있는 0으로 끝나는 문자열을 가리켜야 합니다. 파이썬 인터프리터의 코드는 이 저장소의 내용을 변경하지 않습니다.

바이트 문자열을 디코딩하여 wchar_* 문자열을 얻는데 Py_DecodeLocale()을 사용합니다.

w_char* Py_GetPythonHome()

기본 “홈”, 즉 Py_SetPythonHome() 에 대한 이전 호출에서 설정한 값이나 설정되었다면 PYTHONHOME 환경 변수의 값을 반환합니다.

스레드 상태와 전역 인터프리터 록

파이썬 인터프리터는 완전히 스레드 안전하지 않습니다. 다중 스레드 파이썬 프로그램을 지원하기 위해, 파이썬 객체에 안전하게 액세스하기 전에 현재 스레드가 보유해야 하는 전역 인터프리터 록 혹은 GIL이라고 하는 전역 록이 있습니다. 록 없이는, 가장 간단한 연산조차도 다중 스레드 프로그램에서 문제를 일으킬 수 있습니다: 예를 들어, 두 스레드가 동시에 같은 객체의 참조 횟수를 증가시키면, 참조 횟수가 두 번이 아닌 한 번만 증가할 수 있습니다.

따라서, GIL을 획득한 스레드만 파이썬 객체에서 작동하거나 파이썬/C API 함수를 호출할 수 있다는 규칙이 있습니다. 동시 실행을 모방하기 위해 인터프리터는 정기적으로 스레드 전환을 시도합니다 (sys.setswitchinterval()을 참조하십시오). 록은 파일 읽기나 쓰기와 같은 잠재적인 블로킹 I/O 연산에 대해서도 해제되므로, 그동안 다른 파이썬 스레드가 실행될 수 있습니다.

파이썬 인터프리터는 PyThreadState 라는 데이터 구조체 내에 스레드 별 부기(bookkeeping) 정보를 보관합니다. 현재 PyThreadState 를 가리키는 하나의 전역 변수도 있습니다: PyThreadState_Get()을 사용하여 얻을 수 있습니다.

확장 코드에서 GIL 해제하기

GIL을 조작하는 대부분의 확장 코드는 다음과 같은 간단한 구조로 되어 있습니다:

Save the thread state in a local variable.
Release the global interpreter lock.
... Do some blocking I/O operation ...
Reacquire the global interpreter lock.
Restore the thread state from the local variable.

이것은 매우 일반적이어서 이를 단순화하기 위해 한 쌍의 매크로가 존재합니다:

Py_BEGIN_ALLOW_THREADS
... Do some blocking I/O operation ...
Py_END_ALLOW_THREADS

Py_BEGIN_ALLOW_THREADS 매크로는 새 블록을 열고 숨겨진 지역 변수를 선언합니다; Py_END_ALLOW_THREADS 매크로는 블록을 닫습니다.

위의 블록은 다음 코드로 확장됩니다:

PyThreadState *_save;

_save = PyEval_SaveThread();
... Do some blocking I/O operation ...
PyEval_RestoreThread(_save);

이 함수들의 작동 방식은 다음과 같습니다: 전역 인터프리터 록이 현재 스레드 상태에 대한 포인터를 보호하는 데 사용됩니다. 록을 해제하고 스레드 상태를 저장할 때, 록이 해제되기 전에 현재 스레드 상태 포인터를 가져와야 합니다 (다른 스레드가 즉시 록을 획득하고 전역 변수에 자신의 스레드 상태를 저장할 수 있기 때문입니다). 반대로, 록을 획득하고 스레드 상태를 복원할 때, 스레드 상태 포인터를 저장하기 전에 록을 획득해야 합니다.

참고

시스템 I/O 함수 호출은 GIL을 릴리스하는 가장 일반적인 사용 사례이지만, 메모리 버퍼를 통해 작동하는 압축이나 암호화 함수와 같이, 파이썬 객체에 액세스할 필요가 없는 장기 실행 계산을 호출하기 전에도 유용할 수 있습니다. 예를 들어, 표준 zlib와 hashlib 모듈은 데이터를 압축하거나 해싱할 때 GIL을 해제합니다.

파이썬이 만들지 않은 스레드

전용 파이썬 API(가령 threading 모듈)를 사용하여 스레드를 만들면, 스레드 상태가 자동으로 연결되므로 위에 표시된 코드가 올바릅니다. 그러나, 스레드가 C에서 만들어질 때 (예를 들어 자체 스레드 관리 기능이 있는 제삼자 라이브러리에 의해), GIL을 보유하지 않고, 그들을 위한 스레드 상태 구조도 없습니다.

이러한 스레드에서 파이썬 코드를 호출해야 하면 (종종 앞서 언급한 제삼자 라이브러리에서 제공하는 콜백 API의 일부가 됩니다), 먼저 스레드 상태 자료 구조를 만들어서 인터프리터에 이러한 스레드를 등록한 다음, GIL을 획득하고, 마지막으로 파이썬/C API 사용을 시작하기 전에 스레드 상태 포인터를 저장합니다. 완료되면, 스레드 상태 포인터를 재설정하고, GIL을 해제한 다음, 마지막으로 스레드 상태 자료 구조를 해제해야 합니다.

PyGILState_Ensure()와 PyGILState_Release() 함수는 위의 모든 작업을 자동으로 수행합니다. C 스레드에서 파이썬을 호출하는 일반적인 관용구는 다음과 같습니다:

PyGILState_STATE gstate;
gstate = PyGILState_Ensure();

/* Perform Python actions here. */
result = CallSomeFunction();
/* evaluate result or handle exception */

/* Release the thread. No Python API allowed beyond this point. */
PyGILState_Release(gstate);

PyGILState_*() 함수는 (Py_Initialize()에 의해 자동으로 만들어진) 전역 인터프리터 하나만 있다고 가정함에 유의하십시오. 파이썬은 추가 인터프리터를 만드는 것을 지원하지만 (Py_NewInterpreter()를 사용해서), 다중 인터프리터와 PyGILState_*() API를 혼합하는 것은 지원되지 않습니다.

fork()에 대한 주의 사항

스레드에 대해 주목해야 할 또 다른 중요한 점은 C fork() 호출 시 스레드의 동작입니다. fork()를 사용하는 대부분의 시스템에서는, 프로세스가 포크한 후에 포크를 발행한 스레드만 존재합니다. 이는 록을 처리해야 하는 방법과 CPython 런타임에 저장된 모든 상태 모두에 구체적인 영향을 미칩니다.

“현재” 스레드만 남아 있다는 사실은 다른 스레드가 보유한 록이 해제되지 않음을 의미합니다. 파이썬은 포크 전에 내부적으로 사용하는 록을 획득하고 나중에 해제하여 os.fork()에 대해 이 문제를 해결합니다. 또한, 자식의 모든 Lock 객체를 재설정합니다. 파이썬을 확장하거나 내장할 때, 포크 이전에 획득하거나 이후에 재설정해야 하는 추가(비 파이썬) 록을 파이썬에 알릴 방법이 없습니다. pthread_atfork()와 같은 OS 기능을 사용하여 같은 작업을 수행해야 합니다. 또한, 파이썬을 확장하거나 내장할 때, os.fork()를 통하지 않고 직접 fork()를 호출하면 (그리고 파이썬으로 반환하거나 파이썬을 호출하면), 포크 이후에 사라지는 스레드가 보유하는 파이썬의 내부 록 중 하나에 의해 교착 상태가 발생할 수 있습니다. PyOS_AfterFork_Child()는 필요한 록을 재설정하려고 하지만, 항상 할 수 있는 것은 아닙니다.

다른 모든 스레드가 사라진다는 사실은 또한 CPython의 런타임 상태가 os.fork()와 마찬가지로 적절하게 정리되어야 함을 의미합니다. 이것은 현재 인터프리터와 다른 모든 PyInterpreterState 객체에 속하는 다른 모든 PyThreadState 객체를 파이널리제이션 하는 것을 의미합니다. 이것과 “메인” 인터프리터의 특수한 특성으로 인해, fork()는 CPython 전역 런타임이 원래 초기화된 인터프리터의 “메인” 스레드에서만 호출되어야 합니다. 유일한 예외는 exec()가 그 후에 즉시 호출되는 경우입니다.

고수준 API

다음은 C 확장 코드를 작성하거나 파이썬 인터프리터를 내장할 때 가장 일반적으로 사용되는 형과 함수입니다:

PyInterpreterState

이 자료 구조는 여러 협력 스레드가 공유하는 상태를 나타냅니다. 같은 인터프리터에 속하는 스레드는 모듈 관리와 몇 가지 다른 내부 항목을 공유합니다. 이 구조체에는 공개 멤버가 없습니다.

다른 인터프리터에 속한 스레드는 사용 가능한 메모리, 열린 파일 기술자 등과 같은 프로세스 상태를 제외하고는, 처음에는 아무것도 공유하지 않습니다. 전역 인터프리터 록은 어떤 인터프리터에 속해 있는지에 관계없이 모든 스레드에서 공유됩니다.

PyThreadState

이 자료 구조는 단일 스레드의 상태를 나타냅니다. 유일한 공용 데이터 멤버는 이 스레드의 인터프리터 상태를 가리키는 interp(PyInterpreterState *)입니다.

void PyEval_InitThreads()

Initialize and acquire the global interpreter lock. It should be called in the main thread before creating a second thread or engaging in any other thread operations such as PyEval_ReleaseThread(tstate). It is not needed before calling PyEval_SaveThread() or PyEval_RestoreThread().

This is a no-op when called for a second time.

버전 3.7에서 변경: 이 함수는 이제 Py_Initialize()에 의해 호출되어서, 여러분은 더는 직접 호출할 필요가 없습니다.

버전 3.2에서 변경: 이 함수는 더는 Py_Initialize() 전에 호출할 수 없습니다.

int PyEval_ThreadsInitialized()

PyEval_InitThreads()가 호출되었으면, 0이 아닌 값을 반환합니다. 이 함수는 GIL을 보유하지 않고 호출할 수 있어서, 단일 스레드를 실행할 때 록 API 호출을 회피하는 데 사용할 수 있습니다.

버전 3.7에서 변경: GIL은 이제 Py_Initialize()에 의해 초기화됩니다.

PyThreadState* PyEval_SaveThread()

(만들었다면) 전역 인터프리터 록을 해제하고 스레드 상태를 NULL로 재설정하고, 이전 스레드 상태(NULL이 아닙니다)를 반환합니다. 록이 만들어졌다면, 현재 스레드가 록을 획득했어야 합니다.

void PyEval_RestoreThread(PyThreadState *tstate)

(만들었다면) 전역 인터프리터 록을 획득하고 스레드 상태를 NULL이 아니어야 하는 tstate로 설정합니다. 록이 만들어졌다면, 현재 스레드가 이를 획득하지 않았어야 합니다, 그렇지 않으면 교착 상태가 발생합니다.

참고

런타임이 파이널리제이션 될 때 스레드에서 이 함수를 호출하면, 스레드가 파이썬에 의해 만들어지지 않았더라도 스레드가 종료됩니다. 원치 않는 종료를 방지하려면 _Py_IsFinalizing()이나 sys.is_finalizing()을 사용하여 이 함수를 호출하기 전에 인터프리터가 파이널리제이션 되고 있는지 확인할 수 있습니다.

PyThreadState* PyThreadState_Get()

현재 스레드 상태를 반환합니다. 전역 인터프리터 록을 보유해야 합니다. 현재 스레드 상태가 NULL이면 치명적인 에러가 발생합니다 (그래서 호출자가 NULL을 확인할 필요가 없습니다).

PyThreadState* PyThreadState_Swap(PyThreadState *tstate)

현재 스레드 상태를 인자 tstate(NULL일 수 있습니다)가 제공하는 스레드 상태와 스와프합니다. 전역 인터프리터 록을 보유해야 하며 해제되지 않습니다.

다음 함수는 스레드 로컬 저장소를 사용하며, 서브 인터프리터와 호환되지 않습니다:

PyGILState_STATE PyGILState_Ensure()

현재 스레드가 파이썬의 현재 상태나 전역 인터프리터 록과 관계없이 파이썬 C API를 호출할 준비가 되었는지 확인합니다. 이것은 각 호출이 PyGILState_Release()에 대한 호출과 쌍을 이루는 한 스레드에서 원하는 만큼 여러 번 호출될 수 있습니다. 일반적으로, 스레드 상태가 Release() 전에 이전 상태로 복원되는 한 PyGILState_Ensure()와 PyGILState_Release() 호출 간에 다른 스레드 관련 API를 사용할 수 있습니다. 예를 들어, Py_BEGIN_ALLOW_THREADS와 Py_END_ALLOW_THREADS 매크로의 정상적인 사용은 허용됩니다.

반환 값은 PyGILState_Ensure()가 호출되었을 때의 스레드 상태에 대한 불투명한 “핸들”이며, 파이썬이 같은 상태에 있도록 하려면 PyGILState_Release()로 전달되어야 합니다. 재귀 호출이 허용되더라도, 이 핸들들은 공유할 수 없습니다 - PyGILState_Ensure()에 대한 각 고유 호출은 자신의 PyGILState_Release()에 대한 호출을 위해 핸들을 저장해야 합니다.

함수가 반환할 때, 현재 스레드는 GIL을 보유하고 임의의 파이썬 코드를 호출할 수 있습니다. 실패는 치명적인 에러입니다.

참고

런타임이 파이널리제이션 될 때 스레드에서 이 함수를 호출하면, 스레드가 파이썬에 의해 만들어지지 않았더라도 스레드가 종료됩니다. 원치 않는 종료를 방지하려면 _Py_IsFinalizing()이나 sys.is_finalizing()을 사용하여 이 함수를 호출하기 전에 인터프리터가 파이널리제이션 되고 있는지 확인할 수 있습니다.

void PyGILState_Release(PyGILState_STATE)

이전에 획득 한 모든 자원을 해제합니다. 이 호출 후에, 파이썬의 상태는 해당 PyGILState_Ensure() 호출 이전과 같습니다 (그러나 일반적으로 이 상태는 호출자에게 알려지지 않아서, GILState API를 사용합니다).

PyGILState_Ensure()에 대한 모든 호출은 같은 스레드에서 PyGILState_Release()에 대한 호출과 쌍을 이뤄야 합니다.

PyThreadState* PyGILState_GetThisThreadState()

이 스레드의 현재 스레드 상태를 가져옵니다. 현재 스레드에서 GILState API가 사용되지 않았으면 NULL을 반환할 수 있습니다. 메인 스레드에서 자동 스레드 상태 호출(auto-thread-state call)이 수행되지 않은 경우에도, 메인 스레드에는 항상 이러한 스레드 상태가 있음에 유의하십시오. 이것은 주로 도우미/진단 함수입니다.

int PyGILState_Check()

현재 스레드가 GIL을 보유하고 있으면 1을 반환하고 그렇지 않으면 0을 반환합니다. 이 함수는 아무 때나 모든 스레드에서 호출할 수 있습니다. 파이썬 스레드 상태가 초기화되었고 현재 GIL을 보유하고 있을 때만 1을 반환합니다. 이것은 주로 도우미/진단 함수입니다. 예를 들어 콜백 컨텍스트나 메모리 할당 함수에서 유용할 수 있는데, GIL이 잠겨 있다는 것을 알면 호출자가 민감한 작업을 수행하거나 그렇지 않으면 다르게 동작하도록 할 수 있습니다.

버전 3.4에 추가.

다음 매크로는 일반적으로 후행 세미콜론 없이 사용됩니다; 파이썬 소스 배포에서 사용 예를 찾으십시오.

Py_BEGIN_ALLOW_THREADS

이 매크로는 { PyThreadState *_save; _save = PyEval_SaveThread(); 로 확장됩니다. 여는 중괄호가 포함되어 있음에 유의하십시오; 뒤따르는 Py_END_ALLOW_THREADS 매크로와 일치해야 합니다. 이 매크로에 대한 자세한 내용은 위를 참조하십시오.

Py_END_ALLOW_THREADS

이 매크로는 PyEval_RestoreThread(_save); }로 확장됩니다. 닫는 중괄호가 포함되어 있음에 유의하십시오; 이전 Py_BEGIN_ALLOW_THREADS 매크로와 일치해야 합니다. 이 매크로에 대한 자세한 내용은 위를 참조하십시오.

Py_BLOCK_THREADS

이 매크로는 PyEval_RestoreThread(_save); 로 확장됩니다: 닫는 중괄호가 없는 Py_END_ALLOW_THREADS와 동등합니다.

Py_UNBLOCK_THREADS

이 매크로는 _save = PyEval_SaveThread(); 로 확장됩니다: 여는 중괄호와 변수 선언이 없는 Py_BEGIN_ALLOW_THREADS와 동등합니다.

저수준 API

다음 함수는 모두 Py_Initialize() 이후에 호출되어야 합니다.

버전 3.7에서 변경: Py_Initialize()는 이제 GIL을 초기화합니다.

PyInterpreterState* PyInterpreterState_New()

새 인터프리터 상태 객체를 만듭니다. 전역 인터프리터 록을 보유할 필요는 없지만, 이 함수에 대한 호출을 직렬화해야 하면 보유할 수 있습니다.

인자 없이 감사 이벤트 cpython.PyInterpreterState_New를 발생시킵니다.

void PyInterpreterState_Clear(PyInterpreterState *interp)

인터프리터 상태 객체의 모든 정보를 재설정합니다. 전역 인터프리터 록을 보유해야 합니다.

인자 없이 감사 이벤트 cpython.PyInterpreterState_Clear를 발생시킵니다.

void PyInterpreterState_Delete(PyInterpreterState *interp)

인터프리터 상태 객체를 파괴합니다. 전역 인터프리터 록은 보유할 필요 없습니다. 인터프리터 상태는 PyInterpreterState_Clear()에 대한 이전 호출로 재설정되었어야 합니다.

PyThreadState* PyThreadState_New(PyInterpreterState *interp)

주어진 인터프리터 객체에 속하는 새 스레드 상태 객체를 만듭니다. 전역 인터프리터 록을 보유할 필요는 없지만, 이 함수에 대한 호출을 직렬화해야 하면 보유할 수 있습니다.

void PyThreadState_Clear(PyThreadState *tstate)

스레드 상태 객체의 모든 정보를 재설정합니다. 전역 인터프리터 록을 보유해야 합니다.

void PyThreadState_Delete(PyThreadState *tstate)

스레드 상태 객체를 파괴합니다. 전역 인터프리터 록은 보유할 필요 없습니다. 스레드 상태는 PyThreadState_Clear()에 대한 이전 호출로 재설정되었어야 합니다.

PY_INT64_T PyInterpreterState_GetID(PyInterpreterState *interp)

인터프리터의 고유 ID를 반환합니다. 그렇게 하는데 에러가 발생하면 -1이 반환되고 에러가 설정됩니다.

버전 3.7에 추가.

PyObject* PyInterpreterState_GetDict(PyInterpreterState *interp)

인터프리터별 데이터가 저장될 수 있는 딕셔너리를 반환합니다. 이 함수가 NULL을 반환하면 예외는 발생하지 않았고 호출자는 인터프리터별 딕셔너리를 사용할 수 없다고 가정해야 합니다.

이것은 확장이 인터프리터별 상태 정보를 저장하는 데 사용해야 하는 PyModule_GetState()를 대체하는 것이 아닙니다.

버전 3.8에 추가.

PyObject* PyThreadState_GetDict()

Return value: Borrowed reference.

확장이 스레드별 상태 정보를 저장할 수 있는 딕셔너리를 반환합니다. 각 확장은 딕셔너리에 상태를 저장하는 데 사용할 고유 키를 사용해야 합니다. 현재 스레드 상태를 사용할 수 없을 때 이 함수를 호출해도 됩니다. 이 함수가 NULL을 반환하면, 예외는 발생하지 않았고 호출자는 현재 스레드 상태를 사용할 수 없다고 가정해야 합니다.

int PyThreadState_SetAsyncExc(unsigned long id, PyObject *exc)

스레드에서 비동기적으로 예외를 발생시킵니다. id 인자는 대상 스레드의 스레드 id입니다; exc는 발생시킬 예외 객체입니다. 이 함수는 exc에 대한 어떤 참조도 훔치지 않습니다. 순진한 오용을 방지하려면, 이를 호출하는 자체 C 확장을 작성해야 합니다. GIL을 보유한 채로 호출해야 합니다. 수정된 스레드 상태 수를 반환합니다; 일반적으로 1이지만, 스레드 id를 찾지 못하면 0이 됩니다. exc가 NULL이면, 스레드에 대해 계류 중인 예외가 (있다면) 지워집니다. 이것은 예외를 일으키지 않습니다.

버전 3.7에서 변경: id 매개 변수의 형이 long에서 unsigned long으로 변경되었습니다.

void PyEval_AcquireThread(PyThreadState *tstate)

Acquire the global interpreter lock and set the current thread state to tstate, which should not be NULL. The lock must have been created earlier. If this thread already has the lock, deadlock ensues.

참고

런타임이 파이널리제이션 될 때 스레드에서 이 함수를 호출하면, 스레드가 파이썬에 의해 만들어지지 않았더라도 스레드가 종료됩니다. 원치 않는 종료를 방지하려면 _Py_IsFinalizing()이나 sys.is_finalizing()을 사용하여 이 함수를 호출하기 전에 인터프리터가 파이널리제이션 되고 있는지 확인할 수 있습니다.

버전 3.8에서 변경: PyEval_RestoreThread(), Py_END_ALLOW_THREADS() 및 PyGILState_Ensure()와 일관되도록 갱신되었으며, 인터프리터가 파이널리제이션 하는 동안 호출되면 현재 스레드를 종료합니다.

PyEval_RestoreThread()는 (스레드가 초기화되지 않았을 때조차) 항상 사용할 수 있는 고수준 함수입니다.

void PyEval_ReleaseThread(PyThreadState *tstate)

현재 스레드 상태를 NULL로 재설정하고 전역 인터프리터 록을 해제합니다. 록은 이전에 만들어졌어야 하고 현재 스레드가 보유해야 합니다. NULL이 아니어야 하는 tstate 인자는 현재 스레드 상태를 나타내는지 확인하는 데만 사용됩니다 — 그렇지 않으면, 치명적인 에러가 보고됩니다.

PyEval_SaveThread()는 (스레드가 초기화되지 않은 경우에조차) 항상 사용할 수 있는 고수준 함수입니다.

void PyEval_AcquireLock()

전역 인터프리터 록을 획득합니다. 록은 이전에 만들어졌어야 합니다. 이 스레드에 이미 록이 있으면, 교착 상태가 발생합니다.

버전 3.2부터 폐지: 이 함수는 현재 스레드 상태를 갱신하지 않습니다. 대신 PyEval_RestoreThread()나 PyEval_AcquireThread()를 사용하십시오.

참고

런타임이 파이널리제이션 될 때 스레드에서 이 함수를 호출하면, 스레드가 파이썬에 의해 만들어지지 않았더라도 스레드가 종료됩니다. 원치 않는 종료를 방지하려면 _Py_IsFinalizing()이나 sys.is_finalizing()을 사용하여 이 함수를 호출하기 전에 인터프리터가 파이널리제이션 되고 있는지 확인할 수 있습니다.

버전 3.8에서 변경: PyEval_RestoreThread(), Py_END_ALLOW_THREADS() 및 PyGILState_Ensure()와 일관되도록 갱신되었으며, 인터프리터가 파이널리제이션 하는 동안 호출되면 현재 스레드를 종료합니다.

void PyEval_ReleaseLock()

전역 인터프리터 록을 해제합니다. 록은 이전에 만들어졌어야 합니다.

버전 3.2부터 폐지: 이 함수는 현재 스레드 상태를 갱신하지 않습니다. 대신 PyEval_SaveThread()나 PyEval_ReleaseThread()를 사용하십시오.

서브 인터프리터 지원

대부분의 경우, 단일 파이썬 인터프리터만 내장할 것입니다만, 같은 프로세스, 어쩌면 같은 스레드에서 여러 독립 인터프리터를 만들어야 하는 경우가 있습니다. 서브 인터프리터는 그렇게 할 수 있도록 합니다.

“메인” 인터프리터는 런타임이 초기화될 때 만들어지는 첫 번째 인터프리터입니다. 보통은 프로세스에서 유일한 파이썬 인터프리터입니다. 서브 인터프리터와 달리, 메인 인터프리터는 시그널 처리와 같은 고유한 프로세스 전역 책임을 갖습니다. 또한 런타임 초기화 동안 실행을 담당하며 일반적으로 런타임 파이널리제이션 동안 활성 인터프리터입니다. PyInterpreterState_Main() 함수는 그것의 상태에 대한 포인터를 반환합니다.

PyThreadState_Swap() 함수를 사용하여 서브 인터프리터 간에 전환할 수 있습니다. 다음 함수를 사용하여 만들고 파괴할 수 있습니다:

PyThreadState* Py_NewInterpreter()

새 서브 인터프리터를 만듭니다. 이것은 파이썬 코드 실행을 위한 (거의) 완전히 분리된 환경입니다. 특히, 새 인터프리터에는 기본 모듈 builtins, __main__ 및 sys를 포함하여, 모든 임포트 된 모듈의 개별, 독립 버전을 갖습니다. 로드된 모듈 테이블(sys.modules)과 모듈 검색 경로(sys.path)도 별개입니다. 새 환경에는 sys.argv 변수가 없습니다. 새로운 표준 I/O 스트림 파일 객체 sys.stdin, sys.stdout 및 sys.stderr을 갖습니다 (단, 같은 하부 파일 기술자를 참조합니다).

반환 값은 새 서브 인터프리터에서 만들어진 첫 번째 스레드 상태를 가리킵니다. 이 스레드 상태는 현재 스레드 상태에서 만들어집니다. 실제 스레드가 만들어지지 않음에 유의하십시오; 아래 스레드 상태에 대한 설명을 참조하십시오. 새 인터프리터를 만드는 데 실패하면, NULL이 반환됩니다; 예외 상태는 현재 스레드 상태에 저장되고 현재 스레드 상태가 없을 수 있어서 예외가 설정되지 않습니다. (다른 모든 파이썬/C API 함수와 마찬가지로, 전역 인터프리터 록을 이 함수를 호출하기 전에 보유해야 하며 반환될 때 계속 유지됩니다; 그러나, 대부분의 다른 파이썬/C API 함수와 달리, 진입할 때 현재 스레드 상태가 있을 필요는 없습니다.)

확장 모듈은 다음과 같이 (서브) 인터프리터 간에 공유됩니다:

• 다단계 초기화를 사용하는 모듈의 경우, 예를 들어 PyModule_FromDefAndSpec(), 각 인터프리터에 대해 별도의 모듈 객체가 만들어지고 초기화됩니다. C 수준 정적과 전역 변수만 이러한 모듈 객체 간에 공유됩니다.

• 단단계 초기화를 사용하는 모듈의 경우, 예를 들어 PyModule_Create(), 특정 확장이 처음 임포트 될 때, 정상적으로 초기화되고, 모듈 딕셔너리의 (얕은) 사본이 저장됩니다. 다른 (서브) 인터프리터가 같은 확장을 임포트 할 때, 새 모듈이 초기화되고 이 복사본의 내용으로 채워집니다; 확장의 init 함수는 호출되지 않습니다. 따라서 모듈 딕셔너리의 객체는 (서브) 인터프리터 간에 공유되어, 원치 않는 동작을 일으킬 수 있습니다 (아래 버그와 주의 사항을 참조하십시오).

  이것은 인터프리터가 Py_FinalizeEx()와 Py_Initialize()를 호출하여 완전히 다시 초기화된 후 확장을 임포트 할 때 일어나는 것과 다름에 유의하십시오; 이 경우, 확장의 initmodule 함수가 다시 호출됩니다. 다단계 초기화와 마찬가지로, 이는 C 수준의 정적과 전역 변수만 이러한 모듈 간에 공유됨을 의미합니다.

void Py_EndInterpreter(PyThreadState *tstate)

주어진 스레드 상태로 표현되는 (서브) 인터프리터를 파괴합니다. 주어진 스레드 상태는 현재 스레드 상태여야 합니다. 아래의 스레드 상태에 대한 설명을 참조하십시오. 호출이 반환되면, 현재 스레드 상태는 NULL입니다. 이 인터프리터와 관련된 모든 스레드 상태가 파괴됩니다. (전역 인터프리터 록을 이 함수를 호출하기 전에 보유해야 하며 반환될 때 여전히 유지됩니다.) Py_FinalizeEx()는 그 시점에서 명시적으로 파괴되지 않은 모든 서브 인터프리터를 파괴합니다.

버그와 주의 사항

서브 인터프리터(및 메인 인터프리터)는 같은 프로세스의 일부이기 때문에, 그들 간의 절연이 완벽하지 않습니다 — 예를 들어, os.close()와 같은 저수준 파일 연산을 사용하면 서로의 열린 파일에 (실수로 혹은 악의적으로) 영향을 미칠 수 있습니다. (서브) 인터프리터 간에 확장이 공유되는 방식 때문에, 일부 확장이 제대로 작동하지 않을 수 있습니다; 이것은 특히 단단계 초기화나 (정적) 전역 변수를 사용할 때 특히 그렇습니다. 한 서브 인터프리터에서 만든 객체를 다른 (서브) 인터프리터의 이름 공간에 삽입할 수 있습니다; 가능하면 피해야 합니다.

서브 인터프리터 간에 사용자 정의 함수, 메서드, 인스턴스 또는 클래스를 공유하지 않도록 특별한 주의를 기울여야 합니다. 이러한 객체에 의해 실행되는 임포트 연산은 잘못된 (서브) 인터프리터의 로드된 모듈 딕셔너리에 영향을 미칠 수 있기 때문입니다. 위의 것들에서 접근할 수 있는 객체를 공유하지 않는 것도 마찬가지로 중요합니다.

또한 이 기능을 PyGILState_*() API와 결합하는 것은 까다로움에 유의하십시오. 이러한 API는, 서브 인터프리터의 존재로 인해 깨어진 가정인, 파이썬 스레드 상태와 OS 수준 스레드 사이의 일대일 관계를 가정하기 때문입니다. PyGILState_Ensure()와 PyGILState_Release() 호출의 일치하는 쌍 사이에 서브 인터프리터를 전환하지 않는 것이 좋습니다. 또한, 이러한 API를 사용하여 파이썬이 아닌 스레드에서 생성된 스레드에서 파이썬 코드를 호출할 수 있도록 하는 확장(가령 ctypes)은 서브 인터프리터를 사용할 때 망가질 수 있습니다.

비동기 알림

메인 인터프리터 스레드에 비동기 알림을 보내는 메커니즘이 제공됩니다. 이러한 알림은 함수 포인터와 void 포인터 인자의 형태를 취합니다.

int Py_AddPendingCall(int (*func)(void *), void *arg)

메인 인터프리터 스레드에서 호출할 함수를 예약합니다. 성공하면 0이 반환되고 func는 메인 스레드에서 호출되기 위해 큐에 추가됩니다. 실패 시, 예외 설정 없이 -1이 반환됩니다.

성공적으로 큐에 넣으면, func는 arg 인자를 사용하여 결국 메인 인터프리터 스레드에서 호출됩니다. 정상적으로 실행되는 파이썬 코드와 비교할 때 비동기적으로 호출되지만, 다음 두 조건이 모두 충족됩니다:

• 바이트 코드 경계에서;

• 메인 스레드가 전역 인터프리터 록을 보유하면서 (따라서 func는 전체 C API를 사용할 수 있습니다).

func는 성공하면 0을, 실패하면 예외 설정과 함께 -1을 반환해야 합니다. func는 다른 비동기 알림을 재귀적으로 수행하기 위해 중단되지 않지만, 전역 인터프리터 록이 해제되면 스레드를 전환하기 위해 여전히 중단될 수 있습니다.

이 함수는 실행하는 데 현재 스레드 상태가 필요하지 않으며, 전역 인터프리터 록이 필요하지 않습니다.

경고

이것은 매우 특별한 경우에만 유용한, 저수준 함수입니다. func가 가능한 한 빨리 호출된다는 보장은 없습니다. 메인 스레드가 시스템 호출을 실행 중이라 바쁘면, 시스템 호출이 반환되기 전에 func가 호출되지 않습니다. 이 함수는 일반적으로 임의의 C 스레드에서 파이썬 코드를 호출하는 데 적합하지 않습니다. 대신, PyGILState API를 사용하십시오.

버전 3.1에 추가.

프로파일링과 추적

파이썬 인터프리터는 프로파일링과 실행 추적 기능을 연결하기 위한 몇 가지 저수준 지원을 제공합니다. 프로파일링, 디버깅 및 커버리지 분석 도구에 사용됩니다.

이 C 인터페이스를 사용하면 프로파일링이나 추적 코드가 파이썬 수준의 콜러블 객체를 통해 호출하는 오버헤드를 피하고, 대신 직접 C 함수를 호출할 수 있습니다. 시설의 필수 어트리뷰트는 변경되지 않았습니다; 인터페이스는 추적 함수를 스레드별로 설치할 수 있도록 하며, 추적 함수에 보고되는 기본 이벤트는 이전 버전의 파이썬 수준 추적 함수에 보고된 것과 같습니다.

int (*Py_tracefunc)(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg)

PyEval_SetProfile()과 PyEval_SetTrace()를 사용하여 등록된 추적 함수의 형입니다. 첫 번째 매개 변수는 등록 함수에 obj로 전달된 객체이고, frame은 이벤트가 관련된 프레임 객체이고, what은 상수 PyTrace_CALL, PyTrace_EXCEPTION, PyTrace_LINE, PyTrace_RETURN, PyTrace_C_CALL, PyTrace_C_EXCEPTION, PyTrace_C_RETURN 또는 PyTrace_OPCODE 중 하나이고, arg는 what의 값에 따라 다릅니다:

what의 값	arg의 의미
PyTrace_CALL	항상 Py_None.
PyTrace_EXCEPTION	sys.exc_info()에서 반환된 예외 정보.
PyTrace_LINE	항상 Py_None.
PyTrace_RETURN	호출자에게 반환되는 값, 또는 예외로 인한 것이면 NULL.
PyTrace_C_CALL	호출되는 함수 객체.
PyTrace_C_EXCEPTION	호출되는 함수 객체.
PyTrace_C_RETURN	호출되는 함수 객체.
PyTrace_OPCODE	항상 Py_None.

int PyTrace_CALL

함수나 메서드에 대한 새 호출이 보고되거나, 제너레이터에 대한 새 항목이 보고될 때 Py_tracefunc 함수에 대한 what 매개 변수의 값. 제너레이터 함수에 대한 이터레이터의 생성은 해당 프레임의 파이썬 바이트 코드로의 제어 전송이 없기 때문에 보고되지 않음에 유의하십시오.

int PyTrace_EXCEPTION

예외가 발생했을 때 Py_tracefunc 함수에 대한 what 매개 변수의 값. 콜백 함수는 실행되는 프레임 내에서 바이트 코드가 처리된 후 예외가 설정될 때 what에 대해 이 값으로 호출됩니다. 이것의 효과는 예외 전파로 인해 파이썬 스택이 되감기는 것입니다, 예외가 전파되어 각 프레임으로 반환할 때 콜백이 호출됩니다. 추적 함수만 이러한 이벤트를 수신합니다; 프로파일러에는 필요하지 않습니다.

int PyTrace_LINE

줄 번호 이벤트가 보고될 때 what 매개 변수로 Py_tracefunc 함수(하지만 프로파일링 함수는 아닙니다)에 전달되는 값. 해당 프레임의 f_trace_lines를 0으로 설정하여 해당 프레임에 대해 비활성화 할 수 있습니다.

int PyTrace_RETURN

호출이 반환되려고 할 때 Py_tracefunc 함수에 대한 what 매개 변수의 값.

int PyTrace_C_CALL

C 함수가 호출되려고 할 때 Py_tracefunc 함수에 대한 what 매개 변수의 값.

int PyTrace_C_EXCEPTION

C 함수에서 예외가 발생했을 때 Py_tracefunc 함수에 대한 what 매개 변수의 값.

int PyTrace_C_RETURN

C 함수가 반환했을 때 Py_tracefunc 함수에 대한 what 매개 변수의 값.

int PyTrace_OPCODE

새 옵코드가 실행되려고 할 때 Py_tracefunc 함수(하지만 프로파일링 함수는 아닙니다)에 대한 what 매개 변수의 값. 이 이벤트는 기본적으로 방출되지 않습니다: 프레임의 f_trace_opcodes를 1로 설정하여 명시적으로 요청해야 합니다.

void PyEval_SetProfile(Py_tracefunc func, PyObject *obj)

프로파일러 함수를 func로 설정합니다. obj 매개 변수는 첫 번째 매개 변수로 함수에 전달되며, 임의의 파이썬 객체나 NULL일 수 있습니다. 프로파일 함수가 상태를 유지해야 하면, 스레드마다 obj에 다른 값을 사용하면 저장하기에 편리하고 스레드 안전한 위치를 제공합니다. 프로파일 함수는 PyTrace_LINE, PyTrace_OPCODE 및 PyTrace_EXCEPTION을 제외한 모든 관찰되는 이벤트에 대해 호출됩니다.

void PyEval_SetTrace(Py_tracefunc func, PyObject *obj)

추적 함수를 func로 설정합니다. 추적 함수가 줄 번호 이벤트와 옵코드별 이벤트를 수신하지만, 호출되는 C 함수 객체와 관련된 이벤트를 수신하지 않는다는 점을 제외하면, PyEval_SetProfile()과 유사합니다. PyEval_SetTrace()를 사용하여 등록된 모든 추적 함수는 what 매개 변수의 값으로 PyTrace_C_CALL, PyTrace_C_EXCEPTION 또는 PyTrace_C_RETURN을 수신하지 않습니다.

고급 디버거 지원

이 함수들은 고급 디버깅 도구에서만 사용하기 위한 것입니다.

PyInterpreterState* PyInterpreterState_Head()

인터프리터 상태 객체들의 리스트의 머리에 있는 객체를 반환합니다.

PyInterpreterState* PyInterpreterState_Main()

메인 인터프리터 상태 객체를 반환합니다.

PyInterpreterState* PyInterpreterState_Next(PyInterpreterState *interp)

인터프리터 상태 객체들의 리스트에서 interp 이후의 다음 인터프리터 상태 객체를 반환합니다.

PyThreadState * PyInterpreterState_ThreadHead(PyInterpreterState *interp)

인터프리터 interp와 관련된 스레드 리스트에서 첫 번째 PyThreadState 객체에 대한 포인터를 반환합니다.

PyThreadState* PyThreadState_Next(PyThreadState *tstate)

같은 PyInterpreterState 객체에 속하는 모든 스레드 객체 리스트에서 tstate 이후의 다음 스레드 상태 객체를 반환합니다.

스레드 로컬 저장소 지원

파이썬 인터프리터는 파이썬 수준의 스레드 로컬 저장소 API(threading.local)를 지원하기 위해 하부 네이티브 TLS 구현을 래핑하는 스레드 로컬 저장소(TLS)에 대한 저수준 지원을 제공합니다. CPython C 수준 API는 pthread와 윈도우에서 제공하는 API와 유사합니다: 스레드 키와 함수를 사용하여 스레드 당 void* 값을 연결합니다.

이러한 함수를 호출할 때 GIL을 보유할 필요는 없습니다; 그들은 자체 록을 제공합니다.

Python.h에는 TLS API 선언이 포함되어 있지 않음에 유의하십시오, 스레드 로컬 저장소를 사용하려면 pythread.h를 포함해야 합니다.

참고

이러한 API 함수 중 어느 것도 void* 값을 대신해서 메모리 관리를 처리하지 않습니다. 직접 할당하고 할당 해제해야 합니다. void* 값이 PyObject* 이라면, 이 함수들은 참조 횟수 연산도 수행하지 않습니다.

스레드별 저장소 (TSS - Thread Specific Storage) API

CPython 인터프리터 내에서 기존 TLS API의 사용을 대체하기 위해 TSS API가 도입되었습니다. 이 API는 스레드 키를 나타내기 위해 int 대신 새로운 형 Py_tss_t를 사용합니다.

버전 3.7에 추가.

더 보기

“CPython의 스레드-로컬 저장소를 위한 새로운 C-API” (PEP 539)

Py_tss_t

이 자료 구조는 스레드 키의 상태를 나타내며, 정의는 하부 TLS 구현에 따라 달라질 수 있으며, 키의 초기화 상태를 나타내는 내부 필드가 있습니다. 이 구조체에는 공개 멤버가 없습니다.

Py_LIMITED_API가 정의되지 않을 때, Py_tss_NEEDS_INIT로 이 형의 정적 할당이 허용됩니다.

Py_tss_NEEDS_INIT

이 매크로는 Py_tss_t 변수의 초기화자(initializer)로 확장됩니다. 이 매크로는 Py_LIMITED_API에서 정의되지 않음에 유의하십시오.

동적 할당

Py_LIMITED_API로 빌드된 확장 모듈에 필요한, 빌드 시점에 구현이 불투명해서 형의 정적 할당이 불가능한 Py_tss_t의 동적 할당.

Py_tss_t* PyThread_tss_alloc()

Py_tss_NEEDS_INIT로 초기화된 값과 같은 상태의 값을 반환하거나, 동적 할당 실패 시 NULL을 반환합니다.

void PyThread_tss_free(Py_tss_t *key)

모든 관련 스레드 로컬의 대입을 해제하도록 PyThread_tss_delete()를 먼저 호출한 후, PyThread_tss_alloc()에 의해 할당된 주어진 key를 할당 해제합니다. key 인자가 NULL이면 아무런 일도 하지 않습니다.

참고

해제된 키는 매달린(dangling) 포인터가 됩니다, 키를 NULL로 재설정해야 합니다.

메서드

이 함수들의 매개 변수 key는 NULL이 아니어야 합니다. 또한, 주어진 Py_tss_t가 PyThread_tss_create()로 초기화되지 않았으면, PyThread_tss_set()과 PyThread_tss_get()의 동작은 정의되지 않습니다.

int PyThread_tss_is_created(Py_tss_t *key)

주어진 Py_tss_t가 PyThread_tss_create()로 초기화되었으면 0이 아닌 값을 반환합니다.

int PyThread_tss_create(Py_tss_t *key)

TSS 키 초기화에 성공하면 0 값을 반환합니다. key 인자가 가리키는 값이 Py_tss_NEEDS_INIT로 초기화되지 않으면 동작이 정의되지 않습니다. 이 함수는 같은 키에서 반복적으로 호출될 수 있습니다 – 이미 초기화된 키에 대해 호출하면 아무런 일도 하지 않으며 즉시 성공을 반환합니다.

void PyThread_tss_delete(Py_tss_t *key)

TSS 키를 삭제하여 모든 스레드에서 키와 관련된 값을 잊게 하고, 키의 초기화 상태를 초기화되지 않음으로 변경합니다. 파괴된 키는 PyThread_tss_create()로 다시 초기화할 수 있습니다. 이 함수는 같은 키에서 반복적으로 호출될 수 있습니다 – 이미 파괴된 키에 대해 호출하면 아무런 일도 하지 않습니다.

int PyThread_tss_set(Py_tss_t *key, void *value)

현재 스레드에서 void* 값을 TSS 키와 성공적으로 연결했음을 나타내는 0 값을 반환합니다. 각 스레드에는 키에서 void* 값으로의 고유한 매핑이 있습니다.

void* PyThread_tss_get(Py_tss_t *key)

현재 스레드의 TSS 키와 관련된 void* 값을 반환합니다. 현재 스레드에 키와 연결된 값이 없으면 NULL을 반환합니다.

스레드 로컬 저장소 (TLS) API

버전 3.7부터 폐지: 이 API는 스레드별 저장소 (TSS) API로 대체됩니다.

참고

이 버전의 API는 int로 안전하게 캐스트 할 수 없는 방식으로 네이티브 TLS 키가 정의된 플랫폼을 지원하지 않습니다. 이러한 플랫폼에서, PyThread_create_key()는 실패 상태로 즉시 반환되며, 다른 TLS 함수는 이러한 플랫폼에서 모두 아무런 일도 하지 않습니다.

위에서 언급한 호환성 문제로 인해, 이 버전의 API를 새 코드에서 사용해서는 안 됩니다.

int PyThread_create_key()

void PyThread_delete_key(int key)

int PyThread_set_key_value(int key, void *value)

void* PyThread_get_key_value(int key)

void PyThread_delete_key_value(int key)

void PyThread_ReInitTLS()