pincer.objects.application_command.ApplicationCommand.add_option() - Code Metrics - Inspection of ":recycle: Refactored constants to types." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 0b9991...7eff65 )

unknown

created 2021-09-07 15:33 UTC

ApplicationCommand.add_option() A

↳ Parent: pincer.objects.application_command

Complexity

Conditions

Size

Total Lines	10
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

# -*- coding: utf-8 -*-

# MIT License
#
# Copyright (c) 2021 Pincer
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

from __future__ import annotations

from dataclasses import dataclass
from enum import Enum
from typing import List, Union

from pincer.utils.api_object import APIObject
from pincer.utils.snowflake import Snowflake
from pincer.utils.types import MISSING, APINullable


class ApplicationCommandType(Enum):
    """
    Defines the different types of application commands.

    :param CHAT_INPUT:
        Slash commands; a text-based command that shows up when a user
        types /

    :param USER:
        A UI-based command that shows up when you right click or tap on
        a user

    :param MESSAGE:
        A UI-based command that shows up when you right click or tap on
        a message
    """
    CHAT_INPUT = 1
    USER = 2
    MESSAGE = 3


class ApplicationCommandOptionType(Enum):
    """
    Represents a parameter type.

    :param SUB_COMMAND:
        The parameter will be a subcommand.

    :param SUB_COMMAND_GROUP:
        The parameter will be a group of subcommands.

    :param STRING:
        The parameter will be a string.

    :param INTEGER:
        The parameter will be an integer/number. (-2^53 and 2^53)

    :param BOOLEAN:
        The parameter will be a boolean.

    :param USER:
        The parameter will be a Discord user object.

    :param CHANNEL:
        The parameter will be a Discord channel object.

    :param ROLE:
        The parameter will be a Discord role object.

    :param MENTIONABLE:
        The parameter will be mentionable.

    :param NUMBER:
        The parameter will be a float. (-2^53 and 2^53)
    """
    SUB_COMMAND = 1
    SUB_COMMAND_GROUP = 2
    STRING = 3
    INTEGER = 4  # 54-bit
    BOOLEAN = 5
    USER = 6
    CHANNEL = 7
    ROLE = 8
    MENTIONABLE = 9
    NUMBER = 10  # 54-bit


@dataclass
class ApplicationCommandInteractionDataOption(APIObject):
    """
    Represents a Discord Application Command Interaction Data Option

    :param name:
        the name of the parameter

    :param type:
        value of application command option type

    :param value:
        the value of the pair

    :param options:
        present if this option is a group or subcommand
    """
    name: str
    type: int
    value: APINullable[ApplicationCommandOptionType] = MISSING
    options: APINullable[
        List[ApplicationCommandInteractionDataOption]] = MISSING


@dataclass
class ApplicationCommandOptionChoice(APIObject):
    """
    Represents a Discord Application Command Option Choice object

    :param name:
        1-100 character choice name

    :param value:
        value of the choice, up to 100 characters if string
    """
    name: str
    value: Union[str, int, float]


@dataclass
class ApplicationCommandOption(APIObject):
    """

    Represents a Discord Application Command Option object

    :param type:
        the type of option

    :param name:
        1-32 lowercase character name matching `^[\w-]{1,32}$`

    :param description:
        1-100 character description

    :param required:
        if the parameter is required or optional--default `False`

    :param choices:
        choices for `STRING`, `INTEGER`, and `NUMBER`
        types for the user to pick from, max 25

    :param options:
        if the option is a subcommand or subcommand group type,
        this nested options will be the parameters
    """
    type: ApplicationCommandOptionType
    name: str
    description: str

    required: APINullable[bool] = False
    choices: APINullable[List[ApplicationCommandOptionChoice]] = MISSING
    options: APINullable[List[ApplicationCommandOption]] = MISSING


@dataclass

