Datasets:

claudios

/

dypybench_functions

like 1

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/task.py

Task.__lt__

(self, other: Task)

return self.priority < other.priority

def __lt__(self, other: Task) -> bool: if self.priority is None or other.priority is None: return False return self.priority < other.priority

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/task.py#L179-L182

def __lt__(self, other: Task) -> bool: if self.priority is None or other.priority is None: return False return self.priority < other.priority

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/task.py

Task.__eq__

(self, other: object)

return self.priority == other.priority

def __eq__(self, other: object) -> bool: if not isinstance(other, Task): return NotImplemented if not self.priority or not other.priority: # WTF??? return True return self.priority == other.priority

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/task.py#L184-L190

def __eq__(self, other: object) -> bool: if not isinstance(other, Task): return NotImplemented if not self.priority or not other.priority: # WTF??? return True return self.priority == other.priority

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.__init__

( self, task_queue: None | BaseTaskQueue = None, thread_number: None | int = None, network_try_limit: None | int = None, task_try_limit: None | int = None, priority_mode: str = "random", meta: None | dict[str, Any] = None, config: None | dict[str, Any] = None, parser_requests_per_process: int = 10000, parser_pool_size: int = 1, network_service: None | BaseNetworkService = None, grab_transport: None | BaseTransport[HttpRequest, Document] | type[BaseTransport[HttpRequest, Document]] = None, )

Create Spider instance, duh. Arguments: * thread-number - Number of concurrent network streams * network_try_limit - How many times try to send request again if network error was occurred, use 0 to disable * task_try_limit - Limit of tries to execute some task this is not the same as network_try_limit network try limit limits the number of tries which are performed automatically in case of network timeout of some other physical error but task_try_limit limits the number of attempts which are scheduled manually in the spider business logic * priority_mode - could be "random" or "const" * meta - arbitrary user data

Create Spider instance, duh.

def __init__( self, task_queue: None | BaseTaskQueue = None, thread_number: None | int = None, network_try_limit: None | int = None, task_try_limit: None | int = None, priority_mode: str = "random", meta: None | dict[str, Any] = None, config: None | dict[str, Any] = None, parser_requests_per_process: int = 10000, parser_pool_size: int = 1, network_service: None | BaseNetworkService = None, grab_transport: None | BaseTransport[HttpRequest, Document] | type[BaseTransport[HttpRequest, Document]] = None, ) -> None: """Create Spider instance, duh. Arguments: * thread-number - Number of concurrent network streams * network_try_limit - How many times try to send request again if network error was occurred, use 0 to disable * task_try_limit - Limit of tries to execute some task this is not the same as network_try_limit network try limit limits the number of tries which are performed automatically in case of network timeout of some other physical error but task_try_limit limits the number of attempts which are scheduled manually in the spider business logic * priority_mode - could be "random" or "const" * meta - arbitrary user data """ self.fatal_error_queue: Queue[FatalErrorQueueItem] = Queue() self._started: None | float = None self.grab_transport = grab_transport self.parser_requests_per_process = parser_requests_per_process self.stat = Stat() self.runtime_events: dict[str, list[None | str]] = {} self.task_queue: BaseTaskQueue = task_queue if task_queue else MemoryTaskQueue() if config is not None: self.config = config else: self.config = {} if meta: self.meta = meta else: self.meta = {} self.thread_number = thread_number or int( self.config.get("thread_number", DEFAULT_NETWORK_STREAM_NUMBER) ) self.task_try_limit = task_try_limit or int( self.config.get("task_try_limit", DEFAULT_TASK_TRY_LIMIT) ) self.network_try_limit = network_try_limit or int( self.config.get("network_try_limit", DEFAULT_NETWORK_TRY_LIMIT) ) if priority_mode not in ["random", "const"]: raise SpiderMisuseError( 'Value of priority_mode option should be "random" or "const"' ) self.priority_mode = priority_mode self.work_allowed = True self.proxylist_enabled: None | bool = None self.proxylist: None | ProxyList = None self.proxy: None | ProxyServer = None self.proxy_auto_change = False self.parser_pool_size = parser_pool_size assert network_service is None or isinstance( network_service, BaseNetworkService ) self.network_service = ( network_service if network_service is not None else NetworkServiceThreaded( self.fatal_error_queue, self.thread_number, process_task=self.srv_process_task, get_task_from_queue=self.get_task_from_queue, ) ) self.task_dispatcher = TaskDispatcherService( self.fatal_error_queue, process_service_result=self.srv_process_service_result, ) self.parser_service = ParserService( fatal_error_queue=self.fatal_error_queue, pool_size=self.parser_pool_size, task_dispatcher=self.task_dispatcher, stat=self.stat, parser_requests_per_process=self.parser_requests_per_process, find_task_handler=self.find_task_handler, ) self.task_generator_service = TaskGeneratorService( self.fatal_error_queue, self.task_generator(), thread_number=self.thread_number, get_task_queue=self.get_task_queue, parser_service=self.parser_service, task_dispatcher=self.task_dispatcher, )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L72-L171

def __init__( self, task_queue: None | BaseTaskQueue = None, thread_number: None | int = None, network_try_limit: None | int = None, task_try_limit: None | int = None, priority_mode: str = "random", meta: None | dict[str, Any] = None, config: None | dict[str, Any] = None, parser_requests_per_process: int = 10000, parser_pool_size: int = 1, network_service: None | BaseNetworkService = None, grab_transport: None | BaseTransport[HttpRequest, Document] | type[BaseTransport[HttpRequest, Document]] = None, ) -> None: self.fatal_error_queue: Queue[FatalErrorQueueItem] = Queue() self._started: None | float = None self.grab_transport = grab_transport self.parser_requests_per_process = parser_requests_per_process self.stat = Stat() self.runtime_events: dict[str, list[None | str]] = {} self.task_queue: BaseTaskQueue = task_queue if task_queue else MemoryTaskQueue() if config is not None: self.config = config else: self.config = {} if meta: self.meta = meta else: self.meta = {} self.thread_number = thread_number or int( self.config.get("thread_number", DEFAULT_NETWORK_STREAM_NUMBER) ) self.task_try_limit = task_try_limit or int( self.config.get("task_try_limit", DEFAULT_TASK_TRY_LIMIT) ) self.network_try_limit = network_try_limit or int( self.config.get("network_try_limit", DEFAULT_NETWORK_TRY_LIMIT) ) if priority_mode not in ["random", "const"]: raise SpiderMisuseError( 'Value of priority_mode option should be "random" or "const"' ) self.priority_mode = priority_mode self.work_allowed = True self.proxylist_enabled: None | bool = None self.proxylist: None | ProxyList = None self.proxy: None | ProxyServer = None self.proxy_auto_change = False self.parser_pool_size = parser_pool_size assert network_service is None or isinstance( network_service, BaseNetworkService ) self.network_service = ( network_service if network_service is not None else NetworkServiceThreaded( self.fatal_error_queue, self.thread_number, process_task=self.srv_process_task, get_task_from_queue=self.get_task_from_queue, ) ) self.task_dispatcher = TaskDispatcherService( self.fatal_error_queue, process_service_result=self.srv_process_service_result, ) self.parser_service = ParserService( fatal_error_queue=self.fatal_error_queue, pool_size=self.parser_pool_size, task_dispatcher=self.task_dispatcher, stat=self.stat, parser_requests_per_process=self.parser_requests_per_process, find_task_handler=self.find_task_handler, ) self.task_generator_service = TaskGeneratorService( self.fatal_error_queue, self.task_generator(), thread_number=self.thread_number, get_task_queue=self.get_task_queue, parser_service=self.parser_service, task_dispatcher=self.task_dispatcher, )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.collect_runtime_event

(self, name: str, value: None | str)

def collect_runtime_event(self, name: str, value: None | str) -> None: self.runtime_events.setdefault(name, []).append(value)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L173-L174

def collect_runtime_event(self, name: str, value: None | str) -> None: self.runtime_events.setdefault(name, []).append(value)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.setup_queue

(self, *_args: Any, **_kwargs: Any)

Set up queue.

Set up queue.

def setup_queue(self, *_args: Any, **_kwargs: Any) -> None: """Set up queue.""" raise GrabFeatureIsDeprecated( """Method Spider.setup_queue is deprecated. Now MemoryTaskQueue is used by default. If you need custom task queue pass instance of queue class in task_queue parameter in constructor of Spider class.""" )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L178-L184

def setup_queue(self, *_args: Any, **_kwargs: Any) -> None: raise GrabFeatureIsDeprecated( )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.add_task

( self, task: Task, queue: None | BaseTaskQueue = None, raise_error: bool = False, )

return True

Add task to the task queue.

Add task to the task queue.

def add_task( self, task: Task, queue: None | BaseTaskQueue = None, raise_error: bool = False, ) -> bool: """Add task to the task queue.""" if queue is None: queue = self.task_queue if task.priority is None or not task.priority_set_explicitly: task.priority = self.generate_task_priority() task.priority_set_explicitly = False else: task.priority_set_explicitly = True if not task.request.url or not task.request.url.startswith( ("http://", "https://", "ftp://", "file://", "feed://") ): self.collect_runtime_event("task-with-invalid-url", task.request.url) msg = "Invalid task URL: %s" % task.request.url if raise_error: raise SpiderError(msg) logger.error( "%s\nTraceback:\n%s", msg, "".join(format_stack()), ) return False # TODO: keep original task priority if it was set explicitly # WTF the previous comment means? queue.put(task, priority=task.priority, schedule_time=task.schedule_time) return True

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L186-L217

