importlib — import의 구현

버전 3.1에 추가.

소스 코드: Lib/importlib/__init__.py

소개

importlib 패키지의 목적은 두 가지입니다. 하나는 파이썬 소스 코드에서 import 문(그리고, 확장하면 __import__() 함수)의 구현을 제공하는 것입니다. 이것은 모든 파이썬 인터프리터에 이식할 수 있는 import의 구현을 제공합니다. 또한 파이썬 이외의 프로그래밍 언어로 구현된 것보다 이해하기 쉬운 구현을 제공합니다.

둘째, import를 구현하는 구성 요소가 이 패키지에서 노출되어, 사용자가 임포트 프로세스에 참여하기 위해 자신의 사용자 지정 객체(일반적으로 임포터라고 합니다)를 쉽게 만들 수 있도록 합니다.

더 보기

임포트(import) 문

import 문의 언어 레퍼런스.

패키지 명세

패키지의 원래 명세. 이 문서를 작성한 이후로 일부 의미가 변경되었습니다 (예를 들어 sys.modules의 None을 기반으로 하는 리디렉션).

__import__() 함수

import 문은 이 함수의 편의 문법입니다.

PEP 235

대소 문자를 구분하지 않는 플랫폼에서의 임포트

PEP 263

파이썬 소스 코드 인코딩 정의

PEP 302

새로운 임포트 훅

PEP 328

임포트: 다중 줄과 절대/상대

PEP 366

메인 모듈 명시적 상대 임포트

PEP 420

묵시적 이름 공간 패키지

PEP 451

임포트 시스템을 위한 ModuleSpec 형

PEP 488

PYO 파일 제거

PEP 489

다단계 확장 모듈 초기화

PEP 552

결정론적 pyc

PEP 3120

UTF-8을 기본 소스 인코딩으로 사용하기

PEP 3147

PYC 저장소 디렉터리

함수

importlib.__import__(name, globals=None, locals=None, fromlist=(), level=0)

내장 __import__() 함수의 구현.

참고

프로그래밍 방식으로 모듈을 임포트 하려면 이 함수 대신 import_module()을 사용해야 합니다.

importlib.import_module(name, package=None)

모듈을 임포트 합니다. name 인자는 절대나 상대적인 항으로 임포트 할 모듈을 지정합니다 (예를 들어 pkg.mod나 ..mod). 이름이 상대적인 항으로 지정되면, package 인자는 패키지 이름을 결정하기 위한 앵커 역할을 하는 패키지 이름으로 설정해야 합니다 (예를 들어 import_module('..mod', 'pkg.subpkg')는 pkg.mod를 임포트 합니다).

import_module() 함수는 importlib.__import__() 주위를 감싸는 단순화 래퍼 역할을 합니다. 이는 함수의 모든 의미가 importlib.__import__()에서 파생됨을 뜻합니다. 이 두 함수의 가장 중요한 차이점은 import_module()이 지정된 패키지나 모듈(예를 들어 pkg.mod)을 반환하는 반면, __import__()는 최상위 패키지나 모듈(예를 들어 pkg)을 반환한다는 것입니다.

인터프리터가 실행을 시작한 이후 만들어진 모듈(예를 들어, 파이썬 소스 파일을 만들면)을 동적으로 임포트 하는 경우, 임포트 시스템에서 새 모듈을 알 수 있도록 invalidate_caches()를 호출해야 할 수 있습니다.

버전 3.3에서 변경: 부모 패키지는 자동으로 임포트 됩니다.

importlib.find_loader(name, path=None)

선택적으로 지정된 path 내에서, 모듈의 로더를 찾습니다. 모듈이 sys.modules에 있으면, sys.modules[name].__loader__가 반환됩니다 (로더가 None이 되거나 설정되지 않지 않은 한, 그런 경우 ValueError가 발생합니다). 그렇지 않으면 sys.meta_path를 사용한 검색이 수행됩니다. 로더가 발견되지 않으면 None이 반환됩니다.

점으로 구분된 이름은 부모를 묵시적으로 임포트 되게 하지 않습니다, 그렇게 하려면 로드가 필요하고 이것이 바람직하지 않을 수 있기 때문입니다. 서브 모듈을 올바르게 임포트 하려면 서브 모듈의 모든 부모 패키지를 임포트 하고 path에 올바른 인자를 사용해야 합니다.

버전 3.3에 추가.

버전 3.4에서 변경: __loader__가 설정되지 않으면, 어트리뷰트가 None으로 설정되었을 때와 마찬가지로 ValueError를 발생시킵니다.

버전 3.4부터 폐지: 대신 importlib.util.find_spec()을 사용하십시오.

importlib.invalidate_caches()

sys.meta_path에 저장된 파인더의 내부 캐시를 무효로 합니다. 파인더가 invalidate_caches()를 구현하면 무효화를 수행하기 위해 호출됩니다. 모든 파인더가 새로운 모듈의 존재를 알 수 있도록 프로그램이 실행되는 동안 모듈이 만들어진/설치된 경우 이 함수를 호출해야 합니다.

버전 3.3에 추가.

importlib.reload(module)

이전에 임포트 한 module을 다시 로드합니다. 인자는 모듈 객체여야 해서, 이전에 성공적으로 임포트 됐어야 합니다. 외부 편집기를 사용하여 모듈 소스 파일을 편집했고 파이썬 인터프리터를 떠나지 않고 새 버전을 시험해보고 싶을 때 유용합니다. 반환 값은 모듈 객체입니다 (재 임포트로 인해 다른 객체가 sys.modules에 배치되면 다를 수 있습니다).

reload()가 실행될 때:

  • 파이썬 모듈의 코드가 다시 컴파일되고 모듈 수준 코드가 다시 실행되어, 원래 모듈을 로드한 로더를 재사용하여 모듈 딕셔너리에 있는 이름에 연결되는 새로운 객체 집합을 정의합니다. 확장 모듈의 init 함수는 두 번째에는 호출되지 않습니다.

  • 파이썬의 다른 모든 객체와 마찬가지로 이전 객체는 참조 횟수가 0으로 떨어진 후에만 자원이 회수됩니다.

  • 모듈 이름 공간의 이름은 새로운 객체나 변경된 객체를 가리키도록 갱신됩니다.

  • 이전 객체에 대한 다른 참조(가령 모듈 외부의 이름)는 새 객체를 참조하기 위해 다시 연결되지 않으며 필요하다면 그들이 등장하는 각 이름 공간에서 갱신되어야 합니다.

다른 여러 가지 경고가 있습니다:

모듈을 다시 로드할 때, 그것의 (모듈의 전역 변수를 포함하는) 딕셔너리가 유지됩니다. 이름을 재정의하면 이전 정의를 대체해서, 일반적으로 문제가 되지 않습니다. 새 버전의 모듈이 이전 버전이 정의한 이름을 정의하지 않으면, 이전 정의가 그대로 남습니다. 이 기능은 객체의 전역 테이블이나 캐시를 유지한다면 모듈의 이점으로 사용될 수 있습니다 — try 문으로 테이블의 존재를 검사하고 필요하다면 초기화를 건너뛸 수 있습니다:

try:
    cache
except NameError:
    cache = {}

일반적으로 내장이나 동적으로 로드된 모듈을 다시 로드하는 것은 그리 유용하지 않습니다. sys, __main__, builtins 및 기타 주요 모듈을 다시 로드하지 않는 것이 좋습니다. 많은 경우 확장 모듈은 두 번 이상 초기화되도록 설계되지 않았으며, 다시 로드할 때 임의의 방식으로 실패할 수 있습니다.

모듈이 from … import …를 사용하여 다른 모듈에서 객체를 임포트 하면, 다른 모듈에 대해 reload()를 호출해도 그것에서 임포트 한 객체를 재정의하지 않습니다 — 이것을 피하는 한 가지 방법은 from 문을 다시 실행하는 것입니다, 다른 방법은 대신 import와 정규화된 이름(module.name)을 사용하는 것입니다.

모듈이 클래스의 인스턴스를 인스턴스 화하면, 클래스를 정의하는 모듈을 다시 로드해도 인스턴스의 메서드 정의에는 영향을 미치지 않습니다 — 이전 클래스 정의를 계속 사용합니다. 파생 클래스의 경우도 마찬가지입니다.

