프로그래밍/클린 코드2 [클린 코드] 2. docstring과 annotation을 이용한 코드 문서화 내가 작성한 파이썬(Python) 코드, 좀 더 구체적으로 말하면 클래스나 함수를 다른 엔지니어가 사용하려고 할 때 그 함수에 대한 입출력 정보, 동작 방식을 확인할 수 있어야 한다. 이때 사용하는 것이 docstring과 annotation이다. 이번 포스팅에서는 docstring과 annotation에 대해서 알아보려고 한다. docstring과 annotation을 이용한 코드 문서화 1) docstring docstring은 함수, 클래스에 대한 사용법, 입출력 정보 등을 문서화할 수 있는 기능이다. docstring은 어떤 정해진 형식은 없으나 대체로 함수 설명, 입력값 정보, 출력값 정보, 그리고 사용법 예제 순으로 정리하는 것 같다. docstring은 함수 또는 클래스 내에 홑따옴표(또는 .. 2023. 2. 20. [클린 코드] 1. 데이터 타입 일관성 검사하기 (feat. mypy) 클린 코드는 자신을 위해서 또는 내 코드를 사용할 다른 사람들을 위해서 코드를 일관성 있고 가독성 있게 프로그래밍된 코드를 말한다. 이번 포스팅에서는 그중에서 mypy을 이용한 데이터 타입 일관성을 검사하는 방법에 대해서 알아보려고 한다. 데이터 타입 일관성 검사하기 1) mypy 설치하기 mypy는 pip을 통하여 설치할 수 있다. pip install mypy 2) 데이터 타입 일관성 검사하기 먼저 아래 코드를 담은 파이썬(python) 파일 test.py를 만들어준다. 아래 코드는 문자열 타입 변수 message와 문자열을 원소로하는원소로 하는 리스트(List) 또는 튜플(Tuple) 타입 변수 users를 받아서 문자열을 원소로 하는 순회가능한 객체를 리턴한다. 그러고 나서 의도했던 타입이 아닌 .. 2023. 2. 12. 이전 1 다음
