.bzl 스타일 가이드

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 출처 보기

이 페이지에서는 Starlark의 기본 스타일 가이드라인을 다루며 매크로 및 규칙에 대한 정보도 제공합니다.

Starlark는 소프트웨어 빌드 방법을 정의하는 언어이므로 프로그래밍 언어이자 구성 언어입니다.

Starlark를 사용하여 BUILD 파일, 매크로, 빌드 규칙을 작성합니다. 매크로와 규칙은 기본적으로 메타 언어이며 BUILD 파일이 작성되는 방식을 정의합니다. BUILD 파일은 단순하고 반복적인 용도입니다.

모든 소프트웨어가 작성된 것보다 더 자주 읽힙니다. Starlark의 경우 특히 그렇습니다. 엔지니어가 BUILD 파일을 읽고 타겟의 종속 항목과 빌드 세부정보를 이해했기 때문입니다. 이러한 읽기는 종종 다른 작업을 완수하거나 빨리 통과하거나 동시에 진행되기도 합니다. 따라서 사용자가 BUILD 파일을 빠르게 파싱하고 이해할 수 있도록 단순성과 가독성이 매우 중요합니다.

사용자가 BUILD 파일을 열 때 파일의 타겟 목록을 빠르게 확인하거나 C++ 라이브러리의 소스 목록을 검토하거나 자바 바이너리에서 종속 항목을 삭제하려고 합니다. 추상화 레이어를 추가할 때마다 사용자가 이러한 작업을 수행하기가 더 어려워집니다.

BUILD 파일 또한 다양한 도구에서 분석 및 업데이트됩니다. BUILD 파일을 추상화하는 경우 도구에서 파일을 수정하지 못할 수 있습니다. BUILD 파일을 단순하게 유지하면 도구를 더 효율적으로 사용할 수 있습니다. 코드베이스가 증가함에 따라 라이브러리를 업데이트하거나 정리하기 위해 여러 BUILD 파일에 변경사항을 적용하는 것이 점점 더 자주 사용되고 있습니다.

일반 도움말

스타일

Python 스타일

확실하지 않은 경우 가능하면 PEP 8 스타일 가이드를 따르세요. 특히 들여쓰기에 공백 2개가 아닌 4개를 사용하여 Python 규칙을 따르세요.

Starlark는 Python이 아니므로 Python 스타일의 일부 측면이 적용되지 않습니다. 예를 들어 PEP 8에서는 Starlark의 연산자가 아닌 is를 사용하여 싱글톤과 비교하도록 권장합니다.

문서 문자열

docstring을 사용하여 파일과 함수를 문서화합니다. 각 .bzl 파일 상단에 있는 docstring을 사용하고 각 공개 함수에 docstring을 사용합니다.

문서 규칙 및 측면

제공자 및 필드와 함께 속성과 측면은 doc 인수를 사용하여 문서화해야 합니다.

이름 지정 규칙

  • 변수와 함수 이름은 밑줄([a-z][a-z0-9_]*)로 구분된 단어(예: cc_library)와 함께 소문자를 사용합니다.
  • 최상위 비공개 값은 밑줄 1개로 시작됩니다. Bazel은 비공개 값을 다른 파일에서 사용할 수 없도록 강제합니다. 로컬 변수는 밑줄 프리픽스를 사용해서는 안 됩니다.

행 길이

BUILD 파일과 마찬가지로 라벨은 길 수 있기 때문에 엄격한 줄 길이 제한이 없습니다. 가능하면 Python의 스타일 가이드인 PEP 8을 따라 한 줄에 최대 79자 (영문 기준)를 사용해 보세요. 이 가이드라인을 엄격히 시행해서는 안 됩니다. 편집자는 80개 이상의 열을 표시해야 하고 자동화된 변경사항으로 인해 더 긴 줄이 사용되는 경우가 많으며, 사람이 이미 읽을 수 있는 행의 분할에 시간을 낭비해서는 안 됩니다.

키워드 인수

키워드 인수에서는 등호 주변의 공백을 선호합니다.

def fct(name, srcs):
    filtered_srcs = my_filter(source = srcs)
    native.cc_library(
        name = name,
        srcs = filtered_srcs,
        testonly = True,
    )

부울 값

부울 값(예: 규칙에 부울 속성을 사용하는 경우)에 10 대신 TrueFalse 값을 선호합니다.

프로덕션 코드에서는 print() 함수를 사용하지 마세요. 디버깅 전용이며 .bzl 파일의 직접 및 간접 사용자를 모두 스팸 처리합니다. 유일한 예외는 print()가 기본적으로 사용 중지되어 있고 소스를 수정하여 사용 설정할 수 있는 경우만 사용하는 코드를 제출할 수 있다는 것입니다. 예를 들어 print()의 모든 사용이 if DEBUG:에 의해 보호되고 여기서 DEBUGFalse에 하드코딩된 경우입니다. 이러한 설명이 가독성에 미치는 영향을 정당화할 만큼 유용한지 염두에 두세요.

매크로

매크로는 로드 단계 중에 하나 이상의 규칙을 인스턴스화하는 함수입니다. 일반적으로 매크로 대신 규칙을 사용합니다. 사용자에게 표시되는 빌드 그래프는 빌드 중 Bazel이 사용하는 그래프와 다릅니다. Bazel이 빌드 그래프 분석을 실행하기 전에 매크로가 확장됩니다.