버전 3.4에 추가.

버전 3.7에서 변경: 다시 로드되는 모듈에 ModuleSpec이 없으면 ModuleNotFoundError 가 발생합니다.

importlib.abc – import와 관련된 추상 베이스 클래스

소스 코드: Lib/importlib/abc.py

importlib.abc 모듈에는 import에서 사용하는 모든 핵심 추상 베이스 클래스가 포함되어 있습니다. 핵심 ABC 구현에 도움이 되도록 핵심 추상 베이스 클래스의 일부 서브 클래스도 제공됩니다.

ABC 계층:

object
 +-- Finder (deprecated)
 |    +-- MetaPathFinder
 |    +-- PathEntryFinder
 +-- Loader
      +-- ResourceLoader --------+
      +-- InspectLoader          |
           +-- ExecutionLoader --+
                                 +-- FileLoader
                                 +-- SourceLoader
class importlib.abc.Finder

파인더를 나타내는 추상 베이스 클래스.

버전 3.3부터 폐지: 대신 MetaPathFinder나 PathEntryFinder를 사용하십시오.

abstractmethod find_module(fullname, path=None)

지정된 모듈의 로더를 찾는 추상 메서드. 원래 PEP 302에 지정된, 이 메서드는 sys.meta_path와 경로 기반 임포트 서브 시스템에서 사용하기 위한 것입니다.

버전 3.4에서 변경: 호출하면 NotImplementedError를 발생시키는 대신 None을 반환합니다.

class importlib.abc.MetaPathFinder

메타 경로 파인더를 나타내는 추상 베이스 클래스. 호환성을 위해, Finder의 서브 클래스입니다.

버전 3.3에 추가.

find_spec(fullname, path, target=None)

지정된 모듈의 스펙을 찾는 추상 메서드. 최상위 임포트 인 경우, path는 None입니다. 그렇지 않으면, 이것은 서브 패키지나 모듈의 검색이 되고, path는 부모 패키지의 __path__ 값입니다. 스펙을 찾을 수 없으면, None이 반환됩니다. 전달될 때, target은 파인더가 반환할 스펙에 대해 더 정교하게 추측하기 위해 사용할 수 있는 모듈 객체입니다. importlib.util.spec_from_loader()는 구상 MetaPathFinders를 구현하는 데 유용할 수 있습니다.

버전 3.4에 추가.

find_module(fullname, path)

지정된 모듈에 대한 로더를 찾기 위한 레거시 메서드. 최상위 임포트 인 경우, path는 None입니다. 그렇지 않으면, 이것은 서브 패키지나 모듈의 검색이 되고, path는 부모 패키지의 __path__ 값입니다. 로더를 찾을 수 없으면, None이 반환됩니다.

find_spec()이 정의되면, 이전 버전과 호환되는 기능이 제공됩니다.

버전 3.4에서 변경: 호출하면 NotImplementedError를 발생시키는 대신 None을 반환합니다. find_spec()을 사용하여 기능을 제공할 수 있습니다.

버전 3.4부터 폐지: 대신 find_spec()을 사용하십시오.

invalidate_caches()

호출될 때, 파인더가 사용하는 내부 캐시를 무효로 해야 하는 선택적 메서드. sys.meta_path에서 모든 파인더의 캐시를 무효로 할 때 importlib.invalidate_caches()에서 사용합니다.

버전 3.4에서 변경: 호출될 때 NotImplemented 대신 None을 반환합니다.

class importlib.abc.PathEntryFinder

경로 엔트리 파인더를 나타내는 추상 베이스 클래스. MetaPathFinder와 일부 유사하지만, PathEntryFinder는 PathFinder가 제공하는 경로 기반 임포트 서브 시스템 내에서만 사용하려는 것입니다. 이 ABC는 호환성을 위해서만 Finder의 서브 클래스입니다.

버전 3.3에 추가.

find_spec(fullname, target=None)

지정된 모듈의 스펙을 찾는 추상 메서드. 파인더는 할당된 경로 엔트리 내에서만 모듈을 검색합니다. 스펙을 찾을 수 없으면, None이 반환됩니다. 전달될 때, target은 파인더가 반환할 스펙에 대해 더 정교하게 추측하기 위해 사용할 수 있는 모듈 객체입니다. importlib.util.spec_from_loader()는 구상 PathEntryFinders를 구현하는 데 유용할 수 있습니다.

버전 3.4에 추가.

find_loader(fullname)

지정된 모듈에 대한 로더를 찾기 위한 레거시 메서드. (loader, portion)의 2-튜플을 반환하는데, portion은 이름 공간 패키지의 일부에 기여하는 파일 시스템 위치의 시퀀스입니다. 파일 시스템 위치가 이름 공간 패키지에 기여함을 나타내도록 portion을 지정하는 동안 로더는 None일 수 있습니다. 로더가 이름 공간 패키지의 일부가 아님을 표시하기 위해 portion에 빈 리스트를 사용할 수 있습니다. loader가 None이고 portion이 빈 리스트이면 이름 공간 패키지의 로더나 위치가 발견되지 않은 것입니다 (즉 모듈에 대해 아무것도 찾지 못했습니다).

find_spec()이 정의되면 이전 버전과 호환되는 기능이 제공됩니다.

버전 3.4에서 변경: NotImplementedError를 발생시키는 대신 (None, [])를 반환합니다. 가능하다면 기능을 제공하기 위해 find_spec()을 사용하십시오.

버전 3.4부터 폐지: 대신 find_spec()을 사용하십시오.

find_module(fullname)

self.find_loader(fullname)[0]과 동등한 Finder.find_module()의 구상 구현.

버전 3.4부터 폐지: 대신 find_spec()을 사용하십시오.

invalidate_caches()

호출될 때, 파인더가 사용하는 내부 캐시를 무효로 해야 하는 선택적 메서드. 모든 캐시 된 파인더의 캐시를 무효화 할 때 PathFinder.invalidate_caches()에서 사용합니다.

class importlib.abc.Loader

로더의 추상 베이스 클래스. 로더에 대한 정확한 정의는 PEP 302를 참조하십시오.

리소스 읽기를 지원하려는 로더는 importlib.abc.ResourceReader에 지정된 대로 get_resource_reader(fullname) 메서드를 구현해야 합니다.

버전 3.7에서 변경: 선택적 get_resource_reader() 메서드를 도입했습니다.

create_module(spec)

모듈을 임포트 할 때 사용할 모듈 객체를 반환하는 메서드. 이 메서드는 None을 반환해서 기본 모듈 생성 시맨틱이 적용되어야 함을 나타낼 수 있습니다.

버전 3.4에 추가.

버전 3.5에서 변경: 파이썬 3.6부터는, exec_module()이 정의될 때 이 메서드는 선택 사항이 아닙니다.

exec_module(module)

모듈을 임포트 하거나 다시 로드할 때 자체 이름 공간에서 모듈을 실행하는 추상 메서드. exec_module()이 호출될 때 모듈이 이미 초기화되어 있어야 합니다. 이 메서드가 존재하면, create_module()을 정의해야 합니다.

버전 3.4에 추가.

버전 3.6에서 변경: create_module()도 정의해야 합니다.

load_module(fullname)

모듈을 로드하는 레거시 메서드. 모듈을 로드할 수 없으면, ImportError가 발생하고, 그렇지 않으면 로드된 모듈이 반환됩니다.

요청된 모듈이 sys.modules에 이미 존재하면, 해당 모듈이 사용되고 다시 로드되어야 합니다. 그렇지 않으면 로더는 임포트에서 재귀를 방지하기 위해 로드를 시작하기 전에 새 모듈을 만들어 sys.modules에 삽입해야 합니다. 로더가 모듈을 삽입했는데 로드에 실패하면, 로더가 sys.modules에서 모듈을 제거해야 합니다; 로더가 실행을 시작하기 전에 이미 sys.modules에 있었던 모듈은 그대로 두어야 합니다 (importlib.util.module_for_loader()를 참조하십시오).

