pincer.commands.interactable.Interactable.unassign() - Code Metrics - Inspection of ":sparkles: Rewrote command registration and added..." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#389)

by Yohann

created 2022-01-29 22:19 UTC

Interactable.unassign() B

↳ Parent: pincer.commands.interactable

Complexity

Conditions

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	13
dl	0
loc	20
rs	7.3333
c	0
b	0
f	0
cc	8
nop	1

# Copyright Pincer 2021-Present

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

from __future__ import annotations

from collections import ChainMap

from .. import client as _client
from .chat_command_handler import ChatCommandHandler
from .components.component_handler import ComponentHandler
from ..objects.app.command import AppCommand, InteractableStructure


INTERACTION_REGISTERS = ChainMap(ChatCommandHandler.register, ComponentHandler.register)


class Interactable:
    """
    Class that can register :class:`~pincer.commands.interactable.PartialInteractable`
    objects. Any class that subclasses this class can register Application Commands and
    Message Components.
    PartialInteractable objects are registered by running the register function and
    setting an attribute of the client to the result.
    """

    def __init__(self):
        for value in vars(type(self)).values():
            if isinstance(value, InteractableStructure):
                value.manager = self

    def __del__(self):
        self.unassign()

    def unassign(self):
        """
        Removes this objects loaded commands from ChatCommandHandler and
        ComponentHandler and removes loaded events from the client.
        """
        for value in vars(type(self)).values():
            if isinstance(value, InteractableStructure):
                if isinstance(value.metadata, AppCommand):
                    for key, _value in INTERACTION_REGISTERS.items():
                        if value is _value:
                            INTERACTION_REGISTERS.pop(key)

                key = value.call.__name__.lower()

                event_or_list = _client._events.get(key)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
                if isinstance(event_or_list, list):
                    if value in event_or_list:
                        event_or_list.remove(value)
                else:
                    _client._events.pop(key, None)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2022-01-16 19:09 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 __future__ import annotations
5
6			from collections import ChainMap
7
8			from .. import client as _client
9			from .chat_command_handler import ChatCommandHandler
10			from .components.component_handler import ComponentHandler
11			from ..objects.app.command import AppCommand, InteractableStructure
12
13
14			INTERACTION_REGISTERS = ChainMap(ChatCommandHandler.register, ComponentHandler.register)
15
16
17			class Interactable:
18			"""
19			Class that can register :class:`~pincer.commands.interactable.PartialInteractable`
20			objects. Any class that subclasses this class can register Application Commands and
21			Message Components.
22			PartialInteractable objects are registered by running the register function and
23			setting an attribute of the client to the result.
24			"""
25
26			def __init__(self):
27			for value in vars(type(self)).values():
28			if isinstance(value, InteractableStructure):
29			value.manager = self
30
31			def __del__(self):
32			self.unassign()
33
34			def unassign(self):
35			"""
36			Removes this objects loaded commands from ChatCommandHandler and
37			ComponentHandler and removes loaded events from the client.
38			"""
39			for value in vars(type(self)).values():
40			if isinstance(value, InteractableStructure):
41			if isinstance(value.metadata, AppCommand):
42			for key, _value in INTERACTION_REGISTERS.items():
43			if value is _value:
44			INTERACTION_REGISTERS.pop(key)
45
46			key = value.call.__name__.lower()
47
48			event_or_list = _client._events.get(key)
			0 ignored issues – show Coding Style Best Practice introduced 2022-01-19 01:13 UTC by Report Bug Copy Issue Report It seems like `_events` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
49			if isinstance(event_or_list, list):
50			if value in event_or_list:
51			event_or_list.remove(value)
52			else:
53			_client._events.pop(key, None)
			0 ignored issues – show Coding Style Best Practice introduced 2022-01-19 01:13 UTC by Report Bug Copy Issue Report It seems like `_events` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
54

Pincer-org / Pincer

Pull Request — main (#389)

Interactable.unassign() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like