pincer._config.GatewayConfig.uri() - Code Metrics - Inspection of ":sparkles: Support Discord Gateway Event Compressi..." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#160)

unknown

created 2021-10-24 14:08 UTC

pincer._config.GatewayConfig.uri() A

↳ Parent: pincer._config

Complexity

Conditions

Size

Total Lines	16
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	16
rs	10
c	0
b	0
f	0
cc	2
nop	0

# Copyright Pincer 2021-Present

# Full MIT License can be found in `LICENSE` at the project root.

from dataclasses import dataclass
from typing import Optional


@dataclass
class GatewayConfig:
    """
    This file is to make maintaining the library its gateway
        configuration easier.
    """
    socket_base_url: str = "wss://gateway.discord.gg/"
    version: int = 9
    encoding: str = "json"
    compression: Optional[str] = "zlib-stream"

    @staticmethod
    def uri() -> str:
        """
        :return uri:
            The GatewayConfig's uri.
        """
        uri = (
            f"{GatewayConfig.socket_base_url}"
            f"?v={GatewayConfig.version}"
            f"&encoding={GatewayConfig.encoding}"
        )

        if GatewayConfig.compressed():
            uri += f"&compress={GatewayConfig.compression}"

        return uri

    @staticmethod
    def compressed() -> bool:
        """
        :return compressed:
            Whether the Gateway should compress payloads or not.
        """
        return GatewayConfig.compression in ["zlib-stream", "zlib-payload"]


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-08-28 22:08 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			from dataclasses import dataclass
5			from typing import Optional
6
7
8			@dataclass
9			class GatewayConfig:
10			"""
11			This file is to make maintaining the library its gateway
12			configuration easier.
13			"""
14			socket_base_url: str = "wss://gateway.discord.gg/"
15			version: int = 9
16			encoding: str = "json"
17			compression: Optional[str] = "zlib-stream"
18
19			@staticmethod
20			def uri() -> str:
21			"""
22			:return uri:
23			The GatewayConfig's uri.
24			"""
25			uri = (
26			f"{GatewayConfig.socket_base_url}"
27			f"?v={GatewayConfig.version}"
28			f"&encoding={GatewayConfig.encoding}"
29			)
30
31			if GatewayConfig.compressed():
32			uri += f"&compress={GatewayConfig.compression}"
33
34			return uri
35
36			@staticmethod
37			def compressed() -> bool:
38			"""
39			:return compressed:
40			Whether the Gateway should compress payloads or not.
41			"""
42			return GatewayConfig.compression in ["zlib-stream", "zlib-payload"]
43

Pincer-org / Pincer

Pull Request — main (#160)

pincer._config.GatewayConfig.uri() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like