go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/lucicfg/starlark/stdlib/internal/sequence.star (about)

     1  # Copyright 2019 The LUCI Authors.
     2  #
     3  # Licensed under the Apache License, Version 2.0 (the "License");
     4  # you may not use this file except in compliance with the License.
     5  # You may obtain a copy of the License at
     6  #
     7  #      http://www.apache.org/licenses/LICENSE-2.0
     8  #
     9  # Unless required by applicable law or agreed to in writing, software
    10  # distributed under the License is distributed on an "AS IS" BASIS,
    11  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  # See the License for the specific language governing permissions and
    13  # limitations under the License.
    14  
    15  """API for generating sequences of numbers."""
    16  
    17  def _next(name):
    18      """Returns the next value in a sequence.
    19  
    20      Sequences are auto-incrementing integer counters living in the global
    21      interpreter state. They are useful for generating values unique within a
    22      single `lucicfg` run.
    23  
    24      Args:
    25        name: name of the sequence to increment. Required.
    26  
    27      Returns:
    28        A positive integer, a new one each call, in the increasing order.
    29      """
    30      return __native__.sequence_next(name)
    31  
    32  sequence = struct(next = _next)