stuff

Author: jonathandung

asyncutils/channels.pyi

@@ -14,9 +14,11 @@ __all__ = 'EventBus', 'Observable', 'Rendezvous'
 class Observable[**P](LoopContextMixin):
     @type_check_only
     class _Observer(Protocol):
+        '''Not exposed.'''
         async def __call__(self, *a: P.args, **k: P.kwargs) -> Any: ...
     @type_check_only
     class _SubscriptionReturnType(Protocol):
+        '''Not exposed.'''
         def __call__(self, strict: bool=...) -> None: ...
     @property
     def idle(self) -> bool: ...
@@ -66,6 +68,7 @@ class EventBus(LoopContextMixin):
     Use instances as context managers only for proper setup and shutdown.'''
     @type_check_only
     class _WildcardType:
+        '''Not exposed.'''
         def __bool__(self) -> Literal[False]: ...
     WILDCARD: _WildcardType
     '''Sentinel representing the event type of subscribers that accept any event name.'''

asyncutils/config.pyi

@@ -39,7 +39,7 @@ class sentinel_base:
 @final
 @type_check_only
 class _sentinel(sentinel_base):
-    '''Sentinels for this module, internal or public.'''
+    '''Sentinels for this module, internal or public. Not exported.'''
     def __reduce__(self) -> str: '''These sentinels are accessible in the top level of the asyncutils.config namespace.'''
 def set_logger_level(level: int) -> None: '''Set the level of the module-global logger.'''
 def get_past_logs() -> str: '''Returns all stored logs as a string. Logs are only stored if asyncutils was started with -l MEMORY, otherwise an empty string is returned.'''

asyncutils/func.pyi

@@ -43,15 +43,18 @@ class benchmark(tuple[float, float, float, float, int]):
     @property
     def total(self) -> float: '''The total execution time.'''
     @property
-    def avg(self) -> float: '''`total`/`iterations`.'''
+    def avg(self) -> float: '''`total/iterations`.'''
     @property
     def iterations(self) -> int: '''The `times` constructor parameter.'''
 @type_check_only
 class _everymethodrvrv[T, R](Protocol):
+    '''Not exported.'''
     async def __call__(_, self: T, /, *a: Any, **k: Any) -> R|None: ...
 @type_check_only
 class _everymethodft[T, R](Protocol):
+    '''Not exported.'''
     def __call__(_, self: T, /, *a: Any, **k: Any) -> Awaitable[R]: ...
 @type_check_only
 class _frv(Protocol):
+    '''Not exported.'''
     def __call__[T, **P](self, f: Callable[P, Awaitable[T]], /) -> Callable[P, Coroutine[Any, Any, T]]: ...

asyncutils/io.pyi

@@ -76,10 +76,11 @@ if sys.platform == 'win32': type _Seek = Literal[0, 1, 2]
 else: type _Seek = Literal[0, 1, 2, 3, 4]
 @type_check_only
 class _PipeFactory(Protocol):
+    '''Not exported.'''
     def __call__(self) -> tuple[int, int]: ...
 @type_check_only
 class _file(LoopContextMixin):
-    '''Not exposed at runtime. Calls itself asyncutils.io.file.'''
+    '''Not exposed. Calls itself asyncutils.io.file.'''
     if sys.platform != 'win32':
         def madvise(self, option: int, start: int=..., length: int|None=...) -> None: ...
     async def reg(self, m: mmap, /) -> None: ...

asyncutils/queues.pyi

@@ -37,7 +37,7 @@ class _G[R, T](_Q[R, T], Protocol):
     async def get(self, pwd: R) -> T:
         '''Removes and returns an item from the password-protected queue, if the password provided was correct; raises WrongPassword otherwise.
         If the queue is empty, waits until an item is available.'''
-    def get_nowait(self, pwd: R) -> T:        
+    def get_nowait(self, pwd: R) -> T:
         '''Removes and returns an item from the password-protected queue, if the password provided was correct; raises WrongPassword otherwise.
         If the queue is empty, raises asyncio.QueueEmpty.'''
 @type_check_only
@@ -53,11 +53,11 @@ class _P[R, T](_Q[R, T], Protocol):
 class _B[R, V, T](_G[R, T], _P[V, T], Protocol): '''Does not exist at runtime.'''
 @overload
 def password_queue[T, R](password_put: R, *, maxsize: int=..., protect_get: Literal[False]=..., protect_put: Literal[True]=..., can_change_put: bool=..., wait: bool=..., priority: bool=..., lifo: bool=..., raising: bool=..., put_from: str=..., puttyp: type[R]=..., init_items: SupportsIteration[T]=[], log: Callable[[str], None]=..., auditf: Callable[[Literal['asyncutils.queues.password_queue'], Literal[False], Literal[True], str, str], None]=...) -> _P[R, T]:
-    '''Returns a password-protected queue, inheriting from asyncio.Queue, with maximum size maxsize. priority and lifo parameters determine if the queue is a priority queue and last-in-first-out.
-    If protect_get is True, get and get_nowait will require a password, specified by password_get or retrieved from a variable in the caller's scope with name get_from (default 'password').
-    If protect_put is True, put and put_nowait will require a password, specified by password_put or retrieved from a variable in the caller's scope with name put_from (default 'password').
-    If init_items is specified, the items in that (async) iterable will be put into the queue immediately. If there are too many items in the (async) iterable, parameters wait and raising determine the behaviour; log is a function used to emit warnings in that case.
-    auditf (default sys.audit) is an audit function that takes the event name ('asyncutils.queues.password_queue'), protect_get, protect_put, get_from, put_from and returns None; note that the passwords are not passed to the audit function.'''
+    '''Returns a password-protected queue, the type of which inherits from asyncio.Queue, with maximum size `maxsize`. `priority` and `lifo` parameters determine if the queue is a priority queue and last-in-first-out.
+    If `protect_get` is True, get and get_nowait will require a password, specified by password_get or retrieved from a variable in the caller's scope with name `get_from` (default `password`).
+    If `protect_put` is True, put and put_nowait will require a password, specified by password_put or retrieved from a variable in the caller's scope with name `put_from` (default `password`).
+    If `init_items` is specified, the items in that (async) iterable will be put into the queue immediately. If there are too many items in the (async) iterable, parameters wait and raising determine the behaviour; log is a function used to emit warnings in that case.
+    `auditf` (default sys.audit) is an audit function that takes the event name ('asyncutils.queues.password_queue'), `protect_get`, `protect_put`, `get_from`, `put_from` and returns None; note that the passwords are not passed to the audit function.'''
 @overload
 def password_queue[T, R](*, maxsize: int=..., protect_get: Literal[False]=..., protect_put: Literal[True]=..., can_change_put: bool=..., wait: bool=..., priority: bool=..., lifo: bool=..., raising: bool=..., put_from: str=..., puttyp: type[R]=object, init_items: SupportsIteration[T]=[], log: Callable[[str], None]=..., auditf: Callable[[Literal['asyncutils.queues.password_queue'], Literal[False], Literal[True], str, str], None]=...) -> _P[R, T]: ...
 @overload
@@ -73,6 +73,7 @@ def password_queue[T, R, V](*, password_get: R, maxsize: int=..., protect_get: L
 @overload
 def password_queue[T, R, V](*, maxsize: int=..., protect_get: Literal[True], protect_put: Literal[True]=..., can_change_get: bool=..., can_change_put: bool=..., wait: bool=..., priority: bool=..., lifo: bool=..., raising: bool=..., get_from: str=..., put_from: str=..., gettyp: type[R]=object, puttyp: type[V]=object, init_items: SupportsIteration[T]=[], log: Callable[[str], None]=..., auditf: Callable[[Literal['asyncutils.queues.password_queue'], Literal[True], Literal[True], str, str], None]=...) -> _B[R, V, T]: ...
 class PotentQueueBase[T](Queue[T], EventualLoopMixin, metaclass=ABCMeta):
+    '''A base class for queues with much more methods, async- and sync-compatible.'''
     @abstractmethod
     def _init(self, maxsize: int) -> None: ...
     @abstractmethod