2020.09.21

군더더기 없는 파이썬 코드를 위한 타입 체커 4종

Serdar Yegulalp | InfoWorld
파이썬 초기에는 양식(type decoration)이란 것이 없었다. 이는 파이썬의 근본적인 목표와 관련이 있는데, 코드 작성의 복잡한 부분을 처리하고 개발자가 코드를 간결하게 유지하는 데 도움이 되는 유연한 객체 형식을 사용하는 빠르고 다루기 쉬운 언어를 지향했기 때문이다.
 
© Getty Images Bank

그러나 지난 몇 년 동안 파이썬에 형식 주석 지원이 추가되고 개발 중 파이썬 형식을 검사하는 전용 소프트웨어가 쏟아져 나왔다. 파이썬은 적어도 아직은 런타임에 형식을 검사하지 않는다. 그러나 IDE용 형식 검사기를 활용하면 파이썬의 형식 주석을 사용해 프로덕션에 이르기 전에 많은 실수를 잡아낼 수 있다.

여기서는 파이썬을 위한 주요 형식 검사 추가 기능 4가지를 살펴본다. 4개 모두 패턴은 대체로 같아서, 파이썬 코드에서 형식 주석을 스캔해 피드백을 제공한다. 이런 기본 개념에 더해 각자 고유한 기능을 추가했다.
 

마이파이

마이파이(Mypy)는 2012년부터 시작돼 여전히 활발하게 개발되는 파이썬용 첫 정적 형식 검사 시스템이다. 사실상 다른 여러 파이썬용 써드 파티 형식 검사 라이브러리의 프로토타입이다.

마이파이는 독립형 또는 명령 줄에서 실행하거나 편집기나 IDE의 린터에 통합해 사용할 수 있다. 많은 편집기와 IDE가 마이파이를 지원해 비주얼 스튜디오 코드의 파이썬 확장에서는 별도 과정 없이 바로 작동한다. 실행하면 마이파이는 코드가 제공하는 형식 정보를 기반으로 코드의 일관성에 대한 보고서를 생성한다.

코드에 형식 주석이 포함되지 않은 경우 마이파이의 코드 검사 대부분이 수행되지 않는다. 그러나 마이파이를 사용해서 주석이 없는 코드에 플래그를 지정할 수 있다. 플래그의 엄격함 정도는 필요에 따라 다양하게 설정할 수 있다.

코드베이스를 처음부터 새로 시작하고 사전에 공격적인 린팅 전략을 원하는 경우 --strict  옵션을 사용해서 형식이 지정되지 않은 코드를 예방할 수 있다. 반면 형식 정의가 많지 않은 레거시 코드베이스로 작업할 때는 --disallow-untyped-defs를 사용해 형식이 지정되지 않은 함수 정의만 차단하면서 다른 형식 없는 코드는 허용하는 등 더 느슨하게 사용할 수 있다. 또한 언제든 # type: ignore와 같은 인라인 주석을 사용해 개별 코드 라인을 플래그 대상에서 제외할 수 있다.

모듈의 공용 인터페이스를 위한 형식 힌트를 사용하려는 경우 마이파이에서 PEP 484 스텁 파일을 쓰면 된다. 그 외에 마이파이는 기존 코드에서 자동으로 스텁 파일을 생성하는 툴인 stubgen을 제공한다. 형식이 지정되지 않은 코드라면 스텁 파일은 제네릭 형식을 사용하므로 필요에 따라 개발자가 직접 마크업할 수 있다.
 

파이타입

구글이 만든 파이타입(Pytype)은 형식 설명자 대신 추론을 사용한다는 점에서 마이파이 같은 툴과 구분된다. 즉, 파이타입은 엄격히 형식 주석에 의존하는 것이 아니라 코드 흐름을 분석해 형식을 판단한다.

