d2a · PyPI

It converts django models to a sqlalchemy orm/expression objects.

These details have not been verified by PyPI

Project links

Homepage

Project description

https://circleci.com/gh/righ/d2a.svg?style=svg

Requirements

Python: 2.7.15 or later, 3.4 or later.
- Tested with 2.7.15, 3.6
Django: 1.9 or later.
- Tested with 1.11, 2.0, 2.1
SQLAlchemy: 0.9 or later.
- Tested with 1.2

Installation

$ pip install d2a

Usage

Auto loading

Just add d2a to settings.INSTALLED_APPS.

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    # top or here
    'd2a',

    # example apps
    'books',
    'sales',
]

Then models_sqla (default) in all apps become possible to be imported as a module.

>>> from books import models_sqla
>>> models_sqla.  # tab completion
models_sqla.Author(            models_sqla.BookCategory(      models_sqla.CategoryRelation(  models_sqla.transfer(
models_sqla.Book(              models_sqla.Category(          models_sqla.models

>>> models_sqla.Book
<class 'd2a.book'>

>>> models_sqla.Book.  # tab completion
models_sqla.Book.author       models_sqla.Book.content      models_sqla.Book.metadata     models_sqla.Book.tags
models_sqla.Book.author_id    models_sqla.Book.description  models_sqla.Book.mro(         models_sqla.Book.title
models_sqla.Book.category     models_sqla.Book.id           models_sqla.Book.price
# SQL Expression schema
>>> models_sqla.Book.__table__
Table(
  'book', MetaData(bind=None),
  Column('id', UUID(), table=<book>, primary_key=True, nullable=False, default=ColumnDefault(<function uuid4 at 0x7f3cebe7e598>)),
  Column('price', JSON(astext_type=Text()), table=<book>, nullable=False),
  Column('title', VARCHAR(length=255), table=<book>, nullable=False),
  Column('description', TEXT(), table=<book>),
  Column('author_id', INTEGER(), ForeignKey('author.id'), table=<book>),
  Column('content', BYTEA(), table=<book>, nullable=False),
  Column('tags', ARRAY(VARCHAR()), table=<book>, nullable=False),
  schema=None
)

Also, it can extract model declared implicitly depending on m2m field. (in this case, BookCategory)

Note

You can set configrations to settings.py.

Example:

# This variable can be omitted.
D2A_CONFIG = {
    'AUTOLOAD': { # optional
        # module name: It can be used different module name from `models_sqla`.
        'module': 'modelsa',  # optional, default: 'models_sqla'
        # waiting seconds during autoloading
        'seconds': 5,  # default: 1
        # transfer function's args after 'exports' arg.
        'option': {  # optional
            'db_type': 'postgresql',  # default: 'default'
            'back_type': 'backref',  # default: 'backref'
            'as_table': True,  # default: False
            'name_formatter': str.upper,  # default: get_camelcase
        }
    },
    # converting rules for customized fields
    'ALIASES': {  # optional
        # Evaluates ExtendedImageField as ImageField
        ExtendedImageField: models.ImageField,
    },
}

Per models module

If you want to create a module manually, create a models_sqla.py in the apps.

Write like the following to it`:

from d2a import transfer
from . import models
transfer(models, globals())

models_sqla.py exists, auto module creation will be omitted.

And if you create every models_sqla.py manually, it is unnecessary to set d2a to settings.INSTALLED_APPS.

Example:

project_postgresql/books/models_sqla.py
You can omit specifying db_type, then it automatically detects a database type from settings.DATABASES['default'].
- Now postgresql, mysql and oracle are allowed, the other types will be converted to the following types as default type: sqlalchemy/types.py

Per model

If you just want to convert one model, you should use declare function.

>>> from d2a import declare
>>> from sales.models import Sales
>>> sales = declare(Sales)
>>> sales
<class 'd2a.sales'>

>>> sales.__table__
Table(
  'sales', MetaData(bind=None),
  Column('id', BIGINT(), table=<sales>, primary_key=True, nullable=False),
  Column('book_id', UUID(), ForeignKey('book.id'), table=<sales>, nullable=False),
  Column('sold', TIMESTAMP(), table=<sales>, nullable=False),
  Column('reservation', INTERVAL(), table=<sales>),
  Column('source', INET(), table=<sales>),
  schema=None
)

>>> sales.
sales.book         sales.id           sales.mro(         sales.sold
sales.book_id      sales.metadata     sales.reservation  sales.source

Custom fields

If you are using customized field not built-in, you can register the field as the other field using alias or alias_dict method.

from django.db.models import ImageField

class ExtendedImageField(ImageField):
    """something customizing"""

from d2a import alias
alias(ExtendedImageField, ImageField)

# or
alias_dict({
  ExtendedImageField: ImageField,
})

Demo

start up environment

$ git clone git@github.com:righ/d2a.git
$ cd d2a
$ docker-compose up

preparation

$ docker exec -it d2a_app_1 /bin/bash
# python -m venv venv # only first time
# source venv/bin/activate
(venv) # cd project_postgresql/ # (or mysql)
(venv) project_postgresql # ./manage.py migrate

execute

(venv) project_postgresql # ./manage.py shell

>>> from books import models_sqla
>>> book = models_sqla.Book()
>>> author = models_sqla.Author()
>>> book.author = author
>>> author.books
[<d2a.book object at 0x7f3cec539358>]
# And do something you want do ;)

History

1.1.x:

(2019-02-17)
Added a function to load all models automatically.

1.0.2:

(2018-07-10)
Improved a little.

1.0.1:

(2018-07-06)
Fixed a bug, that it will be provided None even though it’s not specified default argument.

1.0.0:

(2018-07-05)
Fixed bugs.
Added unit tests.

0.0.6:

Fixed a bug that abstract models become the targets.
Deleted install_requires.

0.0.5:

added alias method.

0.0.4:

fixed bugs.

0.0.3:

it got easy to declare custom field.
transfer method can define secondary table.

0.0.2:

it supported m2m field.
it limited django version less than 1.9.

0.0.1:

first release (2017-12-27)

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

3.0.1

Apr 18, 2021

3.0.0

Apr 17, 2021

3.0.0b12 pre-release

Apr 17, 2021

3.0.0b11 pre-release

Apr 17, 2021

3.0.0b10 pre-release

Apr 17, 2021

3.0.0b9 pre-release

Apr 17, 2021

3.0.0b8 pre-release

Apr 17, 2021

3.0.0b7 pre-release

Apr 17, 2021

3.0.0b6 pre-release

Apr 16, 2021

3.0.0b5 pre-release

Apr 16, 2021

3.0.0b4 pre-release

Apr 16, 2021

3.0.0b3 pre-release

Apr 16, 2021

3.0.0b2 pre-release

Apr 16, 2021

3.0.0b1 pre-release

Apr 16, 2021

2.8.0

Mar 19, 2021

2.7.0

Sep 19, 2020

2.6.2

Jun 23, 2020

2.6.1

Jun 21, 2020

2.6.0

Jun 6, 2020

2.5.0

May 26, 2020

2.4.0

May 26, 2020

2.3.0

May 25, 2020

2.2.2

Feb 13, 2020

2.2.1

Jan 3, 2020

2.2.0

Jan 3, 2020

2.1.2

Jun 15, 2019

2.1.1

May 5, 2019

2.1.0

Apr 24, 2019

2.0.0

Mar 20, 2019

This version

1.1.4

Feb 28, 2019

1.1.3

Feb 21, 2019

1.1.2

Feb 21, 2019

1.1.1

Feb 20, 2019

1.1.0

Feb 17, 2019

1.0.2

Jul 10, 2018

1.0.1

Jul 6, 2018

1.0.0

Jul 5, 2018

0.0.6

Feb 9, 2018

0.0.5

Feb 6, 2018

0.0.4

Jan 9, 2018

0.0.3

Jan 4, 2018

0.0.2

Dec 29, 2017

0.0.1

Dec 27, 2017

Download files

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

Source Distribution

d2a-1.1.4.tar.gz (8.9 kB view details)

Uploaded Feb 28, 2019 Source

Built Distribution

d2a-1.1.4-py3-none-any.whl (9.6 kB view details)

Uploaded Feb 28, 2019 Python 3

File details

Details for the file d2a-1.1.4.tar.gz.

File metadata

Download URL: d2a-1.1.4.tar.gz
Upload date: Feb 28, 2019
Size: 8.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.4

File hashes

Hashes for d2a-1.1.4.tar.gz
Algorithm	Hash digest
SHA256	`25cefb3ced28a17476f1d742118961166a89d57876d4dcd2b1f26ce8f0d2ea8c`
MD5	`6ee180927630d931897554a58f1acf53`
BLAKE2b-256	`34c2e41d3574161721d778c17396e7850fccad1a37632718b49c370787359692`

See more details on using hashes here.

File details

Details for the file d2a-1.1.4-py3-none-any.whl.

File metadata

Download URL: d2a-1.1.4-py3-none-any.whl
Upload date: Feb 28, 2019
Size: 9.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.4

File hashes

Hashes for d2a-1.1.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`5159e2123a0e1cc7cb5e0ef450661d50f5f5cfb886c0c44a0aa7771d9718292a`
MD5	`97d9dcb8266465482b1aefc9e5247cc6`
BLAKE2b-256	`b5e44c596a4c96383f534b833446e37e5d29cfbc1140b230254daace36c3661c`