로더는 모듈에서 여러 어트리뷰트를 설정해야 합니다. (이러한 어트리뷰트 중 일부는 모듈을 다시 로드할 때 변경될 수 있습니다):

  • __name__

    모듈의 이름

  • __file__

    모듈 데이터가 저장되는 경로입니다 (내장 모듈에는 설정되지 않습니다).

  • __cached__

    모듈의 컴파일 된 버전이 저장되는/저장되어야 하는 경로 (어트리뷰트가 부적절하면 설정되지 않습니다).

  • __path__

    패키지 내에서 검색 경로를 지정하는 문자열 리스트. 이 어트리뷰트는 모듈에는 설정되지 않습니다.

  • __package__

    모듈이 서브 모듈로 로드된 패키지의 완전히 정규화된 이름 (또는 최상위 수준 모듈의 경우 빈 문자열). 패키지의 경우, __name__과 같습니다. importlib.util.module_for_loader() 데코레이터는 __package__의 세부 사항을 처리할 수 있습니다.

  • __loader__

    모듈을 로드하는 데 사용되는 로더. importlib.util.module_for_loader() 데코레이터는 __package__의 세부 사항을 처리 할 수 있습니다.

exec_module()을 사용할 수 있으면 이전 버전과 호환되는 기능이 제공됩니다.

버전 3.4에서 변경: 호출될 때 NotImplementedError 대신 ImportError를 발생시킵니다. exec_module()을 사용할 수 있을 때 제공되는 기능.

버전 3.4부터 폐지: 모듈 로드에 권장되는 API는 exec_module()(및 create_module())입니다. 로더는 load_module() 대신 이것을 구현해야 합니다. 임포트 절차는 exec_module()이 구현될 때 load_module()의 다른 모든 책임을 처리합니다.

module_repr(module)

구현될 때 지정된 모듈의 repr을 문자열로 계산하고 반환하는 레거시 메서드. 모듈 형의 기본 repr()은 이 메서드의 결과를 적절하게 사용합니다.

버전 3.3에 추가.

버전 3.4에서 변경: abstractmethod 대신에 선택 사항으로 만들어졌습니다.

버전 3.4부터 폐지: 임포트 절차는 이제 이것을 자동으로 처리합니다.

class importlib.abc.ResourceReader

Superseded by TraversableResources

리소스(resources)를 읽을 수 있는 기능을 제공하는 추상 베이스 클래스.

이 ABC의 관점에서, 리소스(resource)는 패키지 내에 제공되는 바이너리 아티팩트(artifact)입니다. 일반적으로 이것은 패키지의 __init__.py 파일 옆에 있는 데이터 파일 같은 것입니다. 이 클래스의 목적은 이러한 데이터 파일에 대한 액세스를 추상화하여 패키지와 해당 데이터 파일이 예를 들어 zip 파일에 있는지 파일 시스템에 저장되어 있는지가 중요하지 않도록 만드는 것입니다.

이 클래스의 모든 메서드에서, resource 인자는 개념적으로 단지 파일 이름을 나타내는 경로류 객체가 될 것으로 기대됩니다. 이는 resource 인자에 서브 디렉터리 경로가 포함되지 않아야 함을 의미합니다. 판독기(reader)가 읽으려는 패키지의 위치가 “디렉터리”의 역할을 하기 때문입니다. 따라서 디렉터리와 파일 이름에 대한 은유는 각각 패키지와 리소스입니다. 이것은 또한 이 클래스의 인스턴스가 (잠재적으로 여러 패키지나 모듈을 나타내는 대신) 특정 패키지와 직접적으로 연관될 것으로 기대되는 이유입니다.

리소스 읽기를 지원하려는 로더는 이 ABC의 인터페이스를 구현하는 객체를 반환하는 get_resource_reader(fullname)이라는 메서드를 제공해야 합니다. fullname으로 지정된 모듈이 패키지가 아니면, 이 메서드는 None을 반환해야 합니다. 이 ABC와 호환되는 객체는 지정된 모듈이 패키지일 때만 반환해야 합니다.

버전 3.7에 추가.

abstractmethod open_resource(resource)

resource의 바이너리 읽기를 위해 열린 파일류 객체를 반환합니다.

리소스를 찾을 수 없으면, FileNotFoundError 가 발생합니다.

abstractmethod resource_path(resource)

resource에 대한 파일 시스템 경로를 반환합니다.

리소스가 파일 시스템에 구체적으로 존재하지 않으면, FileNotFoundError 가 발생합니다.

abstractmethod is_resource(name)

명명된 name을 리소스로 간주하면 True를 반환합니다. name이 없으면, FileNotFoundError 가 발생합니다.

abstractmethod contents()

패키지 내용에 대한 문자열의 이터러블을 반환합니다. 이터레이터가 반환한 모든 이름이 실제 리소스일 필요는 없음에 유의하십시오, 예를 들어 is_resource()가 거짓인 이름을 반환하는 것이 허용됩니다.

리소스가 아닌 이름이 반환되도록 하는 것은 패키지와 그것의 리소스가 저장되는 방법이 사전에 알려졌고 리소스가 아닌 이름이 유용한 상황을 허용하기 위함입니다. 예를 들어, 패키지와 리소스가 파일 시스템에 저장되어있는 것으로 알려졌을 때 해당 서브 디렉터리 이름을 직접 사용할 수 있도록 서브 디렉터리 이름 반환이 허용됩니다.

추상 메서드는 항목이 없는 이터러블을 반환합니다.

class importlib.abc.ResourceLoader

스토리지 백 엔드에서 임의의 리소스를 로드하기 위한 선택적 PEP 302 프로토콜을 구현하는 로더의 추상 베이스 클래스.

버전 3.7부터 폐지: 이 ABC는 폐지되었고 importlib.abc.ResourceReader를 통한 리소스 로드 지원으로 대체되었습니다.

abstractmethod get_data(path)

path에 있는 데이터를 바이트열로 반환하는 추상 메서드. 임의의 데이터를 저장할 수 있는 파일류 스토리지 백 엔드가 있는 로더는 이 추상 메서드를 구현하여 저장된 데이터에 직접 액세스하도록 할 수 있습니다. path를 찾을 수 없으면 OSError가 발생합니다. path는 모듈의 __file__ 어트리뷰트나 패키지의 __path__에서 온 항목을 사용하여 구성될 것으로 기대됩니다.

버전 3.4에서 변경: NotImplementedError 대신 OSError를 발생시킵니다.

class importlib.abc.InspectLoader

모듈을 검사(inspect)하는 로더를 위한 선택적 PEP 302 프로토콜을 구현하는 로더의 추상 베이스 클래스.

get_code(fullname)

모듈에 대한 코드 객체나, 모듈에 코드 객체가 없으면 (예를 들어, 내장 모듈이 이런 경우입니다) None을 반환합니다. 로더가 요청한 모듈을 찾을 수 없으면 ImportError가 발생합니다.

참고

이 메서드에는 기본 구현이 있지만, 가능하다면 성능을 위해 재정의하는 것이 좋습니다.

버전 3.4에서 변경: 더는 추상적이지 않고 구상 구현이 제공됩니다.

abstractmethod get_source(fullname)

모듈의 소스를 반환하는 추상 메서드. 인식된 모든 줄 구분자를 '\n' 문자로 변환하는 유니버설 줄 넘김을 사용하여 텍스트 문자열로 반환됩니다. 사용 가능한 소스가 없으면 (예를 들어, 내장 모듈) None을 반환합니다. 로더가 지정된 모듈을 찾을 수 없으면 ImportError를 발생시킵니다.

버전 3.4에서 변경: NotImplementedError 대신 ImportError를 발생시킵니다.

is_package(fullname)

An optional method to return a true value if the module is a package, a false value otherwise. ImportError is raised if the loader cannot find the module.

버전 3.4에서 변경: NotImplementedError 대신 ImportError를 발생시킵니다.

static source_to_code(data, path='<string>')

파이썬 소스에서 코드 객체를 만듭니다.

data 인자는 compile() 함수가 지원하는 것은 무엇이든 될 수 있습니다 (즉 문자열이나 바이트열). path 인자는 소스 코드가 온 곳의 “경로”여야 하며, 추상 개념(예를 들어 zip 파일에서의 위치)일 수 있습니다.

후속 코드 객체를 사용하면 exec(code, module.__dict__)를 실행하여 그 코드를 모듈에서 실행할 수 있습니다.

