module_ctx

도우미 함수와 종속 항목 그래프 전반의 관련 태그에 관한 정보가 포함된 모듈 확장 프로그램의 컨텍스트입니다. 모듈 확장 프로그램을 만들 때 module_ctx 객체를 implementation 함수의 인수로 가져옵니다.

회원

download

struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

제공된 URL의 출력 경로로 파일을 다운로드하고 success가 포함된 구조체(다운로드가 성공적으로 완료된 경우 true 플래그), 성공한 경우 sha256 및 integrity 필드가 있는 파일의 해시를 반환합니다.

매개변수

매개변수 설명
url string; or Iterable of strings 필수
동일한 파일을 참조하는 미러 URL의 목록입니다.
output string; or Label; or path 기본값 = ''
저장소 디렉터리를 기준으로 한 출력 파일의 상대 경로입니다.
sha256 기본값 = ''
다운로드한 파일의 예상 SHA-256 해시입니다. 이는 다운로드한 파일의 SHA-256 해시와 일치해야 합니다. 원격 파일이 변경될 수 있으므로 SHA-256을 생략하면 보안 위험이 발생합니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다.
executable 기본값 = False
생성된 파일에 실행 가능 플래그를 설정합니다. 기본값은 false입니다.
allow_fail 기본값 = False
설정하면 실패한 다운로드에 대해 오류가 발생하는 대신 반환 값에 오류를 표시합니다.
canonical_id 기본값 = ''
설정하면 캐시 적중을 파일이 동일한 표준 ID로 캐시에 추가된 사례로 제한합니다.
auth default = {}
일부 URL에 대한 인증 정보를 지정하는 선택적 사전입니다.
integrity 기본값 = ''
하위 리소스 무결성 형식으로 다운로드한 파일의 예상 체크섬입니다. 이는 다운로드한 파일의 체크섬과 일치해야 합니다. 원격 파일이 변경될 수 있으므로 체크섬을 생략하면 보안 위험이 있습니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다.

download_and_extract

struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})

제공된 URL의 출력 경로로 파일을 다운로드하고 추출한 다음 success(다운로드가 성공적으로 완료되면 true) 플래그를 포함하고 성공한 경우 sha256 및 integrity 필드가 있는 파일의 해시를 포함하는 구조체를 반환합니다.

매개변수

매개변수 설명
url string; or Iterable of strings 필수
동일한 파일을 참조하는 미러 URL의 목록입니다.
output string; or Label; or path 기본값 = ''
보관 파일이 압축 해제될 디렉터리의 경로를 저장소 디렉터리를 기준으로 합니다.
sha256 기본값 = ''
다운로드한 파일의 예상 SHA-256 해시입니다. 이는 다운로드한 파일의 SHA-256 해시와 일치해야 합니다. 원격 파일이 변경될 수 있으므로 SHA-256을 생략하면 보안 위험이 발생합니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다. 제공된 경우 먼저 저장소 캐시에서 지정된 해시가 있는 파일을 확인합니다. 캐시에서 파일을 찾을 수 없는 경우에만 다운로드가 시도됩니다. 다운로드가 완료되면 파일이 캐시에 추가됩니다.
type 기본값 = ''
다운로드한 파일의 보관 파일 유형입니다. 기본적으로 보관 파일 유형은 URL의 파일 확장자에 따라 결정됩니다. 파일에 확장자가 없는 경우 'zip', 'jar', 'war', 'aar', 'tar', 'tar.gz', 'tgz', 'tar.xz', 'txz', '.tar.zst', '.tzst', 'tar.bz2', '.de'. 여기에서 확인하세요.
stripPrefix 기본값 = ''
디렉터리 접두어를 추가하여 압축 해제된 파일에서 제거합니다. 대부분의 보관 파일에는 보관 파일의 모든 파일을 포함하는 최상위 디렉터리가 포함되어 있습니다. build_file에서 이 접두사를 반복해서 지정하는 대신 이 필드를 사용하여 추출된 파일에서 접두사를 제거할 수 있습니다.
allow_fail 기본값 = False
설정하면 실패한 다운로드에 대해 오류가 발생하는 대신 반환 값에 오류를 표시합니다.
canonical_id 기본값 = ''
설정하면 캐시 적중을 파일이 동일한 표준 ID로 캐시에 추가된 사례로 제한합니다.
auth default = {}
일부 URL에 대한 인증 정보를 지정하는 선택적 사전입니다.
integrity 기본값 = ''
하위 리소스 무결성 형식으로 다운로드한 파일의 예상 체크섬입니다. 이는 다운로드한 파일의 체크섬과 일치해야 합니다. 원격 파일이 변경될 수 있으므로 체크섬을 생략하면 보안 위험이 있습니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다.
rename_files default = {}
추출 중 이름을 바꿀 파일을 지정하는 dict(선택사항)입니다. 키와 일치하는 이름을 가진 보관처리 항목의 이름이 디렉터리 접두사 조정 이전의 값으로 변경됩니다. 유니코드가 아닌 파일 이름을 포함하거나 대소문자를 구분하지 않는 파일 시스템에서 동일한 경로로 추출하는 파일이 있는 보관 파일을 추출하는 데 사용할 수 있습니다.

