File: regular-expressions.md

package info (click to toggle)
python-strictyaml 1.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,708 kB
  • sloc: python: 12,836; sh: 48; makefile: 3
file content (150 lines) | stat: -rw-r--r-- 1,903 bytes parent folder | download
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
---
title: Validating strings with regexes (Regex)
---


StrictYAML can validate regular expressions and return a
string. If the regular expression does not match, an
exception is raised.




```python
from strictyaml import Regex, Map, load, as_document
from collections import OrderedDict
from ensure import Ensure

schema = Map({"a": Regex(u"[1-4]"), "b": Regex(u"[5-9]")})

```



Parsed correctly:

```yaml
a: 1
b: 5

```


```python
Ensure(load(yaml_snippet, schema)).equals({"a": "1", "b": "5"})

```




Non-matching:

```yaml
a: 5
b: 5

```


```python
load(yaml_snippet, schema)
```


```python
strictyaml.exceptions.YAMLValidationError:
when expecting string matching [1-4]
found non-matching string
  in "<unicode string>", line 1, column 1:
    a: '5'
     ^ (line: 1)
```




Non-matching suffix:

```yaml
a: 1 Hello
b: 5

```


```python
load(yaml_snippet, schema)
```


```python
strictyaml.exceptions.YAMLValidationError:
when expecting string matching [1-4]
found non-matching string
  in "<unicode string>", line 1, column 1:
    a: 1 Hello
     ^ (line: 1)
```




Serialized successfully:


```python
print(as_document(OrderedDict([("a", "1"), ("b", "5")]), schema).as_yaml())

```

```yaml
a: 1
b: 5
```




Serialization failure non matching regex:


```python
as_document(OrderedDict([("a", "x"), ("b", "5")]), schema)

```


```python
strictyaml.exceptions.YAMLSerializationError:
when expecting string matching [1-4] found 'x'
```




Serialization failure not a string:


```python
as_document(OrderedDict([("a", 1), ("b", "5")]), schema)

```


```python
strictyaml.exceptions.YAMLSerializationError:
when expecting string matching [1-4] got '1' of type int.
```







!!! note "Executable specification"

    Documentation automatically generated from 
    <a href="https://github.com/crdoconnor/strictyaml/blob/master/hitch/story/regexp.story">regexp.story
    storytests.