| # Copyright 2019 The LUCI Authors. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| """API for generating sequences of numbers.""" |
| |
| def _next(name): |
| """Returns the next value in a sequence. |
| |
| Sequences are auto-incrementing integer counters living in the global |
| interpreter state. They are useful for generating values unique within a |
| single `lucicfg` run. |
| |
| Args: |
| name: name of the sequence to increment. Required. |
| |
| Returns: |
| A positive integer, a new one each call, in the increasing order. |
| """ |
| return __native__.sequence_next(name) |
| |
| sequence = struct(next = _next) |