weboob.capabilities.housing

class weboob.capabilities.housing.HousingPhoto(url)

Bases: weboob.capabilities.base.BaseObject

Photo of a housing.
Variables:data – (str) Data of photo
class weboob.capabilities.housing.Housing(id=u'', url=NotLoaded, backend=None)

Bases: weboob.capabilities.base.BaseObject

Content of a housing.
Variables:
  • title – (unicode) Title of housing
  • area – (Decimal) Area of housing, in m2
  • cost – (Decimal) Cost of housing
  • price_per_meter – (Decimal) Price per meter ratio
  • currency – (unicode) Currency of cost
  • utilities – (unicode, unicode, unicode) Utilities included or not
  • date – (date, datetime) Date when the housing has been published
  • location – (unicode) Location of housing
  • station – (unicode) What metro/bus station next to housing
  • text – (unicode) Text of the housing
  • phone – (unicode) Phone number to contact
  • photos – (list) List of photos
  • rooms – (Decimal) Number of rooms
  • bedrooms – (Decimal) Number of bedrooms
  • details – (dict) Key/values of details
class weboob.capabilities.housing.Query(id=u'', url=NotLoaded, backend=None)

Bases: weboob.capabilities.base.BaseObject

Query to find housings.
Variables:
  • type – (int, long) Type of housing to find (TYPE_* constants)
  • cities – (list, tuple) List of cities to search in
  • area_min – (int, long) Minimal area (in m2)
  • area_max – (int, long) Maximal area (in m2)
  • cost_min – (int, long) Minimal cost
  • cost_max – (int, long) Maximal cost
  • nb_rooms – (int, long) Number of rooms
  • house_types – (list, tuple) List of house types (default: [u’Land’, u’House’, u’Unknown’, u’Other’, u’Parking’, u’Apartment’])
HOUSE_TYPES

alias of Enum

TYPE_RENT = 0
TYPE_SALE = 1
TYPE_SHARING = 2
class weboob.capabilities.housing.City(id=u'', url=NotLoaded, backend=None)

Bases: weboob.capabilities.base.BaseObject

City.
Variables:name – (unicode) Name of city
class weboob.capabilities.housing.CapHousing

Bases: weboob.capabilities.base.Capability

Capability of websites to search housings.

get_housing(housing)

Get an housing from an ID.

Parameters:housing (str) – ID of the housing
Return type:Housing or None if not found.
search_city(pattern)

Search a city from a pattern.

Parameters:pattern (str) – pattern to search
Return type:iter[City]
search_housings(query)

Search housings.

Parameters:query (Query) – search query
Return type:iter[Housing]
weboob.capabilities.housing.UTILITIES

alias of Enum