def add_task( self, task: Task, queue: None | BaseTaskQueue = None, raise_error: bool = False, ) -> bool: if queue is None: queue = self.task_queue if task.priority is None or not task.priority_set_explicitly: task.priority = self.generate_task_priority() task.priority_set_explicitly = False else: task.priority_set_explicitly = True if not task.request.url or not task.request.url.startswith( ("http://", "https://", "ftp://", "file://", "feed://") ): self.collect_runtime_event("task-with-invalid-url", task.request.url) msg = "Invalid task URL: %s" % task.request.url if raise_error: raise SpiderError(msg) logger.error( "%s\nTraceback:\n%s", msg, "".join(format_stack()), ) return False # TODO: keep original task priority if it was set explicitly # WTF the previous comment means? queue.put(task, priority=task.priority, schedule_time=task.schedule_time) return True

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.stop

(self)

Instruct spider to stop processing new tasks and start shutting down.

Instruct spider to stop processing new tasks and start shutting down.

def stop(self) -> None: """Instruct spider to stop processing new tasks and start shutting down.""" self.work_allowed = False

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L219-L221

def stop(self) -> None: self.work_allowed = False

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.load_proxylist

( self, source: str | BaseProxySource, source_type: None | str = None, proxy_type: str = "http", auto_init: bool = True, auto_change: bool = True, )

Load proxy list. :param source: Proxy source. Accepts string (file path, url) or ``BaseProxySource`` instance. :param source_type: The type of the specified source. Should be one of the following: 'text_file' or 'url'. :param proxy_type: Should be one of the following: 'socks4', 'socks5' or'http'. :param auto_change: If set to `True` then automatically random proxy rotation will be used. Proxy source format should be one of the following (for each line): - ip:port - ip:port:login:password

Load proxy list.

def load_proxylist( self, source: str | BaseProxySource, source_type: None | str = None, proxy_type: str = "http", auto_init: bool = True, auto_change: bool = True, ) -> None: """Load proxy list. :param source: Proxy source. Accepts string (file path, url) or ``BaseProxySource`` instance. :param source_type: The type of the specified source. Should be one of the following: 'text_file' or 'url'. :param proxy_type: Should be one of the following: 'socks4', 'socks5' or'http'. :param auto_change: If set to `True` then automatically random proxy rotation will be used. Proxy source format should be one of the following (for each line): - ip:port - ip:port:login:password """ if isinstance(source, BaseProxySource): self.proxylist = ProxyList(source) elif isinstance(source, str): if source_type == "text_file": self.proxylist = ProxyList.from_local_file( source, proxy_type=proxy_type ) elif source_type == "url": self.proxylist = ProxyList.from_network_file( source, proxy_type=proxy_type ) else: raise SpiderMisuseError( "Method `load_proxylist` received " "invalid `source_type` argument: %s" % source_type ) else: raise SpiderMisuseError( "Method `load_proxylist` received " "invalid `source` argument: %s" % source ) self.proxylist_enabled = True self.proxy = None if not auto_change and auto_init: self.proxy = self.proxylist.get_random_server() if not self.proxy.proxy_type: raise GrabMisuseError("Could not use proxy without defined proxy type") self.proxy_auto_change = auto_change

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L223-L275

def load_proxylist( self, source: str | BaseProxySource, source_type: None | str = None, proxy_type: str = "http", auto_init: bool = True, auto_change: bool = True, ) -> None: if isinstance(source, BaseProxySource): self.proxylist = ProxyList(source) elif isinstance(source, str): if source_type == "text_file": self.proxylist = ProxyList.from_local_file( source, proxy_type=proxy_type ) elif source_type == "url": self.proxylist = ProxyList.from_network_file( source, proxy_type=proxy_type ) else: raise SpiderMisuseError( "Method `load_proxylist` received " "invalid `source_type` argument: %s" % source_type ) else: raise SpiderMisuseError( "Method `load_proxylist` received " "invalid `source` argument: %s" % source ) self.proxylist_enabled = True self.proxy = None if not auto_change and auto_init: self.proxy = self.proxylist.get_random_server() if not self.proxy.proxy_type: raise GrabMisuseError("Could not use proxy without defined proxy type") self.proxy_auto_change = auto_change

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.render_stats

(self)

return "\n".join(out) + "\n"

def render_stats(self) -> str: out = [ "------------ Stats: ------------", "Counters:", ] # Process counters items = sorted(self.stat.counters.items(), key=lambda x: x[0], reverse=True) for item in items: out.append(" %s: %s" % item) out.append("") out.append("Lists:") # Process event lists sorted by size in descendant order col_sizes = [(x, len(y)) for x, y in self.runtime_events.items()] col_sizes = sorted(col_sizes, key=lambda x: x[1], reverse=True) for col_size in col_sizes: out.append(" %s: %d" % col_size) out.append("") # Process extra metrics if "download-size" in self.stat.counters: out.append( "Network download: %s" % format_traffic_value(self.stat.counters["download-size"]) ) out.append( "Queue size: %d" % self.task_queue.size() if self.task_queue else "NA" ) out.append("Network streams: %d" % self.thread_number) elapsed = (time.time() - self._started) if self._started else 0 hours, seconds = divmod(elapsed, 3600) minutes, seconds = divmod(seconds, 60) out.append("Time elapsed: %d:%d:%d (H:M:S)" % (hours, minutes, seconds)) out.append( "End time: %s" % datetime.utcnow().strftime("%d %b %Y, %H:%M:%S UTC") ) return "\n".join(out) + "\n"

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L277-L314

def render_stats(self) -> str: out = [ "------------ Stats: ------------", "Counters:", ] # Process counters items = sorted(self.stat.counters.items(), key=lambda x: x[0], reverse=True) for item in items: out.append(" %s: %s" % item) out.append("") out.append("Lists:") # Process event lists sorted by size in descendant order col_sizes = [(x, len(y)) for x, y in self.runtime_events.items()] col_sizes = sorted(col_sizes, key=lambda x: x[1], reverse=True) for col_size in col_sizes: out.append(" %s: %d" % col_size) out.append("") # Process extra metrics if "download-size" in self.stat.counters: out.append( "Network download: %s" % format_traffic_value(self.stat.counters["download-size"]) ) out.append( "Queue size: %d" % self.task_queue.size() if self.task_queue else "NA" ) out.append("Network streams: %d" % self.thread_number) elapsed = (time.time() - self._started) if self._started else 0 hours, seconds = divmod(elapsed, 3600) minutes, seconds = divmod(seconds, 60) out.append("Time elapsed: %d:%d:%d (H:M:S)" % (hours, minutes, seconds)) out.append( "End time: %s" % datetime.utcnow().strftime("%d %b %Y, %H:%M:%S UTC") ) return "\n".join(out) + "\n"

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.prepare

(self)

Do additional spider customization here. This method runs before spider has started working.

Do additional spider customization here.

def prepare(self) -> None: """Do additional spider customization here. This method runs before spider has started working. """

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L320-L324

def prepare(self) -> None:

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.shutdown

(self)

Override this method to do some final actions after parsing has been done.

Override this method to do some final actions after parsing has been done.

def shutdown(self) -> None: """Override this method to do some final actions after parsing has been done."""

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L326-L327

def shutdown(self) -> None:

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.create_grab_instance

(self, **kwargs: Any)

return Grab(transport=self.grab_transport, **kwargs)

def create_grab_instance(self, **kwargs: Any) -> Grab: return Grab(transport=self.grab_transport, **kwargs)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L329-L330

def create_grab_instance(self, **kwargs: Any) -> Grab: return Grab(transport=self.grab_transport, **kwargs)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.task_generator

(self)

You can override this method to load new tasks. It will be used each time as number of tasks in task queue is less then number of threads multiplied on 2 This allows you to not overload all free memory if total number of tasks is big.

You can override this method to load new tasks.

def task_generator(self) -> Iterator[Task]: """You can override this method to load new tasks. It will be used each time as number of tasks in task queue is less then number of threads multiplied on 2 This allows you to not overload all free memory if total number of tasks is big. """ yield from ()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L332-L340

def task_generator(self) -> Iterator[Task]: yield from ()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.check_task_limits

(self, task: Task)

return True, "ok"

Check that task's network & try counters do not exceed limits. Returns: * if success: (True, None) * if error: (False, reason)

Check that task's network & try counters do not exceed limits.

def check_task_limits(self, task: Task) -> tuple[bool, str]: """Check that task's network & try counters do not exceed limits. Returns: * if success: (True, None) * if error: (False, reason) """ if task.task_try_count > self.task_try_limit: return False, "task-try-count" if task.network_try_count > self.network_try_limit: return False, "network-try-count" return True, "ok"

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L346-L360

def check_task_limits(self, task: Task) -> tuple[bool, str]: if task.task_try_count > self.task_try_limit: return False, "task-try-count" if task.network_try_count > self.network_try_limit: return False, "network-try-count" return True, "ok"

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.generate_task_priority