버전 3.4에 추가.

버전 3.5에서 변경: 메서드를 정적(static)으로 만들었습니다.

exec_module(module)

Loader.exec_module()의 구현.

버전 3.4에 추가.

load_module(fullname)

Loader.load_module()의 구현.

버전 3.4부터 폐지: 대신 exec_module()을 사용하십시오.

class importlib.abc.ExecutionLoader

구현될 때, 모듈이 스크립트로 실행되도록 돕는 InspectLoader에서 상속되는 추상 베이스 클래스. ABC는 선택적 PEP 302 프로토콜을 표현합니다.

abstractmethod get_filename(fullname)

지정된 모듈의 __file__ 값을 반환하는 추상 메서드. 사용 가능한 경로가 없으면 ImportError가 발생합니다.

소스 코드를 사용할 수 있으면, 메서드는 모듈을 로드하는 데 바이트 코드를 사용했는지와 관계없이 소스 파일의 경로를 반환해야 합니다.

버전 3.4에서 변경: NotImplementedError 대신 ImportError를 발생시킵니다.

class importlib.abc.FileLoader(fullname, path)

ResourceLoader와 ExecutionLoader를 상속하고 ResourceLoader.get_data()와 ExecutionLoader.get_filename()의 구상 구현을 제공하는 추상 베이스 클래스.

fullname 인자는 로더가 처리해야 하는 모듈의 완전히 결정된(resolved) 이름입니다. path 인자는 모듈의 파일 경로입니다.

버전 3.3에 추가.

name

로더가 처리할 수 있는 모듈의 이름.

path

모듈 파일의 경로.

load_module(fullname)

super의 load_module()을 호출합니다.

버전 3.4부터 폐지: 대신 Loader.exec_module()을 사용하십시오.

abstractmethod get_filename(fullname)

path를 반환합니다.

abstractmethod get_data(path)

path를 바이너리 파일로 읽고 그것의 바이트열을 반환합니다.

class importlib.abc.SourceLoader

소스 (및 선택적으로 바이트 코드) 파일 로드를 구현하기 위한 추상 베이스 클래스. 이 클래스는 ResourceLoader와 ExecutionLoader를 모두 상속하며, 다음을 구현해야 합니다:

이 클래스에 의해 정의된 추상 메서드는 선택적 바이트 코드 파일 지원을 추가하는 것입니다. 이러한 선택적 메서드를 구현하지 않으면 (또는 그들이 NotImplementedError를 발생시키도록 하면) 로더가 소스 코드에 대해서만 작동하도록 만듭니다. 메서드를 구현하면 로더가 소스*와* 바이트 코드 파일 모두에 대해 작동하게 할 수 있습니다; 바이트 코드만 제공되는 소스 없는 로드는 허용하지 않습니다. 바이트 코드 파일은 파이썬 컴파일러의 구문 분석 단계를 제거하여 로딩 속도를 높이기 위한 최적화라서, 바이트 코드 전용 API는 노출되지 않습니다.

path_stats(path)

지정된 경로에 대한 메타 데이터를 포함하는 dict를 반환하는 선택적 추상 메서드. 지원되는 딕셔너리 키는 다음과 같습니다:

  • 'mtime' (필수): 소스 코드의 수정 시간을 나타내는 정수나 부동 소수점 숫자;

  • 'size' (선택): 바이트 단위의 소스 코드의 크기.

향후 확장을 위해, 딕셔너리의 다른 키는 무시됩니다. 경로를 처리할 수 없으면, OSError가 발생합니다.

버전 3.3에 추가.

버전 3.4에서 변경: NotImplementedError 대신 OSError를 발생시킵니다.

path_mtime(path)

지정된 경로의 수정 시간을 반환하는 선택적 추상 메서드.

버전 3.3부터 폐지: 이 메서드는 폐지되었고 path_stats()로 대체되었습니다. 구현할 필요는 없지만, 호환성을 위해 여전히 제공됩니다. 경로를 처리할 수 없으면 OSError를 발생시킵니다.

버전 3.4에서 변경: NotImplementedError 대신 OSError를 발생시킵니다.

set_data(path, data)

지정된 바이트열을 파일 경로에 쓰는 선택적 추상 메서드. 존재하지 않는 중간 디렉터리는 자동으로 만들어집니다.

경로가 읽기 전용(errno.EACCES/PermissionError)이라서 경로에 쓰지 못할 때 예외를 전파하지 않습니다.

버전 3.4에서 변경: 호출할 때 더는 NotImplementedError를 발생시키지 않습니다.

get_code(fullname)

InspectLoader.get_code()의 구상 구현.

exec_module(module)

Loader.exec_module()의 구상 구현.

버전 3.4에 추가.

load_module(fullname)

Loader.load_module()의 구상 구현.

버전 3.4부터 폐지: 대신 exec_module()을 사용하십시오.

get_source(fullname)

InspectLoader.get_source()의 구상 구현.

is_package(fullname)

InspectLoader.is_package()의 구상 구현. (ExecutionLoader.get_filename()에서 제공되는) 파일 경로가 파일 확장자를 제거했을 때 __init__라는 이름의 파일이고 동시에 모듈 이름 자체가 __init__로 끝나지 않으면 모듈은 패키지로 결정됩니다.

class importlib.abc.Traversable

디렉터리를 탐색하고 파일을 여는 데 적합한 pathlib.Path 메서드의 부분집합이 있는 객체.

버전 3.9에 추가.

abstractmethod name()

The base name of this object without any parent references.

abstractmethod iterdir()

Yield Traversable objects in self.

abstractmethod is_dir()

Return True if self is a directory.

abstractmethod is_file()

Return True if self is a file.

abstractmethod joinpath(child)

Return Traversable child in self.

abstractmethod __truediv__(child)

Return Traversable child in self.

abstractmethod open(mode='r', *args, **kwargs)

mode may be ‘r’ or ‘rb’ to open as text or binary. Return a handle suitable for reading (same as pathlib.Path.open).

When opening as text, accepts encoding parameters such as those accepted by io.TextIOWrapper.

read_bytes()

Read contents of self as bytes.

read_text(encoding=None)

Read contents of self as text.

Note: In Python 3.11 and later, this class is found in importlib.resources.abc.

class importlib.abc.TraversableResources

files 인터페이스를 제공할 수 있는 리소스 리더를 위한 추상 베이스 클래스. ResourceReader를 서브 클래싱하고 ResourceReader의 추상 메서드의 구상 구현을 제공합니다. 따라서, TraversableReader를 제공하는 모든 로더는 ResourceReader도 제공합니다.

버전 3.9에 추가.

Note: In Python 3.11 and later, this class is found in importlib.resources.abc.

importlib.resources – 리소스

소스 코드: Lib/importlib/resources.py

버전 3.7에 추가.

이 모듈은 파이썬의 임포트 시스템을 활용하여 패키지(packages) 안에 있는 리소스(resources)에 대한 액세스를 제공합니다. 패키지를 임포트 할 수 있으면, 해당 패키지 내의 리소스에 액세스 할 수 있습니다. 바이너리나 텍스트 모드로 리소스를 열거나 읽을 수 있습니다.

리소스는 디렉터리 내의 파일과 거의 비슷하지만, 이것은 단지 은유라는 점을 명심해야 합니다. 리소스와 패키지가 파일 시스템에 실제 파일과 디렉터리로 존재할 필요는 없습니다.

참고

이 모듈은 pkg_resources Basic Resource Access와 유사한 기능을 제공합니다만, 이 패키지의 성능 오버헤드가 없습니다. 이는 더 안정적이고 일관된 의미론으로, 패키지에 포함된 리소스를 더 쉽게 읽을 수 있도록 합니다.

이 모듈의 독립형 역 이식은 using importlib.resources와 migrating from pkg_resources to importlib.resources에서 자세한 정보를 제공합니다.

리소스 읽기를 지원하려는 로더는 importlib.abc.ResourceReader에 지정된 대로 get_resource_reader(fullname) 메서드를 구현해야 합니다.

다음과 같은 형이 정의됩니다.

importlib.resources.Package

