Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gnrfan/django-sequence-field
A Django Field for creating templated sequence strings
https://github.com/gnrfan/django-sequence-field
Last synced: 2 months ago
JSON representation
A Django Field for creating templated sequence strings
- Host: GitHub
- URL: https://github.com/gnrfan/django-sequence-field
- Owner: gnrfan
- License: bsd-3-clause
- Created: 2014-07-03T15:20:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-06-30T01:51:03.000Z (over 5 years ago)
- Last Synced: 2024-08-04T04:05:05.291Z (6 months ago)
- Language: Python
- Size: 211 KB
- Stars: 16
- Watchers: 2
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- starred-awesome - django-sequence-field - A Django Field for creating templated sequence strings (Python)
README
Django Sequence Field
=====================
A Django field for creating templated sequenced strings.
Usage:
Importing and using the SequenceField class:
```python
from sequence_field.fields import SequenceField
# Create your models here.
class TestModel(models.Model):
sequence = SequenceField(
key='test.sequence.1',
template='%Y%m%d%(code)s%NNNNN',
params={'code':'ABC'},
auto=True
)
```
When creating new objects, the sequence is generated automatically
based on the template:
```python
from my_app.models import TestModel
obj = TestModel()
obj.save()
print obj.sequence # 20140703ABC00001
obj = TestModel()
obj.save()
print obj.sequence # 20140703ABC00002
```
An accompaning ```Sequence``` model is used by this app to store the
current value for each key. When a new key is declared in a field a
new ```Sequence``` instance is created and saved on the fly.
If you need to customize the creation of each sequence value passing
different parameters you'll have to do it at the model level with
code like this:
```python
from sequence_field.models import Sequence
print Sequence.next(
'test.sequence.1', template='%Y%m%d%(code)s%NNNNN', params={'code':'XYZ'}
) # 20140703XYZ00003
```
Templates can also be stored in the database so you don't have to pass them
all the time. If a template is provided the first time a key is used it gets
automatically stored.
```python
>>> from sequence_field.models import Sequence
>>> Sequence.next('test.sequence.20', template='%m%d%Y-%NNNNNNNNNNN')
'07042014-00000000001'
>>> Sequence.next('test.sequence.20')
'07042014-00000000002'
```
You can use the provided Expander classes or build your own.
As an example see the code for the ```TimeExpander``` class the uses
Python's ```strftime``` function to perform time-related expansions:
```python
class TimeExpander(BaseExpander):
def expand(self, template=None, count=None, params={}, value=None):
import time
(template, count, params, value) = self.setvars(
template, count, params, value
)
return time.strftime(value)
```
The default expanders are: (taken from the ```constants.py``` file)
```python
SEQUENCE_FIELD_DEFAULT_EXPANDERS = (
'sequence_field.expanders.NumericExpander',
'sequence_field.expanders.TimeExpander',
'sequence_field.expanders.ParameterExpander',
)
```
At your Django project's ```settings.py``` file you can customize this
variables: (default values are shown)
```python
SEQUENCE_FIELD_DEFAULT_VALUE # 1
SEQUENCE_FIELD_ADMIN # True
SEQUENCE_FIELD_DEFAULT_TEMPLATE # '%N'
SEQUENCE_FIELD_DEFAULT_PATTERN # r'(\d+)'
SEQUENCE_FIELD_DEFAULT_EXPANDERS # Already mentioned in the previous section.
```
Installation from Github
========================
```pip install https://github.com/gnrfan/django-sequence-field/zipball/master```
Add this line to your ```requirements.txt``` file:
```-e git+https://github.com/gnrfan/django-sequence-field.git@HEAD#egg=django-sequence-field```
Then just run:
```pip install -r requirements.txt```.
(c) 2014 Antonio Ognio