Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve typing information #163

Merged
merged 1 commit into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/hyperframe/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
"""
hyperframe
~~~~~~~~~~
Expand Down
1 change: 0 additions & 1 deletion src/hyperframe/exceptions.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
"""
hyperframe/exceptions
~~~~~~~~~~~~~~~~~~~~~
Expand Down
1 change: 0 additions & 1 deletion src/hyperframe/flags.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
"""
hyperframe/flags
~~~~~~~~~~~~~~~~
Expand Down
23 changes: 11 additions & 12 deletions src/hyperframe/frame.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
"""
hyperframe/frame
~~~~~~~~~~~~~~~~
Expand All @@ -9,12 +8,12 @@
"""
import struct
import binascii
from typing import Any, Iterable, Optional, Type

from .exceptions import (
UnknownFrameError, InvalidPaddingError, InvalidFrameError, InvalidDataError
)
from .flags import Flag, Flags
from typing import Optional, Tuple, List, Iterable, Any, Dict, Type


# The maximum initial length of a frame. Some frames have shorter maximum
Expand Down Expand Up @@ -44,7 +43,7 @@ class Frame:
The base class for all HTTP/2 frames.
"""
#: The flags defined on this type of frame.
defined_flags: List[Flag] = []
defined_flags: list[Flag] = []

#: The byte used to define the type of the frame.
type: Optional[int] = None
Expand Down Expand Up @@ -99,7 +98,7 @@ def _body_repr(self) -> str:
return _raw_data_repr(self.serialize_body())

@staticmethod
def explain(data: memoryview) -> Tuple["Frame", int]:
def explain(data: memoryview) -> tuple["Frame", int]:
"""
Takes a bytestring and tries to parse a single frame and print it.

Expand All @@ -116,7 +115,7 @@ def explain(data: memoryview) -> Tuple["Frame", int]:
return frame, length

@staticmethod
def parse_frame_header(header: memoryview, strict: bool = False) -> Tuple["Frame", int]:
def parse_frame_header(header: memoryview, strict: bool = False) -> tuple["Frame", int]:
"""
Takes a 9-byte frame header and returns a tuple of the appropriate
Frame object and the length that needs to be read from the socket.
Expand Down Expand Up @@ -343,7 +342,7 @@ class PriorityFrame(Priority, Frame):
reprioritisation of existing streams.
"""
#: The flags defined for PRIORITY frames.
defined_flags: List[Flag] = []
defined_flags: list[Flag] = []

#: The type byte defined for PRIORITY frames.
type = 0x02
Expand Down Expand Up @@ -381,7 +380,7 @@ class RstStreamFrame(Frame):
occurred.
"""
#: The flags defined for RST_STREAM frames.
defined_flags: List[Flag] = []
defined_flags: list[Flag] = []

#: The type byte defined for RST_STREAM frames.
type = 0x03
Expand Down Expand Up @@ -454,7 +453,7 @@ class SettingsFrame(Frame):
#: The byte that signals SETTINGS_ENABLE_CONNECT_PROTOCOL setting.
ENABLE_CONNECT_PROTOCOL = 0x08

def __init__(self, stream_id: int = 0, settings: Optional[Dict[int, int]] = None, **kwargs: Any) -> None:
def __init__(self, stream_id: int = 0, settings: Optional[dict[int, int]] = None, **kwargs: Any) -> None:
super().__init__(stream_id, **kwargs)

if settings and "ACK" in kwargs.get("flags", ()):
Expand All @@ -463,7 +462,7 @@ def __init__(self, stream_id: int = 0, settings: Optional[Dict[int, int]] = None
)

#: A dictionary of the setting type byte to the value of the setting.
self.settings = settings or {}
self.settings: dict[int, int] = settings or {}

def _body_repr(self) -> str:
return "settings={}".format(
Expand Down Expand Up @@ -611,7 +610,7 @@ class GoAwayFrame(Frame):
connection.
"""
#: The flags defined for GOAWAY frames.
defined_flags: List[Flag] = []
defined_flags: list[Flag] = []

#: The type byte defined for GOAWAY frames.
type = 0x07
Expand Down Expand Up @@ -679,7 +678,7 @@ class WindowUpdateFrame(Frame):
original sender.
"""
#: The flags defined for WINDOW_UPDATE frames.
defined_flags: List[Flag] = []
defined_flags: list[Flag] = []

#: The type byte defined for WINDOW_UPDATE frames.
type = 0x08
Expand Down Expand Up @@ -951,7 +950,7 @@ def _raw_data_repr(data: Optional[bytes]) -> str:
return "<hex:" + r + ">"


_FRAME_CLASSES: List[Type[Frame]] = [
_FRAME_CLASSES: list[Type[Frame]] = [
DataFrame,
HeadersFrame,
PriorityFrame,
Expand Down
Loading