Package 형은 Union[str, ModuleType]으로 정의됩니다. 이는 함수가 Package를 받아들인다고 설명하는 위치에 문자열이나 모듈을 전달할 수 있음을 의미합니다. 모듈 객체는 None이 아닌 해석할 수 있는 __spec__.submodule_search_locations를 가져야 합니다.

importlib.resources.Resource

이 형은 이 패키지의 다양한 함수에 전달된 리소스 이름을 기술합니다. 이것은 Union[str, os.PathLike]으로 정의됩니다.

다음과 같은 함수를 사용할 수 있습니다.

importlib.resources.files(package)

Returns an importlib.abc.Traversable object representing the resource container for the package (think directory) and its resources (think files). A Traversable may contain other containers (think subdirectories).

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다.

버전 3.9에 추가.

importlib.resources.as_file(traversable)

Given a importlib.abc.Traversable object representing a file, typically from importlib.resources.files(), return a context manager for use in a with statement. The context manager provides a pathlib.Path object.

컨텍스트 관리자를 종료하면 예를 들어 zip 파일에서 리소스가 추출될 때 만들어진 임시 파일이 정리됩니다.

Traversable 메서드(read_text 등)가 충분하지 않고 파일 시스템의 실제 파일이 필요하면 as_file을 사용하십시오.

버전 3.9에 추가.

importlib.resources.open_binary(package, resource)

package 내에서 resource를 바이너리 읽기로 엽니다.

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다. resource는 package 내에서 열 리소스의 이름입니다; 경로 구분 기호를 포함하지 않아야 하고 서브 리소스를 가질 수도 없습니다 (즉, 디렉터리가 될 수 없습니다). 이 함수는 읽기 위해 열린 바이너리 I/O 스트림인 typing.BinaryIO 인스턴스를 반환합니다.

importlib.resources.open_text(package, resource, encoding='utf-8', errors='strict')

package 내에서 resource를 텍스트 읽기로 엽니다. 기본적으로, 리소스는 UTF-8로 읽도록 열립니다.

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다. resource는 package 내에서 열 리소스의 이름입니다; 경로 구분 기호를 포함하지 않아야 하고 서브 리소스를 가질 수도 없습니다 (즉, 디렉터리가 될 수 없습니다). encoding과 errors는 내장 open()과 같은 의미입니다.

이 함수는 읽기 위해 열린 텍스트 I/O 스트림인 typing.TextIO 인스턴스를 반환합니다.

importlib.resources.read_binary(package, resource)

package 내에서 resource의 내용을 읽고 bytes로 반환합니다.

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다. resource는 package 내에서 열 리소스의 이름입니다; 경로 구분 기호를 포함하지 않아야 하고 서브 리소스를 가질 수도 없습니다 (즉, 디렉터리가 될 수 없습니다). 이 함수는 리소스의 내용을 bytes로 반환합니다.

importlib.resources.read_text(package, resource, encoding='utf-8', errors='strict')

package 내에서 resource의 내용을 읽고 str로 반환합니다. 기본적으로, 내용은 엄격한(strict) UTF-8로 읽습니다.

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다. resource는 package 내에서 열 리소스의 이름입니다; 경로 구분 기호를 포함하지 않아야 하고 서브 리소스를 가질 수도 없습니다 (즉, 디렉터리가 될 수 없습니다). encoding과 errors는 내장 open()과 같은 의미입니다. 이 함수는 리소스의 내용을 str로 반환합니다.

importlib.resources.path(package, resource)

resource에 대한 경로를 실제 파일 시스템 경로로 반환합니다. 이 함수는 with 문에서 사용할 컨텍스트 관리자를 반환합니다. 컨텍스트 관리자는 pathlib.Path 객체를 제공합니다.

컨텍스트 관리자를 종료하면 리소스를 예를 들어 zip 파일에서 추출해야 할 때 만들어진 임시 파일이 정리됩니다.

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다. resource는 package 내에서 열 리소스의 이름입니다; 경로 구분 기호를 포함하지 않아야 하고 서브 리소스를 가질 수도 없습니다 (즉, 디렉터리가 될 수 없습니다).

importlib.resources.is_resource(package, name)

패키지에 name이라는 리소스가 있으면 True를, 그렇지 않으면 False를 반환합니다. 디렉터리는 리소스가 아니라는 것을 기억하십시오! package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다.

importlib.resources.contents(package)

패키지 내에서 이름이 있는 항목에 대한 이터러블을 반환합니다. 이터러블은 str 리소스(예를 들어 파일)와 리소스가 아닌 것(예를 들어 디렉터리)을 반환합니다. 이터러블은 서브 디렉터리로 재귀하지 않습니다.

package는 Package 요구 사항을 준수하는 이름이나 모듈 객체입니다.

importlib.machinery – 임포터와 경로 훅

소스 코드: Lib/importlib/machinery.py

이 모듈에는 import가 모듈을 찾고 로드하는 데 도움이 되는 다양한 객체가 포함되어 있습니다.

importlib.machinery.SOURCE_SUFFIXES

소스 모듈로 인식되는 파일 접미사를 나타내는 문자열 리스트.

버전 3.3에 추가.

importlib.machinery.DEBUG_BYTECODE_SUFFIXES

최적화되지 않은 바이트 코드 모듈의 파일 접미사를 나타내는 문자열 리스트.

버전 3.3에 추가.

버전 3.5부터 폐지: 대신 BYTECODE_SUFFIXES를 사용하십시오.

importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

최적화된 바이트 코드 모듈의 파일 접미사를 나타내는 문자열 리스트.

버전 3.3에 추가.

버전 3.5부터 폐지: 대신 BYTECODE_SUFFIXES를 사용하십시오.

importlib.machinery.BYTECODE_SUFFIXES

바이트 코드 모듈로 인식되는 파일 접미사를 나타내는 문자열 리스트 (앞의 점을 포함합니다).

버전 3.3에 추가.

버전 3.5에서 변경: 이 값은 더는 __debug__에 의존하지 않습니다.

importlib.machinery.EXTENSION_SUFFIXES

확장 모듈로 인식되는 파일 접미사를 나타내는 문자열 리스트.

버전 3.3에 추가.

importlib.machinery.all_suffixes()

표준 임포트 절차가 인식하는 모듈의 모든 파일 접미사를 나타내는 문자열의 결합한 리스트를 반환합니다. 이것은 모듈 종류에 대한 세부 정보 없이 파일 시스템 경로가 잠재적으로 모듈을 참조하는지를 알아야 하는 코드(예를 들어, inspect.getmodulename())를 위한 도우미입니다.

버전 3.3에 추가.

class importlib.machinery.BuiltinImporter

내장 모듈용 임포터. 알려진 모든 내장 모듈은 sys.builtin_module_names에 나열되어 있습니다. 이 클래스는 importlib.abc.MetaPathFinder와 importlib.abc.InspectLoader ABC를 구현합니다.

이 클래스는 인스턴스 화의 필요성을 완화하기 위해 클래스 메서드만 정의합니다.

버전 3.5에서 변경: PEP 489의 일부로, 내장 임포터는 이제 Loader.create_module()과 Loader.exec_module()을 구현합니다.

class importlib.machinery.FrozenImporter

프로즌(frozen) 모듈용 임포터. 이 클래스는 importlib.abc.MetaPathFinder와 importlib.abc.InspectLoader ABC를 구현합니다.

이 클래스는 인스턴스 화의 필요성을 완화하기 위해 클래스 메서드만 정의합니다.

버전 3.4에서 변경: Loader.create_module()과 Loader.exec_module() 메서드를 얻었습니다.

class importlib.machinery.WindowsRegistryFinder

윈도우 레지스트리에 선언된 모듈용 파인더. 이 클래스는 importlib.abc.MetaPathFinder ABC를 구현합니다.

이 클래스는 인스턴스 화의 필요성을 완화하기 위해 클래스 메서드만 정의합니다.

버전 3.3에 추가.

버전 3.6부터 폐지: 대신 site 구성을 사용하십시오. 이후 버전의 파이썬은 기본적으로 이 파인더를 활성화하지 않을 수 있습니다.

class importlib.machinery.PathFinder

sys.path와 패키지 __path__ 어트리뷰트용 파인더. 이 클래스는 importlib.abc.MetaPathFinder ABC를 구현합니다.

이 클래스는 인스턴스 화의 필요성을 완화하기 위해 클래스 메서드만 정의합니다.