(self)

return system_random.randint(*RANDOM_TASK_PRIORITY_RANGE)

def generate_task_priority(self) -> int: if self.priority_mode == "const": return DEFAULT_TASK_PRIORITY return system_random.randint(*RANDOM_TASK_PRIORITY_RANGE)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L362-L365

def generate_task_priority(self) -> int: if self.priority_mode == "const": return DEFAULT_TASK_PRIORITY return system_random.randint(*RANDOM_TASK_PRIORITY_RANGE)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.process_initial_urls

(self)

def process_initial_urls(self) -> None: if self.initial_urls: for url in self.initial_urls: self.add_task(Task(name="initial", request=HttpRequest(url)))

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L367-L370

def process_initial_urls(self) -> None: if self.initial_urls: for url in self.initial_urls: self.add_task(Task(name="initial", request=HttpRequest(url)))

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.get_task_from_queue

(self)

def get_task_from_queue(self) -> None | Literal[True] | Task: try: return self.task_queue.get() except Empty: size = self.task_queue.size() if size: return True return None

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L372-L379

def get_task_from_queue(self) -> None | Literal[True] | Task: try: return self.task_queue.get() except Empty: size = self.task_queue.size() if size: return True return None

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.is_valid_network_response_code

(self, code: int, task: Task)

return code < 400 or code == 404 or code in task.valid_status

Test if response is valid. Valid response is handled with associated task handler. Failed respoosne is processed with error handler.

Test if response is valid.

def is_valid_network_response_code(self, code: int, task: Task) -> bool: """Test if response is valid. Valid response is handled with associated task handler. Failed respoosne is processed with error handler. """ return code < 400 or code == 404 or code in task.valid_status

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L381-L387

def is_valid_network_response_code(self, code: int, task: Task) -> bool: return code < 400 or code == 404 or code in task.valid_status

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.process_parser_error

( self, func_name: str, task: Task, exc_info: tuple[type[Exception], Exception, TracebackType], )

def process_parser_error( self, func_name: str, task: Task, exc_info: tuple[type[Exception], Exception, TracebackType], ) -> None: _, ex, _ = exc_info self.stat.inc("spider:error-%s" % ex.__class__.__name__.lower()) logger.error( "Task handler [%s] error\n%s", func_name, "".join(format_exception(*exc_info)), ) task_url = task.request.url if task else None self.collect_runtime_event( "fatal", "%s|%s|%s|%s" % (func_name, ex.__class__.__name__, str(ex), task_url), )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L389-L408

def process_parser_error( self, func_name: str, task: Task, exc_info: tuple[type[Exception], Exception, TracebackType], ) -> None: _, ex, _ = exc_info self.stat.inc("spider:error-%s" % ex.__class__.__name__.lower()) logger.error( "Task handler [%s] error\n%s", func_name, "".join(format_exception(*exc_info)), ) task_url = task.request.url if task else None self.collect_runtime_event( "fatal", "%s|%s|%s|%s" % (func_name, ex.__class__.__name__, str(ex), task_url), )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.find_task_handler

(self, task: Task)

def find_task_handler(self, task: Task) -> Callable[..., Any]: callback = task.get("callback") if callback: # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], callback) # pylint: enable=deprecated-typing-alias try: # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], getattr(self, "task_%s" % task.name)) # pylint: enable=deprecated-typing-alias except AttributeError as ex: raise NoTaskHandler( "No handler or callback defined for " "task %s" % task.name ) from ex

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L410-L423

def find_task_handler(self, task: Task) -> Callable[..., Any]: callback = task.get("callback") if callback: # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], callback) # pylint: enable=deprecated-typing-alias try: # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], getattr(self, "task_%s" % task.name)) # pylint: enable=deprecated-typing-alias except AttributeError as ex: raise NoTaskHandler( "No handler or callback defined for " "task %s" % task.name ) from ex

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.log_network_result_stats

(self, res: NetworkResult, task: Task)

def log_network_result_stats(self, res: NetworkResult, task: Task) -> None: # Increase stat counters self.stat.inc("spider:request-processed") self.stat.inc("spider:task") self.stat.inc("spider:task-%s" % task.name) if task.network_try_count == 1 and task.task_try_count == 1: self.stat.inc("spider:task-%s-initial" % task.name) # Update traffic statistics if res["grab"] and res["doc"]: doc = res["doc"] self.stat.inc("spider:download-size", doc.download_size) self.stat.inc("spider:upload-size", doc.upload_size)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L425-L437

def log_network_result_stats(self, res: NetworkResult, task: Task) -> None: # Increase stat counters self.stat.inc("spider:request-processed") self.stat.inc("spider:task") self.stat.inc("spider:task-%s" % task.name) if task.network_try_count == 1 and task.task_try_count == 1: self.stat.inc("spider:task-%s-initial" % task.name) # Update traffic statistics if res["grab"] and res["doc"]: doc = res["doc"] self.stat.inc("spider:download-size", doc.download_size) self.stat.inc("spider:upload-size", doc.upload_size)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.process_grab_proxy

(self, task: Task, grab: Grab)

Assign new proxy from proxylist to the task.

Assign new proxy from proxylist to the task.

def process_grab_proxy(self, task: Task, grab: Grab) -> None: """Assign new proxy from proxylist to the task.""" if task.use_proxylist and self.proxylist_enabled: if self.proxy_auto_change: self.change_active_proxy(task, grab) if self.proxy: raise Exception("Look like it is not called from tests")

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L439-L445

def process_grab_proxy(self, task: Task, grab: Grab) -> None: if task.use_proxylist and self.proxylist_enabled: if self.proxy_auto_change: self.change_active_proxy(task, grab) if self.proxy: raise Exception("Look like it is not called from tests")

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.change_active_proxy

(self, task: Task, grab: Grab)

def change_active_proxy(self, task: Task, grab: Grab) -> None: # pylint: disable=unused-argument self.proxy = cast(ProxyList, self.proxylist).get_random_server() if not self.proxy.proxy_type: raise SpiderMisuseError( 'Value of priority_mode option should be "random" or "const"' )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L452-L458

def change_active_proxy(self, task: Task, grab: Grab) -> None: # pylint: disable=unused-argument self.proxy = cast(ProxyList, self.proxylist).get_random_server() if not self.proxy.proxy_type: raise SpiderMisuseError( 'Value of priority_mode option should be "random" or "const"' )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.get_task_queue

(self)

return self.task_queue

def get_task_queue(self) -> BaseTaskQueue: # this method is expected to be called # after "spider.run()" is called # i.e. the "self.task_queue" is set return self.task_queue

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L460-L464

def get_task_queue(self) -> BaseTaskQueue: # this method is expected to be called # after "spider.run()" is called # i.e. the "self.task_queue" is set return self.task_queue

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.is_idle_estimated

(self)

return ( not self.task_generator_service.is_alive() and not self.task_queue.size() and not self.task_dispatcher.input_queue.qsize() and not self.parser_service.input_queue.qsize() and not self.parser_service.is_busy() and not self.network_service.get_active_threads_number() and not self.network_service.is_busy() )

def is_idle_estimated(self) -> bool: return ( not self.task_generator_service.is_alive() and not self.task_queue.size() and not self.task_dispatcher.input_queue.qsize() and not self.parser_service.input_queue.qsize() and not self.parser_service.is_busy() and not self.network_service.get_active_threads_number() and not self.network_service.is_busy() )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L466-L475

def is_idle_estimated(self) -> bool: return ( not self.task_generator_service.is_alive() and not self.task_queue.size() and not self.task_dispatcher.input_queue.qsize() and not self.parser_service.input_queue.qsize() and not self.parser_service.is_busy() and not self.network_service.get_active_threads_number() and not self.network_service.is_busy() )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.is_idle_confirmed

(self, services: list[BaseService])

return False

Test if spider is fully idle. WARNING: As side effect it stops all services to get state of queues anaffected by sercies. Spider is full idle when all conditions are met: * all services are paused i.e. the do not change queues * all queues are empty * task generator is completed

Test if spider is fully idle.

def is_idle_confirmed(self, services: list[BaseService]) -> bool: """Test if spider is fully idle. WARNING: As side effect it stops all services to get state of queues anaffected by sercies. Spider is full idle when all conditions are met: * all services are paused i.e. the do not change queues * all queues are empty * task generator is completed """ if self.is_idle_estimated(): for srv in services: srv.pause() if self.is_idle_estimated(): return True for srv in services: srv.resume() return False

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L477-L495

def is_idle_confirmed(self, services: list[BaseService]) -> bool: if self.is_idle_estimated(): for srv in services: srv.pause() if self.is_idle_estimated(): return True for srv in services: srv.resume() return False

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.run

(self)

def run(self) -> None: self._started = time.time() services = [] try: self.prepare() self.process_initial_urls() services = [ self.task_dispatcher, self.task_generator_service, self.parser_service, self.network_service, ] for srv in services: srv.start() while self.work_allowed: try: exc_info = self.fatal_error_queue.get(True, 0.5) except Empty: pass else: # WTF: why? (see below) # The trackeback of fatal error MUST BE rendered by the sender raise exc_info[1] if self.is_idle_confirmed(services): break finally: self.shutdown_services(services) self.stat.shutdown(join_threads=True)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L497-L524

