Choice Enums

[ashutshkumr]

There are usually two kinds of containers wrt. choice enums:

• A container where all properties are related to choice enums.

  # generated by openapi; possible values: fixed, list, counter, random
  pattern = Pattern(choice='counter', counter=Counter(...))
  # generated by abstract python package
  pattern = Pattern(Counter(...))

• A container where some properties are related to choice enums while some are not.

  # generated by openapi; possible values: basic, pcap
  capture = Capture(name='c1', choice='basic', basic=BasicFilter(...))
  # generated by abstract python package
  capture = Capture(name='c1', choice=BasicFilter(...))

Problem is, in latter, we end up assigning the intended value to choice property which may seem confusing for following reasons:

• It is not very descriptive
• Meaning of choice is now overloaded between internal (string) and external (any object) representation

A possible solution is to always mandate (as a contribution guideline) that whenever a choice is required inside a container, it should not contain any other unrelated properties. e.g.

# generated by openapi; possible values: basic, pcap
capture = Capture(name='c1', filter=Filter(choice='basic', basic=BasicFilter(...)))
# generated by abstract python package
capture = Capture(name='c1', filter=BasicFilter(...))