개발자/파이썬 Python

파이선 함수. 리얼파이선 8

지구빵집 2022. 2. 3. 09:30
반응형

 

 

파이선 함수 리얼파이선 8 

 

앞 장에서 파이선 제어에 대해 알아보았죠. 변수, 연산, 제어에 이어 이제 함수에 대해 배워보겠습니다. 함수란 특정한 기능을 실행하기 위해 블랙박스처럼 구현한 코드의 집합을 말합니다. 함수 안에는 다시 변수, 연산, 제어, 함수가 모두 들어있습니다. 다른 말로 모듈, 패키지, 라이브러리, API, 메써드 등 불리는 이름은 다르더라도 의미로는 함수를 지칭하는 단어입니다. 한 가지 기능을 하는 하나의 함수를 만들기 위해 노력하세요.

 

함수란?

 

함수는 블랙박스와 같습니다. 함수에 대해서 알아야 할 것은 입력 매개변수(인자)와 출력 값(리턴값이 있든 없든)이 전부일 때가 많습니다. 함수의 코드가 실제로 어떻게 돌아가는지 알아야 할 부담감을 항상 느껴야 할 필요는 없습니다.

 

함수를 어떤 기능을 하는 숨겨진 코드 집합으로 이해하세요. 함수를 고차원적으로 생각해 본다면, 흔히 하는 이야기로는 함수라는 것은 "블랙박스"로 취급하면 됩니다. 이 아이디어는 현대 프로그래밍의 기본입니다. 다른 사람들이 만든 여러 가지 모듈의 함수를 모두 보게 됩니다. 물론 호기심이 있다면 함수의 소스코드를 들여다볼 수 있지만, 이들 함수를 사용하기 위해서 코드가 어떤 식으로 돌아가는지를 알 필요는 없습니다. 또한 함수에서는 전역 변수(global 변수)를 쓰지 않도록 권장되기 때문에 보통은 함수의 코드가 프로그램의 나머지 부분과 어떻게 상호작용하는지를 걱정할 필요는 없습니다.

 

 

Components of a python function 이미지 https://datascienceparichay.com/python-for-data-science/python-functions/

 

함수 정의하기

 

피보나치 수열을 임의의 한도까지 출력하는 함수를 만들 수 있습니다:

 

>>> def fib(n):    # write Fibonacci series up to n
...     """Print a Fibonacci series up to n."""
...     a, b = 0, 1
...     while a < n:
...         print(a, end=' ')
...         a, b = b, a+b
...     print()
...
>>> # Now call the function we just defined:
... fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597

 

위와 같이 콘솔에서 실행하지 않고 파일로 만들어 실행할 경우 main.py 로 파일을 만들어 코드를 입력합니다.

 

def fib(n):    # write Fibonacci series up to n
  """"Print a Fibonacci series up to n."""
  a, b = 0, 1
  while a < n:
    print(a, end=' ')
    a, b = b, a+b
    print()

fib(2000)

 

실행은 python main.py 하면 아래와 같은 결과를 볼 수 있습니다.

 

0 
1 
1 
2 
3 
5 
8 
13 
21 
34 
55 
89 
144 
233 
377 
610 
987 
1597

 

 

키워드 def는 함수 정의를 시작합니다. 함수 이름과 괄호로 싸인 형식 매개변수들의 목록이 뒤따릅니다. 함수의 바디를 형성하는 문장들이 다음 줄에서 시작되고, 반드시 들여 쓰기 되어야 합니다.

 

함수 바디의 첫 번째 문장은 선택적으로 문자열 리터럴이 될 수 있습니다; 이 문자열 리터럴은 함수의 도큐멘테이션 문자열, 즉 독스트링 (docstring)입니다. (독스트링에 대한 자세한 내용은 도큐멘테이션 문자열에 나옵니다.) 독스트링을 사용해서 온라인이나 인쇄된 설명서를 자동 생성하거나, 사용자들이 대화형으로 코드를 열람할 수 있도록 하는 도구들이 있습니다; 여러분이 작성하는 코드에 독스트링을 첨부하는 것은 좋은 관습입니다, 그러니 버릇을 들이는 것이 좋습니다.

 

