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

Python에는 코드의 내부 작동 방식을 이해하는 데 도움이 되는 많은 방법이 있습니다. 좋은 프로그래밍 습관은 절반의 노력으로 작업을 더 효과적으로 만들 수 있습니다!

예를 들어, 아래 이미지와 매우 유사한 코드가 생성될 수 있습니다. 최악은 아니지만 다음과 같이 확장해야 할 몇 가지 사항이 있습니다.

• load_las_file 함수에서 f와 d는 무엇을 의미합니까?
• 왜 결과를 클레이 기능으로 확인하나요?
• 이 기능에는 어떤 유형이 필요합니까? Floats? 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_length 매개변수는 부동 소수점 유형이어야 하며 기본값은 None입니다.
• The 함수는 팬더 DataFrame 객체를 반환합니다

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

3. Docstring(문서 문자열)

Document 문자열은 함수 또는 클래스 정의를 따르는 문자열 리터럴입니다. Docstring은 함수가 수행하는 작업, 매개 변수 및 예외를 자세히 설명하는 좋은 방법입니다. 어떤 것이 던져질 것인지, 무엇을 반환할 것인지 등.

또한 Sphinx와 같은 도구를 사용하여 코드에 대한 온라인 문서를 생성하면 독스트링이 자동으로 선택되어 적절한 문서로 변환됩니다.

아래 예는 clay_volume이라는 함수에 대한 독스트링을 보여줍니다.

여기서 각 매개변수가 무엇인지 지정할 수 있는데, 이는 기본 유형 힌트보다 더 자세하게 설명할 수 있으며 학술 참고자료나 방정식과 같이 함수 뒤에 숨겨진 방법에 대한 추가 정보도 포함할 수 있습니다.

독스트링을 갖는 것은 코드의 다른 곳에서 함수를 호출할 때에도 매우 유용합니다. 예를 들어 Visual Studio를 사용하여 코드를 편집할 때 함수 호출 위로 마우스를 가져가면 함수의 기능과 필요한 사항에 대한 팝업을 볼 수 있습니다.

Visual Studio Code(VSCode)를 사용하여 Python 코드를 편집하는 경우 autoDocstring과 같은 확장을 사용하여 Docstring 생성 프로세스를 단순화할 수 있습니다. 플러그인을 사용하면 세 개의 큰따옴표를 입력하고 템플릿의 나머지 부분을 자동으로 채울 수 있으므로, 채워야 하는 다른 세부 사항에만 집중하면 됩니다.

4. 읽을 수 있는 변수 이름

우리는 코드를 작성할 때 변수 이름에 별로 주의를 기울이지 않는 경우가 많습니다. 특히 특정 기능을 완료하려고 할 때는 더욱 그렇습니다. 그러나 우리 코드가 x1 또는 var123이라는 일련의 변수를 반환하는 경우 누구도 첫눈에 그것이 무엇을 의미하는지 이해할 수 없습니다.

아래 예에는 두 개의 변수 f와 d가 있습니다. 코드의 다른 부분을 보면 이것이 무엇을 의미하는지 추측할 수 있지만, 특히 코드가 긴 경우에는 시간이 좀 걸립니다.

이러한 변수에 적절한 이름을 지정하면 그 중 하나가 lasio.read() 호출로 읽은 data_file이고 원본 데이터일 가능성이 높음을 알 수 있으며, data 변수는 이것이 우리가 사용하는 실제 데이터라는 것을 알 수 있습니다.

5. 매직 넘버 피하기

매직 넘버는 설명할 수 없는 많은 의미를 담고 있는 코드의 값이며 상수를 나타낼 수 있습니다. 코드에서 이를 사용하면 특히 숫자가 사용되는 계산에 익숙하지 않은 사람들에게 모호함이 발생할 수 있습니다.

또한 여러 위치에 동일한 매직 넘버가 있고 업데이트해야 한다면 모든 인스턴스를 업데이트해야 합니다. 그러나 적절한 이름의 변수에 숫자를 할당하면 전체 프로세스가 훨씬 쉬워집니다.

아래 예에는 result라는 값을 계산하고 0.6을 곱하는 함수가 있습니다. 우리는 코드에서 코드가 무엇을 의미하는지 정확히 알 수 없습니다.

변수를 선언하고 값을 할당하면 그것이 무엇인지 더 잘 알 수 있습니다. 이 경우 감마선 지수를 점토 부피로 변환하는 데 사용되는 점토 대 셰일 비율입니다.

요약

주석과 독스트링을 통해 코드에 문서를 추가하면 우리 자신과 다른 사람들이 코드가 수행하는 작업을 이해하는 데 큰 도움이 될 수 있습니다. 실제로 처음에는 자질구레한 일처럼 느껴질 수도 있지만 도구를 사용하고 정기적으로 연습하면 제2의 천성이 될 수 있습니다.

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