معرفی شرکت ها
django-model-subscription-0.2.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Subscription model for a django model instance.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-model-subscription-0.2.2 |
| نام | django-model-subscription |
| نسخه کتابخانه | 0.2.2 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Tonye Jack |
| ایمیل نویسنده | tonyejck@gmail.com |
| آدرس صفحه اصلی | https://django-model-subscription.readthedocs.io/en/latest/index.html |
| آدرس اینترنتی | https://pypi.org/project/django-model-subscription/ |
| مجوز | MIT |
[](https://pypi.org/project/django-model-subscription/) [](https://github.com/jackton1/django-model-subscription/actions?query=workflow%3A"django+model+subscription+test.")
[](https://django-model-subscription.readthedocs.io/en/latest/?badge=latest)
[](https://www.codacy.com/gh/tj-django/django-model-subscription/dashboard?utm_source=github.com&utm_medium=referral&utm_content=tj-django/django-model-subscription&utm_campaign=Badge_Grade) [](https://www.codacy.com/gh/tj-django/django-model-subscription/dashboard?utm_source=github.com&utm_medium=referral&utm_content=tj-django/django-model-subscription&utm_campaign=Badge_Coverage) [](https://codecov.io/gh/tj-django/django-model-subscription)
[](https://lgtm.com/projects/g/tj-django/django-model-subscription/alerts/) [](https://lgtm.com/projects/g/tj-django/django-model-subscription/context:python) [](https://github.com/jackton1/django-model-subscription/blob/master/LICENSE)
[](https://pypi.org/project/django-model-subscription)
[](https://docs.djangoproject.com/en/2.2/releases/)
[](https://pepy.tech/project/django-model-subscription)
# [django-model-subscription](https://django-model-subscription.readthedocs.io/en/latest/installation.html)
## Table of contents
* [Motivation](#Motivation)
* [Installation](#Installation)
* [Usage](#Usage)
* [Decorators](#Decorators)
* [Setup Subscribers using AppConfig.ready](#setup-subscribers-using-appconfigready-recomended)
* [Setup Subscribers with auto discovery](#setup-subscribers-using-auto-discovery)
* [Credits](#credits)
* [Resources](#resources)
### Motivation
- Using Observer Pattern notify subscribers about changes to a django model.
- Decouple Business logic from Models.save
- Support for bulk actions (Not available using django signals.)
- Use noop subscribers when `settings.SUBSCRIPTION_RUN_EXTERNAL` is `False`
which prevents having to mock subscribers that call external services in testing, local development
environments.
- Show changes to the instance after it has been updated i.e diff's the initial state and the
current state.
### Installation
```bash
$ pip install django-model-subscription
```
Add `model_subscription` to your INSTALLED_APPS
```python
INSTALLED_APPS = [
...,
'model_subscription',
...
]
```
### Usage
##### Using the `SubscriptionModelMixin` and `SubscriptionQuerySet`
```py
from model_subscription.mixin import SubscriptionModelMixin
from model_subscription.model import SubscriptionQuerySet
class TestModel(SubscriptionModelMixin, models.Model):
name = models.CharField(max_length=255)
objects = SubscriptionQuerySet.as_manager()
```
##### Subclassing the `SubscriptionModel` base class.
```py
from model_subscription.model import SubscriptionModel
class TestModel(SubscriptionModel):
name = models.CharField(max_length=255)
```
#### Creating subscribers.
- Using `OperationType`
```python
import logging
from model_subscription.decorators import subscribe
from model_subscription.constants import OperationType
log = logging.getLogger(__name__)
@subscribe(OperationType.CREATE, TestModel)
def handle_create(instance):
log.debug('Created {}'.format(instance.name))
```
- Using `create_subscription` directly (succinct version).
```python
import logging
from model_subscription.decorators import create_subscription
log = logging.getLogger(__name__)
@create_subscription(TestModel)
def handle_create(instance):
log.debug('Created {}'.format(instance.name))
```
### Decorators
* `subscribe`: Explicit (Requires a valid OperationType).
#### (Create, Update, Delete) operations.
* `create_subscription`: Subscribes to create operation i.e a new instance.
```python
@create_subscription(TestModel)
def handle_create(instance):
log.debug('1. Created {}'.format(instance.name))
```
* `update_subscription`: Subscribes to updates also includes (`changed_data`).
```python
@update_subscription(TestModel)
def handle_update(instance, changed_data):
log.debug('Updated {} {}'.format(instance.name, changed_data))
```
* `delete_subscription`: Subscribes to delete operation:
> NOTE: The instance.pk is already set to None.
```python
@delete_subscription(TestModel)
def handle_delete(instance):
log.debug('Deleted {}'.format(instance.name))
```
#### (Bulk Create, Bulk Update, Bulk Delete) operations.
* `bulk_create_subscription`: Subscribe to bulk create operations.
```python
@bulk_create_subscription(TestModel)
def handle_bulk_create(instances):
for instance in instances:
log.debug('Bulk Created {}'.format(instance.name))
```
* `bulk_update_subscription`: Subscribe to bulk update operations.
```python
@bulk_update_subscription(TestModel)
def handle_bulk_update(instances):
for instance in instances:
log.debug('Updated {}'.format(instance.name))
```
* `bulk_delete_subscription`: Subscribe to bulk delete operations.
```python
@bulk_delete_subscription(TestModel)
def handle_bulk_delete(instances):
for instance in instances:
log.debug('Deleted {}'.format(instance.name))
```
### Setup Subscribers using AppConfig.ready `(Recomended)`.
Update you `apps.py`
```python
from django.apps import AppConfig
class MyAppConfig(AppConfig):
name = 'myapp'
def ready(self):
from myapp import subscriptions
```
### Setup Subscribers using auto discovery.
By default the `settings.SUBSCRIPTION_AUTO_DISCOVER` is set to `False`.
To use auto discovery this is not recommended as it would notify the subscribers
wherever the model is used i.e IPython notebook, external scripts.
In your `settings.py` add
```python
SUBSCRIPTION_AUTO_DISCOVER = True
```
#### Setting up the `SUBSCRIPTION_MODULE`
> NOTE: This is only required when ``SUBSCRIPTION_AUTO_DISCOVER = True``
```python
SUBSCRIPTION_MODULE = 'subscription'
```
#### Credits
- [django-lifecycle](https://github.com/rsinger86/django-lifecycle)
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
#### Resources
- https://python-3-patterns-idioms-test.readthedocs.io/en/latest/Observer.html
- https://refactoring.guru/design-patterns/observer
- https://hackernoon.com/observer-vs-pub-sub-pattern-50d3b27f838c
### TODO's
- Supporting field level subscriptions.
- Support class based subscribers which implements `__call__`
- Extend to include custom OperationType.
- Add support for using a single class to manage multiple actions i.e MyClass.update, MyClass.create.
نیازمندی
| مقدار | نام |
|---|---|
| >=3.6,<4.0) | typing |
| >=0.9.0,<0.10.0 | django-lifecycle |
| >=3.7,<4.0 | typing_extensions |
| >=1.14,<2.0 | six |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6.0,<3.10.0 | Python |
نحوه نصب
نصب پکیج whl django-model-subscription-0.2.2:
pip install django-model-subscription-0.2.2.whl
نصب پکیج tar.gz django-model-subscription-0.2.2:
pip install django-model-subscription-0.2.2.tar.gz