Skip to content
You're viewing docs for Dev. See the latest version →

Pydantic Extra Types Country

Country definitions that are based on the ISO 3166.

CountryAlpha2

Bases: str

CountryAlpha2 parses country codes in the ISO 3166-1 alpha-2 format.

from pydantic import BaseModel

from pydantic_extra_types.country import CountryAlpha2


class Product(BaseModel):
    made_in: CountryAlpha2


product = Product(made_in='ES')
print(product)
# > made_in='ES'

Attributes

alpha3

The country code in the ISO 3166-1 alpha-3 format.

Type: str

numeric_code

The country code in the ISO 3166-1 numeric format.

Type: str

short_name

The country short name.

Type: str

CountryAlpha3

Bases: str

CountryAlpha3 parses country codes in the ISO 3166-1 alpha-3 format.

from pydantic import BaseModel

from pydantic_extra_types.country import CountryAlpha3


class Product(BaseModel):
    made_in: CountryAlpha3


product = Product(made_in='USA')
print(product)
# > made_in='USA'

Attributes

alpha2

The country code in the ISO 3166-1 alpha-2 format.

Type: str

numeric_code

The country code in the ISO 3166-1 numeric format.

Type: str

short_name

The country short name.

Type: str

CountryNumericCode

Bases: str

CountryNumericCode parses country codes in the ISO 3166-1 numeric format.

from pydantic import BaseModel

from pydantic_extra_types.country import CountryNumericCode


class Product(BaseModel):
    made_in: CountryNumericCode


product = Product(made_in='840')
print(product)
# > made_in='840'

Attributes

alpha2

The country code in the ISO 3166-1 alpha-2 format.

Type: str

alpha3

The country code in the ISO 3166-1 alpha-3 format.

Type: str

short_name

The country short name.

Type: str

CountryShortName

Bases: str

CountryShortName parses country codes in the short name format.

from pydantic import BaseModel

from pydantic_extra_types.country import CountryShortName


class Product(BaseModel):
    made_in: CountryShortName


product = Product(made_in='United States')
print(product)
# > made_in='United States'

Attributes

alpha2

The country code in the ISO 3166-1 alpha-2 format.

Type: str

alpha3

The country code in the ISO 3166-1 alpha-3 format.

Type: str

numeric_code

The country code in the ISO 3166-1 numeric format.

Type: str