[210715 TIL] Django

migrate

$ python manage.py migrate

• migrate 명령은 아직 적용되지 않은 마이그레이션을 모두 수집해 이를 실행한다.
  • Django는 django_migrations 테이블을 두어 마이그레이션 적용 여부를 추적한다.
• 이 과정을 통해 모델에서의 변경 사항들과 데이터베이스의 스키마 동기화가 이루어진다.

migration

• 마이그레이션이란?
  • 모델의 변경 내역을 DB 스키마에 적용시키는 장고의 방법
    • 스키마란?
      • DB내에 어떤 구조로 데이터가 저장되는가 를 나타내는 데이터베이스 구조를 스키마라고 한다.
  • 장고는 ORM(파이썬 언어를 SQL문으로 변경해주는 라이브러리)을 사용하기 때문에 models.py와 클래스를 통해 DB 스키마를 생성하고 컨트롤 하게 된다.
  • 이 때 DB 스키마를 git처럼 버전으로 나눠서 관리 할 수 있게 해 주는 시스템이라 생각하면 된다.
• 마이그레이션은 매우 기능이 강력하다.
  • 마치 프로젝트를 개발할 때처럼 데이터베이스나 테이블에 손대지 않고도 모델의 반복적인 변경을 가능하게 해준다.
  • 동작 중인 데이터베이스를 자료 손실 없이 업그레이드 하는데 최적화 되어 있다.
• 모델의 변경을 만드는 세 단계의 지침
  • models.py 에서 모델을 변경한다
  • python manage.py makemigrations을 통해 변경사항에 대한 마이그레이션을 만든다
  • python manage.py migrate 명령을 통해 변경사항을 데이터베이스에 적용한다.

migrate & makemigrations

• 마이그레이션을 만드는 명령과 적용하는 명령이 분리된 이유
  • 버전 관리 시스템에 마이그레이션을 커밋하고 앱과 함께 출시할 수 있도록 하기 위해서이다.

django cycle

• 클라이언트인 사용자는 우리가 만든 웹 어플리케이션을 보기 위해서 요청을 하기 된다.
• 클라이언트가 요청을 하면 웹 서버인 Nginx 나 Apache가 요청을 맞이한다.
  • Nginx, Apache라는 웹 서버가 존재하는데, 이 둘을 흔히 교차해서 사용한다.
    • Django에서는 개발을 위해서 경량 개발 웹 서버가 이미 프로젝트를 만들 때 세팅이 되어 있다.
    • 개발을 할 때는 경량 웹 서버를 사용하고 실제 배포할 때는 Nginx나 Apache와 같은 웹 서버를 사용한다.
• WSGI는 웹 서버와 Django 프레임워크를 연결하기 위해서 사용된다.
• 사용자가 특정 주소를 요청하면 URL 파일에서 요청한 주소를 잘게 나누어준다.
  • 이 과정을 파싱(parsing)이라고 한다.
• 잘게 나누어진 주소들은 역할에 맞게 view로 이동한다.
  • view에는 웹 어플리케이션에 각각 맞는 작업을 하기 위해 작성한 코드가 있다.
    • 코드의 종류
      • 요청받은 데이터를 저장
      • 데이터베이스에서 꺼내옴
      • pdf를 만들기 위한 작업
• view 작업이 끝나면 디자인 담당인 template으로 이동한다.
• 사용자는 요청에 대한 응답을 받게 된다.
• 클라이언트는 위 과정이 끝난 후에 요청한 화면을 볼 수 있게 된다.

프로젝트(project) vs 앱(app)

• 프로젝트는 앱의 묶음이다.
• 앱은 특정한 기능을 수행하는 앱 어플리케이션이다.
  • 특정한 기능이란
    • 아이스크림 가게를 차리는데, 이 가게를 위한 앱을 만든다고 하자
    • 아이스크림 관리를 위한 관리 앱, 주문을 위한 주문 앱, 가게 이벤트 관리를 위한 이벤트 앱
    • 위와 같이 특정 기능을 수행하는 앱을 각각 생성해서 프로젝트를 구성하는 것이다.

urls.py의 전체적인 흐름

mysite/urls

from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path('polls/', include('polls.urls')),
    path('admin/', admin.site.urls),
]

polls/urls

from django.urls import path

from . import views

urlpatterns = [
    path('', views.index, name='index'),
]

