Azure Pipelines에서 Python 코드 형식 확인

안녕하세요 ! 저는 Xavier Jouvenot이고 이 작은 게시물에서는 Python 코드가 Azure Pipelines로 올바르게 형식화되었는지 자동으로 확인하는 방법을 설명할 것입니다.

자기 홍보: 저를 팔로우하고 프로그래머이자 작가로서의 제 작업을 확인할 수 있는 몇 가지 소셜 네트워크가 있습니다 😉

personal website , , , CodeNewbie , Medium , GitHub

문제적

오늘은 버전 관리 중인 Python 코드의 형식이 올바른지 자동으로 확인하는 방법, 특히 Azure Pipelines를 사용하여 이를 수행하는 방법에 중점을 둘 것입니다. 이 프로세스를 자동화하면 모든 사람이 기여하고 싶을 때마다 참여하고 코드 형식을 지정해야 하므로 팀의 효율성이 향상되고 코드의 일관성이 향상됩니다.

코드의 형식을 지정해야 하는지 확신이 서지 않는 경우 제가 작성한 이전 기사Formatting and Automation를 참조하시기 바랍니다. Spaces VS Tabs 에 대해 논쟁하는 데 시간을 소비할 필요가 없기 때문에 코드를 더 읽기 쉽게 만들고 팀의 생산성을 높일 수 있습니다.

해결책

전체 기사를 읽고 싶지 않은 사람들을 위한 짧은 대답은 Azure Pipelines 프로세스에 다음 단계를 삽입하는 것입니다.

- script: |
    pip3 install black
displayName: Installs the latest version of black
- script: |
    black --check .
displayName: Checks if the python scripts are formatted properly with black

"Formatting Python – Why and How !"에 대한 이전 기사가 있는 경우 black이라는 도구에 대해 이미 알고 있을 수 있습니다. 모르시는 분들을 위해 설명드리자면 이것은 작성자가 다음과 같이 설명하는 코드 포맷터입니다. > Black은 타협하지 않는 Python 코드 포맷터입니다. 이를 사용함으로써 귀하는 수동 서식 지정의 세부 사항에 대한 통제권을 양도하는 데 동의하는 것입니다. 그 대가로 Black은 속도, 결정성 및 서식 지정에 대한 파이코드 스타일의 자유를 제공합니다. 더 중요한 일을 위해 시간과 정신 에너지를 절약할 수 있습니다.

위의 단계에서 python package manager pip 과 함께 이 도구를 설치하는 것으로 시작합니다. 그런 다음 폴더의 루트에서 black를 실행합니다. 즉, 리포지토리에서 모든 Python 파일을 찾고 --check 플래그를 사용하고 있으므로 형식이 올바른지 확인합니다. 하나의 Python 파일이 올바르게 형식화되지 않은 경우 black 명령이 오류를 반환하고 Azure Pipelines의 해당 단계가 실패합니다.

원하는 경우 도구가 모든 리포지토리를 재귀적으로 검색하도록 하는 대신 Python 파일 목록을 직접 지정할 수 있습니다. 😉

마지막으로 이러한 단계를 Azure Pipelines에서 사용할 수 있는 모든 환경에서 사용할 수 있다는 점이 흥미롭습니다. 사용 가능한 모든 환경에서 앞에서 설명한 단계를 실행하도록 Azure Pipelines를 설정하는 GitHub 리포지토리를 실제로 만들었습니다. Azure Pipelines에서 새 환경을 사용할 수 있게 되면 업데이트할 예정이므로 살펴보실 수 있습니다here 😉


이 글을 읽어주신 모든 분들께 감사드리며 다음 글까지 화사한 하루 보내세요😉

흥미로운 링크

GitHub repository with the actual working code up to date 및 Azure Pipelines jobs runned

Azure pipelines Microsoft-hosted agents

black GitHub repository , documentation 및 python package

Python website

pip website

10xlearner website , , , CodeNewbie , Medium , GitHub