Ruff (고성능 Python linter) 소개 및 세팅

 

ruff homepage https://beta.ruff.rs/docs/

Ruff

ruff github https://github.com/astral-sh/ruff

GitHub - astral-sh/ruff: An extremely fast Python linter, written in Rust.

Ruff는 Rust로 작성된 고성능 Python Linter 입니다.

위 이미지와 같이 다른 linter 대비 굉장히 고성능임을 보여줍니다.

작업 중 저장할 때 마다 체크해도 무관할 정도입니다.

 

Linter를 사용해야할 이유?

Linter를 사용하면 1차적으로 코드 스타일의 기본적인 부분에 대해 검증할 수 있습니다.

문법 스타일, 코드 라인당 문자수, 함수 내 if 문 개수 등 검증을 Linter에서 해주니 코드 리뷰할 때 리뷰어는 로직부분만 신경쓸 수 있게 됩니다. 

이와 같이 도구를 활용하여 1차적인 코드 리뷰를 진행할 수 있다면 팀내에 생산성도 증가할 것입니다.

고로 안써도 되지만 쓰면 매우 좋은 것이 Linter 입니다.

 

활발하게 사용하는 오픈소스

Apache Airflow

FastAPI

Hugging Face

Pandas

SciPy

등..

유명 오픈소스에서도 ruff를 적극 활용중입니다.

 

설치 및 기본 사용

기본적인 설치 및 세팅 방법에 대해 알려드리겠습니다.

pip install ruff

위 명령어를 통하여 설치합니다.

ruff .
ruff check .
python -m ruff .
python -m ruff check .

위 네가지 방법 중 아무 방법을 사용하여 현재 경로 및 하위 전체 경로에 대해 코드 컨벤션을 검사할 수 있습니다.

대략 위와 같이 어떤 파일의 어느 라인 몇 번째 칸의 코드에 어떤 제약조건에 걸리는지 보여줍니다.

현재는 특정 코드의 라인이 너무 길다는 에러를 남기고 있습니다.

 

pyproject.toml 설정 하기

pyproject.toml은 PEP 518 에서 프로젝트 빌드 시스템에 대한 설정을 할 수 있도록 지정된 파일이며 Ruff 에서는 설정파일로 사용할 수 있습니다.

[tool.ruff]
select = [
    "E",
    "F",
    "PL",
]

Root 경로에 pyproject.toml을 추가후 위 내용을 추가해줍니다.

select는 어떤 룰들을 적용할지 선택하는 옵션입니다.

 

위와 같이 설정하여 코드가 좀 더 많은 제약조건에 걸리게 되었습니다.

 

옵션에 대한 내용은 https://beta.ruff.rs/docs/rules/ 에 자세히 나와있습니다.

필요에 따라 팀내의 룰대로 코드 라인수, 제약조건 등을 설정하여 사용하면 됩니다.

 

 

Ruff 활용 방향

팀 단위 작업이라면 pyproject.toml 파일을 형상에 올려 룰을 관리하면 팀 전체 코드 퀄리티가 올라갈 것입니다.

 

git을 쓴다면 pre-commit hook 에서 커밋시 Ruff를 수행하도록 하여 통과되면 넘어가도록 세팅을 하거나,

PyCharm이라면 File Wathers 플러그인을 활용하여 저장할 때 마다 체크해도 충분히 사용할만 할 것 입니다.

 

Formatter인 Black와 함께 Ruff를 사용하면 코드 정리 및 퀄리티 업을 손쉽게 할 수 있을 것입니다.