Jak parsować plik YAML w Pythonie?
611
Najłatwiejszą i najczystszą metodą bez polegania na nagłówkach C jest PyYaml ( dokumentacja ), którą można zainstalować za pomocą pip install pyyaml
:
#!/usr/bin/env python
import yaml
with open("example.yaml", 'r') as stream:
try:
print(yaml.safe_load(stream))
except yaml.YAMLError as exc:
print(exc)
I to wszystko. Istnieje yaml.load()
również prosta funkcja, ale yaml.safe_load()
zawsze powinna być preferowana, chyba że jawnie potrzebujesz dostarczonej serializacji / deserializacji dowolnego obiektu, aby uniknąć wprowadzenia możliwości wykonania dowolnego kodu.
Uwaga: projekt PyYaml obsługuje wersje do specyfikacji YAML 1.1 . Jeśli wymagana jest obsługa specyfikacji YAML 1.2 , zobacz ruamel.yaml, jak wspomniano w tej odpowiedzi .
yaml.safe_load
ponieważ nie może wykonać dowolnego kodu z pliku YAML.pip install pyyaml
, zobacz ten post, aby uzyskać więcej opcji stackoverflow.com/questions/14261614/…Odczytywanie i zapisywanie plików YAML za pomocą Python 2 + 3 (i Unicode)
Utworzono plik YAML
Typowe zakończenia plików
.yml
i.yaml
Alternatywy
W przypadku aplikacji ważne mogą być:
Zobacz także: Porównanie formatów serializacji danych
Jeśli szukasz sposobu na utworzenie plików konfiguracyjnych, możesz przeczytać mój krótki artykuł Pliki konfiguracyjne w Pythonie
źródło
€
w systemie Windows to€
. Czy ktoś zna przyczynę?io.open(doc_name, 'r', encoding='utf8')
aby odczytać znak specjalny. Wersja YAML 0.1.7open(doc_name, ..., encodung='utf8')
do odczytu i zapisu, bez importowaniaio
.Jeśli masz YAML, który jest zgodny ze specyfikacją YAML 1.2 (wydaną w 2009 r.), Powinieneś użyć ruamel.yaml (zrzeczenie się: Jestem autorem tego pakietu). Jest to w zasadzie nadzbiór PyYAML, który obsługuje większość YAML 1.1 (od 2005).
Jeśli chcesz zachować swoje komentarze podczas podróży w obie strony, z pewnością powinieneś użyć ruamel.yaml.
Aktualizacja przykładu @ Jona jest łatwa:
Używaj,
safe_load()
chyba że naprawdę masz pełną kontrolę nad danymi wejściowymi, potrzebujesz ich (rzadko w przypadku) i wiesz, co robisz.Jeśli używasz pathlib
Path
do manipulowania plikami, lepiej jest użyć nowego interfejsu API ruamel.yaml zapewnia:źródło
UnicodeDecodeError: 'ascii' codec can't decode byte 0xe7 in position 926: ordinal not in range(128)
). Próbowałem ustawić yaml.encoding na utf-8, ale nie działałem, ponieważ metoda ładowania w YAML nadal używa ascii_decode. Czy to błąd?Najpierw zainstaluj pyyaml za pomocą pip3.
Następnie zaimportuj moduł yaml i załaduj plik do słownika o nazwie „my_dict”:
To wszystko czego potrzebujesz. Teraz cały plik yaml znajduje się w słowniku „my_dict”.
źródło
!!python
), może być również niebezpieczny (jak w przypadku całkowitego wyczyszczenia dysku twardego)yaml.load()
. Ponieważ jest to wyraźnie udokumentowane, powinieneś powtórzyć to ostrzeżenie tutaj (w prawie wszystkich przypadkachyaml.safe_load()
można użyć).import yaml
, ale to nie jest wbudowany moduł i nie określasz, który to pakiet. Uruchomienieimport yaml
nowej instalacji Python3 powodujeModuleNotFoundError: No module named 'yaml'
Przykład:
źródło
Używam ruamel.yaml .
Szczegóły i debata tutaj.Użycie ruamel.yaml jest kompatybilne (z pewnymi prostymi rozwiązalnymi problemami) ze starymi zastosowaniami PyYAML i jak podano w linku, który podałem , użyj
zamiast
i naprawi większość twoich problemów.
EDYCJA : PyYAML nie jest martwy, jak się okazuje, po prostu jest trzymany w innym miejscu.
źródło
źródło