파이타입의 구문 오류 검출은 관대한 편이다. 런타임에 작동하며 주석을 부정하지 않는 연산이 있으면 그냥 넘어간다. 이는 플래그가 지정돼야 할 일부 문제가 알림 없이 통과될 수 있음을 의미한다. 예를 들어 한 지점에서 형식을 사용해 변수를 선언한 다음 같은 컨텍스트에서 다시 정의하는 경우다. 개발 로드맵에 따르면, 앞으로 이러한 식으로 작동하지는 않을 예정이다.

코드에 형식 주석을 추가하면 파이타입의 reveal_type 함수가 특히 유용하다. 코드에 reveal_type(expr)이라는 문을 삽입하면 파이타입은 expr을 평가해 형식을 기술하는 알림을 생성한다. 참고로, 특정 파이타입 동작은 코드 자체에 특성을 추가하는 방식으로 제어된다. 예를 들어 파이타입이 누락된 특성이나 동적으로 설정되는 모듈 멤버에 대한 메시지를 생성하지 않도록 하려면 파이타입 구성 메타데이터를 설정하는 것이 아니라 해당 클래스나 모듈에 _HAS_DYNAMIC_ATTRIBUTES = True 특성을 추가해야 한다.
 

파이라이트 / 파이랜스

파이라이트(Pyright)는 마이크로소프트의 파이썬 형식 검사기로, 비주얼 스튜디오 코드용 파이랜스(Pylance) 확장에 포함돼 있다. 비주얼 스튜디오 코드 사용자라면 파이랜스 확장이 파이라이트를 다루는 가장 편리한 방법이다. 설치만 하면 바로 사용할 수 있기 때문이다. 파이라이트는 효과적인 올인원 형식 검사와 코드 린팅 환경을 제공하며, 앞서 살펴본 두 파이썬 분석 툴의 편의성과 고급 기능도 대부분 제공한다.

파이라이트는 파이타입과 마찬가지로 형식 정보가 전혀 없는 코드베이스에서 작동할 수 있다. 형식 정보가 없으면 파이라이트는 현재 적용되는 형식을 추론한다. 따라서 형식 선언이 없는 예전의 코드베이스에서 파이타입으로 좋은 결과를 얻을 수 있다. 그러나 점진적으로 코드에 형식 주석을 추가하면 시간이 갈수록 더 좋은 결과를 얻게 된다.

파이라이트는 실제 파이썬 프로젝트를 보완하는 방식에 있어 상당히 유연하다. 다른 형식 검사기와 마찬가지로 파이라이트는 프로젝트 디렉터리에서 JSON 형식의 구성 파일을 사용해 프로젝트별로 구성할 수 있다. 구성 파일에서 개별 경로를 제외하거나(검사되지 않음) 무시할 수 있으며(오류 및 경고 표시 안 함) 옵션이 매우 세분화돼 있다.

비주얼 스튜디오 코드에서 프로젝트의 여러 부분에 서로 다른 린팅 구성이 필요한 경우 여러 루트가 있는 작업 공간 각각에 파이라이트를 구성할 수도 있다. 같은 맥락에서 한 프로젝트 내에 각자의 venv 또는 가져오기 경로를 둔 여러 '실행 환경'을 정의할 수 있다.
 

파이어

페이스북과 인스타그램의 개발자가 만든 파이어(Pyre)는 형식 검사기(파이어)와 정적 코드 분석 툴인 파이사(Pysa), 두 가지 툴이 하나로 결합한 툴이다. 이 두 개의 툴은 함께 작동하면서 다른 툴에 비해 더 높은 수준의 검사와 분석을 제공하지만, 제대로 활용하려면 직접 해야 할 일이 조금 있다.

파이어의 접근 방법은 파이타입, 마이파이와 비슷하다. 형식이 지정되지 않은 코드는 형식이 지정된 코드에 비해 더 관대하게 취급되므로 형식 없는 파이썬 코드베이스에서 시작해 함수별, 모듈별로 주석을 추가할 수 있다. 모듈에서 '엄격 모드(strict mode)'를 켜면 파이어는 모든 빠진 주석에 플래그를 단다. 또는 엄격 모드를 기본값으로 설정해서 모듈 수준에서 걸러낼 수 있다. 파이어는 .pyi-format 스텁 파일과도 호환된다.

