From 2805841119e22529313d6d9c17fb2644244e2a8c Mon Sep 17 00:00:00 2001 From: Abhinav Singh Date: Mon, 22 Nov 2021 23:52:18 +0530 Subject: [PATCH] Fix doc build --- docs/conf.py | 14 +++++++++++--- proxy/core/acceptor/acceptor.py | 2 +- proxy/core/acceptor/threadless.py | 4 ++-- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2db59aa9b3..4896ca064f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -241,6 +241,7 @@ nitpicky = True _any_role = 'any' +_py_obj_role = 'py:obj' _py_class_role = 'py:class' nitpick_ignore = [ (_any_role, ''), @@ -256,8 +257,10 @@ (_any_role, 'HttpParser.state'), (_any_role, 'HttpProtocolHandler'), (_any_role, 'multiprocessing.Manager'), - (_any_role, 'work_klass'), (_any_role, 'proxy.core.base.tcp_upstream.TcpUpstreamConnectionHandler'), + (_any_role, 'work_klass'), + (_py_class_role, '_asyncio.Task'), + (_py_class_role, 'asyncio.events.AbstractEventLoop'), (_py_class_role, 'CacheStore'), (_py_class_role, 'HttpParser'), (_py_class_role, 'HttpProtocolHandlerPlugin'), @@ -268,12 +271,17 @@ (_py_class_role, 'paramiko.channel.Channel'), (_py_class_role, 'proxy.http.parser.parser.T'), (_py_class_role, 'proxy.plugin.cache.store.base.CacheStore'), + (_py_class_role, 'proxy.core.pool.AcceptorPool'), + (_py_class_role, 'proxy.core.executors.ThreadlessPool'), + (_py_class_role, 'proxy.core.acceptor.threadless.T'), + (_py_class_role, 'queue.Queue[Any]'), (_py_class_role, 'TcpClientConnection'), (_py_class_role, 'TcpServerConnection'), (_py_class_role, 'unittest.case.TestCase'), (_py_class_role, 'unittest.result.TestResult'), (_py_class_role, 'UUID'), - (_py_class_role, 'WebsocketFrame'), (_py_class_role, 'Url'), - (_py_class_role, '_asyncio.Task'), + (_py_class_role, 'WebsocketFrame'), + (_py_class_role, 'Work'), + (_py_obj_role, 'proxy.core.acceptor.threadless.T'), ] diff --git a/proxy/core/acceptor/acceptor.py b/proxy/core/acceptor/acceptor.py index a89e282f5b..481b27e615 100644 --- a/proxy/core/acceptor/acceptor.py +++ b/proxy/core/acceptor/acceptor.py @@ -26,7 +26,7 @@ from multiprocessing.reduction import recv_handle from typing import List, Optional, Tuple -from typing import Any +from typing import Any # noqa: W0611 pylint: disable=unused-import from ...common.flag import flags from ...common.utils import is_threadless diff --git a/proxy/core/acceptor/threadless.py b/proxy/core/acceptor/threadless.py index e7a3388932..2998bbabc8 100644 --- a/proxy/core/acceptor/threadless.py +++ b/proxy/core/acceptor/threadless.py @@ -21,7 +21,7 @@ import selectors import multiprocessing -from abc import abstractmethod, ABC, abstractproperty +from abc import abstractmethod, ABC from typing import Dict, Optional, Tuple, List, Set, Generic, TypeVar, Union from ...common.logger import Logger @@ -87,8 +87,8 @@ def __init__( ] = {} self.wait_timeout: float = DEFAULT_SELECTOR_SELECT_TIMEOUT - @abstractproperty @property + @abstractmethod def loop(self) -> Optional[asyncio.AbstractEventLoop]: raise NotImplementedError()