설정

settings.WIREVIEW의 키 전부다. 여기 적힌 키가 공개이고(호환성 정책), 기본값의 정본은 wireview/settings.py의 DEFAULT다. tests/test_settings_reference.py가 이 표와 DEFAULT를 대조한다.

설정은 쓰는 시점에 읽는다. 테스트에서는 override_settings(WIREVIEW={...})로 바꾼다. 모르는 키나 없어진 키가 있으면 manage.py check가 wireview.W014로 알린다. 기동할 때만 의미가 있는 키는 기동 시로 표시했다 — 실행 중에 바꿔도 아무 일도 일어나지 않는다.

from wireview import AutoBroadcast

WIREVIEW = {
    "BOOST_PAGES": True,
    "AUTO_BROADCAST": AutoBroadcast(model=True, model_pk=True, senders={("todo", "Item")}),
}

페이지와 연결#

서명#

업로드#

chunked-uploads

모델 알림#

senders에 적은 모델은 저장·삭제될 때마다 인스턴스가 직렬화되어 채널 레이어로 가고, 구독한 컴포넌트의 mutation()이 그것을 받는다. 집합으로 적으면 그 모델 테이블의 모든 필드가 간다. 보낼 필드를 줄이려면 senders를 매핑으로 적는다.

WIREVIEW = {
    "AUTO_BROADCAST": AutoBroadcast(
        model=True,
        model_pk=True,
        senders={
            ("todo", "Item"): "__all__",              # 모든 필드. 집합으로 적은 것과 같다
            ("accounts", "User"): ("username", "is_active"),
            ("rating", "Rating"): ("product",),       # FK는 필드 이름으로. product의 id가 간다
            ("audit", "Event"): (),                   # pk만
        },
    ),
}

• 값은 "__all__", 필드 이름의 튜플, ()(pk만) 셋 중 하나다. 맨 문자열(("username")은 튜플이 아니다)은 거절된다.
• pk는 늘 간다. 목록에 적지 않는다(적으면 기동 때 오류다).
• FK는 "product"나 "product_id"로 적고 id가 간다. m2m 필드는 적을 때만 pk 목록이 간다(적지 않으면 그 조회도 없다). 역관계 이름, 다중 테이블 상속의 부모 필드, serialize=False인 필드는 보낼 수 없다.
• 같은 모델을 대소문자만 다른 두 키로 적고 필드가 다르면 기동 때 오류다(어느 쪽이 이길지 정하지 않는다).
• 받는 쪽 인스턴스에는 보낸 필드와 pk만 들어 있다. 적지 않은 필드는 아래의 "실리지 않은 필드"처럼 deferred다. 필요하면 이름을 적어 불러온다: await instance.arefresh_from_db(fields=["title"]). 필드를 적지 않은 arefresh_from_db()는 불러온 필드만 다시 읽고 deferred 필드는 그대로 둔다. 보낸 필드가 있으면 저장은 그것만 쓴다. ()(pk만)로 받은 인스턴스는 저장하지 않는다 — 불러온 필드가 없으면 Django가 저장 범위를 좁히지 못하고, deferred 필드를 하나씩 행에서 읽은 뒤 모든 필드를 쓴다(읽기와 쓰기 사이에 바뀐 컬럼이 덮인다). 그 행을 고치려면 QuerySet.update()나 asave(update_fields=[...])를 쓴다.
• DELETED 알림도 적은 필드만 싣는다. 행이 이미 없어 다시 읽을 수 없으므로, 삭제를 거를 때 쓰는 필드(FK 등)는 목록에 적는다.
• 사용자 모델(AbstractBaseUser의 하위 클래스)의 페이로드에 비밀번호 해시가 실리면 wireview.W017이 알린다. 필드를 적어 줄인다(password를 빼고). 다중 테이블 상속으로 사용자 모델을 물려받은 자식은 제 테이블의 필드만 보내므로 해당하지 않는다.
• 세션 모델(AbstractBaseSession의 하위 클래스)은 필드를 적어도 wireview.W017이 알린다. pk가 세션 키라 모든 페이로드에 실리고 model_pk면 채널 이름에도 들어간다. senders에서 빼고, 컴포넌트에 필요한 것만 담은 모델을 따로 알린다.
• 1.0.0rc4 이전에서 올리는 롤링 배포에서는 모든 프로세스를 올린 뒤에 필드를 줄인다. 그 버전은 빠진 필드를 기본값으로 채운 인스턴스를 mutation()에 넘긴다(배포).

