scrapy.pipelines.images.ImagesPipeline

class documentation

class ImagesPipeline(FilesPipeline): (source)

View In Hierarchy

Abstract pipeline that implement the image thumbnail generation logic

Class Method from_settings Undocumented
Method __init__ Undocumented
Method convert_image Undocumented
Method file_downloaded Undocumented
Method file_path Returns the path where downloaded media should be stored
Method get_images Undocumented
Method get_media_requests Returns the media requests to download
Method image_downloaded Undocumented
Method item_completed Called per item when all media requests has been processed
Method thumb_path Undocumented
Constant DEFAULT_IMAGES_RESULT_FIELD Undocumented
Constant DEFAULT_IMAGES_URLS_FIELD Undocumented
Constant EXPIRES Undocumented
Constant MEDIA_NAME Undocumented
Constant MIN_HEIGHT Undocumented
Constant MIN_WIDTH Undocumented
Constant THUMBS Undocumented
Instance Variable expires Undocumented
Instance Variable IMAGES_RESULT_FIELD Undocumented
Instance Variable images_result_field Undocumented
Instance Variable IMAGES_URLS_FIELD Undocumented
Instance Variable images_urls_field Undocumented
Instance Variable min_height Undocumented
Instance Variable min_width Undocumented
Instance Variable thumbs Undocumented
Instance Variable _deprecated_convert_image Undocumented
Instance Variable _Image Undocumented

Inherited from FilesPipeline:

Method inc_stats Undocumented
Method media_downloaded Handler for success downloads
Method media_failed Handler for failed downloads
Method media_to_download Check request before starting download
Constant DEFAULT_FILES_RESULT_FIELD Undocumented
Constant DEFAULT_FILES_URLS_FIELD Undocumented
Constant STORE_SCHEMES Undocumented
Instance Variable FILES_RESULT_FIELD Undocumented
Instance Variable files_result_field Undocumented
Instance Variable FILES_URLS_FIELD Undocumented
Instance Variable files_urls_field Undocumented
Instance Variable store Undocumented
Method _get_store Undocumented

Inherited from MediaPipeline (via FilesPipeline):

Class SpiderInfo Undocumented
Class Method from_crawler Undocumented
Method open_spider Undocumented
Method process_item Undocumented
Constant LOG_FAILED_RESULTS Undocumented
Instance Variable allow_redirects Undocumented
Instance Variable download_func Undocumented
Instance Variable handle_httpstatus_list Undocumented
Instance Variable spiderinfo Undocumented
Method _cache_result_and_execute_waiters Undocumented
Method _check_media_to_download Undocumented
Method _check_signature Undocumented
Method _compatible Wrapper for overridable methods to allow backwards compatibility
Method _handle_statuses Undocumented
Method _key_for_pipe >>> MediaPipeline()._key_for_pipe("IMAGES") 'IMAGES' >>> class MyPipe(MediaPipeline): ... pass >>> MyPipe()._key_for_pipe("IMAGES", base_class_name="MediaPipeline") 'MYPIPE_IMAGES'
Method _make_compatible Make overridable methods of MediaPipeline and subclasses backwards compatible
Method _modify_media_request Undocumented
Method _process_request Undocumented
Instance Variable _expects_item Undocumented
@classmethod
def from_settings(cls, settings): (source)
overrides scrapy.pipelines.files.FilesPipeline.from_settings

Undocumented

def __init__(self, store_uri, download_func=None, settings=None): (source)
overrides scrapy.pipelines.files.FilesPipeline.__init__

Undocumented

def convert_image(self, image, size=None, response_body=None): (source)

Undocumented

def file_downloaded(self, response, request, info, *, item=None): (source)
overrides scrapy.pipelines.files.FilesPipeline.file_downloaded

Undocumented

def file_path(self, request, response=None, info=None, *, item=None): (source)
overrides scrapy.pipelines.files.FilesPipeline.file_path

Returns the path where downloaded media should be stored

def get_images(self, response, request, info, *, item=None): (source)

Undocumented

def get_media_requests(self, item, info): (source)
overrides scrapy.pipelines.files.FilesPipeline.get_media_requests

Returns the media requests to download

def image_downloaded(self, response, request, info, *, item=None): (source)

Undocumented

def item_completed(self, results, item, info): (source)
overrides scrapy.pipelines.files.FilesPipeline.item_completed

Called per item when all media requests has been processed

def thumb_path(self, request, thumb_id, response=None, info=None, *, item=None): (source)

Undocumented

DEFAULT_IMAGES_RESULT_FIELD: str = (source)

Undocumented

Value
'images'
DEFAULT_IMAGES_URLS_FIELD: str = (source)

Undocumented

Value
'image_urls'
EXPIRES: int = (source)
overrides scrapy.pipelines.files.FilesPipeline.EXPIRES

Undocumented

Value
90
MEDIA_NAME: str = (source)
overrides scrapy.pipelines.files.FilesPipeline.MEDIA_NAME

Undocumented

Value
'image'
MIN_HEIGHT: int = (source)

Undocumented

Value
0
MIN_WIDTH: int = (source)

Undocumented

Value
0
THUMBS: dict = (source)

Undocumented

Value
{}
expires = (source)
overrides scrapy.pipelines.files.FilesPipeline.expires

Undocumented

IMAGES_RESULT_FIELD = (source)

Undocumented

images_result_field = (source)

Undocumented

IMAGES_URLS_FIELD = (source)

Undocumented

images_urls_field = (source)

Undocumented

min_height = (source)

Undocumented

min_width = (source)

Undocumented

thumbs = (source)

Undocumented

_deprecated_convert_image = (source)

Undocumented

_Image = (source)

Undocumented