Skip to main content

Load YAML data fixtures for SQLAlchemy

Project description

Load YAML data fixtures for SQLAlchemy

https://img.shields.io/pypi/v/sqla_yaml_fixtures.svg https://img.shields.io/pypi/l/sqla_yaml_fixtures.svg https://img.shields.io/pypi/pyversions/sqla_yaml_fixtures.svg https://api.shippable.com/projects/5945f25f4fdc63070017442d/badge?branch=master https://api.shippable.com/projects/5945f25f4fdc63070017442d/coverageBadge?branch=master

This package allows you to define some data in YAML and load them into a DB. The yaml data should correspond to SQLAlchemy declarative mappers.

Example:

- User:
  - __key__: joey
    username: joey
    email: joey@example.com
    profile:
      name: Jeffrey

  - __key__: dee
    username: deedee
    email: deedee@example.com

- Profile:
  - user: dee
    name: Douglas

- Group:
  - name: Ramones
    members: [joey.profile, dee.profile]
  • The root of YAML contains a sequence of mapper names e.g. - User, - Profile etc

  • The order of these names should follow relationship dependencies

  • Every name should contain a sequence of instances

  • Each instance is a mapping of attribute -> value

  • the attributes are taken from the mapper __init__() (usually an attributes maps to a column)

  • The special field __key__ can be used to identify this instnace in a relationship reference e.g. The Profile.user

  • Note that any __key__ MUST be globally unique

  • In a to-one relationship the data can be directly nested in the parent data definition

  • References can access attributes using a dot notation, e.g. joey.profile

  • to-many relationships can be added as a list of references

The mapper definition for this example is in the test file.

Installation

pip install sqla-yaml-fixtures

API

This module expose a single function load(ModelBase, session, fixture_text)

Where:

  • ModelBase is SQLAlchemy declarative base

  • session is SQLAlchemy session

  • fixture_text is a string containg the YAML fixtures

from sqlalchemy import create_engine
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import Session

import sqla_yaml_fixtures

BaseModel = declarative_base()

class User(BaseModel):
    __tablename__ = 'user'
    id = Column(Integer, primary_key=True)
    username = Column(String(150), nullable=False, unique=True)
    email = Column(String(254), unique=True)


def main():
    engine = create_engine('sqlite://')
    BaseModel.metadata.create_all(engine)
    connection = engine.connect()
    session = Session(bind=connection)

    fixture = """
    - User:
      - username: deedee
        email: deedee@example.com
      - username: joey
        email: joey@example.commit
    """
    sqla_yaml_fixtures.load(BaseModel, session, fixture)

    print('\n'.join(u.username for u in session.query(User).all()))

if __name__ == '__main__':
    main()

Note: the load() function performs a session.commit().

load() returns an instance of Store. Using this object get() method you can passing a key as argument you get a reference to the object added into the database. This is useful to easily get attributes that are generated by the database.

store = sqla_yaml_fixtures.load(BaseModel, session, fixture)
my_obj = store.get('dee')
print('Created object id: {}'.format(my_obj.id))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqla_yaml_fixtures-0.4.0.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file sqla_yaml_fixtures-0.4.0.tar.gz.

File metadata

File hashes

Hashes for sqla_yaml_fixtures-0.4.0.tar.gz
Algorithm Hash digest
SHA256 375cb3f1f96e751baced1be6d99f705e5ea0a322630851bba58bb89c8f9834e6
MD5 bf67e6882bcf2e862e8e9336ba4d7fca
BLAKE2b-256 72d7895f3b17bf19be7f230c5804023bdc0b51849ca6ce4ab36b1cd9627450c7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page