Base

Utility types used across other sections of the library.

Column Identifier

hazy_configurator.base.col_identifier.col_mapper_processing(col_data)
class hazy_configurator.base.col_identifier.ColId

Bases: HazyBaseModel

Fields:
field col: str [Required]

Column to be targeted.

field table: str [Required]

Table to be targeted.

rename_col(func: Callable[[str, str], str]) → ColId

Creates a renamed column identifier.

Note

This function does not mutate the current ColId, it creates a copy.

Parameters:

func (Callable) – A function accepting a table and column name (retrieved from self), and returning a new column name.

Returns:

Renamed column identifier.

Return type:

ColId

to_tuple() → Tuple[str, str]
copy()

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

  • include – fields to include in new model

  • exclude – fields to exclude from new model, as with values this takes precedence over include

  • update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep – set to True to make a deep copy of the model

Returns:

new model instance

Enums

class hazy_configurator.base.enums.AutoName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

class hazy_configurator.base.enums.TableType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

TABULAR = 'tabular'
SEQUENTIAL = 'sequential'
REFERENCE = 'reference'
class hazy_configurator.base.enums.SequentialType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

STEP = 'step'
DGAN = 'dgan'
RNN = 'rnn'
class hazy_configurator.base.enums.SensitiveFieldsDefaults(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

REDACTED = '<REDACTED>'
class hazy_configurator.base.enums.AuditAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

CREATE_PROJECT = 'create_project'
UPDATE_PROJECT = 'update_project'
ARCHIVE_PROJECT = 'archive_project'
ADD_DATA_SOURCE = 'add_data_source'
ARCHIVE_CONFIG = 'archive_config'
UNDO_ARCHIVE_CONFIG = 'undo_archive_config'
UPDATE_TABLE_DETAILS = 'update_table_details'
UPDATE_DATA_SOURCE = 'update_data_source'
DELETE_DATA_SOURCE = 'delete_data_source'
ATTACH_DATA_SOURCE_TO_PROJECT = 'attach_data_source_to_project'
UPSERT_DATA_CONTROLLER_ACKNOWLEDGEMENT = 'upsert_data_controller_acknowledgement'
CREATE_CONFIG = 'create_config'
UPSERT_CONFIG_DETAILS = 'upsert_config_details'
UNAUTHORISED = 'unauthorised'
UPDATE_SINGLE_COLUMN_CONFIG = 'update_single_column_config'
UPDATE_PRIMARY_KEYS = 'update_primary_keys'
UPDATE_FOREIGN_KEYS = 'update_foreign_keys'
SELECT_ENTITY = 'select_entity'
DESELECT_ENTITY = 'deselect_entity'
CREATE_ENTITY = 'create_entity'
UPSERT_ENTITY_STATE = 'upsert_entity_state'
DUPLICATE_CONFIG = 'duplicate_config'
TRAIN = 'train'
LIST_FILES = 'list_files'
LIST_SCHEMAS = 'list_schemas'
LIST_TABLES = 'list_tables'
ANALYSE = 'analyse'
REANALYSE = 'reanalyse'
GENERATE = 'generate'
KILL_DISPATCH_TASK = 'kill_dispatch_task'
IMPORT_JSON_CONFIG = 'import_json_config'
ARCHIVE_MODEL = 'archive_model'
UPSERT_METRIC_FORM_FIELD_STATE = 'upsert_metric_form_field_state'
ENABLE_METRICS = 'enable_metrics'
DISABLE_METRICS = 'disable_metrics'
DELETE_METRIC = 'delete_metric'
UPDATE_TRAIN_MODEL = 'update_train_model'
UPSERT_TABLE_FORM_FIELD_STATE = 'upsert_table_form_field_state'
PUBLISH_SYNTH_DATASET = 'publish_synth_dataset'
PUBLISH_MODEL = 'publish_model'
UPSERT_GENERAL_SETTING = 'upsert_general_setting'
DOWNLOAD_SYNTH_DATA = 'download_synth_data'
IMPORT_MODEL = 'import_model'
EXPORT_MODEL = 'export_model'
class hazy_configurator.base.enums.MetricType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

AGGREGATED_SEQUENTIAL_DENSITY_DISCLOSURE = 'aggregated_sequential_density_disclosure'
AGGREGATED_SEQUENTIAL_HISTOGRAM_SIMILARITY = 'aggregated_sequential_histogram_similarity'
AGGREGATED_SEQUENTIAL_MUTUAL_INFORMATION = 'aggregated_sequential_mutual_information'
AGGREGATED_SEQUENTIAL_PRESENCE_DISCLOSURE = 'aggregated_sequential_presence_disclosure'
AGGREGATED_SEQUENTIAL_QUERY_UTILITY = 'aggregated_sequential_query_utility'
CROSS_TABLE_MUTUAL_INFORMATION_SIMILARITY = 'cross_table_mutual_information_similarity'
DEGREE_DISTRIBUTION_SIMILARITY = 'degree_distribution_similarity'
DENSITY_DISCLOSURE = 'density_disclosure'
DISTANCE_CLOSEST_RECORD = 'distance_closest_record'
HISTOGRAM_SIMILARITY = 'histogram_similarity'
INDEX_METRIC = 'index_metric'
MUTUAL_INFORMATION_SIMILARITY = 'mutual_information_similarity'
PREDICTIVE_UTILITY = 'predictive_utility'
PRESENCE_DISCLOSURE = 'presence_disclosure'
QUERY_UTILITY = 'query_utility'
SEQ_DISCRIMINATOR = 'seq_discriminator'
SEQUENTIAL_SIMILARITY = 'sequential_similarity'
class hazy_configurator.base.enums.HazyDataType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

ID = 'id'
MAPPED = 'mapped'
INTEGER = 'integer'
FLOAT = 'float'
CATEGORY = 'category'
AGE = 'age'
DATE_TIME = 'date_time'
DRIVING_LICENSE_NUMBER = 'driving_license_number'
PERSON = 'person'
LOCATION = 'location'
COMBINATION = 'combination'
TIME_DELTA = 'time_delta'
FOREIGN_KEY = 'foreign_key'
REAL = 'real'
RAW = 'raw'
PASSPORT = 'passport'
CONSTANT = 'constant'
SYMBOL = 'symbol'
PERCENTAGE = 'percentage'
CURRENCY = 'currency'
GENDER = 'gender'
LIST = 'list'
COPY = 'copy'
NAME = 'name'
USER_NAME = 'user_name'
EMAIL = 'email'
TITLE = 'title'
STREET_ADDRESS = 'street_address'
COUNTRY = 'country'
STATE = 'state'
DISTRICT = 'district'
REGION = 'region'
CITY = 'city'
POSTCODE = 'postcode'
CUSTOM_ADDRESS = 'custom_address'
SSN = 'ssn'
class hazy_configurator.base.enums.EntityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

PERSON = 'person'
LOCATION = 'location'
COMBINATION = 'combination'
class hazy_configurator.base.enums.IdTypeEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

BANK_COUNTRY = 'bank_country'
BBAN = 'bban'
COMPANY = 'company'
COMPOUND = 'compound'
CONDITIONED = 'conditioned'
CPF_NUMBER = 'cpf_number'
CPR = 'cpr'
CREDIT_CARD_NUMBER = 'credit_card_number'
CREDIT_CARD_SECURITY_CODE = 'credit_card_security_code'
IBAN = 'iban'
LICENSE_PLATE = 'license_plate'
MD5 = 'md5'
NUMERICAL = 'numerical'
ID_MIXTURE = 'id_mixture'
INCREMENTAL = 'incremental'
PASSPORT = 'passport'
PASSWORD = 'password'
PHONE_NUMBER = 'phone_number'
REGEX = 'regex'
SORTCODE = 'sortcode'
SSN = 'ssn'
STATIC = 'static'
SWIFT = 'swift'
SWIFT11 = 'swift11'
SWIFT8 = 'swift8'
UUID = 'uuid'
NAME = 'name'
OPTION = 'option'
COLUMN = 'column'
SPLIT = 'split'
REAL = 'real'
class hazy_configurator.base.enums.PersonPartType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

FIRST_NAME = 'first_name'
SECOND_NAME = 'second_name'
THIRD_NAME = 'third_name'
FOURTH_NAME = 'fourth_name'
FIFTH_NAME = 'fifth_name'
SIXTH_NAME = 'sixth_name'
LAST_NAME = 'last_name'
INITIALS = 'initials'
EMAIL = 'email'
FULL_NAME = 'full_name'
USER_NAME = 'user_name'
class hazy_configurator.base.enums.SupportedPersonDetails(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

FIRST_NAME = 'first_name'
SECOND_NAME = 'second_name'
THIRD_NAME = 'third_name'
FOURTH_NAME = 'fourth_name'
FIFTH_NAME = 'fifth_name'
SIXTH_NAME = 'sixth_name'
LAST_NAME = 'last_name'
INITIALS = 'initials'
EMAIL = 'email'
FULL_NAME = 'full_name'
USER_NAME = 'user_name'
GENDER = 'gender'
TITLE = 'title'
CUSTOM_COLUMNS = 'custom_columns'
class hazy_configurator.base.enums.SupportedLocationDetails(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

DOOR = 'door'
FLOOR = 'floor'
STREET_NUMBER = 'street_number'
STREET = 'street'
POSTCODE = 'postcode'
DISTRICT = 'district'
DISTRICT_CODE = 'district_code'
CITY = 'city'
CITY_CODE = 'city_code'
REGION = 'region'
REGION_CODE = 'region_code'
STATE = 'state'
STATE_CODE = 'state_code'
COUNTRY = 'country'
ISO2 = 'iso2'
ISO3 = 'iso3'
OUTCODE = 'outcode'
INCODE = 'incode'
class hazy_configurator.base.enums.CurrencySymbolISO(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

Currencies in ~15 most traded currencies. If currencies share the same symbol, we kept the most traded one. Sources: - volume: Bank for International Settlements, 2022 - symbols: xe

CHF = 'CHF'
EUR = '€'
GBP = '£'
JPY = '¥'
SEK = 'kr'
USD = '$'
KRW = '₩'
class hazy_configurator.base.enums.CurrencyNamesISO(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

ADP = 'ADP'
AED = 'AED'
AFA = 'AFA'
AFN = 'AFN'
ALK = 'ALK'
ALL = 'ALL'
AMD = 'AMD'
ANG = 'ANG'
AOA = 'AOA'
AOK = 'AOK'
AON = 'AON'
AOR = 'AOR'
ARA = 'ARA'
ARP = 'ARP'
ARS = 'ARS'
ARY = 'ARY'
ATS = 'ATS'
AUD = 'AUD'
AWG = 'AWG'
AYM = 'AYM'
AZM = 'AZM'
AZN = 'AZN'
BAD = 'BAD'
BAM = 'BAM'
BBD = 'BBD'
BDT = 'BDT'
BEC = 'BEC'
BEF = 'BEF'
BEL = 'BEL'
BGJ = 'BGJ'
BGK = 'BGK'
BGL = 'BGL'
BGN = 'BGN'
BHD = 'BHD'
BIF = 'BIF'
BMD = 'BMD'
BND = 'BND'
BOB = 'BOB'
BOP = 'BOP'
BOV = 'BOV'
BRB = 'BRB'
BRC = 'BRC'
BRE = 'BRE'
BRL = 'BRL'
BRN = 'BRN'
BRR = 'BRR'
BSD = 'BSD'
BTN = 'BTN'
BUK = 'BUK'
BWP = 'BWP'
BYB = 'BYB'
BYN = 'BYN'
BYR = 'BYR'
BZD = 'BZD'
CAD = 'CAD'
CDF = 'CDF'
CHC = 'CHC'
CHE = 'CHE'
CHF = 'CHF'
CHW = 'CHW'
CLF = 'CLF'
CLP = 'CLP'
CNY = 'CNY'
COP = 'COP'
COU = 'COU'
CRC = 'CRC'
CSD = 'CSD'
CSJ = 'CSJ'
CSK = 'CSK'
CUC = 'CUC'
CUP = 'CUP'
CVE = 'CVE'
CYP = 'CYP'
CZK = 'CZK'
DDM = 'DDM'
DEM = 'DEM'
DJF = 'DJF'
DKK = 'DKK'
DOP = 'DOP'
DZD = 'DZD'
ECS = 'ECS'
ECV = 'ECV'
EEK = 'EEK'
EGP = 'EGP'
ERN = 'ERN'
ESA = 'ESA'
ESB = 'ESB'
ESP = 'ESP'
ETB = 'ETB'
EUR = 'EUR'
FIM = 'FIM'
FJD = 'FJD'
FKP = 'FKP'
FRF = 'FRF'
GBP = 'GBP'
GEK = 'GEK'
GEL = 'GEL'
GHC = 'GHC'
GHP = 'GHP'
GHS = 'GHS'
GIP = 'GIP'
GMD = 'GMD'
GNE = 'GNE'
GNF = 'GNF'
GNS = 'GNS'
GQE = 'GQE'
GRD = 'GRD'
GTQ = 'GTQ'
GWE = 'GWE'
GWP = 'GWP'
GYD = 'GYD'
HKD = 'HKD'
HNL = 'HNL'
HRD = 'HRD'
HRK = 'HRK'
HTG = 'HTG'
HUF = 'HUF'
IDR = 'IDR'
IEP = 'IEP'
ILP = 'ILP'
ILR = 'ILR'
ILS = 'ILS'
INR = 'INR'
IQD = 'IQD'
IRR = 'IRR'
ISJ = 'ISJ'
ISK = 'ISK'
ITL = 'ITL'
JMD = 'JMD'
JOD = 'JOD'
JPY = 'JPY'
KES = 'KES'
KGS = 'KGS'
KHR = 'KHR'
KMF = 'KMF'
KPW = 'KPW'
KRW = 'KRW'
KWD = 'KWD'
KYD = 'KYD'
KZT = 'KZT'
LAJ = 'LAJ'
LAK = 'LAK'
LBP = 'LBP'
LKR = 'LKR'
LRD = 'LRD'
LSL = 'LSL'
LSM = 'LSM'
LTL = 'LTL'
LTT = 'LTT'
LUC = 'LUC'
LUF = 'LUF'
LUL = 'LUL'
LVL = 'LVL'
LVR = 'LVR'
LYD = 'LYD'
MAD = 'MAD'
MDL = 'MDL'
MGA = 'MGA'
MGF = 'MGF'
MKD = 'MKD'
MLF = 'MLF'
MMK = 'MMK'
MNT = 'MNT'
MOP = 'MOP'
MRO = 'MRO'
MRU = 'MRU'
MTL = 'MTL'
MTP = 'MTP'
MUR = 'MUR'
MVQ = 'MVQ'
MVR = 'MVR'
MWK = 'MWK'
MXN = 'MXN'
MXP = 'MXP'
MXV = 'MXV'
MYR = 'MYR'
MZE = 'MZE'
MZM = 'MZM'
MZN = 'MZN'
NAD = 'NAD'
NGN = 'NGN'
NIC = 'NIC'
NIO = 'NIO'
NLG = 'NLG'
NOK = 'NOK'
NPR = 'NPR'
NZD = 'NZD'
OMR = 'OMR'
PAB = 'PAB'
PEH = 'PEH'
PEI = 'PEI'
PEN = 'PEN'
PES = 'PES'
PGK = 'PGK'
PHP = 'PHP'
PKR = 'PKR'
PLN = 'PLN'
PLZ = 'PLZ'
PTE = 'PTE'
PYG = 'PYG'
QAR = 'QAR'
RHD = 'RHD'
ROK = 'ROK'
ROL = 'ROL'
RON = 'RON'
RSD = 'RSD'
RUB = 'RUB'
RUR = 'RUR'
RWF = 'RWF'
SAR = 'SAR'
SBD = 'SBD'
SCR = 'SCR'
SDD = 'SDD'
SDG = 'SDG'
SDP = 'SDP'
SEK = 'SEK'
SGD = 'SGD'
SHP = 'SHP'
SIT = 'SIT'
SKK = 'SKK'
SLE = 'SLE'
SLL = 'SLL'
SOS = 'SOS'
SRD = 'SRD'
SRG = 'SRG'
SSP = 'SSP'
STD = 'STD'
STN = 'STN'
SUR = 'SUR'
SVC = 'SVC'
SYP = 'SYP'
SZL = 'SZL'
THB = 'THB'
TJR = 'TJR'
TJS = 'TJS'
TMM = 'TMM'
TMT = 'TMT'
TND = 'TND'
TOP = 'TOP'
TPE = 'TPE'
TRL = 'TRL'
TRY = 'TRY'
TTD = 'TTD'
TWD = 'TWD'
TZS = 'TZS'
UAH = 'UAH'
UAK = 'UAK'
UGS = 'UGS'
UGW = 'UGW'
UGX = 'UGX'
USD = 'USD'
USN = 'USN'
USS = 'USS'
UYI = 'UYI'
UYN = 'UYN'
UYP = 'UYP'
UYU = 'UYU'
UYW = 'UYW'
UZS = 'UZS'
VEB = 'VEB'
VED = 'VED'
VEF = 'VEF'
VES = 'VES'
VNC = 'VNC'
VND = 'VND'
VUV = 'VUV'
WST = 'WST'
XAF = 'XAF'
XAG = 'XAG'
XAU = 'XAU'
XBA = 'XBA'
XBB = 'XBB'
XBC = 'XBC'
XBD = 'XBD'
XCD = 'XCD'
XDR = 'XDR'
XEU = 'XEU'
XFO = 'XFO'
XFU = 'XFU'
XOF = 'XOF'
XPD = 'XPD'
XPF = 'XPF'
XPT = 'XPT'
XRE = 'XRE'
XSU = 'XSU'
XTS = 'XTS'
XUA = 'XUA'
XXX = 'XXX'
YDD = 'YDD'
YER = 'YER'
YUD = 'YUD'
YUM = 'YUM'
YUN = 'YUN'
ZAL = 'ZAL'
ZAR = 'ZAR'
ZMK = 'ZMK'
ZMW = 'ZMW'
ZRN = 'ZRN'
ZRZ = 'ZRZ'
ZWC = 'ZWC'
ZWD = 'ZWD'
ZWL = 'ZWL'
ZWN = 'ZWN'
ZWR = 'ZWR'
class hazy_configurator.base.enums.ComponentType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

SELECT = 'select'
TEXT_INPUT = 'text_input'
NUMBER_INPUT = 'number_input'
REGEX_INPUT = 'regex_input'
HASH_MAP_SELECT = 'hash_map_select'
ENTITY_ID_SELECT = 'entity_id_select'
SWITCH = 'switch'
MULTI_SELECT = 'multi_select'
SAME_TABLE_COLUMN_SELECT = 'same_table_column_select'
ANY_TABLE_COLUMN_SELECT = 'any_table_column_select'
FORMULA_INPUT = 'formula_input'
METADATA_INPUT = 'metadata_input'
EPSILON_INPUT = 'epsilon_input'
BOUNDED_INPUT = 'bounded_input'
SAME_TABLE_MULTI_COLUMN_SELECT = 'same_table_multi_column_select'
METRIC_MULTI_COLUMN_SELECT = 'metric_multi_column_select'
JSON_EDITOR = 'json_editor'
MAGNITUDE_INPUT = 'magnitude_input'
TABLE_SELECT = 'table_select'
RANGE_INPUT = 'range_input'
GROUP = 'group'
CHECKBOX = 'checkbox'
PARENT_INPUT = 'parent_input'
FILE_UPLOAD = 'file_upload'
GENERATOR_TYPE_SELECT = 'generator_type_select'
class hazy_configurator.base.enums.FileUploadType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

URLSAFE_BASE64 = 'urlsafe_base64'
TEXT = 'text'
class hazy_configurator.base.enums.RawDtype(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

BOOLEAN = '?'
BYTE = 'b'
UNSIGNED_BYTE = 'B'
INTEGER = 'Int64'
UNSIGNED_INTEGER = 'UInt64'
FLOAT = 'float64'
COMPLEX_FLOAT = 'c'
TIME_DELTA = 'm'
DATETIME = 'M'
OBJECT = 'O'
UNICODE_STRING = 'U'
CATEGORY = 'category'
class hazy_configurator.base.enums.GeoLocales(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of locales for the location handler

en_GB = 'en_GB'
en_US = 'en_US'
en_CA = 'en_CA'
en_AU = 'en_AU'
en_IE = 'en_IE'
es_ES = 'es_ES'
fr_FR = 'fr_FR'
da_DK = 'da_DK'
de_DE = 'de_DE'
sv_SE = 'sv_SE'
no_NO = 'no_NO'
fi_FI = 'fi_FI'
cs_CZ = 'cs_CZ'
class hazy_configurator.base.enums.PersonLocales(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of locales for the person handler

ar_AA = 'ar_AA'
ar_PS = 'ar_PS'
ar_SA = 'ar_SA'
az_AZ = 'az_AZ'
bg_BG = 'bg_BG'
bn_BD = 'bn_BD'
cs_CZ = 'cs_CZ'
da_DK = 'da_DK'
de_AT = 'de_AT'
de_CH = 'de_CH'
de_DE = 'de_DE'
el_GR = 'el_GR'
en_GB = 'en_GB'
en_IE = 'en_IE'
en_NZ = 'en_NZ'
en_US = 'en_US'
es_CA = 'es_CA'
es_CL = 'es_CL'
es_CO = 'es_CO'
es_ES = 'es_ES'
et_EE = 'et_EE'
fa_IR = 'fa_IR'
fi_FI = 'fi_FI'
fr_CA = 'fr_CA'
fr_CH = 'fr_CH'
fr_FR = 'fr_FR'
fr_QC = 'fr_QC'
ga_IE = 'ga_IE'
he_IL = 'he_IL'
hr_HR = 'hr_HR'
hu_HU = 'hu_HU'
hy_AM = 'hy_AM'
id_ID = 'id_ID'
it_IT = 'it_IT'
ja_JP = 'ja_JP'
ka_GE = 'ka_GE'
ko_KR = 'ko_KR'
ne_NP = 'ne_NP'
nl_NL = 'nl_NL'
no_NO = 'no_NO'
or_IN = 'or_IN'
pl_PL = 'pl_PL'
pt_BR = 'pt_BR'
pt_PT = 'pt_PT'
ro_RO = 'ro_RO'
ru_RU = 'ru_RU'
sl_SI = 'sl_SI'
sv_SE = 'sv_SE'
ta_IN = 'ta_IN'
th_TH = 'th_TH'
tr_TR = 'tr_TR'
tw_GH = 'tw_GH'
uk_UA = 'uk_UA'
zh_CN = 'zh_CN'
zh_TW = 'zh_TW'
class hazy_configurator.base.enums.NameIDTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of name types for the name ID generator

FULL_NAME = 'full_name'
FULL_NAME_FEMALE = 'full_name_female'
FULL_NAME_MALE = 'full_name_male'
FIRST_NAME = 'first_name'
FIRST_NAME_FEMALE = 'first_name_female'
FIRST_NAME_MALE = 'first_name_male'
LAST_NAME = 'last_name'
class hazy_configurator.base.enums.NameTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of name types for the name data type

FIRST_NAME = 'first_name'
SECOND_NAME = 'second_name'
THIRD_NAME = 'third_name'
FOURTH_NAME = 'fourth_name'
FIFTH_NAME = 'fifth_name'
SIXTH_NAME = 'sixth_name'
LAST_NAME = 'last_name'
FULL_NAME = 'full_name'
CUSTOM_NAME = 'custom_name'
INITIALS = 'initials'
class hazy_configurator.base.enums.SwiftTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of swift types for the swift code generator

SWIFT8 = 'SWIFT8'
SWIFT11 = 'SWIFT11'
class hazy_configurator.base.enums.SwiftLocales(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of locales for the swift code generator

AD = 'AD'
AE = 'AE'
AG = 'AG'
AI = 'AI'
AL = 'AL'
AM = 'AM'
AO = 'AO'
AR = 'AR'
AS = 'AS'
AT = 'AT'
AU = 'AU'
AW = 'AW'
AZ = 'AZ'
BA = 'BA'
BB = 'BB'
BD = 'BD'
BE = 'BE'
BF = 'BF'
BG = 'BG'
BH = 'BH'
BJ = 'BJ'
BM = 'BM'
BN = 'BN'
BO = 'BO'
BQ = 'BQ'
BR = 'BR'
BS = 'BS'
BT = 'BT'
BW = 'BW'
BY = 'BY'
BZ = 'BZ'
CA = 'CA'
CH = 'CH'
CI = 'CI'
CK = 'CK'
CL = 'CL'
CM = 'CM'
CN = 'CN'
CO = 'CO'
CR = 'CR'
CV = 'CV'
CW = 'CW'
CY = 'CY'
CZ = 'CZ'
DE = 'DE'
DJ = 'DJ'
DK = 'DK'
DM = 'DM'
DO = 'DO'
DZ = 'DZ'
EC = 'EC'
EE = 'EE'
EG = 'EG'
EH = 'EH'
ES = 'ES'
ET = 'ET'
FI = 'FI'
FJ = 'FJ'
FK = 'FK'
FO = 'FO'
FR = 'FR'
GA = 'GA'
GB = 'GB'
GD = 'GD'
GE = 'GE'
GG = 'GG'
GH = 'GH'
GI = 'GI'
GL = 'GL'
GM = 'GM'
GN = 'GN'
GP = 'GP'
GQ = 'GQ'
GR = 'GR'
GT = 'GT'
GU = 'GU'
GW = 'GW'
GY = 'GY'
HK = 'HK'
HN = 'HN'
HR = 'HR'
HT = 'HT'
HU = 'HU'
ID = 'ID'
IE = 'IE'
IL = 'IL'
IM = 'IM'
IN = 'IN'
IS = 'IS'
IT = 'IT'
JE = 'JE'
JM = 'JM'
JO = 'JO'
JP = 'JP'
KE = 'KE'
KG = 'KG'
KH = 'KH'
KI = 'KI'
KM = 'KM'
KN = 'KN'
KR = 'KR'
KW = 'KW'
KY = 'KY'
KZ = 'KZ'
LA = 'LA'
LB = 'LB'
LC = 'LC'
LI = 'LI'
LK = 'LK'
LR = 'LR'
LS = 'LS'
LT = 'LT'
LU = 'LU'
LV = 'LV'
MA = 'MA'
MC = 'MC'
MD = 'MD'
ME = 'ME'
MG = 'MG'
MH = 'MH'
MK = 'MK'
ML = 'ML'
MM = 'MM'
MN = 'MN'
MO = 'MO'
MQ = 'MQ'
MR = 'MR'
MS = 'MS'
MT = 'MT'
MU = 'MU'
MV = 'MV'
MW = 'MW'
MX = 'MX'
MY = 'MY'
MZ = 'MZ'
NA = 'NA'
NC = 'NC'
NE = 'NE'
NG = 'NG'
NI = 'NI'
NL = 'NL'
NO = 'NO'
NP = 'NP'
NZ = 'NZ'
OM = 'OM'
PA = 'PA'
PE = 'PE'
PF = 'PF'
PG = 'PG'
PH = 'PH'
PK = 'PK'
PL = 'PL'
PR = 'PR'
PS = 'PS'
PT = 'PT'
PW = 'PW'
PY = 'PY'
QA = 'QA'
RE = 'RE'
RO = 'RO'
RS = 'RS'
RU = 'RU'
RW = 'RW'
SA = 'SA'
SB = 'SB'
SC = 'SC'
SD = 'SD'
SE = 'SE'
SG = 'SG'
SH = 'SH'
SI = 'SI'
SK = 'SK'
SL = 'SL'
SM = 'SM'
SN = 'SN'
SO = 'SO'
SR = 'SR'
SS = 'SS'
ST = 'ST'
SV = 'SV'
SX = 'SX'
SY = 'SY'
TC = 'TC'
TG = 'TG'
TH = 'TH'
TJ = 'TJ'
TK = 'TK'
TL = 'TL'
TM = 'TM'
TN = 'TN'
TO = 'TO'
TR = 'TR'
TT = 'TT'
TV = 'TV'
TW = 'TW'
TZ = 'TZ'
UA = 'UA'
UG = 'UG'
UM = 'UM'
US = 'US'
UY = 'UY'
UZ = 'UZ'
VE = 'VE'
VG = 'VG'
VI = 'VI'
VN = 'VN'
VU = 'VU'
WF = 'WF'
WS = 'WS'
XK = 'XK'
YE = 'YE'
YT = 'YT'
ZA = 'ZA'
ZM = 'ZM'
ZW = 'ZW'
class hazy_configurator.base.enums.IbanLocales(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of locales for the iban and bban handler IMPORTANT: If you change this, update the regexes in IBAN.py and BBAN.py

AD = 'AD'
AE = 'AE'
AL = 'AL'
AT = 'AT'
AZ = 'AZ'
BA = 'BA'
BE = 'BE'
BG = 'BG'
BH = 'BH'
BI = 'BI'
BR = 'BR'
BY = 'BY'
CH = 'CH'
CR = 'CR'
CY = 'CY'
CZ = 'CZ'
DE = 'DE'
DJ = 'DJ'
DK = 'DK'
DO = 'DO'
EE = 'EE'
EG = 'EG'
ES = 'ES'
FI = 'FI'
FO = 'FO'
FR = 'FR'
GB = 'GB'
GE = 'GE'
GI = 'GI'
GL = 'GL'
GR = 'GR'
GT = 'GT'
HR = 'HR'
HU = 'HU'
IE = 'IE'
IL = 'IL'
IQ = 'IQ'
IS = 'IS'
IT = 'IT'
JO = 'JO'
KW = 'KW'
KZ = 'KZ'
LB = 'LB'
LC = 'LC'
LI = 'LI'
LT = 'LT'
LU = 'LU'
LV = 'LV'
LY = 'LY'
MC = 'MC'
MD = 'MD'
ME = 'ME'
MK = 'MK'
MR = 'MR'
MT = 'MT'
MU = 'MU'
NL = 'NL'
NO = 'NO'
PK = 'PK'
PL = 'PL'
PS = 'PS'
PT = 'PT'
QA = 'QA'
RO = 'RO'
RS = 'RS'
RU = 'RU'
SA = 'SA'
SC = 'SC'
SD = 'SD'
SE = 'SE'
SI = 'SI'
SK = 'SK'
SM = 'SM'
SO = 'SO'
ST = 'ST'
SV = 'SV'
TL = 'TL'
TN = 'TN'
TR = 'TR'
UA = 'UA'
VA = 'VA'
VG = 'VG'
XK = 'XK'
class hazy_configurator.base.enums.PassportCountries(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

AR = 'AR'
AU = 'AU'
AT = 'AT'
BE = 'BE'
BR = 'BR'
BG = 'BG'
CA = 'CA'
CN = 'CN'
HR = 'HR'
CY = 'CY'
CZ = 'CZ'
DK = 'DK'
EE = 'EE'
FI = 'FI'
FR = 'FR'
DE = 'DE'
GR = 'GR'
HU = 'HU'
IS = 'IS'
IN = 'IN'
IE = 'IE'
IT = 'IT'
JM = 'JM'
JP = 'JP'
KZ = 'KZ'
KR = 'KR'
LV = 'LV'
LI = 'LI'
LT = 'LT'
LU = 'LU'
MY = 'MY'
MT = 'MT'
MX = 'MX'
NL = 'NL'
NZ = 'NZ'
NO = 'NO'
PH = 'PH'
PL = 'PL'
PT = 'PT'
RO = 'RO'
RU = 'RU'
SG = 'SG'
SK = 'SK'
ZA = 'ZA'
ES = 'ES'
SE = 'SE'
CH = 'CH'
TW = 'TW'
TH = 'TH'
TR = 'TR'
UA = 'UA'
GB = 'GB'
US = 'US'
class hazy_configurator.base.enums.SSNLocales(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of locales supported by the ssn handler

ar_AA = 'ar_AA'
ar_AE = 'ar_AE'
ar_BH = 'ar_BH'
ar_EG = 'ar_EG'
ar_JO = 'ar_JO'
ar_PS = 'ar_PS'
ar_SA = 'ar_SA'
az_AZ = 'az_AZ'
bg_BG = 'bg_BG'
bn_BD = 'bn_BD'
bs_BA = 'bs_BA'
cs_CZ = 'cs_CZ'
da_DK = 'da_DK'
de = 'de'
de_AT = 'de_AT'
de_CH = 'de_CH'
de_DE = 'de_DE'
dk_DK = 'dk_DK'
el_CY = 'el_CY'
el_GR = 'el_GR'
en = 'en'
en_AU = 'en_AU'
en_CA = 'en_CA'
en_GB = 'en_GB'
en_IE = 'en_IE'
en_IN = 'en_IN'
en_NZ = 'en_NZ'
en_PH = 'en_PH'
en_TH = 'en_TH'
en_US = 'en_US'
es = 'es'
es_CA = 'es_CA'
es_CL = 'es_CL'
es_CO = 'es_CO'
es_ES = 'es_ES'
es_MX = 'es_MX'
et_EE = 'et_EE'
fa_IR = 'fa_IR'
fi_FI = 'fi_FI'
fil_PH = 'fil_PH'
fr_CA = 'fr_CA'
fr_CH = 'fr_CH'
fr_FR = 'fr_FR'
fr_QC = 'fr_QC'
ga_IE = 'ga_IE'
he_IL = 'he_IL'
hi_IN = 'hi_IN'
hr_HR = 'hr_HR'
hu_HU = 'hu_HU'
hy_AM = 'hy_AM'
id_ID = 'id_ID'
it_CH = 'it_CH'
it_IT = 'it_IT'
ja_JP = 'ja_JP'
ka_GE = 'ka_GE'
ko_KR = 'ko_KR'
la = 'la'
lb_LU = 'lb_LU'
lt_LT = 'lt_LT'
lv_LV = 'lv_LV'
mt_MT = 'mt_MT'
ne_NP = 'ne_NP'
nl_BE = 'nl_BE'
nl_NL = 'nl_NL'
no_NO = 'no_NO'
or_IN = 'or_IN'
pl_PL = 'pl_PL'
pt_BR = 'pt_BR'
pt_PT = 'pt_PT'
ro_RO = 'ro_RO'
ru_RU = 'ru_RU'
sk_SK = 'sk_SK'
sl_SI = 'sl_SI'
sq_AL = 'sq_AL'
sv_SE = 'sv_SE'
ta_IN = 'ta_IN'
th = 'th'
th_TH = 'th_TH'
tl_PH = 'tl_PH'
tr_TR = 'tr_TR'
tw_GH = 'tw_GH'
uk_UA = 'uk_UA'
vi_VN = 'vi_VN'
zh_CN = 'zh_CN'
zh_TW = 'zh_TW'
class hazy_configurator.base.enums.DrivingLicenseLocales(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of locales supported by the driving license handler

AT = 'AT'
AU = 'AU'
BE = 'BE'
CA = 'CA'
CZ = 'CZ'
DE = 'DE'
DK = 'DK'
ES = 'ES'
FI = 'FI'
FR = 'FR'
GR = 'GR'
IE = 'IE'
IN = 'IN'
IT = 'IT'
JP = 'JP'
KR = 'KR'
MT = 'MT'
NL = 'NL'
NZ = 'NZ'
PL = 'PL'
SE = 'SE'
SG = 'SG'
UK = 'UK'
US = 'US'
class hazy_configurator.base.enums.SupportedCardTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of card types supported by the Credit Card Number ID Handler

amex = 'amex'
diners = 'diners'
discover = 'discover'
jcb = 'jcb'
jcb15 = 'jcb15'
jcb16 = 'jcb16'
maestro = 'maestro'
mastercard = 'mastercard'
visa = 'visa'
visa13 = 'visa13'
visa16 = 'visa16'
visa19 = 'visa19'
class hazy_configurator.base.enums.ProcessingType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

ID = 'id'
MAPPED = 'mapped'
ID_MAPPER = 'id_mapper'
SYMBOL = 'symbol'
SAMPLE = 'sample'
DETERMINED_RULE = 'determined_rule'
CONDITIONED_RULE = 'conditioned_rule'
FORMULA_RULE = 'formula_rule'
BOUNDED = 'bounded'
GEO_CLUSTER = 'geo_cluster'
PERSON = 'person'
DATE_FORMAT = 'date_format'
DATE_REFORMAT = 'date_reformat'
TIME_DELTA = 'time_delta'
AGE = 'age'
SUMMARY = 'summary'
SEQUENCE = 'sequence'
COMBINATION = 'combination'
REAL = 'real'
ONE_HOT = 'one_hot'
STATIC_ATTRIBUTE = 'static_attribute'
TEXT_CATEGORY = 'text_category'
PLACEHOLDER = 'placeholder'
CONDITIONED_ID = 'conditioned_id'
EMPTY_STRING = 'empty_string'
STRIP_STRING = 'strip_string'
COMPONENT = 'component'
PATTERN = 'pattern'
CURRENCY = 'currency'
CATEGORY_MAPPER = 'category_mapper'
LIST = 'list'
JAVASCRIPT = 'javascript'
class hazy_configurator.base.enums.JavascriptHandlerReturnType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

STRING = 'string'
CATEGORY = 'category'
DATETIME = 'datetime'
INTEGER = 'integer'
FLOAT = 'float'
class hazy_configurator.base.enums.PandasSupportedInvalidType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

RAISE = 'raise'
COERCE = 'coerce'
class hazy_configurator.base.enums.TimeDeltaUnit(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

WEEK = 'W'
DAY = 'D'
HOUR = 'h'
MINUTE = 'm'
SECOND = 's'
MILLI_SECOND = 'ms'
MICRO_SECOND = 'us'
NANO_SECOND = 'ns'
class hazy_configurator.base.enums.PostcodeTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

POSTCODE = 'postcode'
OUTCODE = 'outcode'
INCODE = 'incode'
class hazy_configurator.base.enums.CountryTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

COUNTRY = 'country'
ISO2 = 'iso2'
ISO3 = 'iso3'
class hazy_configurator.base.enums.StreetAddressTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

DOOR = 'door'
FLOOR = 'floor'
STREET_NUMBER = 'street_number'
STREET = 'street'
class hazy_configurator.base.enums.LocationTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

REGULAR = 'regular'
CODE = 'code'
class hazy_configurator.base.enums.LocationPartType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

List of location part types available as part of the location handler

POSTCODE = 'postcode'
DOOR = 'door'
FLOOR = 'floor'
STREET_NUMBER = 'street_number'
STREET = 'street'
DISTRICT = 'district'
DISTRICT_CODE = 'district_code'
CITY = 'city'
CITY_CODE = 'city_code'
REGION = 'region'
REGION_CODE = 'region_code'
STATE = 'state'
STATE_CODE = 'state_code'
COUNTRY = 'country'
ISO2 = 'iso2'
ISO3 = 'iso3'
OUTCODE = 'outcode'
INCODE = 'incode'
class hazy_configurator.base.enums.LocationTypeMismatch(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

RANDOM = 'random'
DROP = 'drop'
APPROXIMATE = 'approximate'
class hazy_configurator.base.enums.ComparisonType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

GTR_EQUAL = '>='
LESS_EQUAL = '<='
class hazy_configurator.base.enums.BoundType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

COLUMN = 'column'
STATIC = 'static'
class hazy_configurator.base.enums.ClassifierType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

NAIVE_BAYES_GAUSS = 'naive_bayes_gauss_classifier'
LOGISTIC_REGRESSION = 'logistic_regression_classifier'
K_NEIGHBORS = 'k_neighbors_classifier'
LINEAR_SVM = 'linear_svm_classifier'
SVM = 'svm_classifier'
DESCISION_TREE = 'decision_tree_classifier'
RANDOM_FOREST = 'random_forest_classifier'
LGBM = 'lgbm_classifier'
get_pretty_label() → str
class hazy_configurator.base.enums.RegressorType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

LINEAR = 'linear_regressor'
RIDGE = 'ridge_regressor'
K_NEIGHBORS = 'k_neighbors_regressor'
DECISION_TREE = 'decision_tree_regressor'
RANDOM_FOREST = 'random_forest_regressor'
LGBM = 'lgbm_regressor'
get_pretty_label() → str
class hazy_configurator.base.enums.CLFSamplerSortModeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

MEAN = 'mean'
MEDIAN = 'median'
MODE = 'mode'
class hazy_configurator.base.enums.AdjacencyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

IDENTITY = 'identity'
RANDOM = 'random'
DEGREE_PRESERVING = 'degree_preserving'
COMPONENT_PRESERVING = 'component_preserving'
class hazy_configurator.base.enums.PrivBayesMetricType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

CFS = 'CFS'
MI = 'MI'
class hazy_configurator.base.enums.BinningStrategyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

UNIFORM = 'uniform'

Splits the continuous range into bins of equal size.

QUANTILE = 'quantile'

Split the continuous range into quantiles (portions of the overall distribution) into equal size. This behaves better for skewed distributions

class hazy_configurator.base.enums.CLFSamplerClassifierType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

DECISION_TREE = 'decision_tree'
LGBM = 'lgbm'
LOGISTIC_REGRESSION = 'logistic_regression'
RANDOM_FOREST = 'random_forest'
class hazy_configurator.base.enums.CLFSamplerClassifierName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

DECISION_TREE = 'Decision Tree'
LGBM = 'LightGBM'
LOGISTIC_REGRESSION = 'Logistic Regression'
RANDOM_FOREST = 'Random Forest'
property type: CLFSamplerClassifierType

Retrieves the classifier type corresponding to this name.

class hazy_configurator.base.enums.PrivBayesUnknownCombinationStrategyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

MARGINAL = 'marginal'
UNIFORM = 'uniform'
class hazy_configurator.base.enums.MetricUseCaseType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

SINGLE_TABLE = 'single_table'
CROSS_TABLE = 'cross_table'
SINGLE_TABLE_SEQUENTIAL = 'single_table_sequential'
SINGLE_TABLE_SEQUENTIAL_FIXED_FREQ = 'single_table_sequential_fixed_freq'
class hazy_configurator.base.enums.AutomaticHandlerExtractorType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

DETERMINED = 'determined'
CONDITIONED = 'conditioned'
class hazy_configurator.base.enums.GenerativeModelType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

PRIV_BAYES = 'priv_bayes'
CLF_SAMPLER = 'clf_sampler'
AIM = 'aim'
MST = 'mst'
class hazy_configurator.base.enums.GenerativeModelName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

Display names of generators in GenerativeModelType.

PRIV_BAYES = 'Priv Bayes'
CLF_SAMPLER = 'CLF Sampler'
MST = 'MST'
AIM = 'AIM'
property type: GenerativeModelType

Retrieves the generative model type corresponding to this name.

class hazy_configurator.base.enums.ParentCompressionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

The the different parent compression strategies available.

NONE = 'No parent compression'
LOW_MI_COLUMN = 'Low mutual information column parent compression'
class hazy_configurator.base.enums.ReductionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

MEAN = 'mean'
MEDIAN = 'median'
MAX = 'max'
class hazy_configurator.base.enums.SynthExportType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

SYNTH_DOCKER = 'SYNTH_DOCKER'
SYNTH_API = 'SYNTH_API'
TRAIN = 'TRAIN'
class hazy_configurator.base.enums.ValueType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

LITERAL = 'literal'
ENV = 'env_var'
class hazy_configurator.base.enums.DatabaseTableExistMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

APPEND = 'append'
REPLACE = 'replace'
FAIL = 'fail'
class hazy_configurator.base.enums.BigQueryTableExistMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

WRITE_TRUNCATE = 'write_truncate'
WRITE_APPEND = 'write_append'
WRITE_EMPTY = 'write_empty'
class hazy_configurator.base.enums.DatabaseDriverType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

DB2 = 'db2'
MSSQL = 'mssql+pyodbc'
SQLITE = 'sqlite'
SNOWFLAKE = 'snowflake'
DATABRICKS = 'databricks'
POSTGRES = 'postgresql+psycopg'
ORACLE = 'oracle+oracledb'
GBQ = 'bigquery'
class hazy_configurator.base.enums.NavigationMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

ROOT = 'root'
CLASSIC = 'classic'
class hazy_configurator.base.enums.SamplingMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

IN_MEMORY = 'in_memory'
IN_DB = 'in_db'
class hazy_configurator.base.enums.IdMismatchBehaviour(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

REPLACE = 'replace'
PRESERVE = 'preserve'
from_str()
class hazy_configurator.base.enums.MetricSection(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

PRIVACY = 'privacy'
UTILITY = 'utility'
SIMILARITY = 'similarity'
class hazy_configurator.base.enums.DataSourceIO(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

INPUT = 'input'
OUTPUT = 'output'
INPUT_OUTPUT = 'input_output'
UPLOAD = 'upload'
DOWNLOAD = 'download'
class hazy_configurator.base.enums.SensitiveDataSourceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

The type of the data source connection.

S3 = 's3_sensitive'
GCS = 'gcs_sensitive'
GBQ = 'gbq_sensitive'
DATABASE = 'database_sensitive'
DISK = 'disk_sensitive'
AZURE = 'azure_sensitive'
DB2 = 'db2_sensitive'
MSSQL = 'mssql_sensitive'
SNOWFLAKE = 'snowflake_sensitive'
SQLITE = 'sqlite_sensitive'
DATABRICKS = 'databricks_sensitive'
POSTGRES = 'postgres_sensitive'
ORACLE = 'oracle_sensitive'
classmethod can_list_files() → Set[SensitiveDataSourceType]
classmethod from_path(path: str) → SensitiveDataSourceType
class hazy_configurator.base.enums.SequentialModelType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

BASIC = 'sequential_basic'
DGAN = 'sequential_dgan'
RNN = 'sequential_rnn'
class hazy_configurator.base.enums.SequentialModelName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

Display names of sequential models in SequentialModelType.

BASIC = 'Basic'
DGAN = 'DGAN'
RNN = 'Recurrent Neural Network (BETA)'
property type: SequentialModelType

Retrieves the sequential model type corresponding to this name.

class hazy_configurator.base.enums.PIIType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

HIGH = 'high'
MEDIUM = 'medium'
LOW = 'low'
NON_PII = 'non_pii'
class hazy_configurator.base.enums.Score(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

PASS = 'pass'
WARN = 'warn'
FAIL = 'fail'
class hazy_configurator.base.enums.OpenSSLMimeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, AutoName

PKCS8 = 'application/pkcs8'
PKCS10 = 'application/pkcs10'
PKIX_CERT = 'application/pkix-cert'
PKIX_CRL = 'application/pkix-crl'
PKCS7_MIME = 'application/pkcs7-mime'
X509_CA = 'application/x-x509-ca-cert'
X509_USER = 'application/x-x509-user-cert'
PKCS7_CRL = 'application/x-pkcs7-crl'
PEM_FILE = 'application/x-pem-file'
PKCS12 = 'application/x-pkcs12'
PKCS7_CERTIFICATES = 'application/x-pkcs7-certificates'
PKCS7_CERTREQRESP = 'application/x-pkcs7-certreqresp'
class hazy_configurator.base.enums.HazySecretType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

ENV_VAR = 'env'
AWS_SECRETS_MANAGER = 'aws_sm'
class hazy_configurator.base.enums.LocationTerritoryModellingType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

COMBINATION = 'combination'
ASSET_SAMPLING = 'asset_sampling'
class hazy_configurator.base.enums.PublishState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

PUBLISHED = 'PUBLISHED'
HIDDEN = 'HIDDEN'
class hazy_configurator.base.enums.TorchDevice(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

CPU = 'cpu'
CUDA = 'cuda'
MPS = 'mps'
class hazy_configurator.base.enums.AttachedToPublishedModel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

ATTACHED_AT_CONSUMING_LEVEL = 'attached_at_consuming_level'
ATTACHED_AT_PUBLISHING_LEVEL = 'attached_at_publishing_level'
NOT_ATTACHED = 'not_attached'
static get_attached() → List[AttachedToPublishedModel]
static get_non_consumer_attachments() → List[AttachedToPublishedModel]

Bounds

class hazy_configurator.base.bounded_base.ColumnBound

Bases: BaseBound

Fields:
field type: Literal['column'] = 'column'

The bound type, required only for JSON syntax

field value: Union[ColId, str] [Required]

Column name. If the column exists in a table different to that of the target column then use a ColId object and provide the name of the column and the table that it is in.

class hazy_configurator.base.bounded_base.StaticBound

Bases: BaseBound

Fields:
field type: Literal['static'] = 'static'

The bound type, required only for JSON syntax

field value: Union[float, int] [Required]

Expression

class hazy_configurator.base.formula_descriptions.ExpressionConfig

Bases: HazyBaseModel

Fields:
field expression: str [Required]

Formula to apply to the column.

Some examples of valid formulas are "a + b + c" or "if(is_last(x), y, z)". Note that the formula cannot contain static values such as integers or strings. If this is required use a static value in the column map. See Expression syntax for available syntax and examples.

field column_map: Dict[str, str] [Required]

A mapping between variables defined in the formula and the columns of the provided data.

The dictionary value can either be a string specifying the name of a column or a ColId object (for when the column exists in different table to the target column), or another dictionary specifying a static value . If it is a dictionary specifying a static value then it should be in the format StaticValue(value="30 days, 2 hours", dtype="timedelta") where the type is always static, the value is the value and the dtype is a required parameter which is used to convert the provided value into a datatype. The dtype can be either "string", "float", "integer", "boolean", "datetime" or "timedelta".

When using “timedelta” in the column_map the following units can be used in strings:

  • W

  • D / days / day

  • hours / hour / hr / h

  • m / minute / min / minutes / T

  • S / seconds / sec / second

  • ms / milliseconds / millisecond / milli / millis / L

  • us / microseconds / microsecond / micro / micros / U

  • ns / nanoseconds / nano / nanos / nanosecond / N

It is recommended to use these in a comma separated list. Some examples are:

  • 30 days, 2 hours

  • 1W - i.e. 1 week

  • 1 hour, 30 mins, 30 seconds

When using a “datetime” value in the column_map it is recommended to use isoformat following YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]] where * can match any single character.

Some examples are:

  • 2011-11-04

  • 2011-11-04T00:05:23

  • 2011-11-04 00:05:23.283

  • 2011-11-04 00:05:23.283+00:00

  • 2011-11-04T00:05:23+04:00

class hazy_configurator.base.formula_descriptions.StaticValue

Bases: HazyBaseModel

Fields:
field dtype: Literal['string', 'float', 'integer', 'boolean', 'datetime', 'timedelta'] [Required]

Data type to coerce the static value to

field value: Any = None

Value to be coerced into the dtype

Schema Version

class hazy_configurator.base.extra_schema_params.SchemaVersion(*, major: int, minor: int, patch: int)

Bases: HazyBaseModel

Used to define semantic versions of schemas.

field major: int [Required]

Major version.

field minor: int [Required]

Minor version.

field patch: int [Required]

Patch version.

as_str() → str

Create a string representation of this object of the form ‘{major}.{minor}.{patch}’.

Returns:

String representation.

Return type:

str

classmethod from_string(version: str) → SchemaVersion

Class constructor method from string version.

Parameters:

version (str) – Version string of the form ‘{major}.{minor}.{patch}’.

Return type:

SchemaVersion

classmethod fs(version: str) → SchemaVersion

Class constructor method from string version.

Parameters:

version (str) – Version string of the form ‘{major}.{minor}.{patch}’.

Return type:

SchemaVersion

classmethod from_list_of_lists(value: List[List])
Previous:
Entities
Next:
Evaluation