포스팅 작성동기

누군가와 나의 코드를 서로 이해하기 쉽게 동일한 룰로
맞춰서 작성하는게 좋다면,
일단 나부터 어떻게 코드를 짜는지 알아야하지않을까 ?

230406 새마음 새출발을 맞아 데탑, 맥북에있던
지금까지다녔던회사, 지금까지외주했던거, 레슨했던거,
토이프로젝트, 개인적으로개발했던 모든 퀘퀘묵은 코드들을
정리하기 시작함 :(

But, 예전코드 보니 진짜 가관 :(...
지금도 잘하는건 아니지만 예전은 진짜 규칙없이 내맘대로
코드를 썻구나를 느껴서 누군가와 코드를 맞추기전,
나부터 정리정돈을 해볼겸 정리를 결심

def python_code_convention

주 참조는 PEP8 https://peps.python.org/pep-0008/
아래글은 제가 보기편하게 정리 한 내용입니다 :D
좀 더 자세한 원본을 보고싶으면 링크로 고고 !

python은 귀도반로섬(Benevolent dictator for life)선생님이 창시하시고
수많은 사람들이 의견내고 토론하며 발전해온 언어다
그 과정에서 수많은 토론, 수많은 시도를 하였을텐데...
그러한 내용들을 PEP( Python Enhancement Proposal )
라는 이름으로 document화 하여 python은 이렇게 발전했으면 좋겠다를 공식화 하였고, 가장 유명한 건 아래 두개입니다

PEP 20 - The Zen of python
Tim Peters님이 지으신 python의 핵심철학

PEP 8 - Style Guide for Python Code

This document gives coding conventions for 
the Python code comprising the standard library 
in the main Python distribution. ...
This document and PEP 257 (Docstring Conventions) were adapted from 
Guido’s original Python Style Guide essay, 
with some additions from Barry’s style guide

위 두개를 토대로 내가 필요한 정보들만 추려서
정리해보고자 합니다

클래스, 함수, 변수명 규칙

선요약:

• 기본적으론 lower + 팟홀=스네이크 표기법(Snake Case)베이스

class LongClassName
def long_function_name
long_variable = [] 

# 여러개 import
import os
import sys
from subprocess import Popen, PIPE # 한줄로 

# 클래스명 = upper+camel styel 
code: int
class Point:
    coords: Tuple[int, int]
    label: str = '<unknown>'
    
# 함수이름 
def long_function_name(
		var_one, var_two
        var_three,):
# 긴 변수 
long_var_list = [
    1, 2, 3,
    4, 5, 6,
    ]
# 수식같은거 적을 때는 
income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction
          - student_loan_interest)
          
# String내 Whitespace = 쉼표는붙이고 뒤 뛰기 
spam(ham[1], {eggs: 2})

# 변수 Assign때는 굳이 맞추지 마세요 !
x = 1
y = 2
long_variable = 3