파이어에는 형식 지정 포맷으로 코드베이스를 마이그레이션하는 강력한 기능이 있다. infer  명령줄 옵션은 파일 또는 디렉터리를 분석해 사용된 형식을 경험적으로 추론하고 파일에 주석을 적용한다. 단, 먼저 코드를 백업해야 한다. 실행 중인 파이썬 프로그램에서 형식 정보를 얻고자 하는 경우 또 다른 페이스북/인스타그램 프로젝트인 몽키타입(MonkeyType)을 사용하면 된다.

파이어의 기능은 여기서 다룬 다른 패키지의 기능과 동일하지만 파이사(Pysa)는 다르다. 파이사는 코드에서 '오염 분석(taint analysis)'을 수행해 잠재적인 보안 문제를 찾는다. 특정 소프트웨어 구성요소에 대한 흐름 분석 라이브러리를 활용해 작동하며, 취약한 것으로 나타나는 코드에 플래그를 표시한다. 이 코드가 접촉하는 모든 부분에도 오염 플래그가 지정되지만 문제가 되는 데이터를 삭제하고 오염 그래프에서 해당 데이터를 빼는 구성요소를 지정할 수 있다.

한 가지 단점은 파이사의 써드 파티 구성요소 오염 분석 라이브러리는 아직 규모가 작아 모델을 직접 만들어야 할 수 있다는 점이다. 그러나 오염 분석의 상당수는 일반적인 파일 시스템 문제를 위한 분석은 물론 장고(Django) 웹 프레임워크, SQL 알케미(Alchemy) ORM, 판다스(Pandas) 데이터 과학 라이브러리와 같이 광범위하게 사용되는 소프트웨어를 대상으로 한다. editor@itworld.co.kr


2020.09.21

군더더기 없는 파이썬 코드를 위한 타입 체커 4종

Serdar Yegulalp | InfoWorld
파이썬 초기에는 양식(type decoration)이란 것이 없었다. 이는 파이썬의 근본적인 목표와 관련이 있는데, 코드 작성의 복잡한 부분을 처리하고 개발자가 코드를 간결하게 유지하는 데 도움이 되는 유연한 객체 형식을 사용하는 빠르고 다루기 쉬운 언어를 지향했기 때문이다.
 
© Getty Images Bank

그러나 지난 몇 년 동안 파이썬에 형식 주석 지원이 추가되고 개발 중 파이썬 형식을 검사하는 전용 소프트웨어가 쏟아져 나왔다. 파이썬은 적어도 아직은 런타임에 형식을 검사하지 않는다. 그러나 IDE용 형식 검사기를 활용하면 파이썬의 형식 주석을 사용해 프로덕션에 이르기 전에 많은 실수를 잡아낼 수 있다.

여기서는 파이썬을 위한 주요 형식 검사 추가 기능 4가지를 살펴본다. 4개 모두 패턴은 대체로 같아서, 파이썬 코드에서 형식 주석을 스캔해 피드백을 제공한다. 이런 기본 개념에 더해 각자 고유한 기능을 추가했다.
 

마이파이

마이파이(Mypy)는 2012년부터 시작돼 여전히 활발하게 개발되는 파이썬용 첫 정적 형식 검사 시스템이다. 사실상 다른 여러 파이썬용 써드 파티 형식 검사 라이브러리의 프로토타입이다.

마이파이는 독립형 또는 명령 줄에서 실행하거나 편집기나 IDE의 린터에 통합해 사용할 수 있다. 많은 편집기와 IDE가 마이파이를 지원해 비주얼 스튜디오 코드의 파이썬 확장에서는 별도 과정 없이 바로 작동한다. 실행하면 마이파이는 코드가 제공하는 형식 정보를 기반으로 코드의 일관성에 대한 보고서를 생성한다.

