'NO'/"NO" (string enum value) gets serialized to False_ ?

[tommyjcarpenter]

I have a really bizarre issue where the string 'NO' (ISO country code for Norway - we need this literal string to be an enum value), as part of an enum, is getting serlialized to False

we have an enum of ISO codes that includes the literal string 'NO' - I have tried this without quotes, and with both single and double

    MyModel:
      type: object
      additionalProperties: false
      required:
      - country_code
      properties:
        country_code:
            type: string
            example: US
            enum:
              - 'AE'
              - 'AR'
             ...
              - 'NL'
              - 'NO' <----------- have tried just NO, 'NO', and "NO" 
              - 'NZ'
             ...

using the generation flags:

    --strict-types str bool 
    --set-default-enum-member 
    --enum-field-as-literal one 
    --use-default  
    --strict-nullable 
    --collapse-root-models 
    --output-model-type pydantic_v2.BaseModel

we get the following output!

class CountryCode(Enum):
    AE = "AE"
    AR = "AR"
    ...
    NL = "NL"
    False_ = False  <------------- !!
    NZ = "NZ"
    ...

'NO' becomes False! Can you please let me know how to not do that?

Thanks much

[tommyjcarpenter]

@koxudaxi 🙏

[koxudaxi]

I just tried to your example.
But, the result includes NO

[koxudaxi]

@tommyjcarpenter
I guess your complaint comes from pyyaml behavior.
yaml/pyyaml#376

I confirmed the problem when I removed the single quotes.

[tommyjcarpenter]

@koxudaxi that's it - my original comment of trying quotes wasn't quite correct, because our openapi goes through a resolver, which spits out a fully resolved openapi that is missing the quotes - which then uses this package, and produces those results

thanks so much for your help.. i will need to dig into the resolver to see if I can fix this 😢

[koxudaxi]

Do you use pyyaml?
datamodel-code-generator ignores the behavior for timestamp string by using the code.

datamodel-code-generator/datamodel_code_generator/util.py

Lines 54 to 56 in 54800a1

	SafeLoader.yaml_constructors[
	'tag:yaml.org,2002:timestamp'
	] = SafeLoader.yaml_constructors['tag:yaml.org,2002:str']

I can see the URL(tag:yaml.org,2002:bool) for bool in the yaml document
https://yaml.org/type/bool.html

By the way, thank you for your sponsoring me 😄

[tommyjcarpenter]

@koxudaxi i asked my company if i could sponsor you with their money for more.. but no luck yet. you've been extremely helpful, my pleasure

we are using ruamel as a preprocessing step before the generator, and that is what is losing the quotes, which only affects this NO case. so, im looking into the flags for that to ...not do this

This issue is near the top of the list of dumbest things I've spent time on 😂

[koxudaxi]

@tommyjcarpenter

i asked my company if i could sponsor you with their money for more.. but no luck yet. you've been extremely helpful, my pleasure

I'm happy to hear the comment:smile_cat:

we are using ruamel as a preprocessing step before the generator,

Can you convert the yaml to json before passing yaml to datamldel-code-generator? If my understanding is correct, you can avoid the yaml issue.

[tommyjcarpenter]

@koxudaxi i tried this:

cat apis/openapi_resolved.yaml | yq e -o=json - > /tmp/as_json.json
datamodel-codegen --strict-types str bool --set-default-enum-member --enum-field-as-literal one --input-file-type openapi --input /tmp/as_json.json --output indexapi_types/pydantic_v2_types.py --use-default  --strict-nullable --collapse-root-models --output-model-type pydantic_v2.BaseModel

but that didnt seem to work, im double checking

[koxudaxi]

@tommyjcarpenter

@koxudaxi this is even a bigger problem because the JSON is double quoted in that output:

Sorry, I don't understand the problem. I can generate the enum from the json file 🤔

[tommyjcarpenter]

@koxudaxi sorry you are right - I was looking at the wrong output 🤦 converting to JSON works!

should this be noted somewhere? This was a nasty one to track down.

thanks much