<div id="readability-page-1" class="page"><div id="container" role="main">

 
 
 

 
 
 

 
 
 

 
 
 

 
 
 

 
 
 

 
 
 

 
 
 <article>
 <div>
 
 

 
 <header>
 
 </header>

 

 <div>&nbsp;안녕하세요. 이번 시간에는 field 단위로 동작하는 validator에 대해 알아보겠습니다.

<hr contenteditable="false" data-ke-type="horizontalRule" data-ke-style="style3">
&nbsp;먼저 아래 프로그램을 보겠습니다.

<figure data-ke-mobilestyle="widthOrigin" data-filename="vt1.png" data-origin-width="559" data-origin-height="299"><img src="https://blog.kakaocdn.net/dn/OhWaP/btsjkajIexA/bH2aA0CZJU0zmJBRjkNK00/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt1.png" data-origin-width="559" data-origin-height="299"></figure>

&nbsp;&nbsp;x: int = Field(gt=5)라고 되어 있습니다. pydantic의 Field인데요. gt는 greater than의 약자입니다. 즉, 5보다 커야 된다는 조건이 있어야 합니다. 9번째 줄에는 custom validator를 작성하였는데요. "x"는 필드명을 의미합니다. 필드명 x에 대한 커스텀 벨리데이터 함수는 check_x를 의미해요.

&nbsp;1번째 인자는 cls, 2번째 인자는 v인데요. v는 실제로 check_x에 들어온 필드 x의 값을 의미합니다. 보통 이 v값을 검증해서, 조건에 맞지 않으면 ValueError를 떨어트리게 됩니다. pre=True라고 되어 있는데요. 어떻게 실행되는지 보겠습니다.


<figure data-ke-mobilestyle="widthOrigin" data-filename="vt2.png" data-origin-width="743" data-origin-height="319"><img src="https://blog.kakaocdn.net/dn/dtGTH8/btsjlYbuSYA/5SfK6DkhvXr1Km9rVkr7F1/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt2.png" data-origin-width="743" data-origin-height="319"></figure>

&nbsp;x에 -6을, y에 0을 넘겨주었습니다. 그러면, pre=True이므로 check_x가 실행됩니다. 들어온 v의 값이 10보다는 작았으므로, -v 값인 6이 리턴됩니다. 그 다음에 Field(ge=5) Validator로 넘어가는데요. 6은 5보다 크므로 참이 리턴됩니다.


<figure data-ke-mobilestyle="widthOrigin" data-filename="vt7.png" data-origin-width="470" data-origin-height="279"><img src="https://blog.kakaocdn.net/dn/czMVDK/btsjlWq7P9y/22CFb7HJlTdpKbaoiv6xWk/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt7.png" data-origin-width="470" data-origin-height="279"></figure>

&nbsp;post /res가 호출되면, 그대로 res_request.x와 res_request.y를 돌려주게 되는데요. validation을 하는 과정에서, res_request.x의 값에 -1이 곱해집니다.

<figure data-ke-mobilestyle="widthOrigin" data-filename="vt3.png" data-origin-width="561" data-origin-height="151"><img src="https://blog.kakaocdn.net/dn/oM5TJ/btsjk53hYYU/DwTqsDbKntcqLtLtiPvML1/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt3.png" data-origin-width="561" data-origin-height="151"></figure>

&nbsp;결과는 x가 6, y가 0이 나오게 됩니다.

<figure data-ke-mobilestyle="widthOrigin" data-filename="vt4.png" data-origin-width="544" data-origin-height="298"><img src="https://blog.kakaocdn.net/dn/CCpcW/btsjj8M2K4a/nLpZpkliKJZLKIG0ie48UK/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt4.png" data-origin-width="544" data-origin-height="298"></figure>

&nbsp;반대로 이 경우에는 어떨까요? Field(gt=5) 먼저 수행되게 됩니다.

<figure data-ke-mobilestyle="widthOrigin" data-filename="vt5.png" data-origin-width="736" data-origin-height="246"><img src="https://blog.kakaocdn.net/dn/brmf1Z/btsjkE5W1Ih/TfvBkjopYLkawuRK7Wl4T1/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt5.png" data-origin-width="736" data-origin-height="246"></figure>

&nbsp;다시 post /res에 요청을 요래 날려보겠습니다.

<figure data-ke-mobilestyle="widthOrigin" data-filename="vt6.png" data-origin-width="564" data-origin-height="343"><img src="https://blog.kakaocdn.net/dn/6QP8Q/btsjlmDCnHh/LZ47qtyOS5iP8o4jGshzRK/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt6.png" data-origin-width="564" data-origin-height="343"></figure>

&nbsp;그러면 아까와 다르게 not_gt 에러가 뜨면서 422가 떨어짐을 알 수 있어요. int는 gt, ge, lt, le 등을 상당히 많이 쓰니 알아두면 좋습니다.


<hr contenteditable="false" data-ke-type="horizontalRule" data-ke-style="style3">
<figure data-ke-mobilestyle="widthOrigin" data-filename="vt8.png" data-origin-width="434" data-origin-height="142"><img src="https://blog.kakaocdn.net/dn/cnBZCW/btsjlZVMZoT/UyknAEeKzKPv2KO64gnaIk/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt8.png" data-origin-width="434" data-origin-height="142"></figure>

