File: validators.py

package info (click to toggle)
python-clint 0.5.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 328 kB
  • sloc: python: 1,815; makefile: 3
file content (122 lines) | stat: -rw-r--r-- 2,873 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# -*- coding: utf-8 -*-

"""
clint.textui.validators
~~~~~~~~~~~~~~~~~~~~~~~

Core TextUI functionality for input validation.

"""

from __future__ import absolute_import

import os
import sys
import re

# Useful for very coarse version differentiation.
PY2 = sys.version_info[0] == 2
PY3 = sys.version_info[0] == 3

if PY3:
    string_types = str,
else:
    string_types = basestring,


class ValidationError(Exception):
    """An error while validating data."""

    def __init__(self, message):
        self.message = message
        self.error_list = [self]


class RegexValidator(object):
    regex = ''
    message = 'Enter a valid value.'

    def __init__(self, regex=None, message=None):
        if regex is not None:
            self.regex = regex
        if message is not None:
            self.message = message

        # Compile the regex if it was not passed pre-compiled.
        if isinstance(self.regex, string_types):
            self.regex = re.compile(self.regex)

    def __call__(self, value):
        """
        Validates that the input matches the regular expression.
        """
        if not self.regex.search(value):
            raise ValidationError(self.message)
        return value


class PathValidator(object):
    message = 'Enter a valid path.'

    def __init__(self, message=None):
        if message is not None:
            self.message = message

    def __call__(self, value):
        """
        Validates that the input is a valid directory.
        """
        if not os.path.isdir(value):
            raise ValidationError(self.message)
        return value


class FileValidator(object):
    message = 'Enter a valid file.'

    def __init__(self, message=None):
        if message is not None:
            self.message = message

    def __call__(self, value):
        """
        Validates that the input is a valid file.
        """
        if not os.path.isfile(value):
            raise ValidationError(self.message)
        return value


class IntegerValidator(object):
    message = 'Enter a valid number.'

    def __init__(self, message=None):
        if message is not None:
            self.message = message

    def __call__(self, value):
        """
        Validates that the input is a integer.
        """
        try:
            return int(value)
        except (TypeError, ValueError):
            raise ValidationError(self.message)

class OptionValidator(object):
    message = 'Select from the list of valid options.'

    def __init__(self, options, message=None):
        self.options = options
        if message is not None:
            self.message = message

    def __call__(self, value):
        """
        Validates that the input is in the options list.
        """
        if value in self.options:
            return value
        else:
            raise ValidationError(self.message)