Table of Contents

Module: API ../src/API.py

Moduł udostępniający API do tworzenia interfejsów i nie tylko.

Funkcje te umozliwiają wygodne, mam nadzieję, programowanie UI bez potrzeby wchodzenia w niższe warstwy implementacji. Dodanie też tego poziomu abstrakcji umożliwia też zmiany poniżej bez wprowadzania wielu zmian w innych miejscach, a jedynie raz w API.

Imported modules   
import KXML
import TMPL
import copy
import druk
import misc
import os
import os.path
import weryfikacja
import wlasciwosci
Functions   
atrybut
dla_wszystkich_dokumentow
dodaj_dokument
dodaj_sekcje
drukuj_dokument
lista_dokumentow
lista_dostepnych_typow
lista_firm
lista_podzestawow
lista_pol
lista_sekcji
lista_zestawow
nazwa
nazwa_zestawu
nowy_dokument
nowy_platnik
nowy_zestaw
poziom_wyzej
przygotuj_znajdz
typ_dokumentu
usun_sekcje
wartosc_pola
weryfikuj
wylicz_automatycznie
zapisz_dokument
zmien_wartosc_pola
znajdz
  atrybut 
atrybut (
        typ_dokum,
        nazwa_pola_lub_sekcji,
        nazwa_atrybutu,
        )

Funkcja zwracająca wartość atrybutu pola lub sekcji.

Pola i sekcje posiadają swoje atrybuty, które są niezależne od danych w nich zawartych - są wspólne dla wszystkich dokumentów danego typu. Może być to np. opis pola czy sekcji, długość pola, oznacznie czy dana sekcja jest wielokrotna.

  dla_wszystkich_dokumentow 
dla_wszystkich_dokumentow ( zestaw,  funkcja )

Wykonanie podanaj funkcji dla wszystkich dokumentów w zestawie.

  dodaj_dokument 
dodaj_dokument ( dokument,  zestaw )

Funkcja dodająca nowy dokument do zestawu.

  dodaj_sekcje 
dodaj_sekcje ( dokument,  sekcja )

Funkcja wstawiająca kopie podanej sekcji do dokumentu.

Dla dokumentów w których występują sekcje wielokrotne, zachodzi czasami potrzeba dodania kolejnej takiej sekcji. Funkcja ta kopiuje podaną sekcje wielokrotną i wstawia ja na koniec listy takich sekcji w dokumencie. Zwracany jest też odnosnik do nowo utworzonej sekcji.

  drukuj_dokument 
drukuj_dokument ( dokument,  plik )

Funkcja drukująca dokument do pliku.

Podany dokument jest drukowany do plików o podanej nazwie, z dodanym numerem strony i rozszezeniem. Zwracana jest liczba wydrukowanych stron - stworzonych plików.

  lista_dokumentow 
lista_dokumentow ( zestaw,  podzestaw )

Funkcja zwracająca listę dokumentów w danym podzestawie.

Po szczegółowe informację o podzestawach zobacz lista_podzestawow()

  lista_dostepnych_typow 
lista_dostepnych_typow ()

Fukcja zwracająca listę dostępnych typów.

Lista dostępnych typów dokumentów ZUS, czyli takich dla których istnieje plik tmpl.

  lista_firm 
lista_firm ()

Funkcja zwracająca listę płatników.

  lista_podzestawow 
lista_podzestawow ( zestaw,  podzestaw )

Funkcja zwracająca listę podzestawów.

Dokumenty w zestawie są umieszczone w swego rodzaju drzewie, którego korzeniem jest zestaw, liśćmi dokumenty, a węzłami wewnętrznymi podzestawy. Aby uzyskać listę podzestawów wywodzących się z zestawu, należy jako argumenty podać zestaw i '' (pusty łańcuch). Aby uzyskać podzestwy poniżej, należy jako argumenty podać zestaw i uzyskany za pomocą tej funkcji podzestaw. W tym momencie zestaw dzieli sie na dokumenty zgłoszeniowe płatnika, zgłoszeniowe ubezpieczonego i rozliczeniowe. Zaś te ostatnie dzielą się według miesiąca utworzenia.

  lista_pol 
lista_pol ( sekcja )

Funkcja zwracająca listę pól z sekcji.

  lista_sekcji 
lista_sekcji ( dokument )

Funkcja zwracająca listę sekcji z dokumentu.