execute

exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

인수 목록에서 지정된 명령어를 실행합니다. 명령어의 실행 시간은 timeout (초 단위, 기본값은 600초)로 제한됩니다. 이 메서드는 명령어의 출력이 포함된 exec_result 구조를 반환합니다. environment 맵은 프로세스에 전달할 일부 환경 변수를 재정의하는 데 사용할 수 있습니다.

매개변수

매개변수 설명
arguments 필수
인수의 목록으로, 첫 번째 요소는 실행할 프로그램의 경로여야 합니다.
timeout 기본값 = 600
명령어의 최대 지속 시간(초)입니다(기본값은 600초).
environment default = {}
일부 환경 변수가 프로세스에 전달되도록 강제 설정합니다.
quiet 기본값 = True
stdout 및 stderr을 터미널에 출력해야 하는 경우
working_directory 기본값 = ""
명령어 실행을 위한 작업 디렉터리 저장소 루트 또는 절대값을 기준으로 할 수 있습니다.

파일

None module_ctx.file(path, content='', executable=True, legacy_utf8=True)

제공된 콘텐츠로 저장소 디렉터리에 파일을 생성합니다.

매개변수

매개변수 설명
path string; or Label; or path 필수
저장소 디렉터리를 기준으로 한, 만들 파일의 경로입니다.
content 기본값 = ''
생성할 파일의 콘텐츠이며, 기본적으로 비어 있습니다.
executable 기본값 = True
생성된 파일에서 실행 가능 플래그를 기본적으로 true로 설정합니다.
legacy_utf8 기본값 = True
기본적으로 true로 설정합니다. 향후 버전에서는 기본값이 변경되고 이 매개변수가 삭제됩니다.

modules

list module_ctx.modules

외부 종속 항목 그래프에 있는 모든 Bazel 모듈의 목록입니다. 각 모듈은 이 모듈 확장 프로그램에 지정된 모든 태그를 노출하는 bazel_module 객체입니다. 이 사전의 반복 순서는 루트 모듈에서 시작하는 상세 검색 순서와 동일합니다.

os

repository_os module_ctx.os

시스템의 정보에 액세스하는 구조체입니다.

경로

path module_ctx.path(path)

문자열, 라벨 또는 경로에서 경로를 반환합니다. 상대 경로인 경우 저장소 디렉터리를 기준으로 확인됩니다. 경로가 라벨인 경우 해당 파일의 경로로 확인됩니다. 원격 저장소는 분석 단계에서 실행되므로 대상 결과에 종속될 수 없습니다 (라벨은 생성되지 않은 파일을 가리켜야 함). 경로가 경로인 경우 해당 경로를 있는 그대로 반환합니다.

매개변수

매개변수 설명
path string; or Label; or path 필수
경로를 만들 문자열, 라벨 또는 경로

read

string module_ctx.read(path)

파일 시스템에 있는 파일의 콘텐츠를 읽습니다.

매개변수

매개변수 설명
path string; or Label; or path 필수
읽을 파일의 경로입니다.

report_progress

None module_ctx.report_progress(status='')

이 저장소 또는 모듈 확장 프로그램 가져오기의 진행 상태를 업데이트합니다.

매개변수

매개변수 설명
status string 기본값 = ''
가져오기 진행 상황의 현재 상태를 설명하는 문자열

어떤

path module_ctx.which(program)

해당 프로그램의 경로를 반환하거나 경로에 프로그램이 없는 경우 None을 반환합니다.

매개변수

매개변수 설명
program 필수
경로에서 찾을 프로그래밍
None을(를) 반환할 수 있습니다.