def run(self) -> None: self._started = time.time() services = [] try: self.prepare() self.process_initial_urls() services = [ self.task_dispatcher, self.task_generator_service, self.parser_service, self.network_service, ] for srv in services: srv.start() while self.work_allowed: try: exc_info = self.fatal_error_queue.get(True, 0.5) except Empty: pass else: # WTF: why? (see below) # The trackeback of fatal error MUST BE rendered by the sender raise exc_info[1] if self.is_idle_confirmed(services): break finally: self.shutdown_services(services) self.stat.shutdown(join_threads=True)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.shutdown_services

(self, services: list[BaseService])

def shutdown_services(self, services: list[BaseService]) -> None: # TODO: for srv in services: # Resume service if it has been paused # to allow service to process stop signal srv.resume() srv.stop() start = time.time() while any(x.is_alive() for x in services): time.sleep(0.1) if time.time() - start > 10: break for srv in services: if srv.is_alive(): logger.error("The %s has not stopped :(", srv) self.stat.render_moment() self.shutdown() self.task_queue.clear() self.task_queue.close() logger.debug("Work done")

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L526-L545

def shutdown_services(self, services: list[BaseService]) -> None: # TODO: for srv in services: # Resume service if it has been paused # to allow service to process stop signal srv.resume() srv.stop() start = time.time() while any(x.is_alive() for x in services): time.sleep(0.1) if time.time() - start > 10: break for srv in services: if srv.is_alive(): logger.error("The %s has not stopped :(", srv) self.stat.render_moment() self.shutdown() self.task_queue.clear() self.task_queue.close() logger.debug("Work done")

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.log_failed_network_result

(self, res: NetworkResult)

def log_failed_network_result(self, res: NetworkResult) -> None: orig_exc = ( res["exc"].original_exc if isinstance(res["exc"], OriginalExceptionGrabError) else res["exc"] ) msg = ( ("http-%s" % res["doc"].code) if res["ok"] else orig_exc.__class__.__name__ ) self.stat.inc("error:%s" % msg)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L547-L557

def log_failed_network_result(self, res: NetworkResult) -> None: orig_exc = ( res["exc"].original_exc if isinstance(res["exc"], OriginalExceptionGrabError) else res["exc"] ) msg = ( ("http-%s" % res["doc"].code) if res["ok"] else orig_exc.__class__.__name__ ) self.stat.inc("error:%s" % msg)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.log_rejected_task

(self, task: Task, reason: str)

def log_rejected_task(self, task: Task, reason: str) -> None: if reason == "task-try-count": self.collect_runtime_event("task-count-rejected", task.request.url) elif reason == "network-try-count": self.collect_runtime_event("network-count-rejected", task.request.url) else: raise SpiderError("Unknown response from check_task_limits: %s" % reason)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L559-L565

def log_rejected_task(self, task: Task, reason: str) -> None: if reason == "task-try-count": self.collect_runtime_event("task-count-rejected", task.request.url) elif reason == "network-try-count": self.collect_runtime_event("network-count-rejected", task.request.url) else: raise SpiderError("Unknown response from check_task_limits: %s" % reason)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.get_fallback_handler

(self, task: Task)

return None

def get_fallback_handler(self, task: Task) -> None | Callable[..., Any]: if task.fallback_name: # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], getattr(self, task.fallback_name)) # pylint: enable=deprecated-typing-alias if task.name: fb_name = "task_%s_fallback" % task.name if hasattr(self, fb_name): # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], getattr(self, fb_name)) # pylint: enable=deprecated-typing-alias return None

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L567-L578

def get_fallback_handler(self, task: Task) -> None | Callable[..., Any]: if task.fallback_name: # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], getattr(self, task.fallback_name)) # pylint: enable=deprecated-typing-alias if task.name: fb_name = "task_%s_fallback" % task.name if hasattr(self, fb_name): # pylint: disable=deprecated-typing-alias return cast(typing.Callable[..., Any], getattr(self, fb_name)) # pylint: enable=deprecated-typing-alias return None

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.srv_process_service_result

( self, result: Task | None | Exception | dict[str, Any], task: Task, meta: None | dict[str, Any] = None, )

Process result submitted from any service to task dispatcher service. Result could be: * Task * None * Task instance * ResponseNotValid-based exception * Arbitrary exception * Network response: {ok, ecode, emsg, exc, grab, grab_config_backup} Exception can come only from parser_service and it always has meta {"from": "parser", "exc_info": <...>}

Process result submitted from any service to task dispatcher service.

def srv_process_service_result( self, result: Task | None | Exception | dict[str, Any], task: Task, meta: None | dict[str, Any] = None, ) -> None: """Process result submitted from any service to task dispatcher service. Result could be: * Task * None * Task instance * ResponseNotValid-based exception * Arbitrary exception * Network response: {ok, ecode, emsg, exc, grab, grab_config_backup} Exception can come only from parser_service and it always has meta {"from": "parser", "exc_info": <...>} """ if meta is None: meta = {} if isinstance(result, Task): self.add_task(result) elif result is None: pass elif isinstance(result, ResponseNotValid): self.add_task(task.clone()) error_code = result.__class__.__name__.replace("_", "-") self.stat.inc("integrity:%s" % error_code) elif isinstance(result, Exception): if task: handler = self.find_task_handler(task) handler_name = getattr(handler, "__name__", "NONE") else: handler_name = "NA" self.process_parser_error( handler_name, task, meta["exc_info"], ) if isinstance(result, FatalError): self.fatal_error_queue.put(meta["exc_info"]) elif isinstance(result, dict) and "grab" in result: self.srv_process_network_result(result, task) else: raise SpiderError("Unknown result received from a service: %s" % result)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L583-L629

def srv_process_service_result( self, result: Task | None | Exception | dict[str, Any], task: Task, meta: None | dict[str, Any] = None, ) -> None: if meta is None: meta = {} if isinstance(result, Task): self.add_task(result) elif result is None: pass elif isinstance(result, ResponseNotValid): self.add_task(task.clone()) error_code = result.__class__.__name__.replace("_", "-") self.stat.inc("integrity:%s" % error_code) elif isinstance(result, Exception): if task: handler = self.find_task_handler(task) handler_name = getattr(handler, "__name__", "NONE") else: handler_name = "NA" self.process_parser_error( handler_name, task, meta["exc_info"], ) if isinstance(result, FatalError): self.fatal_error_queue.put(meta["exc_info"]) elif isinstance(result, dict) and "grab" in result: self.srv_process_network_result(result, task) else: raise SpiderError("Unknown result received from a service: %s" % result)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.srv_process_network_result

(self, result: NetworkResult, task: Task)

def srv_process_network_result(self, result: NetworkResult, task: Task) -> None: # TODO: Move to network service # starts self.log_network_result_stats(result, task) # ends is_valid = False if task.get("raw"): is_valid = True elif result["ok"]: res_code = result["doc"].code is_valid = self.is_valid_network_response_code(res_code, task) if is_valid: self.parser_service.input_queue.put((result, task)) else: self.log_failed_network_result(result) # Try to do network request one more time if self.network_try_limit > 0: self.add_task(task) self.stat.inc("spider:request")

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L631-L649

def srv_process_network_result(self, result: NetworkResult, task: Task) -> None: # TODO: Move to network service # starts self.log_network_result_stats(result, task) # ends is_valid = False if task.get("raw"): is_valid = True elif result["ok"]: res_code = result["doc"].code is_valid = self.is_valid_network_response_code(res_code, task) if is_valid: self.parser_service.input_queue.put((result, task)) else: self.log_failed_network_result(result) # Try to do network request one more time if self.network_try_limit > 0: self.add_task(task) self.stat.inc("spider:request")

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/base.py

Spider.srv_process_task

(self, task: Task)

def srv_process_task(self, task: Task) -> None: task.network_try_count += 1 is_valid, reason = self.check_task_limits(task) if is_valid: grab = self.create_grab_instance() self.process_grab_proxy(task, grab) self.stat.inc("spider:request-network") self.stat.inc("spider:task-%s-network" % task.name) try: result: dict[str, Any] = { "ok": True, "ecode": None, "emsg": None, "grab": grab, "task": task, "exc": None, "doc": None, } try: result["doc"] = grab.request(task.request) except ( GrabNetworkError, GrabInvalidUrl, GrabInvalidResponse, GrabTooManyRedirectsError, ) as ex: result.update({"ok": False, "exc": ex}) self.task_dispatcher.input_queue.put((result, task, None)) finally: pass else: self.log_rejected_task(task, reason) handler = self.get_fallback_handler(task) if handler: handler(task)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/base.py#L651-L686

def srv_process_task(self, task: Task) -> None: task.network_try_count += 1 is_valid, reason = self.check_task_limits(task) if is_valid: grab = self.create_grab_instance() self.process_grab_proxy(task, grab) self.stat.inc("spider:request-network") self.stat.inc("spider:task-%s-network" % task.name) try: result: dict[str, Any] = { "ok": True, "ecode": None, "emsg": None, "grab": grab, "task": task, "exc": None, "doc": None, } try: result["doc"] = grab.request(task.request) except ( GrabNetworkError, GrabInvalidUrl, GrabInvalidResponse, GrabTooManyRedirectsError, ) as ex: result.update({"ok": False, "exc": ex}) self.task_dispatcher.input_queue.put((result, task, None)) finally: pass else: self.log_rejected_task(task, reason) handler = self.get_fallback_handler(task) if handler: handler(task)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/memory.py

