Skip to content

Commit e44e085

Browse files
committed
Use relative imports everywhere, for consistency.
Fix #946.
1 parent 70fadbf commit e44e085

File tree

5 files changed

+14
-11
lines changed

5 files changed

+14
-11
lines changed

docs/api/extensions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Per-Message Deflate
1313
Abstract classes
1414
----------------
1515

16-
.. automodule:: websockets.extensions.base
16+
.. automodule:: websockets.extensions
1717

1818
.. autoclass:: Extension
1919
:members:

docs/extensions.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,8 @@ As a consequence, writing an extension requires implementing several classes:
9191
``websockets`` provides abstract base classes for extension factories and
9292
extensions. See the API documentation for details on their methods:
9393

94-
* :class:`~base.ClientExtensionFactory` and
95-
:class:`~base.ServerExtensionFactory` for extension factories,
96-
97-
* :class:`~base.Extension` for extensions.
94+
* :class:`ClientExtensionFactory` and class:`ServerExtensionFactory` for
95+
:extension factories,
96+
* :class:`Extension` for extensions.
9897

9998

src/websockets/extensions/__init__.py

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
from .base import *
2+
3+
4+
__all__ = ["Extension", "ClientExtensionFactory", "ServerExtensionFactory"]

src/websockets/frames.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ def parse(
103103
*,
104104
mask: bool,
105105
max_size: Optional[int] = None,
106-
extensions: Optional[Sequence["websockets.extensions.base.Extension"]] = None,
106+
extensions: Optional[Sequence["extensions.Extension"]] = None,
107107
) -> Generator[None, None, "Frame"]:
108108
"""
109109
Read a WebSocket frame.
@@ -172,7 +172,7 @@ def serialize(
172172
self,
173173
*,
174174
mask: bool,
175-
extensions: Optional[Sequence["websockets.extensions.base.Extension"]] = None,
175+
extensions: Optional[Sequence["extensions.Extension"]] = None,
176176
) -> bytes:
177177
"""
178178
Write a WebSocket frame.
@@ -338,4 +338,4 @@ def check_close(code: int) -> None:
338338

339339

340340
# at the bottom to allow circular import, because Extension depends on Frame
341-
import websockets.extensions.base # isort:skip # noqa
341+
from . import extensions # isort:skip # noqa

src/websockets/legacy/framing.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ async def read(
3131
*,
3232
mask: bool,
3333
max_size: Optional[int] = None,
34-
extensions: Optional[Sequence["websockets.extensions.base.Extension"]] = None,
34+
extensions: Optional[Sequence["extensions.Extension"]] = None,
3535
) -> "Frame":
3636
"""
3737
Read a WebSocket frame.
@@ -102,7 +102,7 @@ def write(
102102
write: Callable[[bytes], Any],
103103
*,
104104
mask: bool,
105-
extensions: Optional[Sequence["websockets.extensions.base.Extension"]] = None,
105+
extensions: Optional[Sequence["extensions.Extension"]] = None,
106106
) -> None:
107107
"""
108108
Write a WebSocket frame.
@@ -132,4 +132,4 @@ def write(
132132

133133

134134
# at the bottom to allow circular import, because Extension depends on Frame
135-
import websockets.extensions.base # isort:skip # noqa
135+
from .. import extensions # isort:skip # noqa

0 commit comments

Comments
 (0)