코드에 형식 주석이 포함되지 않은 경우 마이파이의 코드 검사 대부분이 수행되지 않는다. 그러나 마이파이를 사용해서 주석이 없는 코드에 플래그를 지정할 수 있다. 플래그의 엄격함 정도는 필요에 따라 다양하게 설정할 수 있다.

코드베이스를 처음부터 새로 시작하고 사전에 공격적인 린팅 전략을 원하는 경우 --strict  옵션을 사용해서 형식이 지정되지 않은 코드를 예방할 수 있다. 반면 형식 정의가 많지 않은 레거시 코드베이스로 작업할 때는 --disallow-untyped-defs를 사용해 형식이 지정되지 않은 함수 정의만 차단하면서 다른 형식 없는 코드는 허용하는 등 더 느슨하게 사용할 수 있다. 또한 언제든 # type: ignore와 같은 인라인 주석을 사용해 개별 코드 라인을 플래그 대상에서 제외할 수 있다.

모듈의 공용 인터페이스를 위한 형식 힌트를 사용하려는 경우 마이파이에서 PEP 484 스텁 파일을 쓰면 된다. 그 외에 마이파이는 기존 코드에서 자동으로 스텁 파일을 생성하는 툴인 stubgen을 제공한다. 형식이 지정되지 않은 코드라면 스텁 파일은 제네릭 형식을 사용하므로 필요에 따라 개발자가 직접 마크업할 수 있다.
 

파이타입

구글이 만든 파이타입(Pytype)은 형식 설명자 대신 추론을 사용한다는 점에서 마이파이 같은 툴과 구분된다. 즉, 파이타입은 엄격히 형식 주석에 의존하는 것이 아니라 코드 흐름을 분석해 형식을 판단한다.

파이타입의 구문 오류 검출은 관대한 편이다. 런타임에 작동하며 주석을 부정하지 않는 연산이 있으면 그냥 넘어간다. 이는 플래그가 지정돼야 할 일부 문제가 알림 없이 통과될 수 있음을 의미한다. 예를 들어 한 지점에서 형식을 사용해 변수를 선언한 다음 같은 컨텍스트에서 다시 정의하는 경우다. 개발 로드맵에 따르면, 앞으로 이러한 식으로 작동하지는 않을 예정이다.

코드에 형식 주석을 추가하면 파이타입의 reveal_type 함수가 특히 유용하다. 코드에 reveal_type(expr)이라는 문을 삽입하면 파이타입은 expr을 평가해 형식을 기술하는 알림을 생성한다. 참고로, 특정 파이타입 동작은 코드 자체에 특성을 추가하는 방식으로 제어된다. 예를 들어 파이타입이 누락된 특성이나 동적으로 설정되는 모듈 멤버에 대한 메시지를 생성하지 않도록 하려면 파이타입 구성 메타데이터를 설정하는 것이 아니라 해당 클래스나 모듈에 _HAS_DYNAMIC_ATTRIBUTES = True 특성을 추가해야 한다.
 

파이라이트 / 파이랜스

파이라이트(Pyright)는 마이크로소프트의 파이썬 형식 검사기로, 비주얼 스튜디오 코드용 파이랜스(Pylance) 확장에 포함돼 있다. 비주얼 스튜디오 코드 사용자라면 파이랜스 확장이 파이라이트를 다루는 가장 편리한 방법이다. 설치만 하면 바로 사용할 수 있기 때문이다. 파이라이트는 효과적인 올인원 형식 검사와 코드 린팅 환경을 제공하며, 앞서 살펴본 두 파이썬 분석 툴의 편의성과 고급 기능도 대부분 제공한다.

