모듈_관련

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
도우미 함수와 종속 항목 그래프에 관한 관련 태그에 관한 정보가 포함된 모듈 확장 프로그램의 컨텍스트 모듈 확장 프로그램을 만들 때 module_ctx 객체를 implementation 함수의 인수로 받습니다.

회원

download

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

제공된 URL의 출력 경로에 파일을 다운로드하고, 다운로드가 완료되면 success 플래그(true)를 포함하고 구조체는 sha256integrity 필드가 포함된 파일 해시를 반환합니다.

매개변수

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

다운로드_및_추출

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; default = ''
저장소 디렉터리를 기준으로 보관 파일이 압축 해제되는 디렉터리의 경로입니다.
sha256 default = ''
다운로드된 파일의 예상 SHA-256 해시입니다. 다운로드한 파일의 SHA-256 해시와 일치해야 합니다. 원격 파일이 변경될 수 있으므로 SHA-256을 생략하는 것이 보안상 위험합니다. 이 필드를 생략하면 빌드가 기본 제공되지 않습니다. 보다 쉽게 개발할 수 있지만 배송 전에 설정해야 합니다. 제공된 경우 저장소 캐시는 지정된 해시가 있는 파일을 먼저 확인합니다. 파일이 캐시에서 발견되지 않은 경우에만 다운로드를 시도합니다. 다운로드가 완료되면 파일이 캐시에 추가됩니다.
type default = ''
다운로드한 파일의 보관 파일 유형입니다. 기본적으로 보관 유형은 URL의 파일 확장자에 따라 결정됩니다. 파일에 확장자가 없는 경우 두 개의
stripPrefix default = ''
추출된 파일에서 삭제할 디렉터리 프리픽스 대부분의 아카이브에는 자료실의 모든 파일이 포함된 최상위 디렉터리가 있습니다. 이 접두사를 build_file에서 반복해서 지정할 필요 없이 추출 파일에서 파일에서 삭제하는 데 사용할 수 있습니다.
allow_fail 기본값 = False
설정되면 실패한 다운로드에 대해 오류를 발생시키지 않고 반환 값에 오류를 표시합니다.
canonical_id 기본값 = ''
설정된 경우 파일이 동일한 표준 ID로 캐시에 추가된 경우에만 캐시 적중
auth default = {}
일부 URL에 대한 인증 정보를 지정하는 선택적 dict입니다.
integrity default = ''
다운로드한 파일의 예상 체크섬이며 하위 리소스 무결성 형식입니다. 다운로드된 파일의 체크섬과 일치해야 합니다. 원격 파일은 변경될 수 있으므로 체크섬을 생략하는 것은 보안상 위험합니다. 이 필드를 생략하면 빌드가 기본 제공되지 않습니다. 보다 쉽게 개발할 수 있지만 배송 전에 설정해야 합니다.
rename_files 기본값 = {}
추출 중에 이름을 바꿀 파일을 지정하는 선택적 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 default = True
stdout 및 stderr을 터미널에 출력해야 하는 경우
working_directory default = ""
명령어 실행을 위한 작업 디렉터리입니다. 저장소 루트 또는 절댓값을 기준으로 할 수 있습니다.

파일

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

제공된 콘텐츠를 사용하여 저장소 디렉터리에 파일을 생성합니다.

매개변수

매개변수 설명
path string; or Label; or path, 생성할 디렉터리 경로
(저장소 디렉터리 기준)입니다.
content default = ''
기본적으로 만들 파일의 콘텐츠입니다.
executable default = True
생성된 파일의 실행 가능한 플래그를 설정하며, 기본값은 true입니다.
legacy_utf8 default = True
파일 콘텐츠를 UTF-8로 인코딩하고 기본적으로 true입니다. 향후 버전에서는 기본값을 변경하고 이 매개변수를 삭제할 예정입니다.

modules

list module_ctx.modules

외부 종속 항목 그래프의 모든 Bazel 모듈 목록입니다. 각 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, 읽을
파일의 필수 경로입니다.

보고서_진행

None module_ctx.report_progress(status='')

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

매개변수

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

어떤

path module_ctx.which(program)

해당 프로그램의 경로를 반환하거나 경로에 이러한 프로그램이 없으면 None을 반환합니다.

매개변수

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