Python 코드의 가독성을 향상시키는 5가지 필수 팁

번역가 | Zhao Qingyu

리뷰어 | Sun Shujuan

종종 6개월 전에 작성한 코드를 되돌아보고 이 코드에서 무슨 일이 일어나고 있는지 알고 싶나요? 어디서부터 시작해야 할까요? 이 상황은 개발자에게 비교적 일반적입니다. Python에는 코드의 내부 작동을 이해하는 데 도움이 되는 많은 메서드가 있으므로 처음부터 코드를 보거나 코드를 작성할 때 중단한 부분부터 계속하는 것이 더 쉬울 것입니다.

여기서 아래와 같은 코드를 얻을 수 있습니다. 이것이 최악은 아니지만 다음과 같이 확인해야 할 사항이 있습니다.

• load_las_file 함수에서 f와 d는 무엇을 의미하나요?
• 클레이 함수에서 결과를 확인하는 이유는 무엇인가요? 이 함수에는 어떤 유형이 필요합니까? 아니면 DataFrames인가요?

이 기사에서는 문서화, 프롬프트 입력 및 적절한 변수 이름을 통해 애플리케이션/스크립트의 가독성을 향상시키는 방법에 대한 5가지 기본 팁을 다룰 것입니다.

1. 댓글

코드에서 가장 먼저 할 수 있는 일은 특정 줄에 댓글을 추가하는 것입니다. 하지만 너무 많은 댓글을 달지 않도록 주의하세요. 주석은 구현 방식보다는 코드가 작동하는 이유나 특정 방식으로 작업이 수행되는 이유를 설명해야 합니다. Python의 주석은 일반적으로 한 줄 또는 여러 줄에 걸쳐 있을 수 있는 파운드 기호(#)를 사용하여 수행됩니다.

# Comment using the hashtag
# Another comment using the hashtag

여러 줄 주석의 경우 큰따옴표를 사용할 수도 있습니다.

"""
This is an example of
a multi-line comment
"""

아래 예에서는 특정 코드 줄의 작동 방식과 이유를 설명하기 위해 몇 가지 주석이 코드에 추가되었습니다.

2. 명시적 입력

Python 언어는 동적으로 입력됩니다. 즉, 변수 유형은 다음과 같습니다. 런타임에만 확인됩니다. 또한 변수는 코드 실행 중에 유형을 변경할 수 있습니다. 반면 정적 유형 지정에는 변수 유형을 명시적으로 선언하는 작업이 포함되며 코드 실행 중에 변경할 수 없습니다.

2014년 PEP 484는 유형 힌트 개념을 도입했으며, 이 개념은 이후 Python 3.5에 도입되었습니다. 이를 통해 변수 유형을 명시적으로 선언할 수 있습니다. 유형 힌트를 추가하면 코드의 가독성을 크게 향상시킬 수 있습니다. 다음 예에서 볼 수 있습니다.

에는 두 개의 매개변수가 필요합니다.

• 매개변수 파일 이름 유형은 문자열입니다.
• 매개변수 start_깊이 유형은 부동 소수점 유형이고 이 매개변수의 기본값은 None입니다.
• 함수는 다음을 반환합니다. Pandas DataFrame 객체

유형 힌트를 기반으로 함수에 필요한 것과 반환할 내용을 정확히 알 수 있습니다.

3. 문서 문자열

문서 문자열은 함수 또는 클래스 정의 바로 뒤에 오는 문자열입니다. Docstring은 함수가 수행하는 작업, 함수가 취하는 인수, 발생하는 예외, 반환 값 등을 자세히 설명하는 좋은 방법입니다. 또한 Sphinx와 같은 도구를 사용하여 코드에 대한 온라인 문서를 만드는 경우 독스트링이 자동으로 추출되어 적절한 문서로 변환됩니다. 다음 예는 clay_volume이라는 함수에 대한 독스트링을 보여줍니다. 여기에서 각 매개변수의 의미를 지정할 수 있습니다. 이렇게 하면 기본 유형 힌트보다 더 자세해집니다. 학술 참고자료나 방정식과 같이 함수 뒤에 있는 방법론에 대한 자세한 정보를 포함할 수도 있습니다.

Doc 문자열은 코드의 다른 곳에서 함수를 호출할 때도 매우 유용합니다. 예를 들어 Visual Studio를 사용하여 코드를 작성할 때 함수 호출 위로 마우스를 가져가면 함수의 기능과 필요한 사항을 보여주는 팝업을 볼 수 있습니다.

Visual Studio Code(VS Code)를 사용하여 Python 코드를 편집하는 경우 autoDocstring과 같은 확장을 사용하면 Docstring 생성 프로세스를 더 쉽게 만들 수 있습니다. 세 개의 큰따옴표를 입력하면 나머지 템플릿이 자동으로 채워집니다. 세부 사항을 작성하기 만하면됩니다.

팁: 매개변수에 유형을 선언한 경우 해당 유형이 자동으로 선택됩니다.

4. 읽을 수 있는 변수 이름

때때로 코드를 작성할 때 특히 시간이 부족할 때는 변수 이름에 크게 신경 쓰지 않을 때가 있습니다. 그러나 다시 코드를 살펴보면서 x1 또는 var123이라는 일련의 변수를 발견하면 언뜻 보기에는 그것이 무엇을 나타내는지 이해하지 못할 수도 있습니다. 아래 예에는 두 개의 변수 f와 d가 있습니다. 코드의 다른 부분을 살펴보면 이러한 변수의 의미를 추측할 수 있지만, 특히 코드가 긴 경우에는 시간이 걸릴 수 있습니다.

이러한 변수에 적절한 이름을 지정하면 변수 중 하나가 lasio.read() 호출에서 읽은 data_file이며 원본 데이터일 가능성이 높다는 것을 알 수 있습니다. 데이터 변수는 이것이 우리가 다루고 있는 실제 데이터임을 알려줍니다.

5. 매직 넘버를 피하세요

매직 넘버는 코드에서 설명할 수 없는 의미를 지닌 값으로 상수가 될 수 있습니다. 코드에서 이러한 항목을 사용하면 특히 계산에 숫자를 사용하는 데 익숙하지 않은 경우 모호함이 발생할 수 있습니다. 또한 여러 위치에 동일한 매직 넘버가 있는 경우 업데이트해야 할 때 모든 인스턴스를 업데이트해야 합니다. 그러나 이러한 숫자에 적절한 이름의 변수가 할당되면 대체 프로세스가 훨씬 쉬워집니다. 아래 예에는 result라는 값을 계산하고 여기에 0.6을 곱하는 함수가 있습니다. 그것은 무엇을 의미합니까? 스칼라입니까?

변수를 선언하고 값을 할당하면 그것이 무엇인지 더 잘 알 수 있습니다. 이 경우 감마선 지수를 점토 부피로 변환하기 위해 점토와 셰일의 비율을 사용합니다.

6. 최종 코드

위의 팁을 적용한 후 최종 코드는 이제 더 깔끔하고 이해하기 쉬워졌습니다.

7. 요약

주석과 독스트링을 통해 코드에 설명을 추가하면 귀하와 다른 사람들이 코드의 기능을 이해하는 데 도움이 될 수 있습니다. 처음에는 자질구레한 일처럼 느껴질 수도 있지만 도구를 사용하고 정기적으로 연습하면 제2의 천성이 될 것입니다.

원본 링크: https://towardsdatascience.com/5-essential-tips-to-improve-the-readability-of-your-python-code-a1d5e62a4bf0

번역자 소개

Zhao Qingyu, 51CTO 커뮤니티 편집자, 참여 수년간의 개발 추진. 그의 연구 관심 분야는 보안 OS 및 네트워크 보안 분야이며, 네트워크 관련 특허를 발표했습니다.

위 내용은 Python 코드의 가독성을 향상시키는 5가지 필수 팁의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!