sql-fixture 0.1.0

Load YAML data fixtures for SQLAlchemy ✨

Define data in YAML format and load it into a relational database using SQLAlchemy✨

Features

• The YAML root contains a sequence of mapper names, such as - User and - Profile.
• These names should be ordered based on relationship dependencies.
• Each mapper name should contain a sequence of instances.
• An instance is a mapping of attributes to values.
• The attributes are derived from the mapper's __init__() method, which typically maps attributes to columns.
• A special field called __key__ can be used to identify instances in relationship references, such as Profile.user.
• It is crucial to note that any __key__ must be globally unique.
• In a to-one relationships, data can be nested directly in the parent data definition.
• References can access attributes using a dot notation, such as xyz.profile.
• To-many relationships can be added as a list of references.

Example

This module expose a single function load(ModelBase, session, fixture_text, loader=None).

• ModelBase is SQLAlchemy declarative base.
• Session is SQLAlchemy session.
• fixture_text is a string contain 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

from sql_fixture import fixture

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)

    fixtures = """
    - User:
      - username: xyz
        email: [e-mail]
      - username: abc
        email: [e-mail]
    """
    fixture.load(BaseModel, session, fixtures)

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

if __name__ == '__main__':
    main()

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

The load() function yields a fixture.Store instance. With this instance, you can utilize the get() method by providing a key argument to obtain a reference to the object that was added to the database. This approach is convenient for accessing attributes that were produced by the database.

data = fixture.load(BaseModel, session, fixtures)
my_obj = data.get('my_key')
print(f"The id of my_obj is {my_obj.id}")

Warning : The default YAML loading method employs yaml.FullLoader. However, this method is insecure when used to load untrusted input. To address this, it is feasible to replace the default loader with a different one by specifying the loader parameter within the load() function.

Installation

You can add sql-fixture in a few easy steps. First of all, install the dependency:

$ pip install sql_fixture

---> 100%

Successfully installed sql_fixture

Development 🚧

Setup environment 📦

You should create a virtual environment and activate it:

python -m venv venv/

source venv/bin/activate

And then install the development dependencies:

# Install dependencies
pip install -e .[test,lint]

Run tests 🌝

You can run all the tests with:

bash scripts/test.sh

Note: You can also generate a coverage report with:

bash scripts/test_html.sh

Format the code 🍂

Execute the following command to apply pre-commit formatting:

bash scripts/format.sh

Execute the following command to apply mypy type checking:

bash scripts/lint.sh

License

This project is licensed under the terms of the MIT license.