A package that allows modifying a model of any django app from the outside, without modifying the code of the app itself.
Project description
django-fieldbustier
The purpose of this django-app is to allow you to add, delete, or modify fields in models from third-party applications outside of your django project.
Why this name?
Because wanting to add models from another django-app, from your own, is a bit like wanting to get on a boat and do it by shouting "All Aboard", a knife between your teeth.
And in French, a pirate is also a "flibustier", a word quite close to fieldbustier, so -> django-fieldbustier.
How to use django-fieldbustier
First, add "django_fieldbustier" to your installed apps, above any apps that you intend to modify.
Then, you must declare the fields you want to add, modify, or delete in your settings.
There are three configuration variables that are:
- ADD_FIELD_DJANGO_FIELDBUSTIER to add fields
- REPLACE_FIELD_DJANGO_FIELDBUSTIER to modify fields
- DELETE_FIELD_DJANGO_FIELDBUSTIER to delete fields
To add or modify fields you must use FieldBustierConfig
. To delete fields you must use DeleteFieldBustierConfig
.
FieldBustierConfig
are namedtuple
with these attributes :
- app_name
- model_klass
- field_name
- field_klass (You can use Django Field or your Field)
- args (a tuple for positional args)
- kwargs (a dict for keyword args)
DeleteFieldBustierConfig
are namedtuple
with these attributes :
- app_name
- model_klass
- field_name
Add a Field
from django_fieldbustier.fieldbustier_config import FieldBustierConfig
ADD_FIELD_DJANGO_FIELDBUSTIER = [
FieldBustierConfig(
"demo_app",
"DummyModel",
"new_char_field",
"CharField",
("An another CharField",),
{"blank": True, "max_length": 200},
)
]
Modify a Field
from django_fieldbustier.fieldbustier_config import FieldBustierConfig
REPLACE_FIELD_DJANGO_FIELDBUSTIER = [
FieldBustierConfig(
app_name="demo_app",
model_klass="DummyModel",
field_name="char_field",
field_klass="CharField",
args=("CharField FieldBusted !",),
kwargs={"blank": True, "max_length": 200},
),
FieldBustierConfig(
"demo_app",
"DummyModel",
"decimal_field",
"DecimalField",
("Decimal Field FieldBustier",),
{"default": 2.3, "max_digits": 14, "decimal_places": 3},
),
]
Delete a Field
from django_fieldbustier.fieldbustier_config import FieldBustierConfig
DELETE_FIELD_DJANGO_FIELDBUSTIER = [DeleteFieldBustierConfig("demo_app",
"DummyModel",
"int_field")]
Migrations
GENERATE_FIELDBUSTIER_MIGRATIONS option
If you have used SQL to directly implement your changes, then you will not want the migrations to be generated.
To do this, you just have to set (in your settings) GENERATE_FIELDBUSTIER_MIGRATIONS to False.
Location of migration files
By default, the migration files of an application are located in the application. In our case, if you use Django-Fieldbustier, we want to avoid modifying the target application. The default behavior is therefore not appropriate at all.
To avoid this, simply use django's MIGRATION_MODULES variable to choose where you want your migrations to be generated. Ideally, this should be done at the beginning of a project to avoid issues.
For instance, if editing a model in the built-in django app auth
, we might want to save the migrations in our local users
app. In this case, we could add the following to settings:
MIGRATION_MODULES = {'auth': 'users.migrations_auth'}
This requires copying the original auth
migrations to the migrations_auth
folder inside your users
app. Now your project will look for (and add) migrations files for the auth
app in the migrations_auth
folder inside your users
app.
Thanks
Thanks for Olivier Meunier, Creme CRM codebase and Mezzanine injection Fields system for the original idea.
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
Hashes for django-fieldbustier-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaec5f5db21d69b3254a9dcf69cfa1aaceab8d7d01b9d51e1f73a37f9622796b |
|
MD5 | fa2883ec06349d30988f6f42c33f6fee |
|
BLAKE2b-256 | fc114df594365f9e35e17308447e4ed0a7fff0d9a182d087c0a93974e7bf054b |