MemoryTaskQueue.__init__

(self)

def __init__(self) -> None: super().__init__() self.queue_object: PriorityQueue[tuple[int, Task]] = PriorityQueue() self.schedule_list: list[tuple[datetime, Task]] = []

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/memory.py#L12-L15

def __init__(self) -> None: super().__init__() self.queue_object: PriorityQueue[tuple[int, Task]] = PriorityQueue() self.schedule_list: list[tuple[datetime, Task]] = []

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/memory.py

MemoryTaskQueue.put

( self, task: Task, priority: int, schedule_time: None | datetime = None )

def put( self, task: Task, priority: int, schedule_time: None | datetime = None ) -> None: if schedule_time is None: self.queue_object.put((priority, task)) else: self.schedule_list.append((schedule_time, task))

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/memory.py#L17-L23

def put( self, task: Task, priority: int, schedule_time: None | datetime = None ) -> None: if schedule_time is None: self.queue_object.put((priority, task)) else: self.schedule_list.append((schedule_time, task))

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/memory.py

MemoryTaskQueue.get

(self)

return task

def get(self) -> Task: now = datetime.utcnow() removed_indexes = [] for idx, item in enumerate(self.schedule_list): schedule_time, task = item if schedule_time <= now: self.put(task, 1) removed_indexes.append(idx) self.schedule_list = [ x for idx, x in enumerate(self.schedule_list) if idx not in removed_indexes ] _, task = self.queue_object.get(block=False) return task

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/memory.py#L25-L40

def get(self) -> Task: now = datetime.utcnow() removed_indexes = [] for idx, item in enumerate(self.schedule_list): schedule_time, task = item if schedule_time <= now: self.put(task, 1) removed_indexes.append(idx) self.schedule_list = [ x for idx, x in enumerate(self.schedule_list) if idx not in removed_indexes ] _, task = self.queue_object.get(block=False) return task

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/memory.py

MemoryTaskQueue.size

(self)

return self.queue_object.qsize() + len(self.schedule_list)

def size(self) -> int: return self.queue_object.qsize() + len(self.schedule_list)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/memory.py#L42-L43

def size(self) -> int: return self.queue_object.qsize() + len(self.schedule_list)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/memory.py

MemoryTaskQueue.clear

(self)

def clear(self) -> None: with suppress(Empty): while True: self.queue_object.get(False) self.schedule_list = []

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/memory.py#L45-L49

def clear(self) -> None: with suppress(Empty): while True: self.queue_object.get(False) self.schedule_list = []

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/base.py

BaseTaskQueue.random_queue_name

(self)

return "task_queue_{}".format(str(uuid4()).replace("-", "_"))

def random_queue_name(self) -> str: return "task_queue_{}".format(str(uuid4()).replace("-", "_"))

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/base.py#L15-L16

def random_queue_name(self) -> str: return "task_queue_{}".format(str(uuid4()).replace("-", "_"))

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/base.py

BaseTaskQueue.put

( self, task: Task, priority: int, schedule_time: None | datetime = None, )

def put( self, task: Task, priority: int, schedule_time: None | datetime = None, ) -> None: # pragma: no cover raise NotImplementedError

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/base.py#L18-L24

def put( self, task: Task, priority: int, schedule_time: None | datetime = None, ) -> None: # pragma: no cover raise NotImplementedError

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/base.py

BaseTaskQueue.get

(self)

Return `Task` object or raise `Queue.Empty` exception. @returns: `grab.spider.task.Task` object @raises: `Queue.Empty` exception

Return `Task` object or raise `Queue.Empty` exception.

def get(self) -> Task: # pragma: no cover """Return `Task` object or raise `Queue.Empty` exception. @returns: `grab.spider.task.Task` object @raises: `Queue.Empty` exception """ raise NotImplementedError

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/base.py#L26-L32

def get(self) -> Task: # pragma: no cover raise NotImplementedError

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/base.py

BaseTaskQueue.size

(self)

def size(self) -> int: # pragma: no cover raise NotImplementedError

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/base.py#L35-L36

def size(self) -> int: # pragma: no cover raise NotImplementedError

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/base.py

BaseTaskQueue.clear

(self)

Remove all tasks from the queue.

Remove all tasks from the queue.

def clear(self) -> None: # pragma: no cover """Remove all tasks from the queue.""" raise NotImplementedError

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/base.py#L38-L40

def clear(self) -> None: # pragma: no cover raise NotImplementedError

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/queue_backend/base.py

BaseTaskQueue.close

(self)

def close(self) -> None: # pragma: no cover raise NotImplementedError

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/queue_backend/base.py#L42-L43

def close(self) -> None: # pragma: no cover raise NotImplementedError

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/network.py

BaseNetworkService.get_active_threads_number

(self)

def get_active_threads_number(self) -> int: # pragma: no cover raise NotImplementedError

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/network.py#L18-L19

def get_active_threads_number(self) -> int: # pragma: no cover raise NotImplementedError

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/network.py

NetworkServiceThreaded.__init__

( self, fatal_error_queue: Queue[FatalErrorQueueItem], thread_number: int, process_task: Callable[[Task], None], get_task_from_queue: Callable[[], None | Literal[True] | Task], )

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], thread_number: int, process_task: Callable[[Task], None], get_task_from_queue: Callable[[], None | Literal[True] | Task], ) -> None: super().__init__(fatal_error_queue) self.thread_number = thread_number self.process_task = process_task self.get_task_from_queue = get_task_from_queue self.worker_pool = [] for _ in range(self.thread_number): self.worker_pool.append(self.create_worker(self.worker_callback)) self.register_workers(self.worker_pool)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/network.py#L23-L37

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], thread_number: int, process_task: Callable[[Task], None], get_task_from_queue: Callable[[], None | Literal[True] | Task], ) -> None: super().__init__(fatal_error_queue) self.thread_number = thread_number self.process_task = process_task self.get_task_from_queue = get_task_from_queue self.worker_pool = [] for _ in range(self.thread_number): self.worker_pool.append(self.create_worker(self.worker_callback)) self.register_workers(self.worker_pool)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/network.py

NetworkServiceThreaded.get_active_threads_number

(self)

return sum( 1 for x in self.iterate_workers(self.worker_registry) if x.is_busy_event.is_set() )

def get_active_threads_number(self) -> int: return sum( 1 for x in self.iterate_workers(self.worker_registry) if x.is_busy_event.is_set() )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/network.py#L39-L44

def get_active_threads_number(self) -> int: return sum( 1 for x in self.iterate_workers(self.worker_registry) if x.is_busy_event.is_set() )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/network.py

NetworkServiceThreaded.worker_callback

(self, worker: ServiceWorker)

def worker_callback(self, worker: ServiceWorker) -> None: while not worker.stop_event.is_set(): worker.process_pause_signal() try: task = self.get_task_from_queue() except Empty: time.sleep(0.1) else: if task is None or task is True: time.sleep(0.1) else: worker.is_busy_event.set() try: self.process_task(task) finally: worker.is_busy_event.clear()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/network.py#L47-L62

def worker_callback(self, worker: ServiceWorker) -> None: while not worker.stop_event.is_set(): worker.process_pause_signal() try: task = self.get_task_from_queue() except Empty: time.sleep(0.1) else: if task is None or task is True: time.sleep(0.1) else: worker.is_busy_event.set() try: self.process_task(task) finally: worker.is_busy_event.clear()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/parser.py

ParserService.__init__

( self, fatal_error_queue: Queue[FatalErrorQueueItem], pool_size: int, task_dispatcher: TaskDispatcherService, stat: Stat, parser_requests_per_process: int, find_task_handler: Callable[[Task], Callable[..., None]], )

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], pool_size: int, task_dispatcher: TaskDispatcherService, stat: Stat, parser_requests_per_process: int, find_task_handler: Callable[[Task], Callable[..., None]], ) -> None: super().__init__(fatal_error_queue) self.task_dispatcher = task_dispatcher self.stat = stat self.parser_requests_per_process = parser_requests_per_process self.find_task_handler = find_task_handler self.input_queue: Queue[Any] = Queue() self.pool_size = pool_size self.workers_pool = [] for _ in range(self.pool_size): self.workers_pool.append(self.create_worker(self.worker_callback)) self.supervisor = self.create_worker(self.supervisor_callback) self.register_workers(self.workers_pool, self.supervisor)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/parser.py#L22-L42

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], pool_size: int, task_dispatcher: TaskDispatcherService, stat: Stat, parser_requests_per_process: int, find_task_handler: Callable[[Task], Callable[..., None]], ) -> None: super().__init__(fatal_error_queue) self.task_dispatcher = task_dispatcher self.stat = stat self.parser_requests_per_process = parser_requests_per_process self.find_task_handler = find_task_handler self.input_queue: Queue[Any] = Queue() self.pool_size = pool_size self.workers_pool = [] for _ in range(self.pool_size): self.workers_pool.append(self.create_worker(self.worker_callback)) self.supervisor = self.create_worker(self.supervisor_callback) self.register_workers(self.workers_pool, self.supervisor)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/parser.py

