Coding/Clean Code 3

[PEP] 함수 Docstring과 Type Hint 작성 방법

파이썬에서 유명한 라이브러리 코드를 보게 되면 무언가 많이 작성되어 있는 것을 볼 수가 있다. def generate_identified_filename(filename: Path, identifier: str) -> Path: """ Append a string-identifier at the end (before the extension, if any) to the provided filepath Args: filename: pathlib.Path The actual path object we would like to add an identifier suffix identifier: The suffix to add Returns: String with c..

Coding/Clean Code 2024.06.11

[PEP] Pythonic한 Name Convention에 대해 알아보자

파이썬에서 사용하는 PEP(Program Enhance Proposal) 에서 Name Convention에 대해 알아보려고 한다. PEP는 파이썬 개발자들 간의 관습을 적어놓은 것이라고 생깍하면 된다. 파이썬 유저라면 파이썬 코드를 작성할 때 PEP-8을 이용해서 쓰는 것을 추천한다.목차피해야 할 이름Package and Module Names (패키지 모듈 이름)Class Name (클래스 이름)Type Variable Names (타입 변수 이름)Exception Names (예외 이름)Global Variable Names (전역 변수 이름)Function and Variable Names (함수, 변수 이름)Method Names and Instance Variables (메소드와 인스턴스 변수..

Coding/Clean Code 2024.06.10

[Clean Code] 프로그래밍 명명 규칙인 Camel Case, Snake Case, Pascal Case, Kebab Case에 대해 알아보자

프로그래밍을 하다 보면 변수, 함수, 클래스 등을 정의할 때 대문자를 쓰거나 언더바('_')를 쓰는 경우를 볼 수 있는데 이에 대해 자세하게 알아보려고 한다. 요약명명 규칙설명예시Snake_case모든 글자를 소문자로 하며, 단어는 밑줄로 구분한다. new_object, my_website_name, user_profile camelCasePascalCase와 유사하지만 첫 글자는 소문자이며, 공백은 없다. newObject, myWebsiteName, userProfile PascalCase각 단어의 첫 글자를 대문자로 이며, 공백은 없다 NewObject, MyWebsiteName, UserProfile Kebab-case모든 글자를 소문자로 하며, 단어는 하이픈( '-' )으로 구분한다. new-o..

Coding/Clean Code 2024.06.09