&nbsp;문자열의 경우도 검증을 많이 합니다. 이 중에서 제가 자주 쓰는 regex만 알아보겠습니다. regex는 패턴에 맞지 않으면 실패하게 됩니다. 예를 들어, ResRequest schema의 x는 str이고, "^[0-9a-zA-Z]{1,5}$"만 허용한다고 해 보겠습니다. 이것은 대소문자나 숫자로만 이루어진 길이 1에서 5 사이의 문자열만 허용한다는 의미입니다.

<figure data-ke-mobilestyle="widthOrigin" data-filename="vt9.png" data-origin-width="341" data-origin-height="280"><img src="https://blog.kakaocdn.net/dn/dPS82o/btsjjadxisd/ggA9QLKbRm0oGpUmbsoTZK/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt9.png" data-origin-width="341" data-origin-height="280"></figure>

&nbsp;post /res 요청이 날라왔을 때 불리는 메서드는 위와 같습니다. 이제 post /res 요청을 날려보겠습니다.


<figure data-ke-mobilestyle="widthOrigin" data-filename="vt10.png" data-origin-width="717" data-origin-height="225"><img src="https://blog.kakaocdn.net/dn/bq1zji/btsjkFX6HUw/tVvkevMKcWjIjIJCdUvlS1/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt10.png" data-origin-width="717" data-origin-height="225"></figure>

&nbsp;문자열 "12-45"를 보내보겠습니다.


<figure data-ke-mobilestyle="widthOrigin" data-filename="vt11.png" data-origin-width="575" data-origin-height="345"><img src="https://blog.kakaocdn.net/dn/xCV48/btsjlXjiJjl/E08pvBK3zKvZoUIaML0ZGk/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-filename="vt11.png" data-origin-width="575" data-origin-height="345"></figure>

&nbsp;그러면, 정규식에 맞지 않기 때문에, 422가 떨어지게 됩니다.</div>

 
 
 
 
 
 

 </div>
 </article>
 
 
 

 
									
									
 </div></div>

강아지의 코딩공부

안녕하세요. 이번 시간에는 field 단위로 동작하는 validator에 대해 알아보겠습니다.
 
 먼저 아래 프로그램을 보겠습니다.
 
  x: int = Field(gt=5)라고 되어 있습니다. pydantic의 Field인데요. gt는 greater than의 약자입니다. 즉, 5보다 커야 된다는 조건이 있어야 합니다. 9번째 줄에는 custom validator를 작성하였는데요. "x"는 필드명을 의미합니다. 필드명 x에 대한 커스텀 벨리데이터 함수는 check_x를 의미해요.
 
 1번째 인자는 cls, 2번째 인자는 v인데요. v는 실제로 check_x에 들어온 필드 x의 값을 의미합니다. 보통 이 v값을 검증해서, 조건에 맞지 않으면 ValueError를 떨어트리게 됩니다. pre=True라고 되어 있는데요. 어떻게 실행되는지 보겠습니다.
 
 
 x에 -6을, y에 0을 넘겨주었습니다. 그러면, pre=True이므로 check_x가 실행됩니다. 들어온 v의 값이 10보다는 작았으므로, -v 값인 6이 리턴됩니다. 그 다음에 Field(ge=5) Validator로 넘어가는데요. 6은 5보다 크므로 참이 리턴됩니다.
 
 
 post /res가 호출되면, 그대로 res_request.x와 res_request.y를 돌려주게 되는데요. validation을 하는 과정에서, res_request.x의 값에 -1이 곱해집니다.
 
 결과는 x가 6, y가 0이 나오게 됩니다.
 
 반대로 이 경우에는 어떨까요? Field(gt=5) 먼저 수행되게 됩니다.
 
 다시 post /res에 요청을 요래 날려보겠습니다.
 
 그러면 아까와 다르게 not_gt 에러가 뜨면서 422가 떨어짐을 알 수 있어요. int는 gt, ge, lt, le 등을 상당히 많이 쓰니 알아두면 좋습니다.
 
 
 문자열의 경우도 검증을 많이 합니다. 이 중에서 제가 자주 쓰는 regex만 알아보겠습니다. regex는 패턴에 맞지 않으면 실패하게 됩니다. 예를 들어, ResRequest schema의 x는 str이고, "^[0-9a-zA-Z]{1,5}$"만 허용한다고 해 보겠습니다. 이것은 대소문자나 숫자로만 이루어진 길이 1에서 5 사이의 문자열만 허용한다는 의미입니다.
 
 post /res 요청이 날라왔을 때 불리는 메서드는 위와 같습니다. 이제 post /res 요청을 날려보겠습니다.
 
 
 문자열 "12-45"를 보내보겠습니다.
 
 
 그러면, 정규식에 맞지 않기 때문에, 422가 떨어지게 됩니다.

fastapi pydantic 필드 단위로 동작하는 validator를 간단하게 알아봅시다

댓글