• 최상위 url.py에서 우리가 작성한 url을 연결해 주었다.
  • ex) 127.0.0.1/polls 라는 url이 최상위 url에 들어왔다면, 이 url을 파싱해서 polls라는 해당 path를 잡아내고 polls앱의 url로 연결시켜 준다.
  • 최상위 url에서 url을 파싱하여 받아주고 path별로 다른 앱으로 분기를 시켜준다
    • 앱이 여러개 있다면 url에 따라 파싱을 해주고 path에 따른 앱으로 분기를 시켜준다.
• polls/urls가 최상위 urls.py에서 요청을 전달받으면 path내에서 view.index라는 view 내부로 연결을 시켜준다.
• view 내부의 index 함수의 응답을 클라이언트에게 전달해준다.

settings.py

mysite/settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

• 세팅 파일에는 이러한 코드가 존재한다.
• INSTALLED_APPS 안에 있는 앱들은 각각의 기능을 수행하고 있다.
• INSTALLED_APPS안에 앱을 명시하면, '이러한 앱들을 사용하겠다.' 라고 Django에게 이야기 하는 것이다.
• 위는 기본적으로 설정된 앱들이다.

$ python manage.py migrate

• 기본적으로 제공되는 앱들은 최소한 하나 이상의 데이터베이스 테이블을 사용한다.
• 데이터베이스 테이블을 사용하기 위해서 위의 명령어를 입력하면 된다.

모델 만들기

• tutorial에서 만드는 설문조사 앱은 다음과 같은 데이터 저장을 필요로 한다.
  • 질문 (Question)
    • 질문 (question)
    • 발행일 (publication date)
  • 사용자가 질문에 대한 선택을 할 수 있는 리스트 (Choice)
    • 선택지 (choice)
    • 표 (vote)
  • Question과 Choice에 대한 데이터베이스 모델을 만들 수 있다.

polls/models.py

from django.db import models


class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')


