woob.capabilities.file

class BaseFile(id='', url=NotLoaded, backend=None)

Bases: BaseObject

Represent a file.

Variables:

• url – (str) url

• title – (str) File title

• ext – (str) File extension

• author – (str) File author

• description – (str) File description

• date – (date, datetime) File publication date

• size – (int) File size in bytes (default: Not available)

• rating – (int, float) Rating (default: Not available)

• rating_max – (int, float) Maximum rating (default: Not available)

• license – (str) License name

classmethod id2url(_id)

Overloaded in child classes provided by backends.

property page_url

Get file page URL

class CapFile

Bases: Capability

Provide file download

SEARCH_RELEVANCE = 0

SEARCH_RATING = 1

SEARCH_VIEWS = 2

SEARCH_DATE = 3

search_file(pattern, sortby=SEARCH_RELEVANCE)

Parameters:

• pattern (str) – pattern to search on

• sortby – sort by … (user SEARCH_* constants) (default: SEARCH_RELEVANCE)

Return type:

iter[BaseFile]

get_file(_id)

Get a file from an ID

Parameters:

_id (str) – the file id. I can be a numeric ID, or a page url

Return type:

BaseFile or None if not found.