ParserService.check_pool_health

(self)

def check_pool_health(self) -> None: to_remove = [] for worker in self.workers_pool: if not worker.is_alive(): self.stat.inc("parser:worker-restarted") new_worker = self.create_worker(self.worker_callback) self.workers_pool.append(new_worker) new_worker.start() to_remove.append(worker) for worker in to_remove: self.workers_pool.remove(worker)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/parser.py#L44-L54

def check_pool_health(self) -> None: to_remove = [] for worker in self.workers_pool: if not worker.is_alive(): self.stat.inc("parser:worker-restarted") new_worker = self.create_worker(self.worker_callback) self.workers_pool.append(new_worker) new_worker.start() to_remove.append(worker) for worker in to_remove: self.workers_pool.remove(worker)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/parser.py

ParserService.supervisor_callback

(self, worker: ServiceWorker)

def supervisor_callback(self, worker: ServiceWorker) -> None: while not worker.stop_event.is_set(): worker.process_pause_signal() self.check_pool_health() time.sleep(1)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/parser.py#L56-L60

def supervisor_callback(self, worker: ServiceWorker) -> None: while not worker.stop_event.is_set(): worker.process_pause_signal() self.check_pool_health() time.sleep(1)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/parser.py

ParserService.worker_callback

(self, worker: ServiceWorker)

def worker_callback(self, worker: ServiceWorker) -> None: process_request_count = 0 while not worker.stop_event.is_set(): worker.process_pause_signal() try: result, task = self.input_queue.get(True, 0.1) except Empty: pass else: worker.is_busy_event.set() try: process_request_count += 1 try: handler = self.find_task_handler(task) except NoTaskHandler as ex: self.task_dispatcher.input_queue.put( (ex, task, {"exc_info": sys.exc_info()}) ) self.stat.inc("parser:handler-not-found") else: self.execute_task_handler(handler, result, task) self.stat.inc("parser:handler-processed") if self.parser_requests_per_process and ( process_request_count >= self.parser_requests_per_process ): self.stat.inc( "parser:handler-req-limit", ) return finally: worker.is_busy_event.clear()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/parser.py#L62-L92

def worker_callback(self, worker: ServiceWorker) -> None: process_request_count = 0 while not worker.stop_event.is_set(): worker.process_pause_signal() try: result, task = self.input_queue.get(True, 0.1) except Empty: pass else: worker.is_busy_event.set() try: process_request_count += 1 try: handler = self.find_task_handler(task) except NoTaskHandler as ex: self.task_dispatcher.input_queue.put( (ex, task, {"exc_info": sys.exc_info()}) ) self.stat.inc("parser:handler-not-found") else: self.execute_task_handler(handler, result, task) self.stat.inc("parser:handler-processed") if self.parser_requests_per_process and ( process_request_count >= self.parser_requests_per_process ): self.stat.inc( "parser:handler-req-limit", ) return finally: worker.is_busy_event.clear()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/parser.py

ParserService.execute_task_handler

( self, handler: Callable[[Grab, Task], None], result: NetworkResult, task: Task )

def execute_task_handler( self, handler: Callable[[Grab, Task], None], result: NetworkResult, task: Task ) -> None: try: handler_result = handler(result["doc"], task) if handler_result is None: pass else: for item in handler_result: self.task_dispatcher.input_queue.put( (item, task, None), ) except Exception as ex: self.task_dispatcher.input_queue.put( ( ex, task, { "exc_info": sys.exc_info(), "from": "parser", }, ) )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/parser.py#L94-L116

def execute_task_handler( self, handler: Callable[[Grab, Task], None], result: NetworkResult, task: Task ) -> None: try: handler_result = handler(result["doc"], task) if handler_result is None: pass else: for item in handler_result: self.task_dispatcher.input_queue.put( (item, task, None), ) except Exception as ex: self.task_dispatcher.input_queue.put( ( ex, task, { "exc_info": sys.exc_info(), "from": "parser", }, ) )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/task_dispatcher.py

TaskDispatcherService.__init__

( self, fatal_error_queue: Queue[FatalErrorQueueItem], process_service_result: Callable[[Any, Task, None | dict[str, Any]], Any], )

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], process_service_result: Callable[[Any, Task, None | dict[str, Any]], Any], ): super().__init__(fatal_error_queue) self.process_service_result = process_service_result self.input_queue: Queue[Any] = Queue() self.worker = self.create_worker(self.worker_callback) self.register_workers(self.worker)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/task_dispatcher.py#L13-L22

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], process_service_result: Callable[[Any, Task, None | dict[str, Any]], Any], ): super().__init__(fatal_error_queue) self.process_service_result = process_service_result self.input_queue: Queue[Any] = Queue() self.worker = self.create_worker(self.worker_callback) self.register_workers(self.worker)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/task_dispatcher.py

TaskDispatcherService.start

(self)

def start(self) -> None: self.worker.start()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/task_dispatcher.py#L24-L25

def start(self) -> None: self.worker.start()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/task_dispatcher.py

TaskDispatcherService.worker_callback

(self, worker: ServiceWorker)

def worker_callback(self, worker: ServiceWorker) -> None: while not worker.stop_event.is_set(): worker.process_pause_signal() try: result, task, meta = self.input_queue.get(True, 0.1) except Empty: pass else: self.process_service_result(result, task, meta)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/task_dispatcher.py#L27-L35

def worker_callback(self, worker: ServiceWorker) -> None: while not worker.stop_event.is_set(): worker.process_pause_signal() try: result, task, meta = self.input_queue.get(True, 0.1) except Empty: pass else: self.process_service_result(result, task, meta)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.__init__

( self, fatal_error_queue: Queue[FatalErrorQueueItem], worker_callback: Callable[..., Any], )

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], worker_callback: Callable[..., Any], ) -> None: self.fatal_error_queue = fatal_error_queue self.thread = Thread( target=self.worker_callback_wrapper(worker_callback), args=[self] ) self.thread.daemon = True self.thread.name = self.build_thread_name(worker_callback) self.pause_event = Event() self.stop_event = Event() self.resume_event = Event() self.activity_paused = Event() self.is_busy_event = Event()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L17-L32

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], worker_callback: Callable[..., Any], ) -> None: self.fatal_error_queue = fatal_error_queue self.thread = Thread( target=self.worker_callback_wrapper(worker_callback), args=[self] ) self.thread.daemon = True self.thread.name = self.build_thread_name(worker_callback) self.pause_event = Event() self.stop_event = Event() self.resume_event = Event() self.activity_paused = Event() self.is_busy_event = Event()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.build_thread_name

(self, worker_callback: Callable[..., Any])

return "worker:%s:%s" % (cls_name, worker_callback.__name__)

def build_thread_name(self, worker_callback: Callable[..., Any]) -> str: cls_name = ( worker_callback.__self__.__class__.__name__ if hasattr(worker_callback, "__self__") else "NA" ) return "worker:%s:%s" % (cls_name, worker_callback.__name__)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L34-L40

def build_thread_name(self, worker_callback: Callable[..., Any]) -> str: cls_name = ( worker_callback.__self__.__class__.__name__ if hasattr(worker_callback, "__self__") else "NA" ) return "worker:%s:%s" % (cls_name, worker_callback.__name__)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.worker_callback_wrapper

( self, callback: Callable[..., Any] )

return wrapper

def worker_callback_wrapper( self, callback: Callable[..., Any] ) -> Callable[..., None]: def wrapper(*args: Any, **kwargs: Any) -> None: try: callback(*args, **kwargs) except Exception as ex: logger.error("Spider Service Fatal Error", exc_info=ex) # pylint: disable=deprecated-typing-alias self.fatal_error_queue.put( cast( Tuple[Type[Exception], Exception, TracebackType], sys.exc_info() ) ) return wrapper

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L42-L57

def worker_callback_wrapper( self, callback: Callable[..., Any] ) -> Callable[..., None]: def wrapper(*args: Any, **kwargs: Any) -> None: try: callback(*args, **kwargs) except Exception as ex: logger.error("Spider Service Fatal Error", exc_info=ex) # pylint: disable=deprecated-typing-alias self.fatal_error_queue.put( cast( Tuple[Type[Exception], Exception, TracebackType], sys.exc_info() ) ) return wrapper

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.start

(self)

def start(self) -> None: self.thread.start()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L59-L60

def start(self) -> None: self.thread.start()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.stop

(self)

def stop(self) -> None: self.stop_event.set()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L62-L63

def stop(self) -> None: self.stop_event.set()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.process_pause_signal

(self)

def process_pause_signal(self) -> None: if self.pause_event.is_set(): self.activity_paused.set() self.resume_event.wait()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L65-L68

def process_pause_signal(self) -> None: if self.pause_event.is_set(): self.activity_paused.set() self.resume_event.wait()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.pause

(self)

def pause(self) -> None: self.resume_event.clear() self.pause_event.set() while True: if self.activity_paused.wait(0.1): break if not self.is_alive(): break

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L70-L77

def pause(self) -> None: self.resume_event.clear() self.pause_event.set() while True: if self.activity_paused.wait(0.1): break if not self.is_alive(): break

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.resume

(self)

def resume(self) -> None: self.pause_event.clear() self.activity_paused.clear() self.resume_event.set()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L79-L82

