timing.cli.toolbox.IntRange Class Reference

Inheritance diagram for timing.cli.toolbox.IntRange:

Collaboration diagram for timing.cli.toolbox.IntRange:

Public Member Functions
	__init__ (self, min=None, max=None, clamp=False)
	convert (self, value, param, ctx)
	__repr__ (self)

Public Attributes
	min = min
	max = max
	clamp = clamp

Static Public Attributes
str	name = 'integer range'

Detailed Description

A parameter that works similar to :data:`click.INT` but restricts
the value to fit into a range.  The default behavior is to fail if the
value falls outside the range, but it can also be silently clamped
between the two edges.

See :ref:`ranges` for an example.

Definition at line 50 of file toolbox.py.

Constructor & Destructor Documentation

__init__()

timing.cli.toolbox.IntRange.__init__	(		self,
			min = None,
			max = None,
			clamp = False )

Definition at line 60 of file toolbox.py.

    def __init__(self, min=None, max=None, clamp=False):
        self.min = min
        self.max = max
        self.clamp = clamp
 

Member Function Documentation

__repr__()

timing.cli.toolbox.IntRange.__repr__

(

self

)

Definition at line 97 of file toolbox.py.

    def __repr__(self):
        return 'IntRange(%r, %r)' % (self.min, self.max)
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------

convert()

timing.cli.toolbox.IntRange.convert	(		self,
			value,
			param,
			ctx )

Definition at line 65 of file toolbox.py.

    def convert(self, value, param, ctx):
        
        if type(value) == str:
            if value.startswith('0x'):
                base = 16
            elif value.startswith('0o'):
                bae = 8
            elif value.startswith('0b'):
                base = 2   
            else:
                base = 10
            rv = int(value, base)
        else:
            rv = int(value)
        if self.clamp:
            if self.min is not None and rv < self.min:
                return self.min
            if self.max is not None and rv > self.max:
                return self.max
        if self.min is not None and rv < self.min or \
           self.max is not None and rv > self.max:
            if self.min is None:
                self.fail('%s is bigger than the maximum valid value '
                          '%s.' % (rv, self.max), param, ctx)
            elif self.max is None:
                self.fail('%s is smaller than the minimum valid value '
                          '%s.' % (rv, self.min), param, ctx)
            else:
                self.fail('%s is not in the valid range of %s to %s.'
                          % (rv, self.min, self.max), param, ctx)
        return rv
 

Member Data Documentation

clamp

timing.cli.toolbox.IntRange.clamp = clamp

Definition at line 63 of file toolbox.py.

max

timing.cli.toolbox.IntRange.max = max

Definition at line 62 of file toolbox.py.

min

timing.cli.toolbox.IntRange.min = min

Definition at line 61 of file toolbox.py.

name

str timing.cli.toolbox.IntRange.name = 'integer range'

static

Definition at line 58 of file toolbox.py.

---

The documentation for this class was generated from the following file:

• /github/workspace/dunedaq/sourcecode/timing/python/timing/cli/toolbox.py