따라서 문제가 발생하는 경우 사용자는 매크로 구현을 이해하여 빌드 문제를 해결해야 합니다. 또한 bazel query에 있는 결과는 매크로 확장으로 인해 결과에 표시되기 때문에 해석하기 어려울 수 있습니다. 마지막으로 측면이 매크로를 인식하지 못하므로 요소 (IDE 등)에 따라 도구가 실패할 수 있습니다.

안전한 매크로 사용은 Bazel CLI 또는 BUILD 파일에서 직접 참조되는 추가 대상을 정의하는 데 사용됩니다. 이 경우 이러한 대상의 최종 사용자만 이를 알아야 하며 매크로에 의해 발생하는 모든 빌드 문제는 사용에서 멀어지지 않습니다.

생성된 타겟을 정의하는 매크로({/5}

  • 매크로는 name 인수를 사용하고 해당 이름으로 타겟을 정의해야 합니다. 이 타겟은 매크로의 기본 타겟이 됩니다.
  • 생성된 타겟(매크로로 정의된 다른 모든 타겟)은 다음을 따라야 합니다.
    • 이름에 <name> 또는 _<name> 프리픽스를 붙여야 합니다. name = '%s_bar' % (name)을 사용하는 경우를 예로 들 수 있습니다.
    • 공개 상태 제한 (//visibility:private)
    • 와일드 카드 타겟(:all, ..., :* 등)의 확장을 방지하려면 manual 태그가 있어야 합니다.
  • name는 매크로에서 정의한 타겟의 이름을 파생하는 데만 사용해야 하며 다른 용도로는 사용하지 않아야 합니다. 예를 들어 매크로 자체에서 생성되지 않는 종속 항목이나 입력 파일을 파생하는 데 이름을 사용하지 마세요.
  • 매크로에서 생성된 모든 타겟은 어떤 식으로든 기본 타겟과 결합되어야 합니다.
  • 매크로의 매개변수 이름을 일관되게 유지하세요. 매개변수가 기본 대상에 속성 값으로 전달되면 이름을 동일하게 유지합니다. 매크로 매개변수가 일반 규칙 속성과 동일한 목적으로 사용되는 경우(예: deps) 속성과 마찬가지로 이름을 지정합니다(아래 참고).
  • 매크로를 호출할 때는 키워드 인수만 사용합니다. 이는 규칙에 부합하며 가독성을 크게 개선합니다.

엔지니어는 때에 따라 규칙이 Bazel 내에서 정의되었는지 또는 Starlark에서 정의되었는지에 관계없이 관련 규칙의 Starlark API가 특정 사용 사례에 충분하지 않을 때 매크로를 작성합니다. 이 문제가 발생하면 규칙 작성자에게 목표를 달성하기 위해 API를 확장할 수 있는지 문의하세요.

일반적으로 규칙과 유사한 매크로가 많을수록 좋습니다.

매크로도 참고하세요.

규칙

  • 규칙, 측면 및 속성의 속성은 소문자 이름('스네이크 케이스')을 사용해야 합니다.
  • 규칙 이름은 종속 항목의 관점에서 (또는 리프 규칙의 경우 사용자) 규칙을 통해 생성되는 기본 아티팩트의 종류를 설명하는 명사입니다. 파일 서픽스일 필요는 없습니다. 예를 들어 Python 확장 프로그램으로 사용할 C++ 아티팩트를 생성하는 규칙을 py_extension라고 할 수 있습니다. 대부분의 언어에서 일반적인 규칙은 다음과 같습니다.
    • *_library - 컴파일 단위 또는 '모듈'
    • *_binary - 실행 파일 또는 배포 단위를 생성하는 타겟
    • *_test - 테스트 대상입니다. 여기에는 여러 테스트가 포함될 수 있습니다. *_test 타겟의 모든 테스트는 동일한 테마의 변형일 수 있습니다(예: 단일 라이브러리 테스트).
    • *_import: 사전 컴파일된 아티팩트(예: .jar 또는 컴파일 중에 사용되는 .dll)를 캡슐화하는 대상입니다.
  • 속성에 일관된 이름과 유형을 사용합니다. 일반적으로 적용 가능한 속성은 다음과 같습니다.
    • srcs: label_list, 파일 허용: 소스 파일(일반적으로 사람이 작성함)
    • deps: label_list, 일반적으로 파일을 허용하지 않음: 컴파일 종속 항목
    • data: label_list, 테스트 데이터 등의 데이터 파일 허용
    • runtime_deps: label_list: 컴파일에 필요하지 않은 런타임 종속 항목입니다.
  • 명확하지 않은 동작이 있는 속성 (예: 특수한 대체가 포함된 문자열 템플릿 또는 특정 요구사항으로 호출되는 도구)의 경우 doc 키워드 인수를 속성 선언 (attr.label_list() 또는 이와 유사한)에 사용하여 문서를 제공합니다.
  • 규칙 구현 함수는 거의 항상 비공개 함수(앞에 밑줄이 지정됨)여야 합니다. 일반적인 스타일은 myrule의 구현 함수에 _myrule_impl 이름을 지정하는 것입니다.
  • 잘 정의된 provider 인터페이스를 사용하여 규칙 간에 정보를 전달합니다. 제공업체 필드를 선언하고 문서화합니다.
  • 확장성을 염두에 두고 규칙을 설계합니다. 다른 규칙이 규칙과 상호작용하고 제공업체에 액세스하며 생성한 작업을 재사용하고자 할 수 있습니다.
  • 규칙에서 실적 가이드라인을 따릅니다.