🐞 Types cased like Constants

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

There are some types such as GUARDIAN_ID that are cased incorrectly. These variables function as types and not constants and therefore should be using “CapWords” since these are actually functioning as Type’s.

https://www.python.org/dev/peps/pep-0008/

Expected Behavior

Global Constants should be capitalized with underscores THRESHOLD = 3

Classes and Types should be like this: GuardianId = str

Steps To Reproduce

No response

Environment

- OS: Any

Anything else?

It’s probably helpful just to look at the types from this level for speed.

https://github.com/microsoft/electionguard-python/blob/main/src/electionguard/__init__.py https://github.com/microsoft/electionguard-python/blob/main/src/electionguard_tools/__init__.py https://github.com/microsoft/electionguard-python/blob/main/src/electionguard_verify/__init__.py

[keithrfung]

@faraazb Interesting dilemma. That’s a good catch.

Change to Private In this case, I think the best case is to change these to private. These don’t need to be exported since these are simply strings and shouldn’t be cast. These types are strings and serving the purpose of making these more readable.

_AuxiliaryPublicKey _AuxiliarySecretKey _Message _EncryptedMessage

Other notes: There is probably an overall naming scheme around public key that should get revisited @AddressXception .

[faraazb]

@keithrfung There is already a class named AuxiliaryPublicKey. So should I postfix the type AUXILIARY_PUBLIC_KEY with ‘Type’ and rename it as AuxiliaryPublicKeyType? We also have AUXILIARY_SECRET_KEY, so should I append ‘Type’ to that as well to be consistent?