함수의 실행은 함수의 지역 변수들을 위한 새 심볼 테이블을 만듭니다. 좀 더 구체적으로, 함수에서의 모든 변수 대입들은 값을 지역 심벌 테이블에 저장합니다; 반면에 변수 참조는 먼저 지역 심벌 테이블을 본 다음, 전역 심벌 테이블을 본 후, 마지막으로 내장 이름들의 테이블을 살핍니다. 그래서, 참조될 수는 있다 하더라도, 전역 변수들과 둘러싸는 함수의 변수들은 함수 내에서 직접 값이 대입될 수 없습니다 (전역 변수를 global 문으로 명시하거나 둘러싸는 함수의 변수를 nonlocal 문으로 명시하지 않는 이상).

 

함수 호출로 전달되는 실제 매개변수들 (인자들)은 호출될 때 호출되는 함수의 지역 심벌 테이블에 만들어집니다; 그래서 인자들은 값에 의한 호출(call by value)로 전달됩니다 (값은 항상 객체의 값이 아니라 객체 참조입니다). 1 함수가 다른 함수를 호출할 때, 또는 자신을 재귀적으로 호출할 때, 그 호출을 위한 새 지역 심벌 테이블이 만들어집니다.

 

함수 정의는 함수 이름을 현재 심볼 테이블의 함수 객체와 연결합니다. 인터프리터는 해당 이름이 가리키는 객체를 사용자 정의 함수로 인식합니다. 다른 이름은 같은 함수 객체를 가리킬 수 있으며 함수에 액세스 하는 데 사용될 수도 있습니다:

 

>>> fib
<function fib at 10042ed0>
>>> f = fib
>>> f(100)
0 1 1 2 3 5 8 13 21 34 55 89

 

다른 언어들을 사용했다면, fib 가 값을 돌려주지 않기 때문에 함수가 아니라 프로시저라고 생각할 수 있습니다. 사실, return 문이 없는 함수도 값을 돌려줍니다, 비록 따분한 값이기는 하지만. 이 값은 None이라고 불립니다 (내장 이름입니다). None 이 출력할 유일한 값이라면, 인터프리터는 보통 None 값 출력을 억제합니다. 꼭 보길 원한다면 print()를 사용할 수 있습니다:

 

>>>fib
<function fib at 0x7f84df1091f0>
>>>fib(100)
0 
1 
1 
2 
3 
5 
8 
13 
21 
34 
55 
89 
>>>

 

인쇄하는 대신, 피보나치 수열의 숫자들 리스트를 돌려주는 함수를 작성하는 것도 간단합니다:

 

>>> def fib2(n):  # return Fibonacci series up to n
...     """Return a list containing the Fibonacci series up to n."""
...     result = []
...     a, b = 0, 1
...     while a < n:
...         result.append(a)    # see below
...         a, b = b, a+b
...     return result
...
>>> f100 = fib2(100)    # call it
>>> f100                # write the result
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

 

이 예는 몇 가지 새로운 파이썬 기능을 보여줍니다:

 

return 문은 함수로부터 값을 갖고 복귀하게 만듭니다. 표현식 인자 없는 return 은 None을 돌려줍니다. 함수의 끝으로 떨어지면 역시 None을 돌려줍니다.

 

문장 result.append(a) 은 리스트 객체 result의 메서드를 호출합니다. 메서드는 객체에 〈속하는〉 함수이고 obj.methodname 라고 이름 붙여지는데, obj는 어떤 객체이고 (표현식이 될 수 있습니다), methodname 는 객체의 형에 의해 정의된 메서드의 이름입니다. 다른 형은 다른 메서드들을 정의합니다. 서로 다른 형들의 메서드는 모호함 없이 같은 이름을 가질 수 있습니다. (클래스를 사용해서 여러분 자신의 형과 메서드를 정의하는 것이 가능합니다, 클래스를 보세요) 예에 나오는 메서드 append()는 리스트 객체들에 정의되어 있습니다; 요소를 리스트의 끝에 덧붙입니다. 이 예에서는 result = result + [a] 와 동등하지만, 더 효율적입니다.

 