class Choice(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

• 우리가 만든 database 모델은 Question과 Choice가 있다.
  • Question: 질문 내용, 생성 날짜
    • 질문의 데이터형
      • question_text = models.CharField(max_length=200)
        • 문자, 최대길이 200자
      • pub_date = models.DateTimeField('date published')
        • 발행일, 시간테이블을 가지고 있다.
  • Choice: 선택지에 해당하는 질문, 투표수
    • 질문의 데이터형
      • question = models.ForeignKey(Question, on_delete=models.CASCADE)
        • 외래키(ForeignKey): Question이라는 데이터모델을 참조하겠다.
        • Choice 내에 있는 question은 생성된 Question을 가리키고 있다.
        • CASCADE: 위의 class Question이 삭제가 되면 Choice내의 question도 삭제가 된다라는 뜻
• ForeignKey
  • Question이라는 테이블이 있고, Choice라는 테이블이 존재한다.
  • Choice 테이블 내의 question은 Question 테이블을 참조하고 있다.
  • 하나의 Question 테이블에 여러 개의 Choice를 갖는 구조이기 때문에 1:다 구조이다.

모델의 활성화

• 장고의 철학
  • 앱별로 기능이 나뉘어져있다.
  • 앱을 등록을 하느냐 하지 않느냐에 따라서 앱을 사용하지 않겠다, 앱을 사용하겠다 명시를 해줄 수 있다.

mysite/settings.py

INSTALLED_APPS = [
    'polls.apps.PollsConfig',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

• 위처럼 세팅 파일에 만든 polls 앱을 등록해 준다.
• 'polls.apps.PollsConfig'
  • 'polls 앱 파일안의 apps 파일의 PollsConfig를 등록하겠다.' 라는 뜻

$ python manage.py makemigrations polls

• makemigrations
  • 모델을 작성하고 migration이라는 장소에다 이 모델들을 데이터베이스 내에 테이블을 생성할 수 있도록 설계도를 만드는 작업

python manage.py makemigrations polls
Migrations for 'polls':
  polls/migrations/0001_initial.py
    - Create model Question
    - Create model Choice

• 위의 화면이 출력되었다면 migrations 디렉토리안에 0001_initial.py이라는 파일이 생성된 것을 확인 할 수 있다.

polls/migrations/0001_initial.py

from django.db import migrations, models
import django.db.models.deletion


class Migration(migrations.Migration):

    initial = True

    dependencies = [
    ]

    operations = [
        migrations.CreateModel(
            name='Question',
            fields=[
                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                ('question_text', models.CharField(max_length=200)),
                ('pub_date', models.DateTimeField(verbose_name='date published')),
            ],
        ),
        migrations.CreateModel(
            name='Choice',
            fields=[
                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                ('choice_text', models.CharField(max_length=200)),
                ('votes', models.IntegerField(default=0)),
                ('question', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='polls.question')),
            ],
        ),
    ]

• 데이터베이스내의 테이블을 생성하기 위한 설계도가 만들어진 것을 볼 수 있다.

python manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, polls, sessions
Running migrations:
  Applying polls.0001_initial... OK

• 이제 migrate를 하면 작업이 완료된다.

API 가지고 놀기

• API란
  • 개발자가 필요로 하는 데이터를 뽑아낼 수 있도록 만들어놓은 함수,서버, 데이터베이스에게 데이터를 입력할 수 있도록 만들어 놓은 함수같은 것

>>> from polls.models import Choice, Question 

• 만들어놓은 polls안의 모델내의 Choice, Question을 사용하겠다라고 추가를 하는 작업

>>> Question.objects.all()
<QuerySet []>

• 현재 Question 내의 모든 데이터를 가지고 와라

>>> from django.utils import timezon

• Question 모델에는 질문, 발행일이 있었다.
• 발행일 시간을 입력하기 위해서 timezone이라는 라이브러리를 import하면 된다.

>>> q = Question(question_text="What's new?", pub_date=timezone.now())
>>> q.save()
>>> q.id
1

• Question을 하나 추가한다.
• id는 모델을 생성할 때 명시를 하지 않더라도 Django에서 자동으로 만들어주는 필드 중 하나이다.

  >>> Question.objects.all()
  <QuerySet [<Question: Question object (1)>]>
  

• 오브젝트를 추가했으니 Question의 오브젝트를 모두 불러오면 하나가 존재한다고 뜬다!
• 그런데 사용자가 볼때는 object (1)로 출력이 되는데, 어떤 데이터인지 잘 구분이 가지 않게 된다.
• 모델 내에 __str__() 메소드를 추가하면 오브젝트가 문자로 출력이 되게 된다.

polls/models.py

from django.db import models

# Create your models here.

class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

    def __str__(self):
        return self.question_text


class Choice(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

    def __str__(self):
        return self.choice_text

• 모델 내에 위처럼 __str__ 메소드를 추가해준다.

import datetime

from django.db import models
from django.utils import timezone


class Question(models.Model):
    # ...
    def was_published_recently(self):
        return self.pub_date >= timezone.now() - datetime.timedelta(days=1)

• 개발자에게 필요한 커스템 메서드 또한 추가할 수 있다.
• 위에서 추가한 __str__을 포함한 코드를 지우지 말고 class Question에 추가해주면 된다.
• 간단하게 함수를 살펴보자
  • timezone.now() : 현재 시간
  • datetime.timedelta(days=1) : 하루 전날의 시간
  • timezone.now() - datetime.timedelta(days=1)
    • 현재시간에서 하루 전날의 시간을 빼준다.
    • 현재로부터 하루 차감한 어제의 시간 반환
  • return self.pub_date >= timezone.now() - datetime.timedelta(days=1)
    • 어제 이후로 반환한 데이터가 리턴됨
  • 많은 모듈들을 다 알 수 없으니 그 때 그 때 사용하면서 익혀나가자

>>> Question.objects.all()
<QuerySet [<Question: What's new?>]>

• 위 모델의 변경사항을 저장하고 shell을 다시 실행하면 문자가 출력된다.

django admin

• django의 편리한 기능 중 하나는 admin기능을 제공하는 것이다.
• admin은 사이트 관리를 위한 관리자 전용 사이트이다.
• html 페이지만 존재하는 사이트가 아니고서는 거의 모든 웹 어플리케이션에 admin이 존자한다.
• 컨텐츠를 관리해야 되기 때문이다.
• django는 model, 즉 데이터베이스를 ui가 존재하는 화면으로 관리할 수 있게끔 admin을 만들어준다.

$ python manage.py createsuperuser

• 관리자사이트에 로그인 할 수 있는 사용자를 만든다.

$ python manage.py runserver

• 서버를 동작한다.
  

• 서버를 동작한 뒤 http://127.0.0.1:8000/admin/ 주소로 접속하면 위와 같은 창이 뜬다.

• 여기서 입력한 url은 mysite/urls.py 안에 존재한다.

• 이제 admin 화면에서 질문 수정과 삭제가 가능하다.

<참고>

• https://jwprogramming.tistory.com/47
• https://tibetsandfox.tistory.com/24
• https://youtube.com/playlist?list=PLi4xPOplIq7d1vDdLBAvS5PmQR-p6KwUz