SQLAlchemy - создать таблицу из ямла или словаря?

Сегодня этот выпуск поддерживает SQLAthanor (v.0.3.0). Используя SQLAthanor, вы можете программно генерировать объект Table SQLAlchemy со следующим кодом (при условии, что metadata содержат объект SQLAlchemy MetaData):

from sqlathanor import Table

my_table = Table.from_yaml('yaml_file.yaml', 
                           'my_table_name', 
                           metadata, 
                           primary_key = 'id')

ETA: Обратите внимание, что вы также можете создавать объекты Table используя Table.from_json(), Table.from_dict() и Table.from_csv().

Здесь документация (как правило) о том, как она работает: https://sqlathanor.readthedocs.io/en/latest/using.html#generating-sqlalchemy-tables-from-serialized-data

И здесь ссылка на документацию конкретного Table.from_yaml(): https://sqlathanor.readthedocs.io/en/latest/api.html#sqlathanor.schema.Table.from_yaml

(Я рекомендую просмотреть документацию по методу - он переходит в некоторые из "готовых" программных построений объекта Table из сериализованных данных)

---

ETA:

В принципе, способ создания программных Table заключается в том, что SQLAthanor:

1. Сначала преобразует сериализованную строку (или файл) в Python dict. Для YAML стандартным де-сериализатором является PyYAML. Для JSON, по умолчанию де-сериализатору является simplejson (оба по умолчанию deserializers может быть переопределен с помощью deserialize_function аргумента).

2. После того, как Python dict сгенерирован, SQLAthanor читает каждый из ключей в этом dict, чтобы определить имена столбцов. Он считывает значения для каждого ключа и на основе типа данных значения пытается "угадать" в типе данных SQLAlchemy.

3. Учитывая то, что он нашел на шаге 2, он создает объект Table с объектами Column где каждый объект Column соответствует ключу де-сериализованного dict.

Если вам нужен более точный контроль над каждым Column, вы можете:

• переопределить его тип данных SQLAlchemy, используя type_mapping аргумента (type_mapping получает dict, где клавиши верхнего уровня соответствуют имени столбца, и каждое значение является типом данных, чтобы применить к Column)
• передать дополнительные аргументы ключевых слов в Column конструктору с использованием column_kwargs аргумента (column_kwargs получает dict, где клавиши верхнего уровня соответствует имени столбца, и каждое значение является dict с аргументами ключевых слов, которые будут поставлены этим конструктора столбец.

По умолчанию Table.from_<format>() не поддерживает вложенные структуры данных. По умолчанию для skip_nested установлено значение True, что означает, что ключ в де-сериализованном dict который содержит вложенный объект (или итерируемый или dict), будет пропущен (т.е. не получит соответствующий Column). Если вашей Table необходимо хранить вложенные данные, вы можете установить skip_nested в False и активировать default_to_str в True. Это приведет к преобразованию вложенных данных (итераций или объектов dict) в строки и, таким образом, сохранит их в столбце " Text (если не переопределено type_mapping).

---

Table.from_dict()

Ниже приведен пример dict который может быть поставлен в Table.from_dict():

sample_dict = {
    'id': 123,
    'some_column_name': 'Some Column Value',
    'created_datetime': datetime.utcnow()
}

my_table = Table.from_dict(sample_dict, 
                           'my_table', 
                           metadata, 
                           primary_key = 'id')

Когда подается в Table.from_dict() это dict будет производить Table объект с именем таблицы базы данных my_table, который содержит три колонки:

• id который будет иметь тип Integer который установлен как первичный ключ таблицы
• some_column_name которое будет иметь тип Text
• created_datetime которое будет иметь тип DateTime

Table.from_yaml()

Ниже приведен один и тот же пример, но вместо этого используется строка/документ YAML, которая может быть Table.from_yaml() в Table.from_yaml():

sample_yaml = """
    id: 123
    some_column_name: Test Value
    created_timestamp: 2018-01-01T01:23:45.67890
"""

my_table = Table.from_yaml(sample_yaml, 
                           'my_table', 
                           metadata, 
                           primary_key = 'id')

Когда он будет Table.from_yaml() в Table.from_yaml() он сначала де-сериализует sample_yaml в dict же, как в предыдущем примере, а затем создает объект Table с именем таблицы базы данных my_table который содержит три столбца:

• id который будет иметь тип Integer который установлен как первичный ключ таблицы
• some_column_name которое будет иметь тип Text
• created_datetime которое будет иметь тип DateTime

Надеюсь это поможет!