ݺߣ

ݺߣShare a Scribd company logo

20 1 코딩스타일

•
•
Changwon National University
Changwon National University

코딩 스타일은 파이썬의 아주 중요한 요소중 하나입니다. 이번 강의에서는 PEP-8 의 코딩 스타일 가이드 라인에 대해 자세히 살펴보고 pyCharm의 리포맷 기능에 대해서도 알아보겠습니다. - 강의 키노트 자료는 다음 링크를 통해 다운 받으세요 https://drive.google.com/drive/folders/1UrrO4_ch4xcIErbExstwpUVY6vFvPdkW - 강의 소스코드는 다음 링크를 통해 다운 받으세요 https://github.com/dongupak/Basic-Python-Programmingwjd

1 of 18
Download to read offline
널널한 교수의 기초 파이썬 20_1. 코딩스타일 창원대학교 정보통신공학과 박동규
동영상 강의자료와 코드 • 동영상 강의(널널한 교수의 기초 파이썬) • https://www.youtube.com/watch? v=TK6RLGaM3Ao&list=PL2P1Vm9k53HOEn-QYXAfblQWkR0OW9mKX • 소스코드( GitHub ) • https://github.com/dongupak/Basic-Python-Programming
코딩 스타일 • C 언어는 다양한 방식의 코딩이 가능하다-융통성 있는 코딩이 가능 • 코딩방식에 관계없이 동작하지만 나중에 이 코드를 이해하기가 힘들다. 협업이 어렵다 이해하기 어려운 코딩 A 들어쓰기와 블럭화로 읽기 쉬운 코딩 B
코딩 스타일 • 파이썬은 동일한 블럭은 동일한 크기의 들여쓰기를 해야 한다 • 코딩 스타일을 강제로 통일시켜 준다 • 따라서 프로그램의 유지 보수도 쉬워진다 • 더욱이 PEP-8 문서를 통해 코딩 스타일의 가이드라인을 제시한다 • PEP-8 가이드라인은 필수 사항은 아니지만 가이드라인을 따를 경우 더욱 정돈된 코딩이 가능하다
PEP-8 https://www.python.org/dev/peps/pep-0008/ 본 강좌에 사용된 자료는 위 문서를 설명합니다
들여쓰기 • 들여쓰기란 문장을 쓸 때 문자열을 오른쪽 으로 옮겨서 다른 주변의 문장과 구별하는 것 • 조건문에서 if, else 문 다음에 들여쓰 기를 해서 코드를 읽기쉽게 도와주는 경우 • 파이썬에서는 4칸 스페이스키를 이용 할 것을 권장한다 예시: 3장의 코딩 다른 주변 문장과 구분됨 tab 키 보다는 스페이스 키 4개 tab의 크기(간격이)가 시스템 설정에 따라 달라질 수 있기때문
함수 인자의 들여쓰기 • 함수의 인자가 많아서 한 줄을 넘길 경우는 4칸 들여쓰기 대신 함수 시작 괄호 지점에서 들여쓰기를 한다 4칸 들여쓰기의 경우 코드 읽기가 어려워진다 괄호에서 들여쓰기를 시작하면 읽기가 쉬워진다(가독성이 증가) O X
함수와 들여쓰기 • def 로 시작하는 함수의 헤드아래 몸체는 4칸 들여쓰기를 한다. • 매개변수가 많을 경우 매개변수의 들여쓰기를 4칸으로 하지 않는다 X O 함수의 몸체와 같은 크기의 4칸 들여쓰기의 경우 코드 읽기가 어려워진다
연산자가 많은 수식의 경우 X O 연산자가 피연산자 뒤에 나와서 코드 읽기가 불편하다 연산자가 피연산자 앞에 나란히 나와서 코드 읽기가 편하다
수식내에서 공백사용 X O 대괄호, 중괄호, 소괄호 다음에 불필요하게 공백을 넣었음 대괄호, 중괄호, 소괄호 다음에 불필요하게 공백을 넣지 않는 것이 좋다
불필요하게 공백을 넣지 않는 것이 더 좋다. 하지만 연산자와 피연산자 사이에 하나의 공백은 넣는 것이 더 좋다 x=1 의 경우보다 x = 1 이 더 보기 좋다 할당연산자에는 한칸의 공백 X O 할당연산자 앞에 너무 공백이 많다
수식내에서 공백사용 X O 쉼표, 세미콜론 사이에 불필요한 공백이 있다 쉼표와 세미콜론은 문장이나 변수를 구분하는 역할이 있으므로 이미 구분된 변수 사이에 별도의 공백을 줄 이유가 없다 불필요하게 공백을 넣지 않는 것이 더 좋다 ( ( )
그외 • 함수의 annotation(설명달기), 복잡한 문장에서 스타일 • 뒤쪽에 쉼표가 오는 경우 • 주석문 만들기 : 코드로 해석이 가능한 경우 불필요한 주석은 없는 것이 더 낫다 • 변수나 함수 이름 짓는 방식등등
pyCharm의 팁 우측 사이드바와 코드내의 풍선 도움말이 나타나서 어떤 부분이 PEP 8 가이드라인에 맞지 않는지 알려준다. 이를 참고로 수정한다 coding_stype_bad.py
pyCharm의 팁 자동 리포매팅, 그러나 한 줄 띄어쓰기등은 툴팁을 참고로하여 직접해야 함
Lab
코딩 스타일 • 코딩 스타일이 나쁘면 작성된 프로그램을 읽고 이해하기 어렵다 • 특히 협업작업시 다른 사람과 코드 읽기를 많이 하게 된다 • 파이썬의 코딩 가이드라인에 따르는 것이 좋은 습관이며, 다른 모든 프로그래밍 언어 작성시에도 깔끔하고 예쁜 코딩을 하도록 노력해 야 한다 • 그리고 훌륭한 프로그래머가 되기위해서는 변수나 함수, 클래스, 메 소드의 이름짓기에도 매우 매우 신경을 쓰야한다
감사니다

More Related Content

20 1 코딩스타일

  • 1. 널널한 교수의 기초 파이썬 20_1. 코딩스타일 창원대학교 정보통신공학과 박동규
  • 2. 동영상 강의자료와 코드 • 동영상 강의(널널한 교수의 기초 파이썬) • https://www.youtube.com/watch? v=TK6RLGaM3Ao&list=PL2P1Vm9k53HOEn-QYXAfblQWkR0OW9mKX • 소스코드( GitHub ) • https://github.com/dongupak/Basic-Python-Programming
  • 3. 코딩 스타일 • C 언어는 다양한 방식의 코딩이 가능하다-융통성 있는 코딩이 가능 • 코딩방식에 관계없이 동작하지만 나중에 이 코드를 이해하기가 힘들다. 협업이 어렵다 이해하기 어려운 코딩 A 들어쓰기와 블럭화로 읽기 쉬운 코딩 B
  • 4. 코딩 스타일 • 파이썬은 동일한 블럭은 동일한 크기의 들여쓰기를 해야 한다 • 코딩 스타일을 강제로 통일시켜 준다 • 따라서 프로그램의 유지 보수도 쉬워진다 • 더욱이 PEP-8 문서를 통해 코딩 스타일의 가이드라인을 제시한다 • PEP-8 가이드라인은 필수 사항은 아니지만 가이드라인을 따를 경우 더욱 정돈된 코딩이 가능하다
  • 6. 들여쓰기 • 들여쓰기란 문장을 쓸 때 문자열을 오른쪽 으로 옮겨서 다른 주변의 문장과 구별하는 것 • 조건문에서 if, else 문 다음에 들여쓰 기를 해서 코드를 읽기쉽게 도와주는 경우 • 파이썬에서는 4칸 스페이스키를 이용 할 것을 권장한다 예시: 3장의 코딩 다른 주변 문장과 구분됨 tab 키 보다는 스페이스 키 4개 tab의 크기(간격이)가 시스템 설정에 따라 달라질 수 있기때문
  • 7. 함수 인자의 들여쓰기 • 함수의 인자가 많아서 한 줄을 넘길 경우는 4칸 들여쓰기 대신 함수 시작 괄호 지점에서 들여쓰기를 한다 4칸 들여쓰기의 경우 코드 읽기가 어려워진다 괄호에서 들여쓰기를 시작하면 읽기가 쉬워진다(가독성이 증가) O X
  • 8. 함수와 들여쓰기 • def 로 시작하는 함수의 헤드아래 몸체는 4칸 들여쓰기를 한다. • 매개변수가 많을 경우 매개변수의 들여쓰기를 4칸으로 하지 않는다 X O 함수의 몸체와 같은 크기의 4칸 들여쓰기의 경우 코드 읽기가 어려워진다
  • 9. 연산자가 많은 수식의 경우 X O 연산자가 피연산자 뒤에 나와서 코드 읽기가 불편하다 연산자가 피연산자 앞에 나란히 나와서 코드 읽기가 편하다
  • 10. 수식내에서 공백사용 X O 대괄호, 중괄호, 소괄호 다음에 불필요하게 공백을 넣었음 대괄호, 중괄호, 소괄호 다음에 불필요하게 공백을 넣지 않는 것이 좋다
  • 11. 불필요하게 공백을 넣지 않는 것이 더 좋다. 하지만 연산자와 피연산자 사이에 하나의 공백은 넣는 것이 더 좋다 x=1 의 경우보다 x = 1 이 더 보기 좋다 할당연산자에는 한칸의 공백 X O 할당연산자 앞에 너무 공백이 많다
  • 12. 수식내에서 공백사용 X O 쉼표, 세미콜론 사이에 불필요한 공백이 있다 쉼표와 세미콜론은 문장이나 변수를 구분하는 역할이 있으므로 이미 구분된 변수 사이에 별도의 공백을 줄 이유가 없다 불필요하게 공백을 넣지 않는 것이 더 좋다 ( ( )
  • 13. 그외 • 함수의 annotation(설명달기), 복잡한 문장에서 스타일 • 뒤쪽에 쉼표가 오는 경우 • 주석문 만들기 : 코드로 해석이 가능한 경우 불필요한 주석은 없는 것이 더 낫다 • 변수나 함수 이름 짓는 방식등등
  • 14. pyCharm의 팁 우측 사이드바와 코드내의 풍선 도움말이 나타나서 어떤 부분이 PEP 8 가이드라인에 맞지 않는지 알려준다. 이를 참고로 수정한다 coding_stype_bad.py
  • 15. pyCharm의 팁 자동 리포매팅, 그러나 한 줄 띄어쓰기등은 툴팁을 참고로하여 직접해야 함
  • 16. Lab
  • 17. 코딩 스타일 • 코딩 스타일이 나쁘면 작성된 프로그램을 읽고 이해하기 어렵다 • 특히 협업작업시 다른 사람과 코드 읽기를 많이 하게 된다 • 파이썬의 코딩 가이드라인에 따르는 것이 좋은 습관이며, 다른 모든 프로그래밍 언어 작성시에도 깔끔하고 예쁜 코딩을 하도록 노력해 야 한다 • 그리고 훌륭한 프로그래머가 되기위해서는 변수나 함수, 클래스, 메 소드의 이름짓기에도 매우 매우 신경을 쓰야한다