🐞 Types cased like Constants

[keithrfung]

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

[Meghwantsingh]

Hello , I would like to try this can I.

[keithrfung]

@Meghwantsingh You got it

[Meghwantsingh]

thx for assigning this problem sorry but I am currently working on some other project also so it may take some time or so sorry .

[keithrfung]

@Meghwantsingh That's ok. I'll unassign for now. No pressure. There will always be more code to write.

[faraazb]

Hello! I would like to work on this. If I am understanding correctly, I would have to refactor the types which are cased incorrectly with PascalCase throughout the repository, right?

[keithrfung]

@faraazb you got it! Yes. There are types for example GUARDIAN_ID = str that should be refactored to PascalCase, Python PEPs refer to this as CapWords.

Watch out and be sure not to refactor actual constants, for example something like CONSTANT = 123

[faraazb]

@keithrfung Thank you for the detailed instructions! I will start working on this.

[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?