[ADD] sequence_python
Tom Blauwendraat
ntsirintanis
parent
e9cfae667c
commit
8a0ba91728
|
|
@ -0,0 +1,113 @@
|
|||
===============================
|
||||
Sequence from Python expression
|
||||
===============================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||
:alt: License: AGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/server-tools/tree/13.0/sequence_python
|
||||
:alt: OCA/server-tools
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-sequence_python
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/149/13.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module allows to generate a sequence by a Python formula expression.
|
||||
|
||||
Besides common Python functions and operators, it provides several functions
|
||||
like 'random' and 'uuid' in the expression, as well as variables such as the
|
||||
next number in the sequence. These are also listed next to the input field
|
||||
on the sequence form view.
|
||||
|
||||
If you want to add more variables for use in the expression, you can extend
|
||||
this module.
|
||||
|
||||
Use cases for this module could be:
|
||||
|
||||
- You want to generate alphanumeric numbering
|
||||
- You want to apply some math to the number to prevent customers from knowing
|
||||
their place in the sequence
|
||||
- You want to use UUID
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
To use this module, you need to:
|
||||
|
||||
* Go to the form view of an `ir.sequence` record
|
||||
* Go to the Python tab
|
||||
* Enable the 'Use Python' checkbox
|
||||
* Change the default 'number' expression to something more fancy.
|
||||
|
||||
Examples:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# To separate the Odoo-generated number with hyphens eg. 0-0-0-0-1
|
||||
'-'.join(number_padded)
|
||||
|
||||
# To have an UUID as the sequence value
|
||||
uuid.uuid4().hex
|
||||
|
||||
# To use an 8-digit binary number
|
||||
'{0:#010b}'.format(number)[2:]
|
||||
|
||||
And so on.
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20sequence_python%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* Sunflower IT
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Tom Blauwendraat <tom@sunflowerweb.nl>
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.
|
||||
|
||||
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/13.0/sequence_python>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import models
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Copyright 2020 ACSONE SA/NV (<http://acsone.eu>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||
{
|
||||
"name": "Sequence from Python expression",
|
||||
"summary": """Calculate a sequence number from a Python expression""",
|
||||
"author": "Sunflower IT,Odoo Community Association (OCA)",
|
||||
"website": "https://github.com/OCA/server-tools",
|
||||
"version": "13.0.1.0.0",
|
||||
"license": "AGPL-3",
|
||||
"category": "Generic Modules",
|
||||
"depends": ["base"],
|
||||
"data": ["views/ir_sequence.xml"],
|
||||
}
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import ir_sequence
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
# Copyright 2020 Sunflower IT (<https://sunflowerweb.nl>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||
import logging
|
||||
import random
|
||||
import string
|
||||
import uuid
|
||||
|
||||
from odoo import fields, models
|
||||
from odoo.tools import safe_eval
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
DEFAULT_PYTHON_CODE = "number_padded"
|
||||
|
||||
|
||||
class IrSequence(models.Model):
|
||||
"""
|
||||
Inherit standard ir.sequence to let the possibility of using a Python formula
|
||||
to calculate the sequence from input variables such as the sequence number.
|
||||
This allows obfuscation of the order in which sequences are given out,
|
||||
but can also be used for any other purpose.
|
||||
"""
|
||||
|
||||
_inherit = "ir.sequence"
|
||||
|
||||
# Python code
|
||||
use_python_code = fields.Boolean(string="Use Python", default=False)
|
||||
python_code = fields.Text(
|
||||
string="Python expression",
|
||||
default=DEFAULT_PYTHON_CODE,
|
||||
help="Write Python code that generates the sequence body.",
|
||||
)
|
||||
python_code_preview = fields.Char("Preview", compute="_compute_python_code_preview")
|
||||
|
||||
def _get_python_eval_context(self, number_next):
|
||||
"""
|
||||
Get the eval context to evaluate the Python code with.
|
||||
The format is (variable name, description, value)
|
||||
You can inherit this in your custom module.
|
||||
:return: tuple
|
||||
"""
|
||||
return {
|
||||
"number": number_next[0] if isinstance(number_next, tuple) else number_next,
|
||||
"number_padded": "%%0%sd" % self.padding % number_next,
|
||||
"sequence": self,
|
||||
"random": random,
|
||||
"uuid": uuid,
|
||||
"string": string,
|
||||
}
|
||||
|
||||
def _get_python_value(self, number_next):
|
||||
"""
|
||||
Use the python formula to get the value.
|
||||
:return: string
|
||||
"""
|
||||
eval_context = self._get_python_eval_context(number_next)
|
||||
return safe_eval(self.python_code.strip(), eval_context)
|
||||
|
||||
def _compute_python_code_preview(self):
|
||||
for this in self:
|
||||
try:
|
||||
this.python_code_preview = self.get_next_char(
|
||||
(self.number_next_actual,)
|
||||
)
|
||||
except Exception as e: # noqa
|
||||
this.python_code_preview = str(e)
|
||||
|
||||
def get_next_char(self, number_next):
|
||||
if self.use_python_code:
|
||||
interpolated_prefix, interpolated_suffix = self._get_prefix_suffix()
|
||||
return (
|
||||
interpolated_prefix
|
||||
+ self._get_python_value(number_next)
|
||||
+ interpolated_suffix
|
||||
)
|
||||
else:
|
||||
return super(IrSequence, self).get_next_char(number_next)
|
||||
|
|
@ -0,0 +1 @@
|
|||
* Tom Blauwendraat <tom@sunflowerweb.nl>
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
This module allows to generate a sequence by a Python formula expression.
|
||||
|
||||
Besides common Python functions and operators, it provides several functions
|
||||
like 'random' and 'uuid' in the expression, as well as variables such as the
|
||||
next number in the sequence. These are also listed next to the input field
|
||||
on the sequence form view.
|
||||
|
||||
If you want to add more variables for use in the expression, you can extend
|
||||
this module.
|
||||
|
||||
Use cases for this module could be:
|
||||
|
||||
- You want to generate alphanumeric numbering
|
||||
- You want to apply some math to the number to prevent customers from knowing
|
||||
their place in the sequence
|
||||
- You want to use UUID
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
To use this module, you need to:
|
||||
|
||||
* Go to the form view of an `ir.sequence` record
|
||||
* Go to the Python tab
|
||||
* Enable the 'Use Python' checkbox
|
||||
* Change the default 'number' expression to something more fancy.
|
||||
|
||||
Examples:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# To separate the Odoo-generated number with hyphens eg. 0-0-0-0-1
|
||||
'-'.join(number_padded)
|
||||
|
||||
# To have an UUID as the sequence value
|
||||
uuid.uuid4().hex
|
||||
|
||||
# To use an 8-digit binary number
|
||||
'{0:#010b}'.format(number + 300)[2:]
|
||||
|
||||
And so on.
|
||||
|
|
@ -0,0 +1,455 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
|
||||
<title>Sequence from Python expression</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="sequence-from-python-expression">
|
||||
<h1 class="title">Sequence from Python expression</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/13.0/sequence_python"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-sequence_python"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This module allows to generate a sequence by a Python formula expression.</p>
|
||||
<p>Besides common Python functions and operators, it provides several functions
|
||||
like ‘random’ and ‘uuid’ in the expression, as well as variables such as the
|
||||
next number in the sequence. These are also listed next to the input field
|
||||
on the sequence form view.</p>
|
||||
<p>If you want to add more variables for use in the expression, you can extend
|
||||
this module.</p>
|
||||
<p>Use cases for this module could be:</p>
|
||||
<ul class="simple">
|
||||
<li>You want to generate alphanumeric numbering</li>
|
||||
<li>You want to apply some math to the number to prevent customers from knowing
|
||||
their place in the sequence</li>
|
||||
<li>You want to use UUID</li>
|
||||
</ul>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
|
||||
<p>To use this module, you need to:</p>
|
||||
<ul class="simple">
|
||||
<li>Go to the form view of an <cite>ir.sequence</cite> record</li>
|
||||
<li>Go to the Python tab</li>
|
||||
<li>Enable the ‘Use Python’ checkbox</li>
|
||||
<li>Change the default ‘number’ expression to something more fancy.</li>
|
||||
</ul>
|
||||
<p>Example:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="c1"># To separate the Odoo-generated number with hyphens eg. 0-0-0-0-1</span>
|
||||
<span class="s1">'-'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">number_padded</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># To have an UUID as the sequence value</span>
|
||||
<span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span><span class="o">.</span><span class="n">hex</span>
|
||||
|
||||
<span class="c1"># To use an 8-digit binary number</span>
|
||||
<span class="p">{</span><span class="mi">0</span><span class="p">:</span><span class="c1">#010b}'.format(number)</span>
|
||||
</pre>
|
||||
<p>The possibilities are nearly endless.</p>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20sequence_python%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Sunflower IT</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Tom Blauwendraat <<a class="reference external" href="mailto:tom@sunflowerweb.nl">tom@sunflowerweb.nl</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/13.0/sequence_python">OCA/server-tools</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Copyright 2020 ACSONE SA/NV (<http://acsone.eu>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||
from . import test_ir_sequence
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# Copyright 2020 ACSONE SA/NV (<http://acsone.eu>)
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||
|
||||
from odoo.tests.common import SavepointCase
|
||||
|
||||
|
||||
class TestIrSequence(SavepointCase):
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
super().setUpClass()
|
||||
cls.Sequence = cls.env["ir.sequence"]
|
||||
cls.sequence = cls.Sequence.create(
|
||||
{
|
||||
"name": "Test sequence",
|
||||
"implementation": "standard",
|
||||
"code": "test.python.sequence",
|
||||
"prefix": "A",
|
||||
"padding": 2,
|
||||
"number_next": 1,
|
||||
"number_increment": 1,
|
||||
"company_id": False,
|
||||
"use_python_code": True,
|
||||
"python_code": "'B' + number_padded + 'C'",
|
||||
}
|
||||
)
|
||||
|
||||
def test_standard_sequence(self):
|
||||
self.assertEquals(self.sequence.python_code_preview, "AB01C")
|
||||
next_number = self.sequence._next()
|
||||
self.assertEquals(next_number, "AB01C")
|
||||
next_number = self.sequence._next()
|
||||
self.assertEquals(next_number, "AB02C")
|
||||
|
||||
def test_nogap_sequence(self):
|
||||
self.sequence.write(dict(implementation="no_gap"))
|
||||
next_number = self.sequence._next()
|
||||
self.assertEquals(next_number, "AB01C")
|
||||
next_number = self.sequence._next()
|
||||
self.assertEquals(next_number, "AB02C")
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<odoo>
|
||||
<record id="sequence_view" model="ir.ui.view">
|
||||
<field name="model">ir.sequence</field>
|
||||
<field name="inherit_id" ref="base.sequence_view" />
|
||||
<field name="arch" type="xml">
|
||||
<xpath expr="//notebook" position="inside">
|
||||
<page name="code" string="Python Code">
|
||||
<group>
|
||||
<field name="use_python_code" />
|
||||
<field
|
||||
name="python_code"
|
||||
widget="ace"
|
||||
options="{'mode': 'python'}"
|
||||
placeholder="number"
|
||||
attrs="{'invisible': [('use_python_code', '=', False)]}"
|
||||
/>
|
||||
<field
|
||||
name="python_code_preview"
|
||||
attrs="{'invisible': [('use_python_code', '=', False)]}"
|
||||
/>
|
||||
</group>
|
||||
<div style="margin-top: 4px;">
|
||||
<h3>Help with Python expressions</h3>
|
||||
<p
|
||||
>The expression you type here will be evaluated as the next number. The following variables can be used:</p>
|
||||
<ul>
|
||||
<li><code
|
||||
>number</code>: The next number of the sequence (integer)</li>
|
||||
<li><code
|
||||
>number_padded</code>: Padded string of the next number of the sequence</li>
|
||||
<li><code
|
||||
>sequence</code>: Odoo record of the sequence being used</li>
|
||||
<li><code
|
||||
>uuid</code>: The Python uuid module, eg. to use <code
|
||||
>uuid.uuid4()</code></li>
|
||||
<li><code
|
||||
>random</code>: The Python random module, eg. to use <code
|
||||
>random.randint(0, 9)</code></li>
|
||||
<li><code
|
||||
>string</code>: The Python string module, eg. to use <code
|
||||
>random.choices(string.ascii_letters + string.digits, k=4)</code></li>
|
||||
</ul>
|
||||
<p>Aside from this, you may use several <a
|
||||
href="https://github.com/odoo/odoo/blob/13.0/odoo/tools/safe_eval.py#L271"
|
||||
>builtin Python functions</a></p>
|
||||
</div>
|
||||
</page>
|
||||
</xpath>
|
||||
</field>
|
||||
</record>
|
||||
</odoo>
|
||||
Loading…
Reference in New Issue