classmethod find_spec(fullname, path=None, target=None)

sys.path 또는, 정의되었다면, path에서 fullname에 의해 지정된 모듈에 대한 스펙을 찾으려고 시도하는 클래스 메서드. 검색된 각 경로 엔트리에 대해, sys.path_importer_cache가 확인됩니다. 거짓이 아닌 객체를 찾으면 검색 중인 모듈을 찾기 위한 경로 엔트리 파인더로 사용됩니다. sys.path_importer_cache에 엔트리가 없으면, sys.path_hooks에서 경로 엔트리를 위한 파인더를 검색하고, 발견되면, 모듈에 대해 조회되는 것과 동시에 sys.path_importer_cache에 저장됩니다. 파인더가 아예 발견되지 않으면 None이 캐시에 저장되고 반환됩니다.

버전 3.4에 추가.

버전 3.5에서 변경: 현재 작업 디렉터리 – 빈 문자열로 표현됩니다 – 가 더는 유효하지 않으면 None이 반환되지만 sys.path_importer_cache에 값이 캐시 되지는 않습니다.

classmethod find_module(fullname, path=None)

find_spec()을 감싸는 레거시 래퍼.

버전 3.4부터 폐지: 대신 find_spec()을 사용하십시오.

classmethod invalidate_caches()

메서드를 정의하는 sys.path_importer_cache에 저장된 모든 파인더에 대해 importlib.abc.PathEntryFinder.invalidate_caches()를 호출합니다. sys.path_importer_cache에 None으로 설정된 엔트리가 삭제됩니다.

버전 3.7에서 변경: sys.path_importer_cache에서 None의 엔트리가 삭제됩니다.

버전 3.4에서 변경: ''(즉 빈 문자열)에 대해서는 현재 작업 디렉터리로 sys.path_hooks의 객체를 호출합니다.

class importlib.machinery.FileFinder(path, *loader_details)

파일 시스템에서의 결과를 캐시 하는 importlib.abc.PathEntryFinder 의 구상 구현.

path 인자는 파인더가 검색을 담당하는 디렉터리입니다.

loader_details 인자는 각각 로더와 로더가 인식하는 파일 접미사의 시퀀스를 포함하는 가변 개수의 2개 항목 튜플입니다. 로더는 모듈 이름과 찾은 파일의 경로로 구성되는 두 인자를 받아들이는 콜러블일 것으로 기대됩니다.

파인더는 필요에 따라 디렉터리 내용을 캐시 하여, 각 모듈 검색에서 stat 호출을 수행하여 캐시가 시효가 지나지 않았는지 확인합니다. 캐시 만료는 파일 시스템의 운영 체제 상태 정보의 세분성에 의존하기 때문에, 모듈 검색, 새 파일 생성 및 새 파일이 나타내는 모듈 검색의 잠재적 경쟁 조건이 있습니다. stat 호출의 세분성 이하로 연산이 아주 빠르게 수행되면, 모듈 검색이 실패합니다. 이를 방지하려면, 모듈을 동적으로 만들 때, importlib.invalidate_caches()를 호출해야 합니다.

버전 3.3에 추가.

path

파인더가 검색할 경로.

find_spec(fullname, target=None)

path 내에서 fullname을 처리할 스펙을 찾으려고 합니다.

버전 3.4에 추가.

find_loader(fullname)

path 내에서 fullname을 처리할 로더를 찾으려고 합니다.

invalidate_caches()

내부 캐시를 지웁니다.

classmethod path_hook(*loader_details)

sys.path_hooks에 사용할 클로저를 반환하는 클래스 메서드. FileFinder의 인스턴스는 클로저에 직접 제공된 경로 인자와 loader_details를 간접적으로 사용하여 클로저에 의해 반환됩니다.

클로저에 대한 인자가 기존 디렉터리가 아니면, ImportError가 발생합니다.

class importlib.machinery.SourceFileLoader(fullname, path)

importlib.abc.FileLoader를 서브 클래싱하고 다른 메서드의 구상 구현을 제공하는 importlib.abc.SourceLoader의 구상 구현.

버전 3.3에 추가.

name

이 로더가 처리할 모듈의 이름.

path

소스 파일의 경로.

is_package(fullname)

path가 패키지에 대한 것으로 드러나면 True를 반환합니다.

path_stats(path)

importlib.abc.SourceLoader.path_stats()의 구상 구현.

set_data(path, data)

importlib.abc.SourceLoader.set_data()의 구상 구현.

load_module(name=None)

로드할 모듈 이름을 지정하는 것이 선택적인 importlib.abc.Loader.load_module()의 구상 구현.

버전 3.6부터 폐지: 대신 importlib.abc.Loader.exec_module()을 사용하십시오.

class importlib.machinery.SourcelessFileLoader(fullname, path)

바이트 코드 파일을 (즉, 소스 코드 파일 없이) 임포트 할 수 있는 importlib.abc.FileLoader의 구상 구현.

바이트 코드 파일(그래서 소스 코드 파일이 아닌)을 직접 사용하면 모든 파이썬 구현이나 바이트 코드 형식을 변경하는 새 버전의 파이썬에서 모듈을 사용할 수 없게 됨에 유의하십시오.

버전 3.3에 추가.

name

로더가 처리할 모듈의 이름.

path

바이트 코드 파일의 경로.

is_package(fullname)

path를 기반으로 모듈이 패키지인지 판단합니다.

get_code(fullname)

path에서 만들어진 name의 코드 객체를 반환합니다.

get_source(fullname)

이 로더가 사용될 때는 바이트 코드 파일에 소스가 없어서 None을 반환합니다.

load_module(name=None)

로드할 모듈 이름을 지정하는 것이 선택적인 importlib.abc.Loader.load_module()의 구상 구현.

버전 3.6부터 폐지: 대신 importlib.abc.Loader.exec_module()을 사용하십시오.

class importlib.machinery.ExtensionFileLoader(fullname, path)

확장 모듈을 위한 importlib.abc.ExecutionLoader의 구상 구현.

fullname 인자는 로더가 지원할 모듈의 이름을 지정합니다. path 인자는 확장 모듈 파일의 경로입니다.

버전 3.3에 추가.

name

로더가 지원하는 모듈의 이름.

path

확장 모듈의 경로.

create_module(spec)

PEP 489에 따라 지정된 명세에서 모듈 객체를 만듭니다.

버전 3.5에 추가.

exec_module(module)

PEP 489에 따라 주어진 모듈 객체를 초기화합니다.

버전 3.5에 추가.

is_package(fullname)

EXTENSION_SUFFIXES에 기반해서 파일 경로가 패키지의 __init__ 모듈을 가리키면 True를 반환합니다.

get_code(fullname)

확장 모듈에는 코드 객체가 없어서 None을 반환합니다.

get_source(fullname)

확장 모듈에는 소스 코드가 없어서 None을 반환합니다.

get_filename(fullname)

path를 반환합니다.

버전 3.4에 추가.

class importlib.machinery.ModuleSpec(name, loader, *, origin=None, loader_state=None, is_package=None)

모듈의 임포트 시스템 관련 상태에 대한 명세. 이것은 일반적으로 모듈의 __spec__ 어트리뷰트로 노출됩니다. 아래 설명에서, 괄호 안의 이름은 모듈 객체에서 직접 사용 가능한 해당 어트리뷰트를 제공합니다. 예를 들어: module.__spec__.origin == module.__file__. 그러나 values는 일반적으로 동등하지만, 두 객체 간에 동기화가 없기 때문에 다를 수 있음에 유의하십시오. 따라서 실행 시간에 모듈의 __path__를 갱신할 수 있으며, 이는 __spec__.submodule_search_locations에 자동으로 반영되지 않습니다.

버전 3.4에 추가.

name

(__name__)

정규화된 모듈 이름의 문자열.

loader

(__loader__)

모듈을 로드할 때 사용해야 하는 로더. 파인더는 항상 이것을 설정해야 합니다.

origin

(__file__)

모듈이 로드된 장소의 이름, 예를 들어, 내장 모듈의 경우 “builtin”이고 소스에서 로드한 모듈의 경우 파일명. 일반적으로 “origin”을 설정해야 하지만, 지정되지 않았음을 나타내는 None(기본값)일 수 있습니다 (예를 들어 이름 공간 패키지).

