<div id="readability-page-1" class="page"><div id="main" role="main">
  <article>
    <div>
        
      <h2>[Python] PyYAML 사용시 키 이름 "on"이 True로 바뀌는 사례</h2>
      <blockquote>
  <p>PyYAML 사용시 on이 True로 바뀌는 사례</p>
</blockquote>



<h2 id="환경">환경</h2>

<ul>
  <li>Github Action</li>
  <li>Python</li>
  <li>PyYAML</li>
</ul>



<h2 id="배경">배경</h2>

<ul>
  <li>Github Action Workflow 파일을 동적으로 Python을 통해 수정하는데 YAML 파일 파싱시 <code>on</code>이라는 키가 <code>True</code>로 바뀌는 상황이 발생해서 정리.</li>
</ul>



<h2 id="예시">예시</h2>

<p>아래와 같이 Python에서 yaml을 통해 파일을 읽어서 출력하면 <strong>on</strong>이 사라지고 <strong>True</strong>가 들어가 있는걸 볼 수 있다.</p>

<p><strong>코드</strong></p>

<div><pre><code><span>import</span> <span>io</span>
<span>import</span> <span>yaml</span>

<span>file_content</span> <span>=</span> <span>"""
name: Workflow Complete Event Test

on:
  workflow_run:
    workflows: [ "Push Main Branch" ]
    types:
      - completed
"""</span>

<span>file_like_object</span> <span>=</span> <span>io</span><span>.</span><span>StringIO</span><span>(</span><span>file_content</span><span>)</span>
<span>yaml_content</span> <span>=</span> <span>yaml</span><span>.</span><span>safe_load</span><span>(</span><span>file_like_object</span><span>)</span>

<span>print</span><span>(</span><span>yaml_content</span><span>)</span>
</code></pre></div>

<p><strong>결과</strong></p>

<div><pre><code>{'name': 'Workflow Complete Event Test', True: {'workflow_run': {'workflows': ['Push Main Branch'], 'types': ['completed']}}}
</code></pre></div>



<h2 id="이유">이유</h2>

<p>검색해보니 <u>PyYAML의 경우 YAML 1.1 버전을 지원하고 있으며 1.1 버전의경우 "on"은 boolean으로 간주되며 그렇기에 True로 바뀌는게 맞다고 한다.</u> YAML 1.2를 아직 지원하지 않다고 하기에 의도된 동작이며 방법을 따로 찾아야한다.</p>



<h2 id="해결-방법">해결 방법</h2>

<p>여러가지 방식이 있다.</p>

<ul>
  <li>Loader의 코드를 변경해서 설정</li>
  <li>Key에 따옴표(<code>""</code> 또는 <code>''</code>)를 사용</li>
  <li>다른 Python 모듈 사용</li>
</ul>

<p>따옴표가 눈에 띄어서 없애고 싶은 마음이 들지만 두번째 방식이 가장 간단해보이고 기존 yaml 모듈 변경이 없어서 해당 방식을 적용했다.</p>

<p><strong>코드</strong></p>

<div><pre><code><span>import</span> <span>io</span>
<span>import</span> <span>yaml</span>

<span>file_content</span> <span>=</span> <span>"""
name: Workflow Complete Event Test

'on':
  workflow_run:
    workflows: [ "Push Main Branch" ]
    types:
      - completed
"""</span>

<span>file_like_object</span> <span>=</span> <span>io</span><span>.</span><span>StringIO</span><span>(</span><span>file_content</span><span>)</span>
<span>yaml_content</span> <span>=</span> <span>yaml</span><span>.</span><span>safe_load</span><span>(</span><span>file_like_object</span><span>)</span>

<span>print</span><span>(</span><span>yaml_content</span><span>)</span>
</code></pre></div>

<p><strong>결과</strong></p>

<div><pre><code>{'name': 'Workflow Complete Event Test', 'on': {'workflow_run': {'workflows': ['Push Main Branch'], 'types': ['completed']}}}
</code></pre></div>



<h2 id="참고자료">참고자료</h2>

<ul>
  <li><a href="https://github.com/yaml/pyyaml/issues/376">https://github.com/yaml/pyyaml/issues/376</a></li>
  <li><a href="https://stackoverflow.com/questions/36463531/pyyaml-automatically-converting-certain-keys-to-boolean-values">https://stackoverflow.com/questions/36463531/pyyaml-automatically-converting-certain-keys-to-boolean-values</a></li>
  <li><a href="https://github.com/yaml/pyyaml/issues/744">https://github.com/yaml/pyyaml/issues/744</a></li>
</ul>

      
        
        
        </div>
    
    
    

  </article>
</div></div>

TWpower’s Tech Blog

PyYAML 사용시 on이 True로 바뀌는 사례
환경
Github Action
Python
PyYAML
배경
Github Action Workflow 파일을 동적으로 Python을 통해 수정하는데 YAML 파일 파싱시 on이라는 키가 True로 바뀌는 상황이 발생해서 정리.
예시
아래와 같이 Python에서 yaml을 통해 파일을 읽어서 출력하면 on이 사라지고 True가 들어가 있는걸 볼 수 있다.
코드
import io
import yaml
file_content = """
name: Workflow Complete Event Test
on:
  workflow_run:
    workflows: [ "Push Main Branch" ]
    types:
      - completed
"""
file_like_object = io.StringIO(file_content)
yaml_content = yaml.safe_load(file_like_object)
print(yaml_content)
결과
{'name': 'Workflow Complete Event Test', True: {'workflow_run': {'workflows': ['Push Main Branch'], 'types': ['completed']}}}
이유
검색해보니 PyYAML의 경우 YAML 1.1 버전을 지원하고 있으며 1.1 버전의경우 "on"은 boolean으로 간주되며 그렇기에 True로 바뀌는게 맞다고 한다. YAML 1.2를 아직 지원하지 않다고 하기에 의도된 동작이며 방법을 따로 찾아야한다.
해결 방법
여러가지 방식이 있다.
Loader의 코드를 변경해서 설정
Key에 따옴표("" 또는 '')를 사용
다른 Python 모듈 사용
따옴표가 눈에 띄어서 없애고 싶은 마음이 들지만 두번째 방식이 가장 간단해보이고 기존 yaml 모듈 변경이 없어서 해당 방식을 적용했다.
코드
import io
import yaml
file_content = """
name: Workflow Complete Event Test
'on':
  workflow_run:
    workflows: [ "Push Main Branch" ]
    types:
      - completed
"""
file_like_object = io.StringIO(file_content)
yaml_content = yaml.safe_load(file_like_object)
print(yaml_content)
결과
{'name': 'Workflow Complete Event Test', 'on': {'workflow_run': {'workflows': ['Push Main Branch'], 'types': ['completed']}}}
참고자료
https://github.com/yaml/pyyaml/issues/376
https://stackoverflow.com/questions/36463531/pyyaml-automatically-converting-certain-keys-to-boolean-values
https://github.com/yaml/pyyaml/issues/744

[Python] PyYAML 사용시 키 이름 “on”이 True로 바뀌는 사례

댓글