본문 바로가기

Coding/Python113

readthedocs.org에 문서화하는 방법 1. readthedocs.org 가입readthedocs.org위 사이트로 들어가서 회원가입을 진행한다. 2. Sphinx 설치먼저 문서화할 파이썬 소스 폴더로 들어가서 docs라는 폴더를 하나 생성한다. pip3 install sphinx 그리고 위 명령어를 통해 sphinx를 설치한다. 그리고 아래의 명령어를 통해 설정을 시작한다. sphinx-quickstart 대충 뭐 이런식으로 여러가지 질문들이 나오는데 원하는대로 설정을 해주면, 최종적으로 위와 같은 화면을 볼 수 있다. make html 마지막으로 위 명령어를 내려주면 설정을 토대로 파일들이 생성된다. 3. 테마 설정 pip3 install sphinx-rtd-theme 위 명령어를 통해 테마를 설치한다. 기본적으로 설치되는 테마는 조금 직.. 2019. 11. 14.
파이썬 패키지 Pypi에 오픈소스 등록하는 방법 1. pypi 회원가입 https://pypi.org/ 위 사이트로 들어가서 회원가입을 진행한다. 2. setup.py 파일 생성setup.py 파일을 하나 생성하고 아래의 내용으로 채워넣는다. # encoding: utf-8 import setuptools with open("README.md", "r") as fh: long_description = fh.read() setuptools.setup( name="패키지 이름", version="버전", author="만든이", author_email="이메일주소", description="패키지 설명", long_description=long_description, long_description_content_type="text/markdown", ur.. 2019. 11. 12.
Python aiohttp Mocking 하는 방법 일반적으로 파이썬을 사용하여 request를 보낼 때 requests모듈을 사용한다. 하지만 해당 모듈은 async/await 즉, 비동기에 대해 지원하지 않으므로 비동기 요청을 보내기 위해서는 aiohttp등의 라이브러리를 사용한다. aiohttp를 통해 get메소드로 요청을 보낼 때는 아래와 같은 형태로 사용한다. async def request_get(url: str, response_type: str = 'json'): async with ClientSession(headers=headers) as session: async with session.get(url) as response: return await response.json() 보통 Mocking할 때 사용하는것이 unittest의 mo.. 2019. 10. 30.
Django Middleware로 특정 주소 Redirect 시키는 방법 현재 서버는 모든 요청이 API Gateway를 한번 거쳐서 들어오는 형태로 구성되어있다. 각 서비스별로 팀내에서 부를 용어를 통일하기위해 hide처럼 임의의 명칭을 부여했고, 모든 요청앞에 /hide/와 같은 형태로 prefix를 붙이기로 했다. 기존에는 /api/v1/로 시작하는 URL들의 집합체였는데, 모든 URL들에 prefix를 붙이자니 조금 번거로운 작업이 될 것으로 생각하여 Django의 Middleware에 훅을 거는 방식으로 진행하였다. 위 사진을 보면 어떠한 형태로 Django의 Request/Response가 처리되는지 한눈에 알 수 있을 것이다. 우리는 Request가 들어올 때 prefix를 붙여주는 작업을 진행해야하므로 Request Middleware를 생성하기로 했다. fro.. 2019. 10. 21.
Python Alembic으로 Migration 관리하는 방법 Django같은 경우 풀스택을 지향하는 프레임워크로써 기본적으로 수많은 기능들을 제공한다. 그 중 편리한 기능중 하나가 바로 마이그레이션이다. 프레임워크에서 기본적으로 마이그레이션 기능을 제공하기에 사용자는 추가적인 설치나 세팅을 해줄필요가 없이 손쉽게 정의한 모델을 데이터베이스 테이블로 생성할 수 있다. 하지만 Flask, Sanic등 자유도가 높은 프레임워크의 경우 마이그레이션을 위한 기본 기능이 존재하지 않는다. 일반적으로 Alembic을 통해 마이그레이션 관리를 통합하는데, 본 포스팅에서는 SQLAlchemy를 사용하는경우에 Alembic을 통해 데이터베이스 마이그레이션을 관리하는 방법에 대해 기술한다. 1. 설치 아래의 명령어로 라이브러리를 설치한다. pip3 install alembic2. 초.. 2019. 9. 26.
Django Restframework Serializer 뜯어보기 현재 Custom Authentication을 구현하여 request.user에 Header에 들어있는 특정한 값을 파싱하여 넣도록 구현했다. 그 다음으로 리퀘스트를 검증하기위해 Serializer를 사용하는데, 일반적으로 시리얼라이저는 정의해놓은 필드이외의 값을 받지 못한다. 예를 들어 아래와 같은 시리얼라이저가 있다고 가정해보자. class CreatePostRequestSerializer(serializers.Serializer): body = serializers.CharField(required=False) attachments = serializers.ListField(required=False)리퀘스트로는 body, attachments 두개의 값이 들어오고 제대로 값이 들어왔는지 판단하는 .. 2019. 9. 19.