[Python] 사용자 정의 함수를 사용할 때의 주의 사항

[Python] 사용자 정의 함수를 사용할 때의 주의 사항

사용자 정의 함수를 작성할 때, 코드의 가독성과 안정성을 향상 시키기 위해

주의해야 할 점을 정리해보고자 한다.

 

명확한 역할

함수는 한 가지 명확한 역할을 수행하도록 작성해야 한다.

함수가 너무 많은 일을 하거나 다양한 동작을 수행하면 가독성과 유지보수성이 저하된다.

 

부작용 최소화

함수는 입력에 대해 예측가능한 결과를 반환해야 한다.

부작용(ex. 전역 변수 변경, 파일 시스템 수정 등)을 최소화하여 함수의 예측 가능성을 높인다.

 

명확한 이름

함수명은 해당 함수가 하는 일을 명확히 설명해야 한다.

의미 있는 이름을 선택하여 함수의 역할을 명확히 전달한다.

 

매개변수 개수

함수의 매개변수 개수를 적절히 제한해야한다.

많은 매개변수를 가진 함수는 이해하기 어려울 수 있고, 함수 호출 시 실수가 발생 할 가능성이 높아진다.

필요하다면 여러 개의 함수로 분리하여 작성한다.

 

가변 매개변수 사용

필요한 경우에만 가변 매개변수(*args 또는 **kwargs)를 사용한다.

가변 매개변수를 남발하면 함수의 사용법을 이해하기 어려워질 수 있다.

 

주석

함수의 역할과 매개변수의 역할을 설명하는 주석을 추가한다.

함수의 코드가 어려운 부분이나 중요한 부분을 주석으로 설명하여 이해를 돕는다.

 

유닛 테스트 작성

함수의 동작을 검증하기 위해 유닛 테스트를 작성한다.

이를 통해 함수가 의도한대로 동작하는지 확인하고, 코드 변경 시 예기치 않은 동작이 발생하지 않도록 보장한다.

 

반환값 처리

함수가 반환하는 값에 대한 처리를 적절히 한다.

반환값을 무시하거나 예외를 처리하는 등의 방법을 활용한다.

 

주의점에 따라 함수를 작성하면,

코드의 가독성과 유지보수성을 향상 시킬 수 있다.