도우미 함수와 종속 항목 그래프 전반의 관련 태그에 관한 정보를 포함하는 모듈 확장 프로그램의 컨텍스트입니다. 모듈 확장 프로그램을 만들 때 module_ctx 객체가 implementation 함수의 인수로 제공됩니다.
회원
- download
- download_and_extract
- 실행
- extension_metadata
- 파일
- is_dev_dependency
- modules
- os
- 경로
- 읽기
- report_progress
- root_module_has_non_dev_dependency
- 이는
download
struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
success, 다운로드가 완료된 경우 true인 플래그, 다운로드가 완료된 경우 sha256 및 integrity 필드가 포함된 파일의 해시가 포함된 구조체를 반환합니다.
매개변수
| 매개변수 | 설명 |
|---|---|
url
|
문자열 또는 문자열의 반복 가능 항목
필수 동일한 파일을 참조하는 미러 URL의 목록입니다. |
output
|
string 또는 Label 또는 path입니다. 기본값은 저장소 디렉터리를 기준으로 한 출력 파일의 ''경로입니다. |
sha256
|
기본값은 ''입니다.다운로드한 파일의 예상 SHA-256 해시입니다. 이는 다운로드한 파일의 SHA-256 해시와 일치해야 합니다. 원격 파일이 변경될 수 있으므로 SHA-256을 생략하면 보안 위험이 발생합니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다. |
executable
|
기본값은 False입니다. 생성된 파일에 실행 파일 플래그를 설정합니다. 기본값은 false입니다. |
allow_fail
|
기본값은 False입니다. 설정하면 다운로드 실패에 대한 오류를 발생시키지 않고 반환 값에 오류를 표시합니다. |
canonical_id
|
기본값은 ''입니다. 설정하면 캐시 히트를 파일이 동일한 표준 ID로 캐시에 추가된 경우에만 제한합니다. |
auth
|
기본값은 {}입니다.일부 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={})
success, 다운로드가 완료된 경우 true인 플래그, 다운로드가 완료된 경우 sha256 및 integrity 필드가 포함된 파일의 해시가 포함된 구조체를 반환합니다.
매개변수
| 매개변수 | 설명 |
|---|---|
url
|
string 또는 string의 반복 가능한 객체입니다.
필수 동일한 파일을 참조하는 미러 URL 목록입니다. |
output
|
string 또는 Label 또는 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', '.tbz', '.ar' 또는 '.deb'를 명시적으로 지정할 수 있습니다. |
stripPrefix
|
기본값은 ''입니다.추출된 파일에서 제거할 디렉터리 접두사입니다. 많은 보관 파일에는 보관 파일의 모든 파일이 포함된 최상위 디렉터리가 포함되어 있습니다. build_file에서 이 접두사를 반복해서 지정하는 대신 이 필드를 사용하여 추출된 파일에서 접두사를 제거할 수 있습니다.
|
allow_fail
|
기본값은 False입니다. 설정하면 다운로드 실패에 대한 오류를 발생시키지 않고 반환 값에 오류를 표시합니다. |
canonical_id
|
기본값은 ''입니다. 설정하면 캐시 히트를 파일이 동일한 표준 ID로 캐시에 추가된 경우에만 제한합니다. |
auth
|
기본값은 {}입니다.일부 URL에 대한 인증 정보를 지정하는 선택적 사전입니다. |
integrity
|
기본값은 ''입니다.다운로드되는 파일의 예상 체크섬이며, 하위 리소스 무결성 형식입니다. 이는 다운로드한 파일의 체크섬과 일치해야 합니다. 원격 파일이 변경될 수 있으므로 체크섬을 생략하면 보안 위험이 있습니다. 이 필드를 생략하면 기껏해야 빌드가 비밀번호로 보호되지 않게 됩니다. 개발을 더 쉽게 하기 위한 선택사항이지만 출시 전에 설정해야 합니다. |
rename_files
|
기본값은 {}입니다.추출 중에 이름을 바꿀 파일을 지정하는 선택적 사전입니다. 키와 정확히 일치하는 이름의 보관 파일 항목은 디렉터리 접두사 조정 전에 값으로 이름이 바뀝니다. 이 옵션은 유니코드가 아닌 파일 이름이 포함되어 있거나 대소문자를 구분하지 않는 파일 시스템에서 동일한 경로로 추출되는 파일이 포함된 보관 파일을 추출하는 데 사용할 수 있습니다. |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout로 제한됩니다 (단위: 초, 기본값: 600초). 이 메서드는 명령어의 출력이 포함된 exec_result 구조를 반환합니다. environment 매핑은 프로세스에 전달할 일부 환경 변수를 재정의하는 데 사용할 수 있습니다.
매개변수
| 매개변수 | 설명 |
|---|---|
arguments
|
필수 인수 목록. 첫 번째 요소는 실행할 프로그램의 경로여야 합니다. |
timeout
|
기본값은 600입니다.초 단위의 최대 명령어 지속 시간 (기본값은 600초)입니다. |
environment
|
기본값은 {}입니다.일부 환경 변수를 프로세스에 전달되도록 설정합니다. |
quiet
|
기본값은 True입니다. stdout 및 stderr을 터미널에 출력해야 하는 경우입니다. |
working_directory
|
기본값은 ""입니다.명령어 실행을 위한 작업 디렉터리입니다. 저장소 루트에 상대적이거나 절대적일 수 있습니다. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)
매개변수
| 매개변수 | 설명 |
|---|---|
root_module_direct_deps
|
string의 sequence 또는 string 또는 None, 기본값은 None입니다.확장 프로그램이 루트 모듈의 직접 종속 항목으로 간주하는 저장소의 이름입니다. 루트 모듈이 추가 저장소를 가져오거나 use_repo를 통해 이러한 저장소를 모두 가져오지 않으면 확장 프로그램이 평가될 때 Bazel에서 경고와 수정 명령어를 출력합니다.
|
root_module_direct_dev_deps
|
문자열의 시퀀스 또는 문자열 또는 None입니다. 기본값은 None입니다.확장 프로그램에서 루트 모듈의 직접적인 개발자 종속 항목으로 간주하는 저장소의 이름입니다. 루트 모듈이 추가 저장소를 가져오거나 use_extension(..., dev_dependency = True)로 만든 확장 프로그램 프록시에서 use_repo를 통해 이러한 저장소를 모두 가져오지 않으면 확장 프로그램이 평가될 때 Bazel에서 경고와 수정 명령어를 출력합니다.
|
파일
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)매개변수
| 매개변수 | 설명 |
|---|---|
path
|
string, Label 또는 path: 필수 : 저장소 디렉터리를 기준으로 생성할 파일의 경로입니다. |
content
|
기본값은 ''입니다.만들 파일의 콘텐츠로 기본적으로 비어 있습니다. |
executable
|
기본값은 True입니다.생성된 파일에 실행 가능 플래그를 설정합니다. 기본값은 true입니다. |
legacy_utf8
|
기본값은 True파일 콘텐츠를 UTF-8로 인코딩합니다. 기본값은 true입니다. 향후 버전에서는 기본값이 변경되고 이 매개변수가 삭제됩니다. |
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True를 사용한 use_extension 호출의 결과에서 지정된 태그가 있는지 여부를 반환합니다.
매개변수
| 매개변수 | 설명 |
|---|---|
tag
|
bazel_module_tag;
required bazel_module.tags에서 가져온 태그입니다. |
modules
list module_ctx.modules
os
repository_os module_ctx.os
경로
path module_ctx.path(path)
매개변수
| 매개변수 | 설명 |
|---|---|
path
|
string, Label 또는 path(필수) 경로를 만들 문자열, 라벨 또는 경로 |
read
string module_ctx.read(path)
매개변수
| 매개변수 | 설명 |
|---|---|
path
|
string, Label 또는 path: 읽을 파일의 경로입니다.
필수 |
report_progress
None module_ctx.report_progress(status='')매개변수
| 매개변수 | 설명 |
|---|---|
status
|
string; 기본값은 ''입니다.가져오기 진행 상황의 현재 상태를 설명하는 문자열입니다. |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
어떤
path module_ctx.which(program)
매개변수
| 매개변수 | 설명 |
|---|---|
program
|
required 경로에서 찾을 프로그램입니다. |
None을 반환할 수 있습니다.