mutation()이 받은 instance는 보통의 모델 인스턴스처럼 저장된다(#153). save()·asave()는 모델의 save() 오버라이드를 거치고, pre_save·post_save는 raw=False로 나간다. 이미 있는 행으로 복원되므로 UPDATE를 먼저 한다. 알아 둘 것:

• 페이로드에 실린 필드를 모두 쓴다. 페이로드는 시그널이 났을 때의 행이다. 그 뒤에 다른 곳에서 바뀐 컬럼도 페이로드의 옛 값으로 덮인다. 바꾼 필드만 쓰려면 await instance.asave(update_fields=["name"]), 지금 값이 필요하면 await instance.arefresh_from_db() 뒤에 고친다.
• 실리지 않은 필드는 deferred다. Django 직렬화기는 그 모델 자신의 테이블만 쓴다 — 다중 테이블 상속에서 부모 모델의 필드와 serialize=False 필드는 실리지 않는다. 그런 필드는 QuerySet.only()로 읽은 인스턴스처럼 남는다. 읽으면 DB를 조회하므로 mutation()(이벤트 루프)에서 그냥 읽으면 SynchronousOnlyOperation이다 — await instance.arefresh_from_db(fields=["name"])로 먼저 읽는다. 저장은 실린 필드만 쓰고 부모 테이블은 건드리지 않는다. 부모 행은 자식의 pk가 아니라 페이로드에 실린 부모 링크로 찾는다(자식이 pk를 따로 선언하면 둘은 다른 값이다). 링크가 실리지 않은 조상(pk를 따로 둔 부모의 부모)의 키도 deferred로 남아 저장할 때 행에서 읽는다. 인스턴스의 db alias(_state.db)는 라우터의 db_for_write가 고른 곳이다.
• m2m은 쓰지 않는다. 페이로드의 m2m pk 목록은 인스턴스에 실리지 않는다. 보통의 save()처럼 m2m은 그대로다.
• DELETED로 받은 인스턴스를 저장하면 행이 없으므로 다시 INSERT된다. deferred 필드가 있는 인스턴스(상속한 자식, 매핑에 적지 않은 필드가 있는 인스턴스)는 쓸 행이 없어 DatabaseError다. ()(pk만)로 받은 인스턴스는 저장이 deferred 필드를 행에서 읽으려다 DoesNotExist다.
• 저장도 알림을 낸다. 그 모델이 senders에 있으면 수신자의 저장이 같은 채널로 다시 알려지고, 그 컴포넌트의 mutation()이 또 불린다. 받을 때마다 무조건 저장하면 끝없이 돈다. 값이 다를 때만 저장하거나, 시그널을 내지 않는 QuerySet.update()를 쓴다. 1.0.0rc4까지의 raw 저장도 시그널을 냈으므로 이 위험은 새것이 아니다.

픽스처 로드는 알리지 않는다. loaddata는 raw=True로 저장하고, 그 순간의 DB는 아직 일관되지 않을 수 있다. post_save의 raw=True는 거르고, loaddata가 방금 raw로 저장한 객체에 이어서 채우는 m2m도 거른다(m2m_changed에는 raw가 없어서 그 객체에 표시를 남긴다). 같은 객체를 직접 save_base(raw=True)한 뒤 고친 m2m도 그 객체를 보통으로 다시 저장하기 전까지는 알리지 않는다.

m2m 변경(m2m)은 바꾼 쪽의 모델이 senders에 있을 때 알린다. 알림에 실리는 인스턴스가 그쪽이기 때문이다. user.groups.add(g)는 User를, group.user_set.add(u)는 Group을 적어야 알린다. 어느 쪽에서 바꿔도 알리려면 두 모델을 모두 적는다.

개발 도구#