본문 바로가기
파이썬 데이터분석

파이썬 Tip - 함수 도움말 부르기 코멘트 처리

by 데이터스토리 2023. 11. 26.
반응형

파이썬 Tip 입니다. 사용할 함수의 도움말을 부르는 방법과 코멘트를 처리하는 방법입니다. 파이썬 명령어의 함수는 자주 사용하지 않으면 잊어버리게 됩니다. 이때, 예제 하나라고 있으면 좋겠다고 생각하죠.

프로그램을 코딩할 때는 기억이 되어 있지만, 다음날 또는 일주일 후에 그 코드가 무엇이지 확인하려면 힘드는 경험이 있을 것입니다. 관성에 법칙처럼 계속 사용하지 않으면 멀어지는 것이죠. 이럴 때 한줄 코멘트가 정말 유용합니다.

 

함수 도움말 부르기 코멘트 처리
함수 도움말 부르기 코멘트 처리

 

도움말 부르기

함수 위에 커서를 두고 SHIFT+ TAB키를 누르자. 해당 함수 위에 설명글이 나온다. 기본 사용법을 확인하고 하나씩 대입하면 쉽게 적응하게 된다.

 

아래 내용은 그래프 라이브러리인 seaborn 이다. seaborn 사용법을 잊었다. 그럴때, SHIFT+ TAB키로 기억을 회복하자. 예전 경험이 살아남을 느낄 수 있다. 

처음사용해 본다면, 전체 코드를 복사 붙여넣기 하자. 그리고 파라메터 하나씩 대입하며 결과에 순응해 나가자. 그게 빠르게 익숙해 지는 방법이다.

 

1) seaborn 라이브러리를 불렀다.

import seaborn as sns

 

2) sns.relplot() 를 입력하고  SHIFT+ TAB키 눌렀다. 설명이 나온다. 스크롤을 내려서 확인하자. 

  • 상단에 사용법이 나오고 , 그 아래 "docstring"이 나온다. (docstring: 소스코드에 포함된 문서로 매뉴얼처럼 작성된 내용임)
  • "docstring" 부분은 메소드에 대한 설명과 parameter 에 대한 설명, Return 값과,"Examples"이 있다.

도움말 보기
도움말 보기

 

 

 

 

3) 도움말 상단의 코드를 복사해서 넣자, 그리고 파라메터를 하나씩 적용해 가며 결과를 확인하자. 사용법에 익숙해 지게 된다.

파라메터 적용하기
파라메터 적용하기

 

 

 

 

 

 

코멘트 쉽게 달기

 

반응형

 

프로그램에 코멘트를 많이 달면 코드를 나중에 이해할 때 도움이 많이 된다. 심하게는 코드 한 줄당 한개의 코멘트를 이야기 하기도 한다. 그러니 가능한한 많이 달자.

경험한 프로그램 중에서는 변경이력과 누가 작성했는지, 언제 했는지 까지의 정보도 코멘트로 남긴 분도 있다. 정말 성실한 분이란 생각이 든다.

 

코멘트 방법

  • CTRL + /(슬러시) 클릭
  • "#" 표시 뒤는 전부 코멘트로 인식한다. 각 줄마다 "#"을 입력하고 코멘트를 기록하면 된다.
  • 그 보다는 내용을 입력한 후 드래그 하여 " CTRL + /(슬러시)" 하자. 그러면 그 부분이 코멘트 처리된다.
  • 또는 라인 커서를 두고 CTRL + /(슬러시) 하면 된다.
tips = sns.load_dataset("tips") # 일반 문장

# tips = sns.load_dataset("tips") # --> 코멘트 된 문장

 

 

이렇게 도움말을 부르는 방법과 코멘트를 처리하는 방법을 알아봤다. 파이썬 생활에 유용하게 활용되기를 바란다. 참 위에서는 쥬피터 노트북을 사용했다. 아래 링크는 Jupyter Notebook 홈페이지로 연결된다.

 

 

 

 

 

쥬피터 노트북

파이썬 프로그래밍으로 할 때 많이 사용하는 툴에 쥬피터노트북이 있다. 한줄 또는 한 단락단위의 대화식 코딩과 결과를 바로 확인할 수 있다. 쥬피너노트북은 코딩 블럭을 input으로 표현하고, 결과 블럭을 output으로 표현한다. input과 output은 한 쌍으로 구조화 되어 있다.

쥬피터노트북은 빅데이터 시대를 맞아 쥬피터랩을 출시했다. 기계학습이나 데이터 과학에 유용하게 활용할 수 있는 환경을 제공해 주려고 노력하고 있다. 

아래에 두가지 내용을 적었다. 용도에 맞게 사용하기를 바란다. 사용해 보니 JupyterLab 이 더 좋다.

Jupyter 노트북

  • 클래식 노트북 인터페이스
  • 계산 문서를 생성하고 공유하기 위한 원본 웹 애플리케이션
  • 간단하고 능률적인 문서 중심 환경을 제공

 

JupyterLab

  •  차세대 노트북 인터페이스
  • 노트북, 코드 및 데이터를 위한 최신 웹 기반 대화형 개발 환경
  • 유연한 인터페이스를 통해 사용자는 데이터 과학, 과학 컴퓨팅, 컴퓨터 저널리즘 및 기계 학습의 워크플로를 구성하고 배열할 수 있음
  • 모듈식 디자인은 확장을 통해 기능을 확장하고 풍부하게 함

 

 

반응형