submodule_search_locations

(__path__)

패키지이면, 서브 모듈을 찾을 수 있는 문자열 리스트 (그렇지 않으면 None).

loader_state

로드 중 사용하기 위한 추가 모듈 특정 데이터의 컨테이너 (또는 None).

cached

(__cached__)

컴파일된 모듈을 저장해야 하는 장소의 문자열 (또는 None).

parent

(__package__)

(읽기 전용) 모듈이 서브 모듈로 로드되어야 하는 패키지의 정규화된 이름 (또는 최상위 수준 모듈의 경우 빈 문자열). 패키지의 경우, __name__과 같습니다.

has_location

모듈의 “origin” 어트리뷰트가 로드 가능한 위치를 나타내는지를 나타내는 불리언.

importlib.util – 임포터를 위한 유틸리티 코드

소스 코드: Lib/importlib/util.py

이 모듈에는 임포터 구성에 도움이 되는 다양한 객체가 포함되어 있습니다.

importlib.util.MAGIC_NUMBER

바이트 코드 버전 번호를 나타내는 바이트열. 바이트 코드의 로드/쓰기에 도움이 필요하면 importlib.abc.SourceLoader를 고려하십시오.

버전 3.4에 추가.

importlib.util.cache_from_source(path, debug_override=None, *, optimization=None)

소스 path와 연관된 바이트 컴파일된 파일의 PEP 3147/PEP 488 경로를 반환합니다. 예를 들어, path가 /foo/bar/baz.py이면 반환값은 파이썬 3.2의 경우 /foo/bar/__pycache__/baz.cpython-32.pyc입니다. cpython-32 문자열은 현재 매직 태그에서 온 것입니다 (get_tag()를 참조하십시오; sys.implementation.cache_tag가 정의되지 않으면 NotImplementedError 가 발생합니다).

optimization 매개 변수는 바이트 코드 파일의 최적화 수준을 지정하는 데 사용됩니다. 빈 문자열은 최적화하지 않음을 나타내므로, optimization이 '' 인 /foo/bar/baz.py는 바이트 코드 경로가 /foo/bar/__pycache__/baz.cpython-32.pyc가 됩니다. None은 인터프리터의 최적화 수준이 사용되도록 합니다. 다른 값의 문자열 표현은 사용되므로, optimization이 2인 /foo/bar/baz.py는 바이트 코드 경로가 /foo/bar/__pycache__/baz.cpython-32.opt-2.pyc가 됩니다. optimization의 문자열 표현은 영숫자만 가능하며, 그렇지 않으면 ValueError가 발생합니다.

debug_override 매개 변수는 폐지되었고 __debug__의 시스템값을 대체하는 데 사용할 수 있습니다. True 값은 optimization을 빈 문자열로 설정하는 것과 등등합니다. False 값은 optimization을 1로 설정하는 것과 같습니다. debug_override와 optimization이 모두 None이 아니면 TypeError가 발생합니다.

버전 3.4에 추가.

버전 3.5에서 변경: optimization 매개 변수가 추가되었고 debug_override 매개 변수는 폐지되었습니다.

버전 3.6에서 변경: 경로류 객체를 받아들입니다.

importlib.util.source_from_cache(path)

path에 PEP 3147 파일 이름이 주어지면, 연관된 소스 코드 파일 경로를 반환합니다. 예를 들어, path가 /foo/bar/__pycache__/baz.cpython-32.pyc이면 반환된 경로는 /foo/bar/baz.py입니다. path는 존재할 필요는 없지만, PEP 3147이나 PEP 488 형식을 준수하지 않으면, ValueError가 발생합니다. sys.implementation.cache_tag가 정의되지 않으면, NotImplementedError 가 발생합니다.

버전 3.4에 추가.

버전 3.6에서 변경: 경로류 객체를 받아들입니다.

importlib.util.decode_source(source_bytes)

소스 코드를 나타내는 주어진 바이트열을 디코딩하고 유니버설 줄 넘김이 적용된 문자열로 반환합니다 (importlib.abc.InspectLoader.get_source()에 필요한 대로).

버전 3.4에 추가.

importlib.util.resolve_name(name, package)

상대 모듈 이름을 절대 이름으로 결정합니다.

name 선두에 점이 없으면, name이 단순히 반환됩니다. 이를 통해 package 인자가 필요한지 확인하지 않고 importlib.util.resolve_name('sys', __spec__.parent)와 같은 사용이 가능합니다.

name이 상대 모듈 이름이지만 package가 거짓 값(예를 들어 None이나 빈 문자열)이면 ImportError가 발생합니다. ImportError는 또한 상대 이름이 그것을 포함하는 패키지를 벗어날 것 같으면 발생합니다 (예를 들어 spam 패키지 내에서 ..bacon을 요청하는 것).

버전 3.3에 추가.

버전 3.9에서 변경: import 문과의 일관성을 개선하기 위해, 잘못된 상대 임포트 시도에 대해 ValueError 대신 ImportError를 발생시킵니다.

importlib.util.find_spec(name, package=None)

선택적으로 지정된 package 이름에 상대적으로, 모듈의 스펙을 찾습니다. 모듈이 sys.modules에 있으면, sys.modules[name].__spec__이 반환됩니다 (스펙이 None이 되거나 설정되지 않지 않은 한, 그럴 경우는 ValueError가 발생합니다). 그렇지 않으면 sys.meta_path를 사용한 검색이 수행됩니다. 스펙을 찾지 못하면 None이 반환됩니다.

name이 서브 모듈에 관한 것이면 (점을 포함하면), 부모 모듈은 자동으로 임포트 됩니다.

name과 package는 import_module()과 같게 작동합니다.

버전 3.4에 추가.

버전 3.7에서 변경: package가 실제로 패키지가 아니면 (즉 __path__ 어트리뷰트가 없으면) AttributeError 대신 ModuleNotFoundError를 발생시킵니다.

importlib.util.module_from_spec(spec)

spec과 spec.loader.create_module을 기반으로 새 모듈을 만듭니다.

spec.loader.create_module이 None을 반환하지 않으면, 어떤 기존 어트리뷰트도 재설정되지 않습니다. 또한 spec에 액세스하거나 모듈에서 어트리뷰트를 설정하는 동안 트리거 되면 AttributeError가 발생하지 않습니다.

spec은 모듈에서 가능한 많은 임포트 제어 어트리뷰트를 설정하는 데 사용되므로 새 모듈을 작성하는 데 types.ModuleType을 사용하는 것보다 이 함수가 선호됩니다.

버전 3.5에 추가.

@importlib.util.module_for_loader

로드할 적절한 모듈 객체 선택을 처리하기 위한 importlib.abc.Loader.load_module() 용 데코레이터. 데코레이팅 된 메서드에는 두 개의 위치 인자를 취하는 호출 서명을 가질 것으로 기대됩니다 (예를 들어 load_module(self, module)), 두 번째 인자는 로더가 사용할 모듈 객체입니다. 데코레이터는 두 개의 인자를 가정하기 때문에 정적 메서드에서 작동하지 않음에 유의하십시오.

데코레이팅 된 메서드는 로더에 대해 로드될 모듈 이름을 취합니다. sys.modules에 모듈이 없으면 새로운 모듈이 구성됩니다. 모듈의 출처와 관계없이, __loader__는 self로 설정되고 __package__는 importlib.abc.InspectLoader.is_package()가 반환하는 것에 따라 설정됩니다 (사용 가능하다면). 이러한 어트리뷰트는 재로드를 지원하도록 무조건 설정됩니다.

데코레이트 된 메서드가 예외를 발생시키고 sys.modules에 모듈이 추가되었으면, 부분적으로 초기화된 모듈이 sys.modules에 남아 있지 않도록 모듈이 제거됩니다. 모듈이 이미 sys.modules에 있었다면 모듈은 그대로 유지됩니다.

버전 3.3에서 변경: __loader__와 __package__는 자동으로 설정됩니다 (가능하면).

버전 3.4에서 변경: 재로드를 지원하기 위해 __name__, __loader__ __package__를 무조건 설정합니다.