함수 정의 더 보기

 

정해지지 않은 개수의 인자들로 함수를 정의하는 것도 가능합니다. 세 가지 형식이 있는데, 조합할 수 있습니다.

 

기본 인자 값

 

가장 쓸모 있는 형식은 하나나 그 이상 인자들의 기본값을 지정하는 것입니다. 정의된 것보다 더 적은 개수의 인자들로 호출될 수 있는 함수를 만듭니다. 예를 들어:

 

def ask_ok(prompt, retries=4, reminder='Please try again!'):
    while True:
        ok = input(prompt)
        if ok in ('y', 'ye', 'yes'):
            return True
        if ok in ('n', 'no', 'nop', 'nope'):
            return False
        retries = retries - 1
        if retries < 0:
            raise ValueError('invalid user response')
        print(reminder)

 

아래는 실행 예와 결과입니다.

 

>>>ask_ok('end?')
end?y
True

 

이 함수는 여러 가지 방법으로 호출될 수 있습니다:

 

  • 오직 꼭 필요한 인자만 전달해서: ask_ok('정말 끝내길 원하세요?')
  • 선택적 인자 하나를 제공해서: ask_ok('파일을 덮어써도 좋습니까?', 2)
  • 또는 모든 인자를 제공해서: ask_ok('파일을 덮어써도 좋습니까?', 2, '자, 예나 아니요로만 답하세요!')

 

이 예는 in 키워드도 소개하고 있습니다. 시퀀스가 어떤 값을 가졌는지 아닌지를 검사합니다.

 

기본값은 함수 정의 시점에 정의되고 있는 스코프에서 구해집니다. 그래서 아래 코드는 5를 출력합니다.

 

i = 5

def f(arg=i):
    print(arg)

i = 6
f()

 

중요한 주의사항: 기본값은 오직 한 번만 값이 구해집니다. 이것은 기본값이 리스트나 딕셔너리나 대부분 클래스의 인스턴스와 같은 가변 객체일 때 차이를 만듭니다. 예를 들어, 다음 함수는 계속되는 호출로 전달된 인자들을 누적합니다:

 

def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))

 

다음과 같은 것을 인쇄합니다

 

[1]
[1, 2]
[1, 2, 3]

 

연속된 호출 간에 기본값이 공유되지 않기를 원한다면, 대신 함수를 이런 식으로 쓸 수 있습니다:

 

def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L

 

키워드 인자

 

함수는 kwarg=value 형식의 키워드 인자 를 사용해서 호출될 수 있습니다. 예를 들어, 다음 함수는:

 

def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
    print("-- This parrot wouldn't", action, end=' ')
    print("if you put", voltage, "volts through it.")
    print("-- Lovely plumage, the", type)
    print("-- It's", state, "!")

 

하나의 필수 인자(voltage)와 세 개의 선택적 인자 (state, action, type) 를 받아들입니다. 이 함수는 다음과 같은 방법 중 아무것으로나 호출될 수 있습니다.

 

parrot(1000)                                          # 1 positional argument
parrot(voltage=1000)                                  # 1 keyword argument
parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword

 

하지만 다음과 같은 호출들은 모두 올바르지 않습니다:

 

parrot()                     # required argument missing
parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
parrot(110, voltage=220)     # duplicate value for the same argument
parrot(actor='John Cleese')  # unknown keyword argument

 

함수 호출에서, 키워드 인자는 위치 인자 뒤에 나와야 합니다. 전달된 모든 키워드 인자는 함수가 받아들이는 인자 중 하나와 맞아야 하며 (예를 들어, actor는 parrot 함수의 올바른 인자가 아니다), 그 순서는 중요하지 않습니다. 이것들에는 필수 인자들도 포함됩니다 (예를 들어, parrot(voltage=1000) 도 올바릅니다). 어떤 인자도 두 개 이상의 값을 받을 수 없습니다. 여기, 이 제약 때문에 실패하는 예가 있습니다:

 

