Python/Docs

· Python/Docs
repr은 Python에서 객체의 문자열 표현을 반환하는 내장 함수입니다. 주로 디버깅 및 로깅에 사용되며, repr(obj)를 호출하면 obj.__repr__() 메서드가 실행됩니다.repr의 특징객체를 프로그래머가 이해할 수 있는 형식으로 표현가능하면 객체를 재생성할 수 있는 문자열을 반환eval(repr(obj)) == obj가 성립하는 것이 이상적repr vs strrepr(obj): 객체의 명확하고 공식적인 표현 (디버깅용)str(obj): 객체의 사용자 친화적인 표현 (출력용)import datetimenow = datetime.datetime.now()print(repr(now)) # datetime.datetime(2025, 2, 5, 14, 30, 45, 123456)print(str(..
· Python/Docs
배경 Docs작성을 위해 DRF-Seralizer을 사용하면 자동으로 만들어주지만 기존 DRF-Seralizer는 무거워서 사용중인 view들은 Csutom 해서 사용중입니다. 그러나 Docs를 위해 DRF-Seralizer를 만들 수 는 없는 이유이기에 inline_serializer을 이용하기로 했습니다. 여기서 seriliazer을 전체 한땀한땀 만들기엔 너무 귀찮고 시간이 많이 걸리고 다른 Model을 참조하는 것은 Model들을 왔다 갔다 하면서 귀찮아 주금 아주 시간이 오래 걸립니다. 그래서 원하는 필드값을 받아 inline_seralizer로 만드는 함수를 만들었습니다 inline_serializer는 drf-spectacular 패키지에서 제공하는 유틸리티 함수 중 하나입니다. 이 함수는..
· Python/Docs
배경 회사 내에 문서 작업을 notion으로 했는데 계속 늘어나는 api들을 관리하기 위해 문서를 자동화 해주는 도구를 도입하기로 했습니다. sweager과 redoc중 고민을 했는데 두 개의 차이점이 아래와 같아서 프론트와 협업이 위주인 문서들이라 ReDoc를 사용하기로 결정했습니다. Swagger를 선택할 때: 상호 작용 가능한 API 문서가 필요한 경우. 다양한 기능과 확장성이 중요한 경우. 이미 많은 사용자가 Swagger UI에 익숙한 경우. ReDoc를 선택할 때: 단순하고 빠른 UI가 필요한 경우. 읽기 전용 문서로 제공하면 충분한 경우. React 기반의 동적인 UI를 선호하는 경우. 코드 pip install redoc from redoc import RedocView urlpattern..