버전 3.4부터 폐지: 임포트 절차는 이제 이 함수가 제공하는 모든 기능을 직접 수행합니다.

@importlib.util.set_loader

반환된 모듈에서 __loader__ 어트리뷰트를 설정하기 위한 importlib.abc.Loader.load_module() 용 데코레이터. 어트리뷰트가 이미 설정되어 있으면 데코레이터는 아무것도 하지 않습니다. 래핑 된 메서드에 대한 첫 번째 위치 인자(즉, self)가 __loader__가 설정되어야 하는 것으로 가정합니다.

버전 3.4에서 변경: 어트리뷰트가 존재하지 않는 것처럼, None으로 설정되었으면 __loader__를 설정합니다.

버전 3.4부터 폐지: 임포트 절차는 이것을 자동으로 처리합니다.

@importlib.util.set_package

반환된 모듈에서 __package__ 어트리뷰트를 설정하기 위한 importlib.abc.Loader.load_module() 용 데코레이터. __package__가 설정되었고 None 이외의 값을 가지면 변경되지 않습니다.

버전 3.4부터 폐지: 임포트 절차는 이것을 자동으로 처리합니다.

importlib.util.spec_from_loader(name, loader, *, origin=None, is_package=None)

로더(loader)를 기반으로 ModuleSpec 인스턴스를 만들기 위한 팩토리 함수. 매개 변수는 ModuleSpec에서와 같은 의미입니다. 이 함수는 InspectLoader.is_package()와 같은 사용 가능한 로더 API를 사용하여 스펙에 빠진 정보를 채웁니다.

버전 3.4에 추가.

importlib.util.spec_from_file_location(name, location, *, loader=None, submodule_search_locations=None)

파일 경로를 기반으로 ModuleSpec 인스턴스를 만드는 팩토리 함수. 로더 API를 사용하고 모듈이 파일 기반일 것이라는 것이 뜻하는 것으로 누락된 정보가 스펙에 채워집니다.

버전 3.4에 추가.

버전 3.6에서 변경: 경로류 객체를 받아들입니다.

importlib.util.source_hash(source_bytes)

source_bytes의 해시를 바이트열로 반환합니다. 해시 기반 .pyc 파일은 해당 소스 파일 내용의 source_hash()를 헤더에 포함합니다.

버전 3.7에 추가.

class importlib.util.LazyLoader(loader)

모듈이 어트리뷰트에 액세스할 때까지 모듈 로더의 실행을 연기하는 클래스.

이 클래스는 필요한 모듈 형에 대한 제어로 exec_module()을 정의하는 로더**에서만** 작동합니다. 같은 이유로, 로더의 create_module() 메서드는 None을 반환하거나, 슬롯을 사용하지 않고 __class__ 어트리뷰트가 변경될 수 있는 형을 반환해야 합니다. 마지막으로, sys.modules에 배치된 객체를 치환하는 모듈은 인터프리터 전체에서 모듈 참조를 안전하게 대체할 방법이 없어서 작동하지 않습니다; 이러한 치환이 감지되면 ValueError가 발생합니다.

참고

시작 시간이 중요한 프로젝트의 경우, 이 클래스를 사용하면 사용하지 않을 모듈을 로드하는 데 드는 비용을 최소화할 수 있습니다. 시작 시간이 핵심이 아닌 프로젝트의 경우 로딩이 지연되는 동안 만들어진, 따라서 문맥을 벗어난 에러 메시지 때문에, 이 클래스를 사용하지 말 것을 강하게 권고합니다.

버전 3.5에 추가.

버전 3.6에서 변경: importlib.machinery.BuiltinImporter와 importlib.machinery.ExtensionFileLoader 에 대한 호환성 경고를 제거하고, create_module()을 호출하기 시작했습니다.

classmethod factory(loader)

지연된 로더(lazy loader)를 만드는 콜러블을 반환하는 정적 메서드. 이것은 로더가 인스턴스가 아닌 클래스로 전달되는 상황에서 사용하려는 것입니다.

suffixes = importlib.machinery.SOURCE_SUFFIXES
loader = importlib.machinery.SourceFileLoader
lazy_loader = importlib.util.LazyLoader.factory(loader)
finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))

예

프로그래밍 방식으로 임포트 하기

프로그래밍 방식으로 모듈을 임포트 하려면, importlib.import_module()을 사용하십시오.

import importlib

itertools = importlib.import_module('itertools')

모듈을 임포트 할 수 있는지 확인하기

실제로 임포트를 수행하지 않고 모듈을 임포트 할 수 있는지 확인해야 하면, importlib.util.find_spec()을 사용해야 합니다.

import importlib.util
import sys

# For illustrative purposes.
name = 'itertools'

if name in sys.modules:
    print(f"{name!r} already in sys.modules")
elif (spec := importlib.util.find_spec(name)) is not None:
    # If you chose to perform the actual import ...
    module = importlib.util.module_from_spec(spec)
    sys.modules[name] = module
    spec.loader.exec_module(module)
    print(f"{name!r} has been imported")
else:
    print(f"can't find the {name!r} module")

소스 파일을 직접 임포트 하기

파이썬 소스 파일을 직접 임포트 하려면, 다음 조리법을 사용하십시오 (파이썬 3.5 이상):

import importlib.util
import sys

# For illustrative purposes.
import tokenize
file_path = tokenize.__file__
module_name = tokenize.__name__

spec = importlib.util.spec_from_file_location(module_name, file_path)
module = importlib.util.module_from_spec(spec)
sys.modules[module_name] = module
spec.loader.exec_module(module)

임포터 설정하기

임포트의 심층 사용자 정의를 위해서는, 일반적으로 임포터를 구현하려고 합니다. 이는 파인더와 로더 측면을 모두 관리한다는 의미입니다. 파인더에는 필요에 따라 두 가지 종류가 있습니다: 메타 경로 파인더나 경로 엔트리 파인더. 전자는 sys.meta_path에 배치하는 것이고 후자는 sys.path_hooks에서 경로 엔트리 훅을 사용하여 만드는 것으로 sys.path 항목과 함께 작동하여 파인더를 만듭니다. 이 예제는 임포트가 임포터를 사용할 수 있도록 임포터를 등록하는 방법을 보여줍니다 (임포터를 직접 만들려면, 이 패키지에 정의된 적절한 클래스의 설명서를 읽으십시오):

import importlib.machinery
import sys

# For illustrative purposes only.
SpamMetaPathFinder = importlib.machinery.PathFinder
SpamPathEntryFinder = importlib.machinery.FileFinder
loader_details = (importlib.machinery.SourceFileLoader,
                  importlib.machinery.SOURCE_SUFFIXES)

# Setting up a meta path finder.
# Make sure to put the finder in the proper location in the list in terms of
# priority.
sys.meta_path.append(SpamMetaPathFinder)

# Setting up a path entry finder.
# Make sure to put the path hook in the proper location in the list in terms
# of priority.
sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))

importlib.import_module() 근사하기

임포트 자체는 파이썬 코드로 구현되므로, importlib를 통해 대부분의 임포트 절차를 노출할 수 있습니다. 다음은 importlib.import_module()의 근사적인(approximate) 구현을 제공하여 importlib가 노출하는 다양한 API를 설명하는 데 도움을 줍니다 (importlib 사용법에 대해서는 파이썬 3.4 이상, 코드의 다른 부분에 대해서는 파이썬 3.6 이상).

import importlib.util
import sys

def import_module(name, package=None):
    """An approximate implementation of import."""
    absolute_name = importlib.util.resolve_name(name, package)
    try:
        return sys.modules[absolute_name]
    except KeyError:
        pass

    path = None
    if '.' in absolute_name:
        parent_name, _, child_name = absolute_name.rpartition('.')
        parent_module = import_module(parent_name)
        path = parent_module.__spec__.submodule_search_locations
    for finder in sys.meta_path:
        spec = finder.find_spec(absolute_name, path)
        if spec is not None:
            break
    else:
        msg = f'No module named {absolute_name!r}'
        raise ModuleNotFoundError(msg, name=absolute_name)
    module = importlib.util.module_from_spec(spec)
    sys.modules[absolute_name] = module
    spec.loader.exec_module(module)
    if path is not None:
        setattr(parent_module, child_name, module)
    return module