class ApplicationCommand(APIObject):
    """
    Represents a Discord Application Command object

    :param id:
        unique id of the command

    :param type:
        the type of command, defaults `1` if not set

    :param application_id:
        unique id of the parent application

    :param guild_id:
        guild id of the command, if not global

    :param name:
        1-32 character name

    :param description:
        1-100 character description for `CHAT_INPUT` commands,
        empty string for `USER` and `MESSAGE` commands

    :param options:
        the parameters for the command, max 25

    :param default_permission:
        whether the command is enabled by default
        when the app is added to a guild
    """
    type: ApplicationCommandType
    name: str
    description: str

    id: APINullable[Snowflake] = MISSING

    application_id: APINullable[Snowflake] = MISSING
    options: APINullable[List[ApplicationCommandOption]] = MISSING
    guild_id: APINullable[Snowflake] = MISSING
    default_permission: APINullable[bool] = True

    def add_option(self, option: ApplicationCommandOption):
        """
        Add a new option field to the current application command.

        :param option: The option which will be appended.
        """
        if self.options:
            self.options.append(option)
        else:
            self.options = [option]


1			# -- coding: utf-8 --
			0 ignored issues – show introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# MIT License
3			#
4			# Copyright (c) 2021 Pincer
5			#
6			# Permission is hereby granted, free of charge, to any person obtaining
7			# a copy of this software and associated documentation files
8			# (the "Software"), to deal in the Software without restriction,
9			# including without limitation the rights to use, copy, modify, merge,
10			# publish, distribute, sublicense, and/or sell copies of the Software,
11			# and to permit persons to whom the Software is furnished to do so,
12			# subject to the following conditions:
13			#
14			# The above copyright notice and this permission notice shall be
15			# included in all copies or substantial portions of the Software.
16			#
17			# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18			# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19			# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20			# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21			# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22			# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23			# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24
25			from __future__ import annotations
26
27			from dataclasses import dataclass
28			from enum import Enum
29			from typing import List, Union
30
31			from pincer.utils.api_object import APIObject
32			from pincer.utils.snowflake import Snowflake
33			from pincer.utils.types import MISSING, APINullable
34
35
36			class ApplicationCommandType(Enum):
37			"""
38			Defines the different types of application commands.
39
40			:param CHAT_INPUT:
41			Slash commands; a text-based command that shows up when a user
42			types /
43
44			:param USER:
45			A UI-based command that shows up when you right click or tap on
46			a user
47
48			:param MESSAGE:
49			A UI-based command that shows up when you right click or tap on
50			a message
51			"""
52			CHAT_INPUT = 1
53			USER = 2
54			MESSAGE = 3
55
56
57			class ApplicationCommandOptionType(Enum):
58			"""
59			Represents a parameter type.
60
61			:param SUB_COMMAND:
62			The parameter will be a subcommand.
63
64			:param SUB_COMMAND_GROUP:
65			The parameter will be a group of subcommands.
66
67			:param STRING:
68			The parameter will be a string.
69
70			:param INTEGER:
71			The parameter will be an integer/number. (-2^53 and 2^53)
72
73			:param BOOLEAN:
74			The parameter will be a boolean.
75
76			:param USER:
77			The parameter will be a Discord user object.
78
79			:param CHANNEL:
80			The parameter will be a Discord channel object.
81
82			:param ROLE:
83			The parameter will be a Discord role object.
84
85			:param MENTIONABLE:
86			The parameter will be mentionable.
87
88			:param NUMBER:
89			The parameter will be a float. (-2^53 and 2^53)
90			"""
91			SUB_COMMAND = 1
92			SUB_COMMAND_GROUP = 2
93			STRING = 3
94			INTEGER = 4 # 54-bit
95			BOOLEAN = 5
96			USER = 6
97			CHANNEL = 7
98			ROLE = 8
99			MENTIONABLE = 9
100			NUMBER = 10 # 54-bit
101
102
103			@dataclass
104			class ApplicationCommandInteractionDataOption(APIObject):
105			"""
106			Represents a Discord Application Command Interaction Data Option
107
108			:param name:
109			the name of the parameter
110
111			:param type:
112			value of application command option type
113
114			:param value:
115			the value of the pair
116
117			:param options:
118			present if this option is a group or subcommand
119			"""
120			name: str
121			type: int
122			value: APINullable[ApplicationCommandOptionType] = MISSING
123			options: APINullable[
124			List[ApplicationCommandInteractionDataOption]] = MISSING
125
126
127			@dataclass
128			class ApplicationCommandOptionChoice(APIObject):
129			"""
130			Represents a Discord Application Command Option Choice object
131
132			:param name:
133			1-100 character choice name
134
135			:param value:
136			value of the choice, up to 100 characters if string
137			"""
138			name: str
139			value: Union[str, int, float]
140
141
142			@dataclass
143			class ApplicationCommandOption(APIObject):
144			"""
			1 ignored issue – show Bug introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report A suspicious escape sequence `\w` was found. Did you maybe forget to add an `r` prefix? Escape sequences in Python are generally interpreted according to rules similar to standard C. Only if strings are prefixed with `r` or `R` are they interpreted as regular expressions. The escape sequence that was used indicates that you might have intended to write a regular expression. Learn more about the available escape sequences. in the Python documentation. Loading history...
145			Represents a Discord Application Command Option object
146
147			:param type:
148			the type of option
149
150			:param name:
151			1-32 lowercase character name matching `^[\w-]{1,32}$`
152
153			:param description:
154			1-100 character description
155
156			:param required:
157			if the parameter is required or optional--default `False`
158
159			:param choices:
160			choices for `STRING`, `INTEGER`, and `NUMBER`
161			types for the user to pick from, max 25
162
163			:param options:
164			if the option is a subcommand or subcommand group type,
165			this nested options will be the parameters
166			"""
167			type: ApplicationCommandOptionType
168			name: str
169			description: str
170
171			required: APINullable[bool] = False
172			choices: APINullable[List[ApplicationCommandOptionChoice]] = MISSING
173			options: APINullable[List[ApplicationCommandOption]] = MISSING
174
175
176			@dataclass
			0 ignored issues – show best-practice introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report Too many instance attributes (8/7) Loading history...
