도우미 함수와 속성에 대한 정보가 포함된 저장소 규칙의 컨텍스트입니다. 저장소 규칙을 만들 때 storage_ctx 객체를 implementation
함수의 인수로 가져옵니다.
회원
- attr
- 삭제
- 다운로드
- download_and_extract
- 실행
- 추출
- 파일
- getenv
- name
- OS
- patch
- 경로
- 읽기
- report_progress
- 심볼릭 링크
- 템플릿
- 시계
- watch_tree
- 이는
- workspace_root
attr
struct repository_ctx.attr
delete
bool repository_ctx.delete(path)
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 path;
필수 삭제할 파일의 경로(저장소 디렉터리 기준 또는 절대 경로)입니다. 경로 또는 문자열일 수 있습니다. |
download
unknown repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
success
가 포함된 구조체(다운로드가 성공적으로 완료된 경우 true
플래그), 성공한 경우 sha256
및 integrity
필드가 있는 파일의 해시를 반환합니다.
매개변수
매개변수 | 설명 |
---|---|
url
|
string; 또는 문자열의 반복 가능 항목
필수 동일한 파일을 참조하는 미러 URL의 목록입니다. |
output
|
string; 또는 라벨 또는 path
기본값은 '' 입니다. 저장소 디렉터리를 기준으로 한 출력 파일의 상대 경로입니다. |
sha256
|
기본값은 '' 입니다. 다운로드한 파일의 예상 SHA-256 해시입니다. 이는 다운로드한 파일의 SHA-256 해시와 일치해야 합니다. 원격 파일이 변경될 수 있으므로 SHA-256을 생략하면 보안 위험이 발생합니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다. |
executable
|
기본값은 False 입니다. 생성된 파일에 실행 가능 플래그를 설정합니다. 기본값은 false입니다. |
allow_fail
|
기본값은 False 입니다. 설정하면 실패한 다운로드에 대해 오류가 발생하는 대신 반환 값에 오류를 표시합니다. |
canonical_id
|
기본값은 '' 입니다. 설정하면 캐시 적중을 파일이 동일한 표준 ID로 캐시에 추가된 사례로 제한합니다. |
auth
|
기본값은 {} 입니다. 일부 URL에 대한 인증 정보를 지정하는 선택적 사전입니다. |
headers
|
기본값은 {} 입니다. 모든 URL의 http 헤더를 지정하는 선택적 사전입니다. |
integrity
|
기본값은 '' 입니다. 하위 리소스 무결성 형식으로 다운로드한 파일의 예상 체크섬입니다. 이는 다운로드한 파일의 체크섬과 일치해야 합니다. 원격 파일이 변경될 수 있으므로 체크섬을 생략하면 보안 위험이 있습니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다. |
block
|
기본값은 True 입니다. false로 설정하면 호출이 즉시 반환되며 일반 반환 값 대신 단일 메서드 wait()이 포함된 토큰을 반환합니다. 이 메서드는 다운로드가 완료될 때까지 차단하고 일반 반환 값을 반환하거나 평소와 같이 반환합니다. |
download_and_extract
struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
success
(다운로드가 성공적으로 완료되면 true
) 플래그를 포함하고 성공한 경우 sha256
및 integrity
필드가 있는 파일의 해시를 포함하는 구조체를 반환합니다.
매개변수
매개변수 | 설명 |
---|---|
url
|
string; 또는 문자열의 반복 가능 항목
필수 동일한 파일을 참조하는 미러 URL의 목록입니다. |
output
|
string; 또는 라벨 또는 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', '.bz2', '.debz2', 'aar', 'tar', 'tar.gz', 'tgz', 'tar.xz'를 명시적으로 지정할 수 있습니다. 여기에서 확인하세요. |
stripPrefix
|
기본값은 '' 입니다. 디렉터리 접두어를 추가하여 압축 해제된 파일에서 제거합니다. 대부분의 보관 파일에는 보관 파일의 모든 파일을 포함하는 최상위 디렉터리가 포함되어 있습니다. build_file 에서 이 접두사를 반복해서 지정하는 대신 이 필드를 사용하여 추출된 파일에서 접두사를 제거할 수 있습니다.
|
allow_fail
|
기본값은 False 입니다. 설정하면 실패한 다운로드에 대해 오류가 발생하는 대신 반환 값에 오류를 표시합니다. |
canonical_id
|
기본값은 '' 입니다. 설정하면 캐시 적중을 파일이 동일한 표준 ID로 캐시에 추가된 사례로 제한합니다. |
auth
|
기본값은 {} 입니다. 일부 URL에 대한 인증 정보를 지정하는 선택적 사전입니다. |
headers
|
기본값은 {} 입니다. 모든 URL의 http 헤더를 지정하는 선택적 사전입니다. |
integrity
|
기본값은 '' 입니다. 하위 리소스 무결성 형식으로 다운로드한 파일의 예상 체크섬입니다. 이는 다운로드한 파일의 체크섬과 일치해야 합니다. 원격 파일이 변경될 수 있으므로 체크섬을 생략하면 보안 위험이 있습니다. 기껏해야 이 필드를 생략하면 빌드가 밀폐되지 않게 됩니다. 개발을 간소화하기 위한 선택사항이지만 출시 전에 설정해야 합니다. |
rename_files
|
기본값은 {} 입니다. 추출 중 이름을 바꿀 파일을 지정하는 dict(선택사항)입니다. 키와 일치하는 이름을 가진 보관처리 항목의 이름이 디렉터리 접두사 조정 이전의 값으로 변경됩니다. 유니코드가 아닌 파일 이름을 포함하거나 대소문자를 구분하지 않는 파일 시스템에서 동일한 경로로 추출하는 파일이 있는 보관 파일을 추출하는 데 사용할 수 있습니다. |
execute
exec_result repository_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
|
기본값은 "" 입니다. 명령어 실행을 위한 작업 디렉터리 저장소 루트 또는 절대값을 기준으로 할 수 있습니다. |
추출
None
repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')
매개변수
매개변수 | 설명 |
---|---|
archive
|
string; 또는 라벨 또는 path
필수 압축해제할 보관 파일의 경로로, 저장소 디렉터리를 기준으로 합니다. |
output
|
string; 또는 라벨 또는 path
기본값은 '' 입니다. 보관 파일이 압축 해제될 디렉터리의 경로를 저장소 디렉터리를 기준으로 합니다. |
stripPrefix
|
기본값은 '' 입니다. 디렉터리 접두어를 추가하여 압축 해제된 파일에서 제거합니다. 대부분의 보관 파일에는 보관 파일의 모든 파일을 포함하는 최상위 디렉터리가 포함되어 있습니다. build_file 에서 이 접두사를 반복해서 지정하는 대신 이 필드를 사용하여 추출된 파일에서 접두사를 제거할 수 있습니다.
|
rename_files
|
기본값은 {} 입니다. 추출 중 이름을 바꿀 파일을 지정하는 dict(선택사항)입니다. 키와 일치하는 이름을 가진 보관처리 항목의 이름이 디렉터리 접두사 조정 이전의 값으로 변경됩니다. 유니코드가 아닌 파일 이름을 포함하거나 대소문자를 구분하지 않는 파일 시스템에서 동일한 경로로 추출하는 파일이 있는 보관 파일을 추출하는 데 사용할 수 있습니다. |
watch_archive
|
기본값은 'auto' 입니다. 보관 파일을 감상할지 여부를 지정합니다. 문자열 'yes', 'no' 또는 'auto'일 수 있습니다. 'yes' 전달 watch() 메서드를 즉시 호출하는 것과 같습니다. '아니요'를 전달하기 파일을 보려고 시도하지 않습니다. 'auto'를 전달하여 합법적인 경우에만 파일 보기를 시도합니다 (자세한 내용은 watch() 문서 참고).
|
파일
None
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 라벨 또는 path
필수 저장소 디렉터리를 기준으로 한, 만들 파일의 경로입니다. |
content
|
기본값은 '' 입니다. 생성할 파일의 콘텐츠이며, 기본적으로 비어 있습니다. |
executable
|
기본값은 True 입니다. 생성된 파일에서 실행 가능 플래그를 기본적으로 true로 설정합니다. |
legacy_utf8
|
기본값은 True 입니다. 기본적으로 true로 설정합니다. 향후 버전에서는 기본값이 변경되고 이 매개변수가 삭제됩니다. |
getenv
string repository_ctx.getenv(name, default=None)
name
환경 변수의 값을(있는 경우) 문자열로 반환하고 그렇지 않으면 default
을 반환합니다.점진적으로 빌드할 때 name
로 이름이 지정된 변수 값이 변경되면 이 저장소를 다시 가져옵니다.
매개변수
매개변수 | 설명 |
---|---|
name
|
string;
필수 원하는 환경 변수의 이름 |
default
|
string; 또는 None
기본값은 None 입니다. `name` 을 찾을 수 없는 경우 반환할 기본값입니다. |
None
을(를) 반환할 수 있습니다.
이름
string repository_ctx.name
os
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')
매개변수
매개변수 | 설명 |
---|---|
patch_file
|
string; 또는 라벨 또는 path
필수 적용할 패치 파일로, 라벨, 상대 경로 또는 절대 경로일 수 있습니다. 상대 경로인 경우 저장소 디렉터리로 확인됩니다. |
strip
|
기본값은 0 입니다. 파일 이름에서 지정된 수의 선행 구성요소를 제거합니다. |
watch_patch
|
기본값은 'auto' 입니다. 패치 파일을 감시할지 여부입니다. 문자열 'yes', 'no' 또는 'auto'일 수 있습니다. 'yes' 전달 watch() 메서드를 즉시 호출하는 것과 같습니다. '아니요'를 전달하기 파일을 보려고 시도하지 않습니다. 'auto'를 전달하여 합법적인 경우에만 파일 보기를 시도합니다 (자세한 내용은 watch() 문서 참고).
|
경로
path repository_ctx.path(path)
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 라벨 또는 path
필수 경로를 만들 문자열, 라벨 또는 경로 |
read
string repository_ctx.read(path, *, watch='auto')
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 라벨 또는 path
필수 읽을 파일의 경로입니다. |
watch
|
기본값은 'auto' 입니다. 파일을 감상할지 여부를 지정합니다. 문자열 'yes', 'no' 또는 'auto'일 수 있습니다. 'yes' 전달 watch() 메서드를 즉시 호출하는 것과 같습니다. '아니요'를 전달하기 파일을 보려고 시도하지 않습니다. 'auto'를 전달하여 합법적인 경우에만 파일 보기를 시도합니다 (자세한 내용은 watch() 문서 참고).
|
report_progress
None
repository_ctx.report_progress(status='')
매개변수
매개변수 | 설명 |
---|---|
status
|
string;
기본값은 '' 입니다. 가져오기 진행 상황의 현재 상태를 설명하는 문자열 |
심볼릭 링크
None
repository_ctx.symlink(target, link_name)
매개변수
매개변수 | 설명 |
---|---|
target
|
string; 또는 라벨 또는 path
필수 심볼릭 링크가 가리켜야 하는 경로입니다. |
link_name
|
string; 또는 라벨 또는 path
필수 생성할 심볼릭 링크의 경로입니다. |
템플릿
None
repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')
template
를 사용하여 새 파일을 생성합니다. substitutions
키의 template
에서 일치하는 모든 항목은 해당 값으로 대체됩니다. 결과는 path
로 작성됩니다. 선택적 executable
인수 (기본값은 true)를 설정하여 실행 가능 비트를 켜거나 끌 수 있습니다.
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 라벨 또는 path
필수 저장소 디렉터리를 기준으로 한, 만들 파일의 경로입니다. |
template
|
string; 또는 라벨 또는 path
필수 경로를 지정해야 합니다 |
substitutions
|
기본값은 {} 입니다. 템플릿을 펼칠 때 대체해야 합니다. |
executable
|
기본값은 True 입니다. 생성된 파일에서 실행 가능 플래그를 기본적으로 true로 설정합니다. |
watch_template
|
기본값은 'auto' 입니다. 템플릿 파일을 감시할지 여부입니다. 문자열 'yes', 'no' 또는 'auto'일 수 있습니다. 'yes' 전달 watch() 메서드를 즉시 호출하는 것과 같습니다. '아니요'를 전달하기 파일을 보려고 시도하지 않습니다. 'auto'를 전달하여 합법적인 경우에만 파일 보기를 시도합니다 (자세한 내용은 watch() 문서 참고).
|
시계
None
repository_ctx.watch(path)
'변경' 파일 콘텐츠의 변경사항을 포함합니다 (경로가 파일인 경우). 경로가 파일이지만 현재 디렉터리이거나 그 반대인 경우 경로가 기존 경로의 시작 또는 중지인지를 확인할 수 있습니다. 특히 경로가 디렉터리인 경우 디렉터리 아래의 파일에 대한 변경사항은 포함되지 않습니다. 이러한 경우에는 path.readdir()
를 대신 사용하세요.
현재 가져오는 저장소 내부 또는 현재 모듈 확장 프로그램의 작업 디렉터리 내부에서 경로를 감시하려고 하면 오류가 발생합니다. 모듈 확장 프로그램이 현재 Bazel 작업공간 외부의 경로를 보려고 시도하면 오류가 발생합니다.
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 라벨 또는 path
필수 감시할 파일의 경로입니다. |
watch_tree
None
repository_ctx.watch_tree(path)
현재 가져오는 저장소 내에서 경로를 확인하려고 하면 오류가 발생합니다.
매개변수
매개변수 | 설명 |
---|---|
path
|
string; 또는 라벨 또는 path
필수 감시할 디렉터리 트리의 경로입니다. |
어떤
path repository_ctx.which(program)
매개변수
매개변수 | 설명 |
---|---|
program
|
필수 경로에서 찾을 프로그래밍 |
None
을(를) 반환할 수 있습니다.
workspace_root
path repository_ctx.workspace_root