معرفی شرکت ها
django-choicefield-0.2.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
ChoiceField for Django models
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-choicefield-0.2.1 |
| نام | django-choicefield |
| نسخه کتابخانه | 0.2.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Petter Friberg |
| ایمیل نویسنده | petter_friberg@hotmail.com |
| آدرس صفحه اصلی | https://github.com/flaeppe/django-choicefield/ |
| آدرس اینترنتی | https://pypi.org/project/django-choicefield/ |
| مجوز | BSD 3-Clause License |
<h1 align=center>Django ChoiceField</h1>
<p align=left>
<a href=https://github.com/flaeppe/django-choicefield/actions?query=workflow%3ACI+branch%3Amain><img src=https://github.com/flaeppe/django-choicefield/workflows/CI/badge.svg alt="CI Build Status"></a>
<a href="https://codecov.io/gh/flaeppe/django-choicefield" > <img src="https://codecov.io/gh/flaeppe/django-choicefield/branch/main/graph/badge.svg?token=SV7YKU958R"/> </a>
<a href=https://pypi.org/project/django-choicefield/><img src=https://img.shields.io/pypi/v/django-choicefield.svg?color=informational&label=PyPI alt="PyPI Package"></a>
<a href=https://pypi.org/project/django-choicefield/><img src=https://img.shields.io/pypi/pyversions/django-choicefield.svg?color=informational&label=Python alt="Python versions"></a>
</p>
### Motivation
Have you also felt annoyed by having to convert
[Django's enumeration types](https://docs.djangoproject.com/en/dev/ref/models/fields/#enumeration-types)
_back_ to its type? Using tricks seen below to cast it.
```python
class Suit(models.IntegerChoices):
DIAMOND = 1
SPADE = 2
HEART = 3
CLUB = 4
class Card(models.Model):
suit_kind = models.IntegerField(choices=Suit.choices, db_column="suit")
@property
def suit(self) -> Suit:
return Suit(self.suit_kind)
```
This is what `django-choicefield` helps out with. While it additionally supports using
Python's native [enum.Enum](https://docs.python.org/3/library/enum.html) to express
column values.
### Features
#### Using Django's enumeration types
```python
import choicefield
from django.db import models
class Suit(models.IntegerChoices):
DIAMOND = 1
SPADE = 2
HEART = 3
CLUB = 4
class Card(models.Model):
suit = choicefield.ChoiceField(Suit)
instance = Card.objects.create(suit=Suit.CLUB)
assert instance.suit is Suit.CLUB
```
There's also support for Django's `models.TextChoices`.
#### Using Python's native enumeration
```python
import choicefield
from enum import Enum
from django.db import models
class Suit(int, Enum):
DIAMOND = 1
SPADE = 2
HEART = 3
CLUB = 4
class Card(models.Model):
suit = choicefield.ChoiceField(Suit)
instance = Card.objects.create(suit=Suit.DIAMOND)
assert instance.suit is Suit.DIAMOND
```
#### Passing enum values
It's also possible to pass the _value_ of an enum, which will be converted to its
corresponding enum instance.
```python
instance = Card(suit=2)
assert instance.suit is Suit.SPADE
instance.save()
assert instance.suit is Suit.SPADE
instance = Card.objects.get(suit=2)
assert instance.suit is Suit.SPADE
```
### Getting stored database values
If you want to access the stored database values, without conversion to your enum type,
you can use the registered `__raw` transformer.
```python
Card.objects.values("suit__raw")
# <QuerySet [{'suit__raw': 2}]>
```
#### Getting unrecognized values from database
In case of e.g. a migration where an enum has changed by, say, removing a value. The
database could have values not recognized by the registered enum. Thus it could be
necessary to retrieve values _without_ casting them to an enum instance, as it'd raise
an error.
It can be done using the `__raw` transformer while also sidestepping enum validation in
filter values by using
[`Value` expressions](https://docs.djangoproject.com/en/dev/ref/models/expressions/#value-expressions)
```python
Card.objects.filter(suit=Value(1337)).values_list("suit__raw", flat=True)
# <QuerySet [(1337,)]>
```
### Installation
Using `pip`
```console
$ pip install django-choicefield
```
### Development
#### Running tests
Running the whole test matrix
```console
$ tox
```
Running test suite with an editable install
```console
$ tox -e dev
```
Running the test suite for one environment (non editable)
e.g. `Django==4.0.x` and `Python3.11`
```console
$ tox -e django40-py311
```
#### Start a local example project
There are a couple of shortcut commands available using
[Taskfile](https://taskfile.dev/), for your convenience.
e.g.
```console
$ task manage -- createsuperuser
$ task runserver
```
After [installing Taskfile](https://taskfile.dev/installation/) you can run
`task --list-all` to find all available commands.
### Compatibility
`django-choicefield` is tested according to the table below
| Django version | Python version |
| -------------- | -------------- |
| 4.1.x | ^3.9 |
| 4.0.x | ^3.9 |
| 3.2.x | ^3.9 |
نیازمندی
| مقدار | نام |
|---|---|
| >=3.2 | Django |
| - | pytest |
| - | pytest-django |
| - | pytest-cov |
| - | parameterized |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.9 | Python |
نحوه نصب
نصب پکیج whl django-choicefield-0.2.1:
pip install django-choicefield-0.2.1.whl
نصب پکیج tar.gz django-choicefield-0.2.1:
pip install django-choicefield-0.2.1.tar.gz