<div id="readability-page-1" class="page"><div><h2 id="_1">들어가기</h2>
<p>MCP 공부를 하려고 Python으로 Roam Research MCP를 만들어보려고 했는데, Roam Research API를 위한 공식 코드가 패키지화되지 않은 상태로 각각 따로 사용하고 있었다.<br>
그럼 Python 라이브러리를 만들어볼까 하고 한달째 (귀찮아…) 찬찬히 만들어가고 있다.</p>
<p><a href="https://docs.astral.sh/uv/concepts/projects/init/#libraries">uv</a>를 이용해서 <code>uv init --lib</code> 를 하였더니, <code>py.typed</code>라는 파일을 만들어줬다. 이건 뭐지?<br>
파이썬으로 단순 스크립트를 만들거나, 그냥 간단한 cli를 만들어서 사용하던 나에겐 낯선 파일이었다.</p>
<h2 id="pep-561-distributing-and-packaging-type-information">PEP 561 - Distributing and Packaging Type Information</h2>
<p>구글에서 검색하니 <a href="https://peps.python.org/pep-0561/">PEP 561</a> 에 명시된 내용이라고 뜸.</p>
<blockquote>
<p>타입 검사를 지원하는 패키지를 배포하고자 하는 개발자는 타입 검사를 지원하는 패키지에 <code>py.typed</code>라는 마커 파일을 추가해야 합니다. 이 마커는 재귀적으로 적용되므로 최상위 패키지에 이 마커가 포함되어 있으면 모든 하위 패키지에서도 유형 검사를 지원해야합니다. 이 파일을 패키지와 함께 설치하려면 관리자는 아래와 같이 <code>distutils</code>에서 <code>package_data</code>와 같은 기존 패키징 옵션을 사용할 수 있습니다.<br>
(중략)<br>
네임스페이스 패키지 (<a href="https://peps.python.org/pep-0420/">PEP 420</a>)의 경우, 충돌을 피하고 명확성을 위해 <code>py.typed</code> 파일은 네임스페이스의 서브모듈에 있어야 합니다.<br>
이 PEP는 모듈 전용 배포 또는 네임스페이스 패키지 내의 단일 파일 모듈의 일부로 타이핑 정보를 배포하는것을 지원하지 않습니다.<br>
단일 파일 모듈은 패키지로 리팩터링하고 위에서 설명한 대로 패키지가 타이핑을 지원하다는 것을 표시해야 합니다.<br>
(<a href="https://peps.python.org/pep-0561/#packaging-type-information">원문</a>)</p>
</blockquote>

<ul>
<li>이 라이브러리는 타입 힌팅을 완전히 지원한다는 내용을 명시하는 데 사용된다.</li>
<li>내용은 안써도 됩니다.</li>
<li><code>.pyi</code> (<a href="https://typing.python.org/en/latest/spec/distributing.html#stub-files">Stub Files</a>) 파일이 있는 경우엔 <code>py.typed</code> 파일을 필요가 없습니다.</li>
</ul>
<h2 id="tmi">TMI</h2>
<ul>
<li>2017-11-12 일에 <code>.typeinfo</code> 에서 <code>py.typed</code>로 파일명이 변경되었다.</li>
</ul>
<h2 id="_2">참고</h2>
<ul>
<li><a href="https://peps.python.org/pep-0561/">PEP 561</a></li>
<li><a href="https://typing.python.org/en/latest/spec/distributing.html#type-information-in-libraries">Distributing type information</a></li>
<li><a href="https://typing.python.org/en/latest/guides/libraries.html#providing-type-annotations">Typing Python Library</a></li>
</ul></div></div>

잘 밤에 쓸데없는 생각하기...

Thomas Sungjin Kang

들어가기
MCP 공부를 하려고 Python으로 Roam Research MCP를 만들어보려고 했는데, Roam Research API를 위한 공식 코드가 패키지화되지 않은 상태로 각각 따로 사용하고 있었다.
uv를 이용해서 uv init --lib 를 하였더니, py.typed라는 파일을 만들어줬다. 이건 뭐지?
PEP 561 - Distributing and Packaging Type Information
구글에서 검색하니 PEP 561 에 명시된 내용이라고 뜸.
타입 검사를 지원하는 패키지를 배포하고자 하는 개발자는 타입 검사를 지원하는 패키지에 py.typed라는 마커 파일을 추가해야 합니다. 이 마커는 재귀적으로 적용되므로 최상위 패키지에 이 마커가 포함되어 있으면 모든 하위 패키지에서도 유형 검사를 지원해야합니다. 이 파일을 패키지와 함께 설치하려면 관리자는 아래와 같이 distutils에서 package_data와 같은 기존 패키징 옵션을 사용할 수 있습니다.
PEP 420)의 경우, 충돌을 피하고 명확성을 위해 py.typed 파일은 네임스페이스의 서브모듈에 있어야 합니다.
원문)
py.typed 파일이란?
이 라이브러리는 타입 힌팅을 완전히 지원한다는 내용을 명시하는 데 사용된다.
내용은 안써도 됩니다.
.pyi (Stub Files) 파일이 있는 경우엔 py.typed 파일을 필요가 없습니다.
TMI
2017-11-12 일에 .typeinfo 에서 py.typed로 파일명이 변경되었다.
참고
PEP 561
Distributing type information
Typing Python Library

py.typed 파일은 무엇인가?

댓글