[Python] Function

DongHyeon Jung·2022년 9월 19일
0

Python

목록 보기
6/8
post-thumbnail

함수 (function)

함수의 기본 예시

def searchVowels():  
    """searching your vowels"""    
    vowels = set('asdfg')  
    word = input("Provide a word: ")  
    found = vowels.intersection(set(word))  
  
    for letter in found:  
        print(letter)  
  
  
searchVowels()

docstring : """를 이용해서 함수의 기능을 설명하는 역할, 주석이다
(큰따옴표는 주석처리할 때, 작은 따옴표는 문자열을 감쌀 때 사용하자)

좋은 함수명을 생각해야 하는 이유?

인간의 기억력은 한계가 있다
내가 모든 함수의 기능을 구분할 수 없으며, 협업 시에 더 큰 문제가 될 수 있다
이름을 잘 짓는다면 함수의 코드를 살펴보아야만 하는 수고를 덜 수 있다

그렇다면 좋은 함수명을 짓는 방법에 대해 알아보자

1. 의도를 명확하게

def chcek(num)보다 def check(minutes)가 더 직관적이다

2. 올바른 정보

get_list_item같은 추상적인 이름보단
get_board_posts 와 같은 구체적인 기능을 하는 이름이 더 낫다

3. 의미있는 구분

Data 와 Info를 정확하고 엄밀하게 구분할 수 있는 방법은 없다

4. 검색하기 쉬운 이름

혹시 모를 상황을 대비해 수정해야 하는 변수가 있을 수도 있다

5. 기억력을 자랑하지 말자

우린 종종 효율을 위해서 약어를 사용하곤 한다
그러나 몇달 뒤에 그 코드를 본다면 무엇의 약어인지 기억하지 못한다
물론 property는 prop, string은 str으로 사용하긴 하지만
user를 u라고 줄이는 등 나만 이해할 수 있는 약어는 최대한 지양하도록 하자

6. 함수 이름은 동사명으로 짓기

하나의 함수가 너무 많은 동작을 하는 것은 아닌지 점검할 수 있다
함수를 쪼개야 할 필요성을 느낄 수 있게 된다

7. 너무 많은 인수는 혼란스러움

3개보다 많은 인수를 사용해야 할 땐 configuration object를 이용해서 정리한다

📚 참고한 자료

https://youtu.be/Jz8Sx1XYb04
https://dkje.github.io/2020/08/03/CleanCodeSeries2-copy/
https://melevir.medium.com/python-functions-naming-tips-376f12549f9

0개의 댓글