woob.capabilities.housing

class woob.capabilities.housing.ADVERT_TYPES(*args, **kwargs)

Bases: woob.capabilities.base.Enum

PERSONAL = 'Personal'
PROFESSIONAL = 'Professional'
class woob.capabilities.housing.CapHousing

Bases: woob.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]

class woob.capabilities.housing.City(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

City.

Variables

name – (str) Name of city

class woob.capabilities.housing.ENERGY_CLASS(*args, **kwargs)

Bases: woob.capabilities.base.Enum

A = 'A'
B = 'B'
C = 'C'
D = 'D'
E = 'E'
F = 'F'
G = 'G'
class woob.capabilities.housing.HOUSE_TYPES(*args, **kwargs)

Bases: woob.capabilities.base.Enum

APART = 'Apartment'
HOUSE = 'House'
LAND = 'Land'
OTHER = 'Other'
PARKING = 'Parking'
UNKNOWN = 'Unknown'
class woob.capabilities.housing.Housing(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

Content of a housing.

Variables
  • type – (str) Type of housing (rent, sale, sharing)

  • advert_type – (str) Type of advert (professional or personal)

  • house_type – (str) Type of house (apartment, house, parking, …)

  • title – (str) Title of housing

  • area – (Decimal) Area of housing, in m2

  • cost – (Decimal) Cost of housing

  • price_per_meter – (Decimal) Price per meter ratio

  • currency – (str) Currency of cost

  • utilities – (str) Utilities included or not

  • date – (date, datetime) Date when the housing has been published

  • address – (PostalAddress) Location of housing

  • station – (str) What metro/bus station next to housing

  • text – (str) Text of the housing

  • phone – (str) 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

  • DPE – (str) DPE (Energy Performance Certificate)

  • GES – (str) GES (Greenhouse Gas Emissions)

property location
class woob.capabilities.housing.HousingPhoto(url)

Bases: woob.capabilities.image.BaseImage

Photo of a housing.

Variables

data – (bytes) Data of photo

class woob.capabilities.housing.POSTS_TYPES(*args, **kwargs)

Bases: woob.capabilities.base.Enum

FURNISHED_RENT = 'FURNISHED_RENT'
RENT = 'RENT'
SALE = 'SALE'
SHARING = 'SHARING'
VIAGER = 'VIAGER'
class woob.capabilities.housing.Query(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

Query to find housings.

Variables
  • type – (str) Type of housing to find (POSTS_TYPES constants)

  • cities – (list, tuple) List of cities to search in

  • area_min – (int, int) Minimal area (in m2)

  • area_max – (int, int) Maximal area (in m2)

  • cost_min – (int, int) Minimal cost

  • cost_max – (int, int) Maximal cost

  • nb_rooms – (int, int) Number of rooms

  • house_types – (list, tuple) List of house types (default: [‘Apartment’, ‘House’, ‘Parking’, ‘Land’, ‘Other’, ‘Unknown’])

  • advert_types – (list, tuple) List of advert types to filter on (default: [‘Professional’, ‘Personal’])

exception woob.capabilities.housing.TypeNotSupported(msg='This type of house is not supported by this module')

Bases: woob.capabilities.base.UserError

Raised when query type is not supported

class woob.capabilities.housing.UTILITIES(*args, **kwargs)

Bases: woob.capabilities.base.Enum

EXCLUDED = 'H.C.'
INCLUDED = 'C.C.'
UNKNOWN = ''