Otwierasz plik z konfiguracją albo danymi z innego systemu i widzisz znaczniki w nawiasach ostrych. XML to tekstowy sposób opisywania uporządkowanych danych, ale sam wygląd pliku nie mówi jeszcze, czy jego zawartość jest poprawna ani jak program ma ją odczytać.
,
XML opisuje dane za pomocą własnych, zagnieżdżonych znaczników
- Znaczniki nazywają elementy danych, a atrybuty mogą dodawać im właściwości.
- Jeden element główny i prawidłowo domknięte znaczniki to warunki poprawnej składni.
- XML Schema może opisać dozwoloną strukturę i typy danych, ale nie jest obowiązkowa w każdym pliku.
- W Pythonie plik XML można wczytać między innymi za pomocą modułu ElementTree.
XML porządkuje dane, zamiast narzucać ich znaczenie
Wyobraź sobie eksport zamówienia, który ma odczytać program sklepu, system magazynowy i narzędzie do raportów. XML pozwala opisać pola tak, by ich układ był widoczny zarówno dla człowieka, jak i dla parsera, czyli programu analizującego strukturę dokumentu.
Przykładowy fragment może wyglądać tak:
Anna Nowak
149.90
zamowienie, klient i kwota to nazwy elementów wybrane przez twórcę formatu. XML nie wie sam z siebie, że kwota oznacza cenę ani że numer identyfikuje zamówienie. Znaczenie pól określa umowa między systemami, a nie sam język znaczników.
Jeden źle domknięty element może zatrzymać odczyt
Parser nie zgaduje, co autor miał na myśli. Według specyfikacji XML 1.0 W3C dokument poprawny składniowo ma jeden element główny, a znaczniki muszą być prawidłowo zagnieżdżone. To właśnie odróżnia „wygląda sensownie” od „da się bezpiecznie przetworzyć”.
| Sytuacja | Skutek | Co zrobić |
|---|---|---|
Brakuje znacznika zamykającego, na przykład |
Parser zgłosi błąd składni. | Sprawdź miejsce wskazane w komunikacie i domknij element. |
| Elementy nachodzą na siebie zamiast się zagnieżdżać | Struktura dokumentu nie spełnia reguł XML. | Ułóż znaczniki parami, od najgłębiej zagnieżdżonych do nadrzędnych. |
| Plik przechodzi parsowanie, ale nie pasuje do wymaganego układu danych | Może być składniowo poprawny, lecz niezgodny z formatem oczekiwanym przez aplikację. | Porównaj go ze schematem albo dokumentacją systemu, który ma go przyjąć. |
Ten ostatni przypadek często myli początkujących. Poprawność składniowa nie gwarantuje poprawności danych: plik może być dobrze zbudowany, a mimo to zawierać pole w niewłaściwym miejscu lub wartość w nieakceptowanym formacie.
XML Schema sprawdza reguły, których parser nie zna
Dwa pliki mogą być poprawne składniowo, choć tylko jeden odpowiada wymaganiom konkretnej aplikacji. Do opisu takich wymagań służy między innymi XML Schema, nazywana też XSD. Schemat może określać dozwolone elementy, ich kolejność, typy wartości czy to, które pola są wymagane.
Przykładowo parser zaakceptuje element jako prawidłowo zapisany fragment XML. Jeśli jednak schemat wymaga liczby, walidacja względem XSD powinna wykryć niezgodność. Gdy odbiorca pliku nie udostępnia schematu, nie zakładaj, że można dowolnie zmieniać nazwy pól albo kolejność elementów.
Reguła wyboru jest prosta: jeśli chcesz jedynie wczytać strukturę, wystarczy parser; jeśli musisz potwierdzić zgodność z konkretnym kontraktem danych, potrzebujesz także walidacji według schematu. Uważam, że właśnie to rozróżnienie oszczędza najwięcej czasu przy pracy z importami.
W Pythonie XML czyta się jako strukturę elementów
W Pythonie do podstawowego odczytu i tworzenia XML można użyć modułu xml.etree.ElementTree. Dokumentacja ElementTree pokazuje interfejs do pracy z drzewem elementów, czyli strukturą przypominającą hierarchię folderów: element nadrzędny zawiera swoje elementy potomne.
import xml.etree.ElementTree as ET
root = ET.fromstring("""
Anna Nowak
149.90
""")
klient = root.findtext("klient")
kwota = root.findtext("kwota")
print(klient, kwota)
Wynikiem odczytu są wartości tekstowe, więc cenę trzeba jeszcze przekształcić do typu liczbowego, jeśli program ma na niej wykonywać obliczenia. Przy większym pliku dochodzi też kwestia wydajności: wczytanie całego dokumentu do drzewa może zużyć więcej pamięci niż przetwarzanie go fragmentami.
Jeśli komunikat błędu pojawia się przy fromstring lub parse, zacznij od sprawdzenia składni pliku i kodowania znaków. Jeśli parsowanie się udaje, lecz dane nie pasują do logiki aplikacji, przyczyna może leżeć w nazwach, hierarchii lub wartościach pól, a nie w samym parserze.
XML, JSON i HTML rozwiązują różne problemy
Podobieństwo nawiasów ostrych potrafi zmylić: XML i HTML nie pełnią tej samej funkcji. HTML opisuje elementy strony internetowej według ustalonych reguł, natomiast w XML nazwy elementów dobiera się do opisywanych danych. JSON zapisuje dane w innej składni, często wygodnej przy wymianie informacji między aplikacją a usługą internetową.
| Format | Do czego pasuje | Na co uważać |
|---|---|---|
| XML | Dokumenty i wymianę danych, gdy odbiorca wymaga określonej struktury lub schematu. | Jest bardziej rozbudowany składniowo, a zgodność z wymaganiami może wymagać walidacji. |
| JSON | Wymianę danych między współczesnymi aplikacjami i interfejsami API, jeśli obie strony go obsługują. | Nie zastąpi XML, gdy konkretny system oczekuje pliku XML albo korzysta z jego schematu. |
| HTML | Opisywanie struktury treści wyświetlanej w przeglądarce. | Nie traktuj go jako zamiennego formatu do dowolnego modelowania danych. |
Jeśli odbiorca narzuca format, wybór jest przesądzony. Gdy projektujesz nową wymianę danych i masz wpływ na obie strony, dobierz format do istniejących narzędzi oraz kontraktu, zamiast wybierać XML z przyzwyczajenia. Przy integracji z istniejącym systemem nawet elegantszy zapis nie pomoże, jeśli druga strona go nie rozumie.
Przed edycją pliku sprawdź, kto będzie go czytał
XML przydaje się wtedy, gdy potrzebujesz czytelnej hierarchii danych, a system odbiorczy oczekuje właśnie takiego formatu. Zanim zmienisz plik, ustal, czy obowiązuje dla niego schemat XSD i czy nazwy oraz kolejność pól są częścią umowy z aplikacją. Najpierw zgodność z odbiorcą, potem porządki w znacznikach - ta kolejność chroni przed plikiem, który wygląda lepiej, lecz przestaje działać.
