Python - Enum Keys From Another Enum

Question

I have an enum class with the following code:

# enums.py
class AuthCode(Enum):
    ALREADY_AUTHENTICATED               = 1
    MISSING_EMAIL                       = 2
    MISSING_PASSWORD                    = 3
    MISSING_REGISTRATION_TOKEN_CODE     = 4
    INVALID_EMAIL                       = 5
    REDEEMED_EMAIL                      = 6
    INVALID_PASSWORD                    = 7
    INVALID_REGISTRATION_TOKEN_CODE     = 8
    REDEEMED_REGISTRATION_TOKEN_CODE    = 9
    INVALID_CREDENTIALS                 = 10
    SIGNIN_SUCCESSFUL                   = 11
    REGISTRATION_SUCCESSFUL             = 12

class AuthCodeMessage(Enum):
    AuthCode.ALREADY_AUTHENTICATED              = "User was already logged in"
    AuthCode.MISSING_EMAIL                      = "Email was not specified"
    AuthCode.MISSING_PASSWORD                   = "Password was not specified"
    AuthCode.MISSING_REGISTRATION_TOKEN_CODE    = "Registration token code was not specified"
    AuthCode.INVALID_EMAIL                      = "Email is invalid"
    AuthCode.REDEEMED_EMAIL                     = "An account with this email has been created already"
    AuthCode.INVALID_PASSWORD                   = "Password does not meet minimum password requirements"
    AuthCode.INVALID_REGISTRATION_TOKEN_CODE    = "Registration token code is invalid"
    AuthCode.REDEEMED_REGISTRATION_TOKEN_CODE   = "Registration token code has been redeemed already"
    AuthCode.INVALID_CREDENTIALS                = "Account with these credentials does not exist"
    AuthCode.SIGNIN_SUCCESSFUL                  = "User has been signed in successfully"
    AuthCode.REGISTRATION_SUCCESSFUL            = "User account has been created successfully"

Is it possible to define the second enum (AuthCodeMessage) the way it is defined (i.e., using another enum as a key). How can I retrieve the enum value?

Edit 1: I would like to call my this enumeration from my code using the an approach similar to the following:

from enums import AuthCode, AuthCodeMessage

def authResponse(authCode):
    AuthCode.ALREADY_AUTHENTICATED
    return jsonify({
        "code": authCode,
        "message": AuthCodeMessage.authCode
    })

authResponse(AuthCode.ALREADY_AUTHENTICATED)

Can you provide an example of how an enumerator from the second Enum-class may look like? — py_coffee
– py_coffee, Commented Jan 3, 2022 at 14:12
If I understand correctly, you are looking to see how I would like to call the second enumeration. Please see an example under Edit 1 — Sam
– Sam, Commented Jan 3, 2022 at 14:21
What is the first line in authResponse() supposed to be doing? Because it isn't doing anything. — Ethan Furman
– Ethan Furman, Commented Jan 3, 2022 at 17:51

Ethan Furman · Accepted Answer · 2022-01-03 17:42:14Z

2

Instead of using two enums, just use one. Using the AutoNumber recipe from the docs (the second one), your code would look like this:

class AuthCode(AutoNumber):
    ALREADY_AUTHENTICATED   = "User was already logged in"
    MISSING_EMAIL           = "Email was not specified"
    MISSING_PASSWORD        = "Password was not specified"
    ...
    
    def __init__(self, description):
        self.description = description

and later on:

def authResponse(authCode):
    return jsonify({
        "code": authCode.value,
        "message": authCode.description,
    })

--

Disclosure: I am the author of the Python stdlib Enum, the enum34 backport, and the Advanced Enumeration (aenum) library.

answered Jan 3, 2022 at 17:42

Ethan Furman

70.1k21 gold badges174 silver badges251 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Jasmijn · Accepted Answer · 2022-01-03 15:32:07Z

1

What you really want is to map AuthCodes to strings. The usual way to do this in Python is with a dictionary, like this:

AUTHCODE_MESSAGES = {
    AuthCode.ALREADY_AUTHENTICATED: "User was already logged in",
# copy the rest of the code/message pairs here
# make sure to replace the = with :
# and add a , on the end of every line
}

You can then use it like so:

# FIXME: enums is not a very clear name for what it does.
from enums import AuthCode, AUTHCODE_MESSAGES

def authResponse(authCode):
    return jsonify({
        "code": authCode,
        "message": AUTHCODE_MESSAGES[authCode]
    })

edited Jan 3, 2022 at 15:32

answered Jan 3, 2022 at 14:38

Jasmijn

10.7k2 gold badges33 silver badges49 bronze badges

Collectives™ on Stack Overflow

Python - Enum Keys From Another Enum

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related