177			class ApplicationCommand(APIObject):
178			"""
179			Represents a Discord Application Command object
180
181			:param id:
182			unique id of the command
183
184			:param type:
185			the type of command, defaults `1` if not set
186
187			:param application_id:
188			unique id of the parent application
189
190			:param guild_id:
191			guild id of the command, if not global
192
193			:param name:
194			1-32 character name
195
196			:param description:
197			1-100 character description for `CHAT_INPUT` commands,
198			empty string for `USER` and `MESSAGE` commands
199
200			:param options:
201			the parameters for the command, max 25
202
203			:param default_permission:
204			whether the command is enabled by default
205			when the app is added to a guild
206			"""
207			type: ApplicationCommandType
208			name: str
209			description: str
210
211			id: APINullable[Snowflake] = MISSING
			1 ignored issue – show Coding Style Naming introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report Attribute name "id" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,\|_[^\\WA-Z]*\|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern) This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
212			application_id: APINullable[Snowflake] = MISSING
213			options: APINullable[List[ApplicationCommandOption]] = MISSING
214			guild_id: APINullable[Snowflake] = MISSING
215			default_permission: APINullable[bool] = True
216
217			def add_option(self, option: ApplicationCommandOption):
218			"""
219			Add a new option field to the current application command.
220
221			:param option: The option which will be appended.
222			"""
223			if self.options:
224			self.options.append(option)
225			else:
226			self.options = [option]
227

Pincer-org / Pincer

Push — main ( 0b9991...7eff65 )

ApplicationCommand.add_option() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like