zulip/zerver/tornado/descriptors.py

from typing import TYPE_CHECKING, Dict, Optional

if TYPE_CHECKING:
    from zerver.tornado.event_queue import ClientDescriptor

descriptors_by_handler_id: Dict[int, "ClientDescriptor"] = {}

def get_descriptor_by_handler_id(handler_id: int) -> Optional['ClientDescriptor']:
    return descriptors_by_handler_id.get(handler_id)

def set_descriptor_by_handler_id(handler_id: int,
                                 client_descriptor: 'ClientDescriptor') -> None:
    descriptors_by_handler_id[handler_id] = client_descriptor

def clear_descriptor_by_handler_id(handler_id: int) -> None:
    del descriptors_by_handler_id[handler_id]
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2020-06-11 00:54:34 +02:00			`from typing import TYPE_CHECKING, Dict, Optional`
tornado: Move descriptor dict management code to handlers.py. 2016-11-27 06:14:48 +01:00
typing: Use TYPE_CHECKING when dealing with cyclic dependencies. 2019-07-30 20:58:48 +02:00			`if TYPE_CHECKING:`
Mypy: Migrate tornado/descriptors.py to python3 function annotations. Use quoted form of ClientDescriptor to break presumed circular dependency, and modify import statement to shorten quotes. 2018-03-15 01:21:27 +01:00			`from zerver.tornado.event_queue import ClientDescriptor`
tornado: Move descriptor dict management code to handlers.py. 2016-11-27 06:14:48 +01:00
python: Convert assignment type annotations to Python 3.6 style. This commit was split by tabbott; this piece covers the vast majority of files in Zulip, but excludes scripts/, tools/, and puppet/ to help ensure we at least show the right error messages for Xenial systems. We can likely further refine the remaining pieces with some testing. Generated by com2ann, with whitespace fixes and various manual fixes for runtime issues: - invoiced_through: Optional[LicenseLedger] = models.ForeignKey( + invoiced_through: Optional["LicenseLedger"] = models.ForeignKey( -_apns_client: Optional[APNsClient] = None +_apns_client: Optional["APNsClient"] = None - notifications_stream: Optional[Stream] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE) - signup_notifications_stream: Optional[Stream] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE) + notifications_stream: Optional["Stream"] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE) + signup_notifications_stream: Optional["Stream"] = models.ForeignKey('Stream', related_name='+', null=True, blank=True, on_delete=CASCADE) - author: Optional[UserProfile] = models.ForeignKey('UserProfile', blank=True, null=True, on_delete=CASCADE) + author: Optional["UserProfile"] = models.ForeignKey('UserProfile', blank=True, null=True, on_delete=CASCADE) - bot_owner: Optional[UserProfile] = models.ForeignKey('self', null=True, on_delete=models.SET_NULL) + bot_owner: Optional["UserProfile"] = models.ForeignKey('self', null=True, on_delete=models.SET_NULL) - default_sending_stream: Optional[Stream] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE) - default_events_register_stream: Optional[Stream] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE) + default_sending_stream: Optional["Stream"] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE) + default_events_register_stream: Optional["Stream"] = models.ForeignKey('zerver.Stream', null=True, related_name='+', on_delete=CASCADE) -descriptors_by_handler_id: Dict[int, ClientDescriptor] = {} +descriptors_by_handler_id: Dict[int, "ClientDescriptor"] = {} -worker_classes: Dict[str, Type[QueueProcessingWorker]] = {} -queues: Dict[str, Dict[str, Type[QueueProcessingWorker]]] = {} +worker_classes: Dict[str, Type["QueueProcessingWorker"]] = {} +queues: Dict[str, Dict[str, Type["QueueProcessingWorker"]]] = {} -AUTH_LDAP_REVERSE_EMAIL_SEARCH: Optional[LDAPSearch] = None +AUTH_LDAP_REVERSE_EMAIL_SEARCH: Optional["LDAPSearch"] = None Signed-off-by: Anders Kaseorg <anders@zulipchat.com> 2020-04-22 01:09:50 +02:00			`descriptors_by_handler_id: Dict[int, "ClientDescriptor"] = {}`
tornado: Move descriptor dict management code to handlers.py. 2016-11-27 06:14:48 +01:00
mypy: Add Optional to tornado/descriptors.py; remove from mypy.ini. 2018-10-27 03:07:32 +02:00			`def get_descriptor_by_handler_id(handler_id: int) -> Optional['ClientDescriptor']:`
tornado: Move descriptor dict management code to handlers.py. 2016-11-27 06:14:48 +01:00			`return descriptors_by_handler_id.get(handler_id)`

Mypy: Migrate tornado/descriptors.py to python3 function annotations. Use quoted form of ClientDescriptor to break presumed circular dependency, and modify import statement to shorten quotes. 2018-03-15 01:21:27 +01:00			`def set_descriptor_by_handler_id(handler_id: int,`
			`client_descriptor: 'ClientDescriptor') -> None:`
tornado: Move descriptor dict management code to handlers.py. 2016-11-27 06:14:48 +01:00			`descriptors_by_handler_id[handler_id] = client_descriptor`

event_queue: Fix strict_optional errors. Signed-off-by: Anders Kaseorg <anders@zulip.com> 2020-07-05 02:29:31 +02:00			`def clear_descriptor_by_handler_id(handler_id: int) -> None:`
tornado: Move descriptor dict management code to handlers.py. 2016-11-27 06:14:48 +01:00			`del descriptors_by_handler_id[handler_id]`