def resume(self) -> None: self.pause_event.clear() self.activity_paused.clear() self.resume_event.set()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

ServiceWorker.is_alive

(self)

return self.thread.is_alive()

def is_alive(self) -> bool: return self.thread.is_alive()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L84-L85

def is_alive(self) -> bool: return self.thread.is_alive()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.__init__

(self, fatal_error_queue: Queue[FatalErrorQueueItem])

def __init__(self, fatal_error_queue: Queue[FatalErrorQueueItem]) -> None: self.fatal_error_queue = fatal_error_queue self.worker_registry: list[ServiceWorker] = []

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L89-L91

def __init__(self, fatal_error_queue: Queue[FatalErrorQueueItem]) -> None: self.fatal_error_queue = fatal_error_queue self.worker_registry: list[ServiceWorker] = []

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.create_worker

(self, worker_action: Callable[..., None])

return ServiceWorker(self.fatal_error_queue, worker_action)

def create_worker(self, worker_action: Callable[..., None]) -> ServiceWorker: return ServiceWorker(self.fatal_error_queue, worker_action)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L93-L94

def create_worker(self, worker_action: Callable[..., None]) -> ServiceWorker: return ServiceWorker(self.fatal_error_queue, worker_action)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.iterate_workers

(self, objects: list[ServiceWorker])

def iterate_workers(self, objects: list[ServiceWorker]) -> Iterable[ServiceWorker]: for obj in objects: assert isinstance(obj, (ServiceWorker, list)) if isinstance(obj, ServiceWorker): yield obj elif isinstance(obj, list): yield from obj

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L96-L102

def iterate_workers(self, objects: list[ServiceWorker]) -> Iterable[ServiceWorker]: for obj in objects: assert isinstance(obj, (ServiceWorker, list)) if isinstance(obj, ServiceWorker): yield obj elif isinstance(obj, list): yield from obj

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.start

(self)

