Closes #12194: Add pre-defined custom field choices (#13219)

* Initial work on custom field choice sets

* Rename choices to extra_choices (prep for #12194)

* Remove CustomField.choices

* Add & update tests

* Clean up table columns

* Add order_alphanetically boolean for choice sets

* Introduce ArrayColumn for choice lists

* Show dependent custom fields on choice set view

* Update custom fields documentation

* Introduce ArrayWidget for more convenient editing of choices

* Incorporate PR feedback

* Misc cleanup

* Initial work on predefined choices for custom fields

* Misc cleanup

* Add IATA airport codes

* #13241: Add support for custom field choice labels

* Restore ArrayColumn

* Misc cleanup

* Change extra_choices back to a nested ArrayField to preserve choice ordering

* Hack to bypass GraphQL API test utility absent support for nested ArrayFields

netbox/extras/data/__init__.py

@@ -0,0 +1,9 @@
+from .iata import IATA
+from .iso_3166 import ISO_3166
+from .un_locode import UN_LOCODE
+
+CHOICE_SETS = {
+    'IATA': IATA,
+    'ISO_3166': ISO_3166,
+    'UN_LOCODE': UN_LOCODE,
+}

netbox/extras/data/iso_3166.py

@@ -0,0 +1,253 @@
+# Two-letter country codes defined by ISO 3166
+# Source: https://datahub.io/core/country-list
+ISO_3166 = [
+    ('AD', 'AD (Andorra)'),
+    ('AE', 'AE (United Arab Emirates)'),
+    ('AF', 'AF (Afghanistan)'),
+    ('AG', 'AG (Antigua and Barbuda)'),
+    ('AI', 'AI (Anguilla)'),
+    ('AL', 'AL (Albania)'),
+    ('AM', 'AM (Armenia)'),
+    ('AO', 'AO (Angola)'),
+    ('AQ', 'AQ (Antarctica)'),
+    ('AR', 'AR (Argentina)'),
+    ('AS', 'AS (American Samoa)'),
+    ('AT', 'AT (Austria)'),
+    ('AU', 'AU (Australia)'),
+    ('AW', 'AW (Aruba)'),
+    ('AX', 'AX (Åland Islands)'),
+    ('AZ', 'AZ (Azerbaijan)'),
+    ('BA', 'BA (Bosnia and Herzegovina)'),
+    ('BB', 'BB (Barbados)'),
+    ('BD', 'BD (Bangladesh)'),
+    ('BE', 'BE (Belgium)'),
+    ('BF', 'BF (Burkina Faso)'),
+    ('BG', 'BG (Bulgaria)'),
+    ('BH', 'BH (Bahrain)'),
+    ('BI', 'BI (Burundi)'),
+    ('BJ', 'BJ (Benin)'),
+    ('BL', 'BL (Saint Barthélemy)'),
+    ('BM', 'BM (Bermuda)'),
+    ('BN', 'BN (Brunei Darussalam)'),
+    ('BO', 'BO (Bolivia, Plurinational State of)'),
+    ('BQ', 'BQ (Bonaire, Sint Eustatius and Saba)'),
+    ('BR', 'BR (Brazil)'),
+    ('BS', 'BS (Bahamas)'),
+    ('BT', 'BT (Bhutan)'),
+    ('BV', 'BV (Bouvet Island)'),
+    ('BW', 'BW (Botswana)'),
+    ('BY', 'BY (Belarus)'),
+    ('BZ', 'BZ (Belize)'),
+    ('CA', 'CA (Canada)'),
+    ('CC', 'CC (Cocos (Keeling) Islands)'),
+    ('CD', 'CD (Congo, the Democratic Republic of the)'),
+    ('CF', 'CF (Central African Republic)'),
+    ('CG', 'CG (Congo)'),
+    ('CH', 'CH (Switzerland)'),
+    ('CI', "CI (Côte d'Ivoire)"),
+    ('CK', 'CK (Cook Islands)'),
+    ('CL', 'CL (Chile)'),
+    ('CM', 'CM (Cameroon)'),
+    ('CN', 'CN (China)'),
+    ('CO', 'CO (Colombia)'),
+    ('CR', 'CR (Costa Rica)'),
+    ('CU', 'CU (Cuba)'),
+    ('CV', 'CV (Cape Verde)'),
+    ('CW', 'CW (Curaçao)'),
+    ('CX', 'CX (Christmas Island)'),
+    ('CY', 'CY (Cyprus)'),
+    ('CZ', 'CZ (Czech Republic)'),
+    ('DE', 'DE (Germany)'),
+    ('DJ', 'DJ (Djibouti)'),
+    ('DK', 'DK (Denmark)'),
+    ('DM', 'DM (Dominica)'),
+    ('DO', 'DO (Dominican Republic)'),
+    ('DZ', 'DZ (Algeria)'),
+    ('EC', 'EC (Ecuador)'),
+    ('EE', 'EE (Estonia)'),
+    ('EG', 'EG (Egypt)'),
+    ('EH', 'EH (Western Sahara)'),
+    ('ER', 'ER (Eritrea)'),
+    ('ES', 'ES (Spain)'),
+    ('ET', 'ET (Ethiopia)'),
+    ('FI', 'FI (Finland)'),
+    ('FJ', 'FJ (Fiji)'),
+    ('FK', 'FK (Falkland Islands (Malvinas))'),
+    ('FM', 'FM (Micronesia, Federated States of)'),
+    ('FO', 'FO (Faroe Islands)'),
+    ('FR', 'FR (France)'),
+    ('GA', 'GA (Gabon)'),
+    ('GB', 'GB (United Kingdom)'),
+    ('GD', 'GD (Grenada)'),
+    ('GE', 'GE (Georgia)'),
+    ('GF', 'GF (French Guiana)'),
+    ('GG', 'GG (Guernsey)'),
+    ('GH', 'GH (Ghana)'),
+    ('GI', 'GI (Gibraltar)'),
+    ('GL', 'GL (Greenland)'),
+    ('GM', 'GM (Gambia)'),
+    ('GN', 'GN (Guinea)'),
+    ('GP', 'GP (Guadeloupe)'),
+    ('GQ', 'GQ (Equatorial Guinea)'),
+    ('GR', 'GR (Greece)'),
+    ('GS', 'GS (South Georgia and the South Sandwich Islands)'),
+    ('GT', 'GT (Guatemala)'),
+    ('GU', 'GU (Guam)'),
+    ('GW', 'GW (Guinea-Bissau)'),
+    ('GY', 'GY (Guyana)'),
+    ('HK', 'HK (Hong Kong)'),
+    ('HM', 'HM (Heard Island and McDonald Islands)'),
+    ('HN', 'HN (Honduras)'),
+    ('HR', 'HR (Croatia)'),
+    ('HT', 'HT (Haiti)'),
+    ('HU', 'HU (Hungary)'),
+    ('ID', 'ID (Indonesia)'),
+    ('IE', 'IE (Ireland)'),
+    ('IL', 'IL (Israel)'),
+    ('IM', 'IM (Isle of Man)'),
+    ('IN', 'IN (India)'),
+    ('IO', 'IO (British Indian Ocean Territory)'),
+    ('IQ', 'IQ (Iraq)'),
+    ('IR', 'IR (Iran, Islamic Republic of)'),
+    ('IS', 'IS (Iceland)'),
+    ('IT', 'IT (Italy)'),
+    ('JE', 'JE (Jersey)'),
+    ('JM', 'JM (Jamaica)'),
+    ('JO', 'JO (Jordan)'),
+    ('JP', 'JP (Japan)'),
+    ('KE', 'KE (Kenya)'),
+    ('KG', 'KG (Kyrgyzstan)'),
+    ('KH', 'KH (Cambodia)'),
+    ('KI', 'KI (Kiribati)'),
+    ('KM', 'KM (Comoros)'),
+    ('KN', 'KN (Saint Kitts and Nevis)'),
+    ('KP', "KP (Korea, Democratic People's Republic of)"),
+    ('KR', 'KR (Korea, Republic of)'),
+    ('KW', 'KW (Kuwait)'),
+    ('KY', 'KY (Cayman Islands)'),
+    ('KZ', 'KZ (Kazakhstan)'),
+    ('LA', "LA (Lao People's Democratic Republic)"),
+    ('LB', 'LB (Lebanon)'),
+    ('LC', 'LC (Saint Lucia)'),
+    ('LI', 'LI (Liechtenstein)'),
+    ('LK', 'LK (Sri Lanka)'),
+    ('LR', 'LR (Liberia)'),
+    ('LS', 'LS (Lesotho)'),
+    ('LT', 'LT (Lithuania)'),
+    ('LU', 'LU (Luxembourg)'),
+    ('LV', 'LV (Latvia)'),
+    ('LY', 'LY (Libya)'),
+    ('MA', 'MA (Morocco)'),
+    ('MC', 'MC (Monaco)'),
+    ('MD', 'MD (Moldova, Republic of)'),
+    ('ME', 'ME (Montenegro)'),
+    ('MF', 'MF (Saint Martin (French part))'),
+    ('MG', 'MG (Madagascar)'),
+    ('MH', 'MH (Marshall Islands)'),
+    ('MK', 'MK (Macedonia, the Former Yugoslav Republic of)'),
+    ('ML', 'ML (Mali)'),
+    ('MM', 'MM (Myanmar)'),
+    ('MN', 'MN (Mongolia)'),
+    ('MO', 'MO (Macao)'),
+    ('MP', 'MP (Northern Mariana Islands)'),
+    ('MQ', 'MQ (Martinique)'),
+    ('MR', 'MR (Mauritania)'),
+    ('MS', 'MS (Montserrat)'),
+    ('MT', 'MT (Malta)'),
+    ('MU', 'MU (Mauritius)'),
+    ('MV', 'MV (Maldives)'),
+    ('MW', 'MW (Malawi)'),
+    ('MX', 'MX (Mexico)'),
+    ('MY', 'MY (Malaysia)'),
+    ('MZ', 'MZ (Mozambique)'),
+    ('NA', 'NA (Namibia)'),
+    ('NC', 'NC (New Caledonia)'),
+    ('NE', 'NE (Niger)'),
+    ('NF', 'NF (Norfolk Island)'),
+    ('NG', 'NG (Nigeria)'),
+    ('NI', 'NI (Nicaragua)'),
+    ('NL', 'NL (Netherlands)'),
+    ('NO', 'NO (Norway)'),
+    ('NP', 'NP (Nepal)'),
+    ('NR', 'NR (Nauru)'),
+    ('NU', 'NU (Niue)'),
+    ('NZ', 'NZ (New Zealand)'),
+    ('OM', 'OM (Oman)'),
+    ('PA', 'PA (Panama)'),
+    ('PE', 'PE (Peru)'),
+    ('PF', 'PF (French Polynesia)'),
+    ('PG', 'PG (Papua New Guinea)'),
+    ('PH', 'PH (Philippines)'),
+    ('PK', 'PK (Pakistan)'),
+    ('PL', 'PL (Poland)'),
+    ('PM', 'PM (Saint Pierre and Miquelon)'),
+    ('PN', 'PN (Pitcairn)'),
+    ('PR', 'PR (Puerto Rico)'),
+    ('PS', 'PS (Palestine, State of)'),
+    ('PT', 'PT (Portugal)'),
+    ('PW', 'PW (Palau)'),
+    ('PY', 'PY (Paraguay)'),
+    ('QA', 'QA (Qatar)'),
+    ('RE', 'RE (Réunion)'),
+    ('RO', 'RO (Romania)'),
+    ('RS', 'RS (Serbia)'),
+    ('RU', 'RU (Russian Federation)'),
+    ('RW', 'RW (Rwanda)'),
+    ('SA', 'SA (Saudi Arabia)'),
+    ('SB', 'SB (Solomon Islands)'),
+    ('SC', 'SC (Seychelles)'),
+    ('SD', 'SD (Sudan)'),
+    ('SE', 'SE (Sweden)'),
+    ('SG', 'SG (Singapore)'),
+    ('SH', 'SH (Saint Helena, Ascension and Tristan da Cunha)'),
+    ('SI', 'SI (Slovenia)'),
+    ('SJ', 'SJ (Svalbard and Jan Mayen)'),
+    ('SK', 'SK (Slovakia)'),
+    ('SL', 'SL (Sierra Leone)'),
+    ('SM', 'SM (San Marino)'),
+    ('SN', 'SN (Senegal)'),
+    ('SO', 'SO (Somalia)'),
+    ('SR', 'SR (Suriname)'),
+    ('SS', 'SS (South Sudan)'),
+    ('ST', 'ST (Sao Tome and Principe)'),
+    ('SV', 'SV (El Salvador)'),
+    ('SX', 'SX (Sint Maarten (Dutch part))'),
+    ('SY', 'SY (Syrian Arab Republic)'),
+    ('SZ', 'SZ (Swaziland)'),
+    ('TC', 'TC (Turks and Caicos Islands)'),
+    ('TD', 'TD (Chad)'),
+    ('TF', 'TF (French Southern Territories)'),
+    ('TG', 'TG (Togo)'),
+    ('TH', 'TH (Thailand)'),
+    ('TJ', 'TJ (Tajikistan)'),
+    ('TK', 'TK (Tokelau)'),
+    ('TL', 'TL (Timor-Leste)'),
+    ('TM', 'TM (Turkmenistan)'),
+    ('TN', 'TN (Tunisia)'),
+    ('TO', 'TO (Tonga)'),
+    ('TR', 'TR (Turkey)'),
+    ('TT', 'TT (Trinidad and Tobago)'),
+    ('TV', 'TV (Tuvalu)'),
+    ('TW', 'TW (Taiwan, Province of China)'),
+    ('TZ', 'TZ (Tanzania, United Republic of)'),
+    ('UA', 'UA (Ukraine)'),
+    ('UG', 'UG (Uganda)'),
+    ('UM', 'UM (United States Minor Outlying Islands)'),
+    ('US', 'US (United States)'),
+    ('UY', 'UY (Uruguay)'),
+    ('UZ', 'UZ (Uzbekistan)'),
+    ('VA', 'VA (Holy See (Vatican City State))'),
+    ('VC', 'VC (Saint Vincent and the Grenadines)'),
+    ('VE', 'VE (Venezuela, Bolivarian Republic of)'),
+    ('VG', 'VG (Virgin Islands, British)'),
+    ('VI', 'VI (Virgin Islands, U.S.)'),
+    ('VN', 'VN (Viet Nam)'),
+    ('VU', 'VU (Vanuatu)'),
+    ('WF', 'WF (Wallis and Futuna)'),
+    ('WS', 'WS (Samoa)'),
+    ('YE', 'YE (Yemen)'),
+    ('YT', 'YT (Mayotte)'),
+    ('ZA', 'ZA (South Africa)'),
+    ('ZM', 'ZM (Zambia)'),
+    ('ZW', 'ZW (Zimbabwe)')
+]