Table of Contents

Module: users yigg/users.py

Alle Funktionen um Informationen von und ueber Nutzer zu erfahren.

Functions   
_fill_profile
_merge_profile
get_http_profile
get_rest_profile
get_user_news
get_user_news_pages
get_user_votes
get_user_votes_pages
profile
  _fill_profile 
_fill_profile ( user_data )

Takes a dictionary with some user_data and makes a profile out of it

Usage: _fill_profile(user_data) Returns: struktur.Profile()

Diese Funktion wird intern nur von get_http_profile() genutzt, welches veraltet ist.

  _merge_profile 
_merge_profile ( profile1,  profile2 )

Merges two user-profiles

If there are some infos which are different in the two profiles, profile1 wins! This function exists to make an almost complete profile from the infos coming from the rest_profile and from the http_profile

Usage: _merge_profile(profile1, profile2) Returns: struktur.Profile

Wurde intern genutzt, also noch get_http_profile() genutzt wurde...

  get_http_profile 
get_http_profile ( username )

  get_rest_profile 
get_rest_profile ( username,  api_key )

Mit dieser Funktion ist es moeglich das Userprofil eines bestimmten Usersherauszufinden. Die Funktion sollte nicht mehr verwendet werden, man sollte stattdessen profile() verwenden (gleiches Ergebnis).

Aufruf: get_rest_profile(username, api_key) Rueckgabe: struktur.Profile()

Exceptions   
errors.RESTUnknownError
  get_user_news 
get_user_news (
        username,
        api_key,
        page=None,
        )

Gibt die Liste an Stories die ein bestimmter User eingestellt hat zurueck. Diese Liste ist auf mehrere Seiten aufgeteilt.

Der optionale Parameter page (default: erste Seite) ermoeglicht es eine bestimmte Seite aufzurufen oder die komplette Liste zu bekommen (page="ALL").

Aufruf: get_user_news(username, api_key, page=None) Rueckgabe: [int, int, struktur.Article(), struktur.Article()...]

Der erste Integer steht fuer die Anzahl an Seiten die es gibt. Der zweite fuer die aktuelle Seite.

Exceptions   
errors.RESTUnknownError
  get_user_news_pages 
get_user_news_pages ( username,  api_key )

Gibt die Anzahl an Seiten zurueck die es gibt wenn man die Liste mit allen eingereichten Stories eines Users abruft.

Aufruf: get_user_news_pages(username, api_key) Rueckgabe: int

  get_user_votes 
get_user_votes (
        username,
        api_key,
        page=None,
        )

Gibt eine Liste mit Artikeln fuer die der User gevotet hat zurueck.

Da YiGG diese Liste aufsplittet auf mehrere Seiten, gibt es den optionalen Parameter page. Dieser ermoeglicht es eine bestimmte Seite (etwa: page=25) oder alle Seiten: page="ALL" abzurufen. page="ALL" ist weitgehend ungetestet! und kann ausserdem eine extrem lange Liste erzeugen (teilweise bis zu 5000 Elementen oder mehr!)

Aufruf: get_user_votes(username, api_key, page=None) Rueckgabe: [int, int, struktur.Article(), struktur.Article()...]

Der erste int steht hier fuer die Anzahl an Seiten die es gibt. Der zweite fuer die aktuelle Seite.

Exceptions   
errors.RESTUnknownError
  get_user_votes_pages 
get_user_votes_pages ( username,  api_key )

Gibt die Anzahl an Seiten zurueck die es gibt wenn man die Artikel abruft die ein User geyiggt hat.

Aufruf: get_user_votes_pages(username, api_key) Rueckgabe: int

  profile 
profile ( username,  api_key )

Hiermit erhaelt man das Profile eines Users. Diese Funktion sollte statt get_rest_profile() verwendet werden. In Zukunft wird hier der "Code" herwandern und get_rest_profile wird intern profile() aufrufen.

Aufruf: profile(username, api_key) Rueckgabe: struktur.Profile()


Table of Contents

This document was automatically generated on Sun Jun 17 20:22:12 2007 by HappyDoc version 2.1