def start(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.start()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L104-L106

def start(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.start()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.stop

(self)

def stop(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.stop()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L108-L110

def stop(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.stop()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.pause

(self)

def pause(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.pause()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L112-L114

def pause(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.pause()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.resume

(self)

def resume(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.resume()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L116-L118

def resume(self) -> None: for worker in self.iterate_workers(self.worker_registry): worker.resume()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.register_workers

(self, *args: Any)

def register_workers(self, *args: Any) -> None: self.worker_registry = list(args)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L120-L121

def register_workers(self, *args: Any) -> None: self.worker_registry = list(args)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.is_busy

(self)

return any( x.is_busy_event.is_set() for x in self.iterate_workers(self.worker_registry) )

def is_busy(self) -> bool: return any( x.is_busy_event.is_set() for x in self.iterate_workers(self.worker_registry) )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L123-L126

def is_busy(self) -> bool: return any( x.is_busy_event.is_set() for x in self.iterate_workers(self.worker_registry) )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/base.py

BaseService.is_alive

(self)

return any(x.is_alive() for x in self.iterate_workers(self.worker_registry))

def is_alive(self) -> bool: return any(x.is_alive() for x in self.iterate_workers(self.worker_registry))

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/base.py#L128-L129

def is_alive(self) -> bool: return any(x.is_alive() for x in self.iterate_workers(self.worker_registry))

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/task_generator.py

TaskGeneratorService.__init__

( self, fatal_error_queue: Queue[FatalErrorQueueItem], real_generator: Iterator[Task], thread_number: int, get_task_queue: Callable[[], BaseTaskQueue], parser_service: ParserService, task_dispatcher: TaskDispatcherService, )

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], real_generator: Iterator[Task], thread_number: int, get_task_queue: Callable[[], BaseTaskQueue], parser_service: ParserService, task_dispatcher: TaskDispatcherService, ) -> None: super().__init__(fatal_error_queue) self.real_generator = real_generator self.task_queue_threshold = max(200, thread_number * 2) self.get_task_queue = get_task_queue self.parser_service = parser_service self.task_dispatcher = task_dispatcher self.worker = self.create_worker(self.worker_callback) self.register_workers(self.worker)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/task_generator.py#L16-L32

def __init__( self, fatal_error_queue: Queue[FatalErrorQueueItem], real_generator: Iterator[Task], thread_number: int, get_task_queue: Callable[[], BaseTaskQueue], parser_service: ParserService, task_dispatcher: TaskDispatcherService, ) -> None: super().__init__(fatal_error_queue) self.real_generator = real_generator self.task_queue_threshold = max(200, thread_number * 2) self.get_task_queue = get_task_queue self.parser_service = parser_service self.task_dispatcher = task_dispatcher self.worker = self.create_worker(self.worker_callback) self.register_workers(self.worker)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/spider/service/task_generator.py

TaskGeneratorService.worker_callback

(self, worker: ServiceWorker)

def worker_callback(self, worker: ServiceWorker) -> None: # at this point I guess the task queue is set # i.e. "spider.run()" is called task_queue = self.get_task_queue() while not worker.stop_event.is_set(): worker.process_pause_signal() queue_size = max( task_queue.size(), self.parser_service.input_queue.qsize(), ) if queue_size < self.task_queue_threshold: try: for _ in range(self.task_queue_threshold - queue_size): if worker.pause_event.is_set(): return task = next(self.real_generator) self.task_dispatcher.input_queue.put( (task, None, {"source": "task_generator"}) ) except StopIteration: return else: time.sleep(0.1)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/spider/service/task_generator.py#L34-L56

def worker_callback(self, worker: ServiceWorker) -> None: # at this point I guess the task queue is set # i.e. "spider.run()" is called task_queue = self.get_task_queue() while not worker.stop_event.is_set(): worker.process_pause_signal() queue_size = max( task_queue.size(), self.parser_service.input_queue.qsize(), ) if queue_size < self.task_queue_threshold: try: for _ in range(self.task_queue_threshold - queue_size): if worker.pause_event.is_set(): return task = next(self.real_generator) self.task_dispatcher.input_queue.put( (task, None, {"source": "task_generator"}) ) except StopIteration: return else: time.sleep(0.1)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/metrics.py

in_unit

(num: int, unit: str)

return num

def in_unit(num: int, unit: str) -> int | float: if unit == "b": return num if unit == "kb": return round(num / float(KB), 2) if unit == "mb": return round(num / float(MB), 2) if unit == "gb": return round(num / float(GB), 2) return num

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/metrics.py#L8-L17

def in_unit(num: int, unit: str) -> int | float: if unit == "b": return num if unit == "kb": return round(num / float(KB), 2) if unit == "mb": return round(num / float(MB), 2) if unit == "gb": return round(num / float(GB), 2) return num

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/metrics.py

format_traffic_value

(num: int)

return "%s GB" % in_unit(num, "gb")

def format_traffic_value(num: int) -> str: if num < KB: return "%s B" % in_unit(num, "b") if num < MB: return "%s KB" % in_unit(num, "kb") if num < GB: return "%s MB" % in_unit(num, "mb") return "%s GB" % in_unit(num, "gb")

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/metrics.py#L20-L27

def format_traffic_value(num: int) -> str: if num < KB: return "%s B" % in_unit(num, "b") if num < MB: return "%s KB" % in_unit(num, "kb") if num < GB: return "%s MB" % in_unit(num, "mb") return "%s GB" % in_unit(num, "gb")

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/structures.py

merge_with_dict

( hdr1: MutableMapping[str, Any], hdr2: Mapping[str, Any], replace: bool, )

return hdr1

def merge_with_dict( hdr1: MutableMapping[str, Any], hdr2: Mapping[str, Any], replace: bool, ) -> MutableMapping[str, Any]: for key, val in hdr2.items(): if replace or key not in hdr1: hdr1[key] = val return hdr1

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/structures.py#L7-L15

def merge_with_dict( hdr1: MutableMapping[str, Any], hdr2: Mapping[str, Any], replace: bool, ) -> MutableMapping[str, Any]: for key, val in hdr2.items(): if replace or key not in hdr1: hdr1[key] = val return hdr1

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/types.py

resolve_entity

( base_type: type[T], entity: None | T | type[T], default: type[T], )

return cast(typing.Type[T], entity)()

def resolve_entity( base_type: type[T], entity: None | T | type[T], default: type[T], ) -> T: if entity and ( not isinstance(entity, base_type) and (not inspect.isclass(entity) or not issubclass(entity, base_type)) ): raise TypeError("Invalid {} entity: {}".format(base_type, entity)) if entity is None: assert issubclass(default, base_type) return default() if isinstance(entity, base_type): return entity # pylint: disable=deprecated-typing-alias return cast(typing.Type[T], entity)()

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/types.py#L16-L32

def resolve_entity( base_type: type[T], entity: None | T | type[T], default: type[T], ) -> T: if entity and ( not isinstance(entity, base_type) and (not inspect.isclass(entity) or not issubclass(entity, base_type)) ): raise TypeError("Invalid {} entity: {}".format(base_type, entity)) if entity is None: assert issubclass(default, base_type) return default() if isinstance(entity, base_type): return entity # pylint: disable=deprecated-typing-alias return cast(typing.Type[T], entity)()

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/timeout.py

Timeout.__init__

( self, total: None | float | UndefinedParam = UNDEFINED_PARAM, connect: None | float | UndefinedParam = UNDEFINED_PARAM, read: None | float | UndefinedParam = UNDEFINED_PARAM, )

Timeout constructor. Unspecified total timeout is set to None. Unspecified connect timeout is set to total timeout. Unspecified read timeout is set to total timeout.

Timeout constructor.

def __init__( self, total: None | float | UndefinedParam = UNDEFINED_PARAM, connect: None | float | UndefinedParam = UNDEFINED_PARAM, read: None | float | UndefinedParam = UNDEFINED_PARAM, ): """Timeout constructor. Unspecified total timeout is set to None. Unspecified connect timeout is set to total timeout. Unspecified read timeout is set to total timeout. """ self.total = total if total is not UNDEFINED_PARAM else DEFAULT_TOTAL_TIMEOUT self.connect = connect if connect is not UNDEFINED_PARAM else self.total self.read = read if read is not UNDEFINED_PARAM else self.total

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/timeout.py#L17-L31

def __init__( self, total: None | float | UndefinedParam = UNDEFINED_PARAM, connect: None | float | UndefinedParam = UNDEFINED_PARAM, read: None | float | UndefinedParam = UNDEFINED_PARAM, ): self.total = total if total is not UNDEFINED_PARAM else DEFAULT_TOTAL_TIMEOUT self.connect = connect if connect is not UNDEFINED_PARAM else self.total self.read = read if read is not UNDEFINED_PARAM else self.total

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/timeout.py

Timeout.__repr__

(self)

return "{}(connect={!r}, read={!r}, total={!r})".format( type(self).__name__, self.connect, self.read, self.total )

def __repr__(self) -> str: return "{}(connect={!r}, read={!r}, total={!r})".format( type(self).__name__, self.connect, self.read, self.total )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/timeout.py#L33-L36

def __repr__(self) -> str: return "{}(connect={!r}, read={!r}, total={!r})".format( type(self).__name__, self.connect, self.read, self.total )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

create_cookie

( # pylint: disable=too-many-arguments, too-many-locals *, name: str, value: str, domain: str, comment: None | str = None, comment_url: None | str = None, discard: bool = True, domain_initial_dot: None | bool = None, domain_specified: None | bool = None, expires: None | int = None, path: str = "/", path_specified: None | bool = None, port: None | int = None, port_specified: None | bool = None, rest: None | dict[str, Any] = None, rfc2109: bool = False, secure: bool = False, version: int = 0, httponly: None | bool = None, )

return Cookie( # from required scope name=name, value=value, domain=domain, # from non required scope comment=comment, comment_url=comment_url, discard=discard, domain_initial_dot=domain_initial_dot, domain_specified=domain_specified, expires=expires, path=path, path_specified=path_specified, port=str(port) if port else None, # typeshed bundled with mypy wants str type port_specified=port_specified, rest=new_rest, rfc2109=rfc2109, secure=secure, version=version, )

Create cookielib.Cookie instance.

Create cookielib.Cookie instance.

def create_cookie( # pylint: disable=too-many-arguments, too-many-locals *, name: str, value: str, domain: str, comment: None | str = None, comment_url: None | str = None, discard: bool = True, domain_initial_dot: None | bool = None, domain_specified: None | bool = None, expires: None | int = None, path: str = "/", path_specified: None | bool = None, port: None | int = None, port_specified: None | bool = None, rest: None | dict[str, Any] = None, rfc2109: bool = False, secure: bool = False, version: int = 0, httponly: None | bool = None, ) -> Cookie: """Create cookielib.Cookie instance.""" # See also type hints for Cookie at # https://github.com/python/typeshed/blob/main/stdlib/http/cookiejar.pyi if domain == "localhost": domain = "" if rest is None: new_rest = {} else: new_rest = copy(rest) if "HttpOnly" not in new_rest: new_rest["HttpOnly"] = httponly if port_specified is None: port_specified = port is not None if domain_specified is None: domain_specified = domain is not None if domain_initial_dot is None: domain_initial_dot = domain.startswith(".") if path_specified is None: path_specified = path is not None return Cookie( # from required scope name=name, value=value, domain=domain, # from non required scope comment=comment, comment_url=comment_url, discard=discard, domain_initial_dot=domain_initial_dot, domain_specified=domain_specified, expires=expires, path=path, path_specified=path_specified, port=str(port) if port else None, # typeshed bundled with mypy wants str type port_specified=port_specified, rest=new_rest, rfc2109=rfc2109, secure=secure, version=version, )

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L129-L189

def create_cookie( # pylint: disable=too-many-arguments, too-many-locals *, name: str, value: str, domain: str, comment: None | str = None, comment_url: None | str = None, discard: bool = True, domain_initial_dot: None | bool = None, domain_specified: None | bool = None, expires: None | int = None, path: str = "/", path_specified: None | bool = None, port: None | int = None, port_specified: None | bool = None, rest: None | dict[str, Any] = None, rfc2109: bool = False, secure: bool = False, version: int = 0, httponly: None | bool = None, ) -> Cookie: # See also type hints for Cookie at # https://github.com/python/typeshed/blob/main/stdlib/http/cookiejar.pyi if domain == "localhost": domain = "" if rest is None: new_rest = {} else: new_rest = copy(rest) if "HttpOnly" not in new_rest: new_rest["HttpOnly"] = httponly if port_specified is None: port_specified = port is not None if domain_specified is None: domain_specified = domain is not None if domain_initial_dot is None: domain_initial_dot = domain.startswith(".") if path_specified is None: path_specified = path is not None return Cookie( # from required scope name=name, value=value, domain=domain, # from non required scope comment=comment, comment_url=comment_url, discard=discard, domain_initial_dot=domain_initial_dot, domain_specified=domain_specified, expires=expires, path=path, path_specified=path_specified, port=str(port) if port else None, # typeshed bundled with mypy wants str type port_specified=port_specified, rest=new_rest, rfc2109=rfc2109, secure=secure, version=version, )

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

build_cookie_header

( cookiejar: CookieJar, url: str, headers: Mapping[str, str] )

return mocked_req.get_new_headers().get("Cookie")

Build HTTP Cookie header value for given cookies.

Build HTTP Cookie header value for given cookies.

def build_cookie_header( cookiejar: CookieJar, url: str, headers: Mapping[str, str] ) -> None | str: """Build HTTP Cookie header value for given cookies.""" mocked_req = MockRequest(url, dict(headers)) cookiejar.add_cookie_header(cast(urllib.request.Request, mocked_req)) return mocked_req.get_new_headers().get("Cookie")

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L192-L198

def build_cookie_header( cookiejar: CookieJar, url: str, headers: Mapping[str, str] ) -> None | str: mocked_req = MockRequest(url, dict(headers)) cookiejar.add_cookie_header(cast(urllib.request.Request, mocked_req)) return mocked_req.get_new_headers().get("Cookie")

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

build_jar

(cookies: Sequence[Cookie])

return jar

def build_jar(cookies: Sequence[Cookie]) -> CookieJar: jar = CookieJar() for item in cookies: jar.set_cookie(item) return jar

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L201-L205

def build_jar(cookies: Sequence[Cookie]) -> CookieJar: jar = CookieJar() for item in cookies: jar.set_cookie(item) return jar

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

extract_response_cookies

( req_url: str, req_headers: Mapping[str, Any] | HTTPMessage | HTTPHeaderDict, response_headers: HTTPMessage | HTTPHeaderDict, )

return list(jar)

def extract_response_cookies( req_url: str, req_headers: Mapping[str, Any] | HTTPMessage | HTTPHeaderDict, response_headers: HTTPMessage | HTTPHeaderDict, ) -> Sequence[Cookie]: jar = CookieJar() jar.extract_cookies( cast(HTTPResponse, MockResponse(response_headers)), cast(urllib.request.Request, MockRequest(req_url, dict(req_headers))), ) return list(jar)

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L208-L218

def extract_response_cookies( req_url: str, req_headers: Mapping[str, Any] | HTTPMessage | HTTPHeaderDict, response_headers: HTTPMessage | HTTPHeaderDict, ) -> Sequence[Cookie]: jar = CookieJar() jar.extract_cookies( cast(HTTPResponse, MockResponse(response_headers)), cast(urllib.request.Request, MockRequest(req_url, dict(req_headers))), ) return list(jar)

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

MockRequest.__init__

(self, url: str, headers: dict[str, str])

def __init__(self, url: str, headers: dict[str, str]): self._url = url self._headers = headers self._new_headers: dict[str, Any] = {} self.type = urlparse(self._url).scheme

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L38-L42

def __init__(self, url: str, headers: dict[str, str]): self._url = url self._headers = headers self._new_headers: dict[str, Any] = {} self.type = urlparse(self._url).scheme

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

MockRequest.get_type

(self)

return self.type

def get_type(self) -> str: return self.type

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L44-L45

def get_type(self) -> str: return self.type

lorien/grab

2d170c31a3335c2e29578b42a5d62ef3efc5d7ee

grab/util/cookies.py

MockRequest.get_host

(self)

return urlparse(self._url).netloc

def get_host(self) -> str: return urlparse(self._url).netloc

https://github.com/lorien/grab/blob/2d170c31a3335c2e29578b42a5d62ef3efc5d7ee/project1/grab/util/cookies.py#L47-L48