feat: add additional operations to BaseFlags
#1486
Conversation
Implement addition (+), subtraction (-), union (|), intersection (&), and inverse (~) operations on the `Permissions` class and update the documentation accordingly. The addition and union operations are equivalent and their operators are interchangeable (and the latter is consequently omitted from the updated documentation). This allows for things such as adding two `Permissions` objects together to obtain the combined set of permissions they represent; subtracting two `Permissions` objects to set all permissions that are `True` in one object to `False` in the other; finding the intersection of two `Permissions` objects to obtain the set of permissions that are `True` in both; and inverting a `Permissions` object to set all of its `True` permissions to `False` and vice versa. The addition, subtraction, union, and intersection operations can operate on a `Permissions` object and a) another `Permissions` object, b) a `flag_value` object, or c) an integer. Reverse methods for each of these operations are also implemented, so both `Permissions.none() + Permissions.view_channel` and `Permissions.view_channel + Permissions.none()` will produce the same result, for example.
…ethod calls where possible
|
Considered adding this to all flags in |
Yeah this is what I was trying to say |
…d update documentation accordingly
celsiusnarhwal
changed the title
BaseFlags
That actually is a better idea; I made this PR with only the |
Middledot
added
status: awaiting review
Summary
This pull request implements addition (+), subtraction (-), union (|), intersection (&), and inversion (~) operations on the
BaseFlagsclass and accordingly updates the documentation for its inheritors. The addition and union operations are equivalent and their operators interchangeable.I made this change with the
Permissionsclass in mind, intending to enable functionality such as adding twoPermissionsobjects together to obtain the combined set of permissions they represent; subtracting twoPermissionsobjects to set all permissions that areTruein one object toFalsein the other; finding the intersection of twoPermissionsobjects to obtain the set of permissions that areTruein both; and inverting aPermissionsobject to set all of itsTruepermissions toFalseand vice versa. However, this PR enables these operations on all inheritors ofBaseFlags- the previously-described actions could be similarly applied to objects of theIntentsclass, for example.The addition, subtraction, union, and intersection operations can operate on a
BaseFlagsobject and a) anotherBaseFlagsobject, or b) aflag_valueobject. Reverse methods for each of these operations are also implemented, allowing operations betweenBaseFlagsandflag_valueobjects to be properly commutative.Information
Checklist
type: ignorecomments were used, a comment is also left explaining why.