파이라이트는 파이타입과 마찬가지로 형식 정보가 전혀 없는 코드베이스에서 작동할 수 있다. 형식 정보가 없으면 파이라이트는 현재 적용되는 형식을 추론한다. 따라서 형식 선언이 없는 예전의 코드베이스에서 파이타입으로 좋은 결과를 얻을 수 있다. 그러나 점진적으로 코드에 형식 주석을 추가하면 시간이 갈수록 더 좋은 결과를 얻게 된다.

파이라이트는 실제 파이썬 프로젝트를 보완하는 방식에 있어 상당히 유연하다. 다른 형식 검사기와 마찬가지로 파이라이트는 프로젝트 디렉터리에서 JSON 형식의 구성 파일을 사용해 프로젝트별로 구성할 수 있다. 구성 파일에서 개별 경로를 제외하거나(검사되지 않음) 무시할 수 있으며(오류 및 경고 표시 안 함) 옵션이 매우 세분화돼 있다.

비주얼 스튜디오 코드에서 프로젝트의 여러 부분에 서로 다른 린팅 구성이 필요한 경우 여러 루트가 있는 작업 공간 각각에 파이라이트를 구성할 수도 있다. 같은 맥락에서 한 프로젝트 내에 각자의 venv 또는 가져오기 경로를 둔 여러 '실행 환경'을 정의할 수 있다.
 

파이어

페이스북과 인스타그램의 개발자가 만든 파이어(Pyre)는 형식 검사기(파이어)와 정적 코드 분석 툴인 파이사(Pysa), 두 가지 툴이 하나로 결합한 툴이다. 이 두 개의 툴은 함께 작동하면서 다른 툴에 비해 더 높은 수준의 검사와 분석을 제공하지만, 제대로 활용하려면 직접 해야 할 일이 조금 있다.

파이어의 접근 방법은 파이타입, 마이파이와 비슷하다. 형식이 지정되지 않은 코드는 형식이 지정된 코드에 비해 더 관대하게 취급되므로 형식 없는 파이썬 코드베이스에서 시작해 함수별, 모듈별로 주석을 추가할 수 있다. 모듈에서 '엄격 모드(strict mode)'를 켜면 파이어는 모든 빠진 주석에 플래그를 단다. 또는 엄격 모드를 기본값으로 설정해서 모듈 수준에서 걸러낼 수 있다. 파이어는 .pyi-format 스텁 파일과도 호환된다.

파이어에는 형식 지정 포맷으로 코드베이스를 마이그레이션하는 강력한 기능이 있다. infer  명령줄 옵션은 파일 또는 디렉터리를 분석해 사용된 형식을 경험적으로 추론하고 파일에 주석을 적용한다. 단, 먼저 코드를 백업해야 한다. 실행 중인 파이썬 프로그램에서 형식 정보를 얻고자 하는 경우 또 다른 페이스북/인스타그램 프로젝트인 몽키타입(MonkeyType)을 사용하면 된다.

파이어의 기능은 여기서 다룬 다른 패키지의 기능과 동일하지만 파이사(Pysa)는 다르다. 파이사는 코드에서 '오염 분석(taint analysis)'을 수행해 잠재적인 보안 문제를 찾는다. 특정 소프트웨어 구성요소에 대한 흐름 분석 라이브러리를 활용해 작동하며, 취약한 것으로 나타나는 코드에 플래그를 표시한다. 이 코드가 접촉하는 모든 부분에도 오염 플래그가 지정되지만 문제가 되는 데이터를 삭제하고 오염 그래프에서 해당 데이터를 빼는 구성요소를 지정할 수 있다.

한 가지 단점은 파이사의 써드 파티 구성요소 오염 분석 라이브러리는 아직 규모가 작아 모델을 직접 만들어야 할 수 있다는 점이다. 그러나 오염 분석의 상당수는 일반적인 파일 시스템 문제를 위한 분석은 물론 장고(Django) 웹 프레임워크, SQL 알케미(Alchemy) ORM, 판다스(Pandas) 데이터 과학 라이브러리와 같이 광범위하게 사용되는 소프트웨어를 대상으로 한다. editor@itworld.co.kr


X