pincer._config.GatewayConfig.make_uri() - Code Metrics - Inspection of ":bug: :sparkles: Added VERY basic sharding support..." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#329)

unknown

created 2021-12-26 23:38 UTC

pincer._config.GatewayConfig.make_uri() A

↳ Parent: pincer._config

Complexity

Conditions

Size

Total Lines	13
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	13
rs	10
c	0
b	0
f	0
cc	1
nop	2

# 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(repr=False)
class GatewayConfig:
    """This file is to make maintaining the library and its gateway
    configuration easier.
    """
    MAX_RETRIES: int = 5
    version: int = 9
    encoding: str = "json"
    compression: Optional[str] = "zlib-stream"

    @classmethod
    def make_uri(cls, uri) -> str:
        """
        Returns
        -------
        :class:`str`:
            The GatewayConfig's uri.
        """
        return (
            f"{uri}"
            f"?v={cls.version}"
            f"&encoding={cls.encoding}"
        ) + f"&compress={cls.compression}" * cls.compressed()

    @classmethod
    def compressed(cls) -> bool:
        """
        Returns
        -------
        :class:`bool`:
            Whether the Gateway should compress payloads or not.
        """
        return cls.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(repr=False)
9			class GatewayConfig:
10			"""This file is to make maintaining the library and its gateway
11			configuration easier.
12			"""
13			MAX_RETRIES: int = 5
14			version: int = 9
15			encoding: str = "json"
16			compression: Optional[str] = "zlib-stream"
17
18			@classmethod
19			def make_uri(cls, uri) -> str:
20			"""
21			Returns
22			-------
23			:class:`str`:
24			The GatewayConfig's uri.
25			"""
26			return (
27			f"{uri}"
28			f"?v={cls.version}"
29			f"&encoding={cls.encoding}"
30			) + f"&compress={cls.compression}" * cls.compressed()
31
32			@classmethod
33			def compressed(cls) -> bool:
34			"""
35			Returns
36			-------
37			:class:`bool`:
38			Whether the Gateway should compress payloads or not.
39			"""
40			return cls.compression in ["zlib-stream", "zlib-payload"]
41

Pincer-org / Pincer

Pull Request — main (#329)

pincer._config.GatewayConfig.make_uri() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like