1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
|
%global _empty_manifest_terminate_build 0
Name: python-django-better-choices
Version: 1.17
Release: 1
Summary: Better choices library for Django web framework
License: MIT
URL: https://github.com/lokhman/django-better-choices
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/df/13/b9940aba2fe222159ea656dcb88a5ce5bc56c71faf4ba4959e27f8e119ef/django-better-choices-1.17.tar.gz
BuildArch: noarch
%description
# Django Better Choices
[](https://pypi.org/project/django-better-choices)

[](https://github.com/lokhman/django-better-choices/actions?query=workflow%3ACI)
[](https://codecov.io/gh/lokhman/django-better-choices)
[](LICENSE)
Better [choices](https://docs.djangoproject.com/en/3.0/ref/models/fields/#choices) library for Django web framework.
## Requirements
This library was written for Python 3.7+ and will not work in any earlier versions.
## Install
pip install django-better-choices
## Usage
To start defining better choices, you need first to import the `Choices` class.
```python
from django_better_choices import Choices
```
### Class definition
The choices can be defined with overriding `Choices` class.
```python
class PageStatus(Choices):
CREATED = "Created"
PENDING = Choices.Value("Pending", help_text="This set status to pending")
ON_HOLD = Choices.Value("On Hold", value="custom_on_hold")
VALID = Choices.Subset("CREATED", "ON_HOLD")
INVISIBLE = Choices.Subset("PENDING", "ON_HOLD")
class InternalStatus(Choices):
REVIEW = _("On Review")
@classmethod
def get_help_text(cls):
return tuple(
value.help_text
for value in cls.values()
if hasattr(value, "help_text")
)
```
> Choices class key can be any *public* identifier (i.e. not starting with underscore `_`).
> Overridden choices classes cannot be initialised to obtain a new instance, calling the instance will return a tuple of choice entries.
### Inline definition
Alternatively, the choices can be defined dynamically by creating a new `Choices` instance.
```python
PageStatus = Choices("PageStatus", SUCCESS="Success", FAIL="Error", VALID=Choices.Subset("SUCCESS"))
```
> The first `name` parameter of `Choices` constructor is optional and required only for better representation of the returned instance.
### Value accessors
You can access choices values using dot notation and with `getattr()`.
```python
value_created = PageStatus.CREATED
value_review = PageStatus.InternalStatus.REVIEW
value_on_hold = getattr(PageStatus, "ON_HOLD")
```
### Values and value parameters
`Choices.Value` can hold any `typing.Hashable` value and once compiled equals to this value. In addition to `display` parameter, other optional parameters can be specified in `Choices.Value` constructor (see class definition example).
```python
print( PageStatus.CREATED ) # 'created'
print( PageStatus.ON_HOLD ) # 'custom_on_hold'
print( PageStatus.PENDING.display ) # 'Pending'
print( PageStatus.PENDING.help_text ) # 'This set status to pending'
PageStatus.ON_HOLD == "custom_on_hold" # True
PageStatus.CREATED == PageStatus.CREATED # True
class Rating(Choices):
VERY_POOR = Choices.Value("Very poor", value=1)
POOR = Choices.Value("Poor", value=2)
OKAY = Choices.Value("Okay", value=3, alt="Not great, not terrible")
GOOD = Choices.Value("Good", value=4)
VERY_GOOD = Choices.Value("Very good", value=5)
print( Rating.VERY_GOOD ) # 5
print( Rating.OKAY.alt ) # 'Not great, not terrible'
print( {4: "Alright"}[Rating.GOOD] ) # 'Alright'
```
> Instance of `Choices.Value` class cannot be modified after initialisation. All native non-magic methods can be overridden in `Choices.Value` custom parameters.
### Search in choices
Search in choices is performed by value.
```python
"created" in PageStatus # True
"custom_on_hold" in PageStatus # True
"on_hold" in PageStatus # False
value = PageStatus["custom_on_hold"] # ValueType('custom_on_hold')
value = PageStatus.get("on_hold", 123.45) # 123.45
key = PageStatus.get_key("created") # 'CREATED'
```
### Search in subsets
Subsets are used to group several values together (see class definition example) and search by a specific value.
```python
"custom_on_hold" in PageStatus.VALID # True
PageStatus.CREATED in PageStatus.VALID # True
```
> `Choices.Subset` is a subclass of `tuple`, which is compiled to inner choices class after its definition. All internal or custom choices class methods or properties will be available in a subset class (see "Custom methods" section).
### Extract subset
Subsets of choices can be dynamically extracted with `extract()` method.
```python
PageStatus.extract("CREATED", "ON_HOLD") # Choices('PageStatus.Subset', CREATED, ON_HOLD)
PageStatus.VALID.extract("ON_HOLD") # Choices('PageStatus.VALID.Subset', ON_HOLD)
```
### Exclude values
The opposite action to `extract()` is `exclude()`. It is used to exclude values from choices class or a subset and return remaining values as a new subset.
```python
PageStatus.exclude("CREATED", "ON_HOLD") # Choices('PageStatus.Subset', PENDING)
PageStatus.VALID.exclude("ON_HOLD") # Choices('PageStatus.VALID.Subset', CREATED)
```
### Choices iteration
Choices class implements `__iter__` magic method, hence choices are iterable that yield choice entries (i.e. `(value, display)`). Methods `items()`, `keys()` and `values()` can be used to return tuples of keys and values combinations.
```python
for value, display in PageStatus: # can also be used as callable, i.e. PageStatus()
print( value, display )
for key, value in PageStatus.items():
print( key, value, value.display )
for key in PageStatus.keys():
print( key )
for value in PageStatus.values():
print( value, value.display, value.__choice_entry__ )
```
Additional `displays()` method is provided for choices and subsets to extract values display strings.
```python
for display in PageStatus.displays():
print( display )
for display in PageStatus.SUBSET.displays():
print( display )
```
> Iteration methods `items()`, `keys()`, `values()`, `displays()`, as well as class constructor can accept keyword arguments to filter collections based on custom parameters, e.g. `PageStatus.values(help_text="Some", special=123)`.
### Set operations
Choices class and subsets support standard set operations: *union* (`|`), *intersection* (`&`), *difference* (`-`), and *symmetric difference* (`^`).
```python
PageStatus.VALID | PageStatus.INVISIBLE # Choices(CREATED, ON_HOLD, PENDING)
PageStatus.VALID & PageStatus.INVISIBLE # Choices(ON_HOLD)
PageStatus.VALID - PageStatus.INVISIBLE # Choices(CREATED)
PageStatus.VALID ^ PageStatus.INVISIBLE # Choices(CREATED, PENDING)
```
### Custom methods
All custom choices class methods or properties (non-values) will be available in all subsets.
```python
PageStatus.get_help_text()
PageStatus.VALID.get_help_text()
PageStatus.extract("PENDING", "ON_HOLD").get_help_text()
PageStatus.VALID.extract("ON_HOLD").get_help_text()
```
### Inheritance
Choices fully support class inheritance. All child choices classes have access to parent, grandparent, etc. values and custom methods.
```python
class NewPageStatus(PageStatus):
ARCHIVED = "Archived"
ON_HOLD = Choices.Value("On Hold", value="on-hold") # override parent value
INACTIVE = Choices.Subset("ON_HOLD", "ARCHIVED")
print( NewPageStatus.CREATED ) # 'created'
print( NewPageStatus.ARCHIVED ) # 'archived'
print( NewPageStatus.ON_HOLD ) # 'on-hold'
```
### Django model fields
Better choices are not different from the original Django choices in terms of usage in models.
```python
class Page(models.Model):
status = models.CharField(choices=PageStatus, default=PageStatus.CREATED)
```
> Better choices are fully supported by Django migrations and debug toolbar.
### Saving choices on models
Better choices are compatible with standard Django models manipulation.
```python
page = Page.objects.get(pk=1)
page.status = PageStatus.PENDING
page.save()
```
## Tests
Run `python tests.py` for testing.
## License
Library is available under the MIT license. The included LICENSE file describes this in detail.
%package -n python3-django-better-choices
Summary: Better choices library for Django web framework
Provides: python-django-better-choices
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-django-better-choices
# Django Better Choices
[](https://pypi.org/project/django-better-choices)

[](https://github.com/lokhman/django-better-choices/actions?query=workflow%3ACI)
[](https://codecov.io/gh/lokhman/django-better-choices)
[](LICENSE)
Better [choices](https://docs.djangoproject.com/en/3.0/ref/models/fields/#choices) library for Django web framework.
## Requirements
This library was written for Python 3.7+ and will not work in any earlier versions.
## Install
pip install django-better-choices
## Usage
To start defining better choices, you need first to import the `Choices` class.
```python
from django_better_choices import Choices
```
### Class definition
The choices can be defined with overriding `Choices` class.
```python
class PageStatus(Choices):
CREATED = "Created"
PENDING = Choices.Value("Pending", help_text="This set status to pending")
ON_HOLD = Choices.Value("On Hold", value="custom_on_hold")
VALID = Choices.Subset("CREATED", "ON_HOLD")
INVISIBLE = Choices.Subset("PENDING", "ON_HOLD")
class InternalStatus(Choices):
REVIEW = _("On Review")
@classmethod
def get_help_text(cls):
return tuple(
value.help_text
for value in cls.values()
if hasattr(value, "help_text")
)
```
> Choices class key can be any *public* identifier (i.e. not starting with underscore `_`).
> Overridden choices classes cannot be initialised to obtain a new instance, calling the instance will return a tuple of choice entries.
### Inline definition
Alternatively, the choices can be defined dynamically by creating a new `Choices` instance.
```python
PageStatus = Choices("PageStatus", SUCCESS="Success", FAIL="Error", VALID=Choices.Subset("SUCCESS"))
```
> The first `name` parameter of `Choices` constructor is optional and required only for better representation of the returned instance.
### Value accessors
You can access choices values using dot notation and with `getattr()`.
```python
value_created = PageStatus.CREATED
value_review = PageStatus.InternalStatus.REVIEW
value_on_hold = getattr(PageStatus, "ON_HOLD")
```
### Values and value parameters
`Choices.Value` can hold any `typing.Hashable` value and once compiled equals to this value. In addition to `display` parameter, other optional parameters can be specified in `Choices.Value` constructor (see class definition example).
```python
print( PageStatus.CREATED ) # 'created'
print( PageStatus.ON_HOLD ) # 'custom_on_hold'
print( PageStatus.PENDING.display ) # 'Pending'
print( PageStatus.PENDING.help_text ) # 'This set status to pending'
PageStatus.ON_HOLD == "custom_on_hold" # True
PageStatus.CREATED == PageStatus.CREATED # True
class Rating(Choices):
VERY_POOR = Choices.Value("Very poor", value=1)
POOR = Choices.Value("Poor", value=2)
OKAY = Choices.Value("Okay", value=3, alt="Not great, not terrible")
GOOD = Choices.Value("Good", value=4)
VERY_GOOD = Choices.Value("Very good", value=5)
print( Rating.VERY_GOOD ) # 5
print( Rating.OKAY.alt ) # 'Not great, not terrible'
print( {4: "Alright"}[Rating.GOOD] ) # 'Alright'
```
> Instance of `Choices.Value` class cannot be modified after initialisation. All native non-magic methods can be overridden in `Choices.Value` custom parameters.
### Search in choices
Search in choices is performed by value.
```python
"created" in PageStatus # True
"custom_on_hold" in PageStatus # True
"on_hold" in PageStatus # False
value = PageStatus["custom_on_hold"] # ValueType('custom_on_hold')
value = PageStatus.get("on_hold", 123.45) # 123.45
key = PageStatus.get_key("created") # 'CREATED'
```
### Search in subsets
Subsets are used to group several values together (see class definition example) and search by a specific value.
```python
"custom_on_hold" in PageStatus.VALID # True
PageStatus.CREATED in PageStatus.VALID # True
```
> `Choices.Subset` is a subclass of `tuple`, which is compiled to inner choices class after its definition. All internal or custom choices class methods or properties will be available in a subset class (see "Custom methods" section).
### Extract subset
Subsets of choices can be dynamically extracted with `extract()` method.
```python
PageStatus.extract("CREATED", "ON_HOLD") # Choices('PageStatus.Subset', CREATED, ON_HOLD)
PageStatus.VALID.extract("ON_HOLD") # Choices('PageStatus.VALID.Subset', ON_HOLD)
```
### Exclude values
The opposite action to `extract()` is `exclude()`. It is used to exclude values from choices class or a subset and return remaining values as a new subset.
```python
PageStatus.exclude("CREATED", "ON_HOLD") # Choices('PageStatus.Subset', PENDING)
PageStatus.VALID.exclude("ON_HOLD") # Choices('PageStatus.VALID.Subset', CREATED)
```
### Choices iteration
Choices class implements `__iter__` magic method, hence choices are iterable that yield choice entries (i.e. `(value, display)`). Methods `items()`, `keys()` and `values()` can be used to return tuples of keys and values combinations.
```python
for value, display in PageStatus: # can also be used as callable, i.e. PageStatus()
print( value, display )
for key, value in PageStatus.items():
print( key, value, value.display )
for key in PageStatus.keys():
print( key )
for value in PageStatus.values():
print( value, value.display, value.__choice_entry__ )
```
Additional `displays()` method is provided for choices and subsets to extract values display strings.
```python
for display in PageStatus.displays():
print( display )
for display in PageStatus.SUBSET.displays():
print( display )
```
> Iteration methods `items()`, `keys()`, `values()`, `displays()`, as well as class constructor can accept keyword arguments to filter collections based on custom parameters, e.g. `PageStatus.values(help_text="Some", special=123)`.
### Set operations
Choices class and subsets support standard set operations: *union* (`|`), *intersection* (`&`), *difference* (`-`), and *symmetric difference* (`^`).
```python
PageStatus.VALID | PageStatus.INVISIBLE # Choices(CREATED, ON_HOLD, PENDING)
PageStatus.VALID & PageStatus.INVISIBLE # Choices(ON_HOLD)
PageStatus.VALID - PageStatus.INVISIBLE # Choices(CREATED)
PageStatus.VALID ^ PageStatus.INVISIBLE # Choices(CREATED, PENDING)
```
### Custom methods
All custom choices class methods or properties (non-values) will be available in all subsets.
```python
PageStatus.get_help_text()
PageStatus.VALID.get_help_text()
PageStatus.extract("PENDING", "ON_HOLD").get_help_text()
PageStatus.VALID.extract("ON_HOLD").get_help_text()
```
### Inheritance
Choices fully support class inheritance. All child choices classes have access to parent, grandparent, etc. values and custom methods.
```python
class NewPageStatus(PageStatus):
ARCHIVED = "Archived"
ON_HOLD = Choices.Value("On Hold", value="on-hold") # override parent value
INACTIVE = Choices.Subset("ON_HOLD", "ARCHIVED")
print( NewPageStatus.CREATED ) # 'created'
print( NewPageStatus.ARCHIVED ) # 'archived'
print( NewPageStatus.ON_HOLD ) # 'on-hold'
```
### Django model fields
Better choices are not different from the original Django choices in terms of usage in models.
```python
class Page(models.Model):
status = models.CharField(choices=PageStatus, default=PageStatus.CREATED)
```
> Better choices are fully supported by Django migrations and debug toolbar.
### Saving choices on models
Better choices are compatible with standard Django models manipulation.
```python
page = Page.objects.get(pk=1)
page.status = PageStatus.PENDING
page.save()
```
## Tests
Run `python tests.py` for testing.
## License
Library is available under the MIT license. The included LICENSE file describes this in detail.
%package help
Summary: Development documents and examples for django-better-choices
Provides: python3-django-better-choices-doc
%description help
# Django Better Choices
[](https://pypi.org/project/django-better-choices)

[](https://github.com/lokhman/django-better-choices/actions?query=workflow%3ACI)
[](https://codecov.io/gh/lokhman/django-better-choices)
[](LICENSE)
Better [choices](https://docs.djangoproject.com/en/3.0/ref/models/fields/#choices) library for Django web framework.
## Requirements
This library was written for Python 3.7+ and will not work in any earlier versions.
## Install
pip install django-better-choices
## Usage
To start defining better choices, you need first to import the `Choices` class.
```python
from django_better_choices import Choices
```
### Class definition
The choices can be defined with overriding `Choices` class.
```python
class PageStatus(Choices):
CREATED = "Created"
PENDING = Choices.Value("Pending", help_text="This set status to pending")
ON_HOLD = Choices.Value("On Hold", value="custom_on_hold")
VALID = Choices.Subset("CREATED", "ON_HOLD")
INVISIBLE = Choices.Subset("PENDING", "ON_HOLD")
class InternalStatus(Choices):
REVIEW = _("On Review")
@classmethod
def get_help_text(cls):
return tuple(
value.help_text
for value in cls.values()
if hasattr(value, "help_text")
)
```
> Choices class key can be any *public* identifier (i.e. not starting with underscore `_`).
> Overridden choices classes cannot be initialised to obtain a new instance, calling the instance will return a tuple of choice entries.
### Inline definition
Alternatively, the choices can be defined dynamically by creating a new `Choices` instance.
```python
PageStatus = Choices("PageStatus", SUCCESS="Success", FAIL="Error", VALID=Choices.Subset("SUCCESS"))
```
> The first `name` parameter of `Choices` constructor is optional and required only for better representation of the returned instance.
### Value accessors
You can access choices values using dot notation and with `getattr()`.
```python
value_created = PageStatus.CREATED
value_review = PageStatus.InternalStatus.REVIEW
value_on_hold = getattr(PageStatus, "ON_HOLD")
```
### Values and value parameters
`Choices.Value` can hold any `typing.Hashable` value and once compiled equals to this value. In addition to `display` parameter, other optional parameters can be specified in `Choices.Value` constructor (see class definition example).
```python
print( PageStatus.CREATED ) # 'created'
print( PageStatus.ON_HOLD ) # 'custom_on_hold'
print( PageStatus.PENDING.display ) # 'Pending'
print( PageStatus.PENDING.help_text ) # 'This set status to pending'
PageStatus.ON_HOLD == "custom_on_hold" # True
PageStatus.CREATED == PageStatus.CREATED # True
class Rating(Choices):
VERY_POOR = Choices.Value("Very poor", value=1)
POOR = Choices.Value("Poor", value=2)
OKAY = Choices.Value("Okay", value=3, alt="Not great, not terrible")
GOOD = Choices.Value("Good", value=4)
VERY_GOOD = Choices.Value("Very good", value=5)
print( Rating.VERY_GOOD ) # 5
print( Rating.OKAY.alt ) # 'Not great, not terrible'
print( {4: "Alright"}[Rating.GOOD] ) # 'Alright'
```
> Instance of `Choices.Value` class cannot be modified after initialisation. All native non-magic methods can be overridden in `Choices.Value` custom parameters.
### Search in choices
Search in choices is performed by value.
```python
"created" in PageStatus # True
"custom_on_hold" in PageStatus # True
"on_hold" in PageStatus # False
value = PageStatus["custom_on_hold"] # ValueType('custom_on_hold')
value = PageStatus.get("on_hold", 123.45) # 123.45
key = PageStatus.get_key("created") # 'CREATED'
```
### Search in subsets
Subsets are used to group several values together (see class definition example) and search by a specific value.
```python
"custom_on_hold" in PageStatus.VALID # True
PageStatus.CREATED in PageStatus.VALID # True
```
> `Choices.Subset` is a subclass of `tuple`, which is compiled to inner choices class after its definition. All internal or custom choices class methods or properties will be available in a subset class (see "Custom methods" section).
### Extract subset
Subsets of choices can be dynamically extracted with `extract()` method.
```python
PageStatus.extract("CREATED", "ON_HOLD") # Choices('PageStatus.Subset', CREATED, ON_HOLD)
PageStatus.VALID.extract("ON_HOLD") # Choices('PageStatus.VALID.Subset', ON_HOLD)
```
### Exclude values
The opposite action to `extract()` is `exclude()`. It is used to exclude values from choices class or a subset and return remaining values as a new subset.
```python
PageStatus.exclude("CREATED", "ON_HOLD") # Choices('PageStatus.Subset', PENDING)
PageStatus.VALID.exclude("ON_HOLD") # Choices('PageStatus.VALID.Subset', CREATED)
```
### Choices iteration
Choices class implements `__iter__` magic method, hence choices are iterable that yield choice entries (i.e. `(value, display)`). Methods `items()`, `keys()` and `values()` can be used to return tuples of keys and values combinations.
```python
for value, display in PageStatus: # can also be used as callable, i.e. PageStatus()
print( value, display )
for key, value in PageStatus.items():
print( key, value, value.display )
for key in PageStatus.keys():
print( key )
for value in PageStatus.values():
print( value, value.display, value.__choice_entry__ )
```
Additional `displays()` method is provided for choices and subsets to extract values display strings.
```python
for display in PageStatus.displays():
print( display )
for display in PageStatus.SUBSET.displays():
print( display )
```
> Iteration methods `items()`, `keys()`, `values()`, `displays()`, as well as class constructor can accept keyword arguments to filter collections based on custom parameters, e.g. `PageStatus.values(help_text="Some", special=123)`.
### Set operations
Choices class and subsets support standard set operations: *union* (`|`), *intersection* (`&`), *difference* (`-`), and *symmetric difference* (`^`).
```python
PageStatus.VALID | PageStatus.INVISIBLE # Choices(CREATED, ON_HOLD, PENDING)
PageStatus.VALID & PageStatus.INVISIBLE # Choices(ON_HOLD)
PageStatus.VALID - PageStatus.INVISIBLE # Choices(CREATED)
PageStatus.VALID ^ PageStatus.INVISIBLE # Choices(CREATED, PENDING)
```
### Custom methods
All custom choices class methods or properties (non-values) will be available in all subsets.
```python
PageStatus.get_help_text()
PageStatus.VALID.get_help_text()
PageStatus.extract("PENDING", "ON_HOLD").get_help_text()
PageStatus.VALID.extract("ON_HOLD").get_help_text()
```
### Inheritance
Choices fully support class inheritance. All child choices classes have access to parent, grandparent, etc. values and custom methods.
```python
class NewPageStatus(PageStatus):
ARCHIVED = "Archived"
ON_HOLD = Choices.Value("On Hold", value="on-hold") # override parent value
INACTIVE = Choices.Subset("ON_HOLD", "ARCHIVED")
print( NewPageStatus.CREATED ) # 'created'
print( NewPageStatus.ARCHIVED ) # 'archived'
print( NewPageStatus.ON_HOLD ) # 'on-hold'
```
### Django model fields
Better choices are not different from the original Django choices in terms of usage in models.
```python
class Page(models.Model):
status = models.CharField(choices=PageStatus, default=PageStatus.CREATED)
```
> Better choices are fully supported by Django migrations and debug toolbar.
### Saving choices on models
Better choices are compatible with standard Django models manipulation.
```python
page = Page.objects.get(pk=1)
page.status = PageStatus.PENDING
page.save()
```
## Tests
Run `python tests.py` for testing.
## License
Library is available under the MIT license. The included LICENSE file describes this in detail.
%prep
%autosetup -n django-better-choices-1.17
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-django-better-choices -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 1.17-1
- Package Spec generated
|