Sekcja jest to logiczna grupa pól z dokumentów ZUS. Może ona grupować pola odnoszące się np. do danych płatnika, danych ubezpieczonego, itp. Z wyjątkiem sekcji wielokrotnych, wszystkie sekcje występują tylko jeden raz w dokumencie.

  lista_zestawow 
lista_zestawow ( platnik )

Funkcja zwracaące listę zestawów dla podanego płatnika.

  nazwa 
nazwa ( pole_lub_sekcja )

Funkcja zwracająca nazwę pola lub sekcji.

Nazwa ta może być przydatna chociażby do pobrania wartości atrybutu.

  nazwa_zestawu 
nazwa_zestawu ( zestaw )

Funckja zwracająca nazwę podanego zestawu.

  nowy_dokument 
nowy_dokument ( typ )

Stworzenie nowego dokumentu ZUS.

Funkcja tworząca nowy dokument na podstawie podanego typu. Typ można uzyskać albo wybierając jeden z dostępnych przy pomocy funkcji lista_dostepnych_typow() albo np. pobierając typ istniejącego dokumentu za pomocą funcji typ_dokumentu().

  nowy_platnik 
nowy_platnik ( dokument )

Funkcja tworząca nowego płatnika.

Nowy płatnik tworzoy jest na postawie wypełnionego dokumentu opisującego nowego płatnika. Dokumentem tego typu jest np. platnik_fizyczna.tmpl.

  nowy_zestaw 
nowy_zestaw ( nazwa,  platnik )

Funkcja tworząca nowy zestaw dokumantów.

Dla podanego płatnika tworzony jest nowy zestaw dokumentów o podanej nazwie.

  poziom_wyzej 
poziom_wyzej ( podzestaw )

Funkcja zwracająca podzestaw będący rodzicem danego podzestawu.

Po szczegółowe informację o podzestawach zobacz lista_podzestawow()

  przygotuj_znajdz 
przygotuj_znajdz ( dokument )

Funkcja przygotowująca słownik, umożliwiający szybkie wyszukiwanie.

W celu wyszukania pola o danej nazwie można przejrzeć listę pól danego dokumentu. Jeżeli jednak operacja ta ma być powtórzona kilka razy, bardziej opłaca się stworzyś specjalną strukturę umożliwiającą szybkie wyszukanie pola. Funkcja ta tworzy i zwraca taki słownik, który powinien byc podany jako argument do funkcji znajdz().

  typ_dokumentu 
typ_dokumentu ( dokument )

Funkcja zwracająca typ dokumentu.

  usun_sekcje 
usun_sekcje ( dokument,  sekcja )

Funkcja usuwająca sekcje z dokumentu.

Dla dokumentów w których występują sekcje wielokrotne, zachodzi czasami potrzeba usunięcia takiej sekcji. Funkcja ta usuwa podaną sekcje wielokrotną i jeżeli była to ostatnia sekcja tego typu, to wstawiana jest nowa sekcja i zwracany odnośnik do niej. W przeciwnym wypadku zwracany jest None.

  wartosc_pola 
wartosc_pola ( pole )

Funkcja zwracająca wartość podanego pola.

  weryfikuj 
weryfikuj ( dokument )

Exceptions   
NotImplementedError()
  wylicz_automatycznie 
wylicz_automatycznie ( dokument )

Exceptions   
NotImplementedError()
  zapisz_dokument 
zapisz_dokument ( dokument )

Funkcja zapisująca zmieniony dokument do zestawu.

  zmien_wartosc_pola 
zmien_wartosc_pola ( pole,  wartosc )

Funkcja zmieniająca wartość podanego pola.

  znajdz 
znajdz ( slownik,  nazwa )

Funkcja zwracająca listę pól o podanej nazwie.

W celu wyszukania pola o danej nazwie można przejrzeć listę pól danego dokumentu. Jeżeli jednak operacja ta ma być powtórzona kilka razy, bardziej opłaca się stworzyś specjalną strukturę umożliwiającą szybkie wyszukanie pola. Strukturą tą jest słownik zwracany przez funkcję przygotuj_znajdz(). Ta funkcja na postawie tego słownika i nazwy pliku zwraca listę pól. Listę, a nie pojedyncze pole, ponieważ dla dokumentów w którym pojawia się sekcja wielokrotna, pola z tej sekcji mogą się powtarzać.


Table of Contents

This document was automatically generated on Mon Jun 23 21:14:40 2003 by HappyDoc version 2.1