>>> def function(a):
...     pass
...
>>> function(0, a=0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: function() got multiple values for argument 'a'

 

**name 형식의 마지막 형식 매개변수가 존재하면, 형식 매개변수들에 대응하지 않는 모든 키워드 인자들을 담은 딕셔너리 (매핑 형 — dict 를 보세요)를 받습니다. 이것은 *name (다음 서브섹션에서 설명합니다) 형식의 형식 매개변수와 조합될 수 있는데, 형식 매개변수 목록 밖의 위치 인자들을 담은 튜플을 받습니다. (*name은 **name 앞에 나와야 합니다.) 예를 들어, 이런 함수를 정의하면:

 

def cheeseshop(kind, *arguments, **keywords):
    print("-- Do you have any", kind, "?")
    print("-- I'm sorry, we're all out of", kind)
    for arg in arguments:
        print(arg)
    print("-" * 40)
    for kw in keywords:
        print(kw, ":", keywords[kw])

 

이런 식으로 호출될 수 있습니다:

 

cheeseshop("Limburger", "It's very runny, sir.",
           "It's really very, VERY runny, sir.",
           shopkeeper="Michael Palin",
           client="John Cleese",
           sketch="Cheese Shop Sketch")

 

그리고 당연히 이렇게 인쇄합니다:

 

-- Do you have any Limburger ?
-- I'm sorry, we're all out of Limburger
It's very runny, sir.
It's really very, VERY runny, sir.
----------------------------------------
shopkeeper : Michael Palin
client : John Cleese
sketch : Cheese Shop Sketch

 

인쇄되는 키워드 인자들의 순서 함수 호출로 전달된 순서와 일치함이 보장됨에 주목하세요.

 

특수 매개 변수

 

기본적으로, 인자는 위치나 명시적인 키워드로 파이썬 함수에 전달될 수 있습니다. 가독성과 성능을 위해, 개발자가 항목이 위치, 위치나 키워드 또는 키워드로 전달되는지를 판단할 때 함수 정의만을 보면 되도록, 인자가 전달될 방법을 제한하면 좋습니다.

 

함수 정의는 다음과 같습니다:

 

def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
      -----------    ----------     ----------
        |             |                  |
        |        Positional or keyword   |
        |                                - Keyword only
         -- Positional only

 

여기서 /와 *는 선택적입니다. 이 기호는 인자가 함수에 전달되는 방식에 따른 매개 변수의 종류를 나타냅니다: 위치 전용, 위치-키워드 및 키워드 전용. 키워드 매개 변수는 명명된(named) 매개 변수라고도 합니다.

 

위치-키워드(Positional-or-Keyword) 인자

 

함수 정의에 /와 *가 없으면, 인자를 위치나 키워드로 함수에 전달할 수 있습니다.

 

위치 전용 매개 변수

 

좀 더 자세하게 살펴보면, 특정 매개 변수를 위치 전용으로 표시할 수 있습니다. 위치 전용이면, 매개 변수의 순서가 중요하며, 키워드로 매개 변수를 전달할 수 없습니다. 위치 전용 매개 변수는 / (슬래시) 앞에 놓입니다. /는 위치 전용 매개 변수를 나머지 매개 변수들로부터 논리적으로 분리하는 데 사용됩니다. 함수 정의에 /가 없으면, 위치 전용 매개 변수는 없습니다.

 

/ 다음의 매개 변수는 위치-키워드나 키워드 전용일 수 있습니다.

 

키워드 전용 인자

 

매개 변수를 키워드 인자로 전달해야 함을 나타내도록, 매개 변수를 키워드 전용으로 표시하려면, 첫 번째 키워드 전용 매개 변수 바로 전에 인자 목록에 *를 넣으십시오.

 

함수 예제

 

/와 * 마커에 주의를 기울이는 다음 예제 함수 정의를 고려하십시오:

 

>>> def standard_arg(arg):
...     print(arg)
...
>>> def pos_only_arg(arg, /):
...     print(arg)
...
>>> def kwd_only_arg(*, arg):
...     print(arg)
...
>>> def combined_example(pos_only, /, standard, *, kwd_only):
...     print(pos_only, standard, kwd_only)

 

첫 번째 함수 정의 standard_arg는 가장 익숙한 형식으로, 호출 규칙에 아무런 제한을 두지 않으며 인자는 위치나 키워드로 전달될 수 있습니다:

 

>>> standard_arg(2)
2

>>> standard_arg(arg=2)
2

 

두 번째 함수 pos_only_arg는 함수 정의에 /가 있으므로 위치 매개 변수만 사용하도록 제한됩니다:

 

>>> pos_only_arg(1)
1

>>> pos_only_arg(arg=1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: pos_only_arg() got some positional-only arguments passed as keyword arguments: 'arg'

 

세 번째 함수 kwd_only_args는 함수 정의에서 *로 표시된 키워드 인자만 허용합니다:

 

>>> kwd_only_arg(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: kwd_only_arg() takes 0 positional arguments but 1 was given

>>> kwd_only_arg(arg=3)
3

 

마지막은 같은 함수 정의에서 세 가지 호출 규칙을 모두 사용합니다:

 

>>> combined_example(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: combined_example() takes 2 positional arguments but 3 were given

>>> combined_example(1, 2, kwd_only=3)
1 2 3

>>> combined_example(1, standard=2, kwd_only=3)
1 2 3

>>> combined_example(pos_only=1, standard=2, kwd_only=3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: combined_example() got some positional-only arguments passed as keyword arguments: 'pos_only'

 

마지막으로, 위치 인자 name과 name을 키로 가지는 **kwds 사이에 잠재적인 충돌이 있는 이 함수 정의를 고려하십시오:

 

def foo(name, **kwds):
    return 'name' in kwds

 

'name' 키워드는 항상 첫 번째 매개 변수에 결합하므로 True를 반환할 수 있는 호출은 불가능합니다. 예를 들면:

 

>>> foo(1, **{'name': 2})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got multiple values for argument 'name'
>>>

 

그러나 /(위치 전용 인자)를 사용하면, name을 위치 인자로, 동시에 'name'을 키워드 인자의 키로 사용할 수 있으므로 가능합니다:

 

def foo(name, /, **kwds):
    return 'name' in kwds
>>> foo(1, **{'name': 2})
True

 

즉, 위치 전용 매개 변수의 이름을 **kwds에서 모호함 없이 사용할 수 있습니다.

 

복습

 

사용 사례가 함수 정의에서 어떤 매개 변수를 사용할지 결정합니다:

 

def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

 

지침:

 

매개 변수의 이름을 사용자가 사용할 수 없도록 하려면 위치 전용을 사용하십시오. 매개 변수 이름이 실제 의미가 없을 때, 함수가 호출될 때 인자의 순서를 강제하려고 할 때, 또는 일부 위치 매개 변수와 임의의 키워드를 받아들이고 싶을 때 유용합니다.

 

이름이 의미가 있고 함수 정의가 이름을 명시적으로 지정함으로써 더 이해하기 쉬워지거나, 사용자가 전달되는 인자의 위치에 의존하지 못하도록 하려면 키워드 전용을 사용하십시오.

 

API의 경우, 향후 매개 변수의 이름이 수정될 때 비호환 API 변경이 발생하는 것을 방지하려면 위치 전용을 사용하십시오.

 

임의의 인자 목록

 

마지막으로, 가장 덜 사용되는 옵션은 함수가 임의의 개수 인자로 호출될 수 있도록 지정하는 것입니다. 이 인자들은 튜플로 묶입니다 (튜플과 시퀀스 을 보세요). 가변 길이 인자 앞에, 없거나 여러 개의 일반 인자들이 올 수 있습니다.

 

def write_multiple_items(file, separator, *args):
    file.write(separator.join(args))

 

보통, 이 가변 길이 인자들은 형식 매개변수 목록의 마지막에 옵니다, 함수로 전달된 남은 입력 인자들 전부를 그러모으기 때문입니다. *args 매개변수 뒤에 등장하는 형식 매개변수들은 모두 〈키워드-전용〉 인자들인데, 위치 인자 대신 키워드 인자로만 사용될 수 있다는 뜻입니다.

 

>>> def concat(*args, sep="/"):
...     return sep.join(args)
...
>>> concat("earth", "mars", "venus")
'earth/mars/venus'
>>> concat("earth", "mars", "venus", sep=".")
'earth.mars.venus'

 

인자 목록 언 패킹

 

인자들이 이미 리스트나 튜플에 있지만, 분리된 위치 인자들을 요구하는 함수 호출을 위해 언 패킹 해야 하는 경우 반대 상황이 벌어집니다. 예를 들어, 내장 range() 함수는 별도의 start와 stop 인자를 기대합니다. 그것들이 따로 있지 않으면, 리스트와 튜플로부터 인자를 언 패킹하기 위해 *-연산자를 사용해서 함수를 호출하면 됩니다:

 

>>> list(range(3, 6))            # normal call with separate arguments
[3, 4, 5]
>>> args = [3, 6]
>>> list(range(*args))            # call with arguments unpacked from a list
[3, 4, 5]

 

같은 방식으로 딕셔너리도 **-연산자를 써서 키워드 인자를 전달할 수 있습니다:

 

>>> def parrot(voltage, state='a stiff', action='voom'):
...     print("-- This parrot wouldn't", action, end=' ')
...     print("if you put", voltage, "volts through it.", end=' ')
...     print("E's", state, "!")
...
>>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}
>>> parrot(**d)
-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !

 

람다 표현식

 

lambda 키워드들 사용해서 작고 이름 없는 함수를 만들 수 있습니다. 이 함수는 두 인자의 합을 돌려줍니다: lambda a, b: a+b. 함수 객체가 있어야 하는 곳이면 어디나 람다 함수가 사용될 수 있습니다. 문법적으로는 하나의 표현식으로 제한됩니다. 의미적으로는, 일반적인 함수 정의의 편의 문법일 뿐입니다. 중첩된 함수 정의처럼, 람다 함수는 둘러싸는 스코프에 있는 변수들을 참조할 수 있습니다:

 

>>> def make_incrementor(n):
...     return lambda x: x + n
...
>>> f = make_incrementor(42)
>>> f(0)
42
>>> f(1)
43

 

위의 예는 함수를 돌려주기 위해 람다 표현식을 사용합니다. 또 다른 용도는 작은 함수를 인자로 전달하는 것입니다:

 

>>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
>>> pairs.sort(key=lambda pair: pair[1])
>>> pairs
[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]

 

도큐멘테이션 문자열 Docstring

 

여기에 도큐멘테이션 문자열의 내용과 포매팅에 관한 몇 가지 관례가 있습니다. Docstring, Documentation String의 줄임말로, 함수 본문의 시작 부분에 있는 선택적 명령문입니다. 일반적으로 함수가 수행하는 작업을 설명하는 데 사용됩니다. 그것들을 포함하는 것은 좋은 개발 방법입니다. 함수의 경우 __doc__속성을 사용하여 해당 문서 문자열에 액세스 할 수 있습니다. 아래 예를 참조하십시오.

 

def add_numbers(x, y):
    """
    Add the two numbers passed as arguments 
    and return the sum
    """
    total = x+y
    return total
print(add_numbers.__doc__)

코드의 출력은 아래와 같습니다.

 

Add the two numbers passed as arguments 
and return the sum

 

첫 줄은 항상 객체의 목적을 짧고, 간결하게 요약해야 합니다. 간결함을 위해, 객체의 이름이나 형을 명시적으로 언급하지 않아야 하는데, 이것들은 다른 방법으로 제공되기 때문입니다 (이름이 함수의 작업을 설명하는 동사라면 예외입니다). 이 줄은 대문자로 시작하고 마침표로 끝나야 합니다.

 

도큐멘테이션 문자열에 여러 줄이 있다면, 두 번째 줄은 비어있어서, 시각적으로 요약과 나머지 설명을 분리해야 합니다. 뒤따르는 줄들은 하나나 그 이상의 문단으로, 객체의 호출 규약, 부작용 등을 설명해야 합니다.

 

파이썬 파서는 여러 줄 문자열 리터럴에서 들여쓰기를 제거하지 않기 때문에, 설명서를 처리하는 도구들은 필요하면 들여 쓰기를 제거합니다. 이것은 다음과 같은 관례를 사용합니다. 문자열의 첫 줄 뒤에 오는 첫 번째 비어있지 않은 줄이 전체 도큐멘테이션 문자열의 들여 쓰기 수준을 결정합니다. (우리는 첫 줄을 사용할 수 없는데, 일반적으로 문자열을 시작하는 따옴표에 붙어있어서 들여 쓰기가 문자열 리터럴의 것을 반영하지 않기 때문입니다.) 이 들여 쓰기와 《동등한》 공백이 문자열의 모든 줄의 시작 부분에서 제거됩니다. 덜 들여 쓰기 된 줄이 나타나지는 말아야 하지만, 나타난다면 모든 앞부분의 공백이 제거됩니다. 공백의 동등성은 탭 확장 (보통 8개의 스페이스) 후에 검사됩니다.

 

여기 여러 줄 독스트링의 예가 있습니다:

 

>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything.
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

    No, really, it doesn't do anything.

 

변수의 범위 Scope of variable

 

변수의 범위는 변수에 액세스 할 수 있는 코드의 세그먼트를 나타냅니다. 함수 내부에 정의된 변수의 사용 범위는 선언된 함수로 제한됩니다. 외부에서 액세스 할 수 없으며 함수가 실행되는 동안에만 메모리에서 종료됩니다.

 

def add_numbers(x, y):
    """
    Add the two numbers passed as arguments 
    and return the sum
    """
    total = x+y
#     return total
print(add_numbers(2, 3))

출력은 5입니다.

 

범위가 제한된 변수를 지역 변수라고 합니다. 위의 함수 예에서 add_numbers()에서 사용한 total은 지역 변수입니다. 프로그램 전체에서 액세스 할 수 있는 변수를 전역 변수라고 합니다. 아래 예는 차이점을 보여줍니다. 

 

x = 10 # global variable
def sample_function():
    y = 20 # local variable
    print("Value of x inside the function: ", x)
    print("Value of y inside the function: ", y)
# call the sample_function()
sample_function()
# accessing the variables x and y outside the function
print("Value of x outside the function: ", x)
print("Value of y outside the function: ", y)

 

위의 코드는 실행 시 다음과 같은 출력을 제공합니다. 

 

Value of x inside the function:  10
Value of y inside the function:  20
Value of x outside the function:  10
------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-2-59c0eb47437f> in <module>
     10 # accessing the variables x and y outside the function
     11 print("Value of x outside the function: ", x)
---> 12 print("Value of y outside the function: ", y)
NameError: name 'y' is not defined

 

전역 변수 x는 함수 내부와 외부에서 모두 액세스 할 수 있지만 로컬 변수 y는 함수 내부에서만 액세스 할 수 있습니다. y이것이 함수 외부 에 액세스할 때 오류가 발생하는 이유입니다.

 

함수 내부와 외부에서 동일한 변수가 정의된 경우 함수 범위에 대한 로컬 명령어에 대해 로컬 변수의 값이 사용됩니다. 아래 예를 참조하세요. 

 

x = 10 # global variable x
def sample_function():
    x = 20 # local variable x
    print("Value of x inside the function: ", x)
# call the sample_function()
sample_function()
# accessing the variable x outside the function
print("Value of x outside the function: ", x)

 

위의 함수는 실행 시 다음과 같은 출력을 제공합니다. 

 

Value of x inside the function:  20
Value of x outside the function:  10

 

함수 어노테이션

 

함수 어노테이션 은 사용자 정의 함수가 사용하는 형들에 대한 완전히 선택적인 메타데이터 정보입니다 (자세한 내용은 PEP 3107PEP 484 를 보세요).

 

어노테이션은 함수의 __annotations__ 어트리뷰트에 딕셔너리로 저장되고 함수의 다른 부분에는 아무런 영향을 미치지 않습니다. 매개변수 어노테이션은 매개변수 이름 뒤에 오는 콜론으로 정의되는데, 값을 구할 때 어노테이션의 값을 주는 표현식이 뒤따릅니다. 반환 값 어노테이션은 리터럴 -> 와 그 뒤를 따르는 표현식으로 정의되는데, 매개변수 목록과 def 문의 끝을 나타내는 콜론 사이에 놓입니다. 다음 예에서 필수 인자, 선택적 인자, 반환 값이 어노테이트 됩니다:

 

>>> def f(ham: str, eggs: str = 'eggs') -> str:
...     print("Annotations:", f.__annotations__)
...     print("Arguments:", ham, eggs)
...     return ham + ' and ' + eggs
...
>>> f('spam')
Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}
Arguments: spam eggs
'spam and eggs'

 

막간극: 코딩 스타일

 

이제 여러분은 파이썬의 더 길고, 더 복잡한 조각들을 작성하려고 합니다, 코딩 스타일에 대해 말할 적절한 시간입니다. 대부분 언어는 서로 다른 스타일로 작성될 (또는 더 간략하게, 포맷될) 수 있습니다; 어떤 것들은 다른 것들보다 더 읽기 쉽습니다. 다른 사람들이 여러분의 코드를 읽기 쉽게 만드는 것은 항상 좋은 생각이고, 훌륭한 코딩 스타일을 도입하는 것은 그렇게 하는 데 큰 도움을 줍니다.

 

파이썬을 위해, 대부분 프로젝트가 고수하는 스타일 가이드로 PEP 8이 나왔습니다; 이것은 매우 읽기 쉽고 눈이 편안한 코딩 스타일을 장려합니다. 모든 파이썬 개발자는 언젠가는 이 문서를 읽어야 합니다; 여러분을 위해 가장 중요한 부분들을 추려봤습니다:

 

들여 쓰기에 4-스페이스를 사용하고, 탭을 사용하지 마세요.

 

4개의 스페이스는 작은 들여 쓰기 (더 많은 중첩 도를 허락합니다) 와 큰 들여 쓰기 (읽기 쉽습니다) 사이의 좋은 절충입니다. 탭은 혼란을 일으키고, 없애는 것이 최선입니다.

 

한 줄에 79자를 넘지 않도록 줄 넘김 하세요.

 

이것은 작은 화면을 가진 사용자를 돕고 큰 화면에서는 여러 코드 파일들을 나란히 볼 수 있게 합니다.

 

함수, 클래스, 함수 내의 큰 코드 블록 사이에 빈 줄을 넣어 분리하세요.

 

가능하다면, 주석은 별도의 줄로 넣으세요.

 

독스트링을 사용하세요.

 

연산자들 주변과 콤마 뒤에 스페이스를 넣고, 괄호 바로 안쪽에는 스페이스를 넣지 마세요: a = f(1, 2) + g(3, 4).

 

클래스와 함수들에 일관성 있는 이름을 붙이세요; 관례는 클래스의 경우 UpperCamelCase, 함수와 메서드의 경우 lowercase_with_underscores입니다. 첫 번째 메서드 인자의 이름으로는 항상 self를 사용하세요 (클래스와 메서드에 대한 자세한 내용은 클래스와의 첫 만남을 보세요).

 

여러분의 코드를 국제적인 환경에서 사용하려고 한다면 특별한 인코딩을 사용하지 마세요. 어떤 경우에도 파이썬의 기본, UTF-8, 또는 단순 ASCII조차, 이 최선입니다.

 

마찬가지로, 다른 언어를 사용하는 사람이 코드를 읽거나 유지할 약간의 가능성만 있더라도, 식별자에 ASCII 이외의 문자를 사용하지 마세요.

 

 

참고 

파이선 자습서

데이터 사이언스를 위한 파이선

 

파이선 함수

 

 

 

반응형