-
-
Notifications
You must be signed in to change notification settings - Fork 614
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fixup! squash! Implement Enums for Role and State constants in contro…
…lTypes (#12510)
- Loading branch information
Showing
5 changed files
with
92 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,71 @@ | ||
| # A part of NonVisual Desktop Access (NVDA) | ||
| # This file is covered by the GNU General Public License. | ||
| # See the file COPYING for more details. | ||
| # Copyright (C) 2021 NV Access Limited. | ||
|
|
||
| from abc import ABC, ABCMeta, abstractproperty | ||
| from enum import Enum, EnumMeta | ||
| from typing import Dict | ||
|
|
||
| from logHandler import log | ||
|
|
||
|
|
||
| class DisplayStringEnumMixinMeta(ABCMeta, EnumMeta): | ||
| """ | ||
| This helps correct the Method Resolution Order (MRO) when using the `DisplayStringEnumMixin`. | ||
| When creating an Enum with a Mixin, Python suggest an ordering of | ||
| `class EnumWithMixin(Mixin, type, EnumClass):`. | ||
| This creates a metaclass conflict as both DisplayStringEnumMixin and Enum both have metaclasses, | ||
| ABCMeta and EnumMeta. This requires a new MetaClass which subclasses both of these. This follows the | ||
| same ordering of the EnumWithMixin usage. | ||
| See `DisplayStringEnumMixin`. | ||
| """ | ||
| pass | ||
|
|
||
|
|
||
| class DisplayStringEnumMixin(ABC): | ||
| """ | ||
| This mixin can be used with a class which subclasses Enum to provided translated display strings for | ||
| members of the enum. The abstract properties must be overridden. | ||
| To be used with `DisplayStringEnumMixinMeta`. | ||
| Usage for python 3.7 is as follows: | ||
| ``` | ||
| class ExampleEnum(DisplayStringEnumMixin, str, Enum, metaclass=DisplayStringEnumMixinMeta): | ||
| pass | ||
| class ExampleIntEnum(DisplayStringEnumMixin, IntEnum, metaclass=DisplayStringEnumMixinMeta): | ||
| pass | ||
| ``` | ||
| """ | ||
| @abstractproperty | ||
| def _displayStringLabels(self) -> Dict[Enum, str]: | ||
| """ | ||
| Specify a dictionary which takes members of the Enum and returns the translated display string. | ||
| """ | ||
| pass | ||
|
|
||
| @abstractproperty | ||
| def defaultValue(self) -> Enum: | ||
| """ | ||
| Specify an Enum member with a known translated display string to use as a default if there is no known | ||
| display string for a given member in _displayStringLabels. | ||
| """ | ||
| pass | ||
|
|
||
| @property | ||
| def displayString(self) -> str: | ||
| """ | ||
| @return: The translated UI display string that should be used for this value of the enum. | ||
| """ | ||
| try: | ||
| return self._displayStringLabels[self] | ||
| except KeyError: | ||
| log.error(f"No translation mapping for: {self}") | ||
| return self._displayStringLabels[self.defaultValue] | ||
| # A part of NonVisual Desktop Access (NVDA) | ||
| # This file is covered by the GNU General Public License. | ||
| # See the file COPYING for more details. | ||
| # Copyright (C) 2021 NV Access Limited. | ||
|
|
||
| from abc import ABC, ABCMeta, abstractproperty | ||
| from enum import Enum, EnumMeta, IntEnum | ||
| from typing import Dict | ||
|
|
||
| from logHandler import log | ||
|
|
||
|
|
||
| class _DisplayStringEnumMixinMeta(ABCMeta, EnumMeta): | ||
| """ | ||
| This helps correct the Method Resolution Order (MRO) when using the `_DisplayStringEnumMixin`. | ||
| When creating an Enum with a Mixin, Python suggest an ordering of | ||
| `class EnumWithMixin(Mixin, type, EnumClass):`. | ||
| This creates a metaclass conflict as both _DisplayStringEnumMixin and Enum both have metaclasses, | ||
| ABCMeta and EnumMeta. This requires a new MetaClass which subclasses both of these. This follows the | ||
| same ordering of the EnumWithMixin usage. | ||
| See `_DisplayStringEnumMixin`. | ||
| """ | ||
| pass | ||
|
|
||
|
|
||
| class _DisplayStringEnumMixin(ABC): | ||
| """ | ||
| This mixin can be used with a class which subclasses Enum to provided translated display strings for | ||
| members of the enum. The abstract properties must be overridden. | ||
| To be used with `_DisplayStringEnumMixinMeta`. | ||
| Usage for python 3.7 is as follows: | ||
| ``` | ||
| class ExampleEnum(_DisplayStringEnumMixin, str, Enum, metaclass=_DisplayStringEnumMixinMeta): | ||
| pass | ||
| class ExampleIntEnum(_DisplayStringEnumMixin, IntEnum, metaclass=_DisplayStringEnumMixinMeta): | ||
| pass | ||
| ``` | ||
| """ | ||
| @abstractproperty | ||
| def _displayStringLabels(self) -> Dict[Enum, str]: | ||
| """ | ||
| Specify a dictionary which takes members of the Enum and returns the translated display string. | ||
| """ | ||
| pass | ||
|
|
||
| @property | ||
| def displayString(self) -> str: | ||
| """ | ||
| @return: The translated UI display string that should be used for this value of the enum. | ||
| """ | ||
| try: | ||
| return self._displayStringLabels[self] | ||
| except KeyError as e: | ||
| log.error(f"No translation mapping for: {self}") | ||
| raise e | ||
|
|
||
|
|
||
| class DisplayStringEnum(_DisplayStringEnumMixin, Enum, metaclass=_DisplayStringEnumMixinMeta): | ||
| """An Enum class that adds a displayString property defined by _displayStringLabels""" | ||
| pass | ||
|
|
||
|
|
||
| class DisplayStringStrEnum(_DisplayStringEnumMixin, str, Enum, metaclass=_DisplayStringEnumMixinMeta): | ||
| """A str Enum class that adds a displayString property defined by _displayStringLabels""" | ||
| pass | ||
|
|
||
|
|
||
| class DisplayStringIntEnum(_DisplayStringEnumMixin, IntEnum, metaclass=_DisplayStringEnumMixinMeta): | ||
| """An IntEnum class that adds a displayString property defined by _displayStringLabels""" | ||
| pass |