You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ Timeout is best effort. The exact time is not guaranteed.
110
110
111
111
## API Overview
112
112
113
-
`RegexSolverClient` and `AsyncRegexSolverClient` expose the following methods. Every method accepts optional keyword arguments: operations that return a term take `response_format`, `deterministic` and `execution_timeout`, while analyze operations and `determinize()` take `execution_timeout` only — the response format is not theirs to choose.
113
+
`RegexSolverClient` and `AsyncRegexSolverClient` expose the following methods. Every method accepts optional keyword arguments: operations that return a term take `response_format`, `deterministic` and `execution_timeout`, while analyze operations and `determinize()` take `execution_timeout` only; the response format is not theirs to choose. `generate_strings()` additionally takes its ordering, seed, length and charset options as keyword arguments.
114
114
115
115
### Analyze
116
116
@@ -125,7 +125,7 @@ Timeout is best effort. The exact time is not guaranteed.
125
125
|`client.is_empty_string(term, **kwargs)`|`bool`|`True` if the term matches only the empty string. |
126
126
|`client.is_total(term, **kwargs)`|`bool`|`True` if the term matches all possible strings. |
127
127
|`client.is_deterministic(term, **kwargs)`|`bool`|`True` if the term's automaton is deterministic. Only a deterministic FAIR guarantees consistent string ordering across paginated `generate_strings()` calls; call `determinize()` first if this is `False`. |
128
-
|`client.subset(term1, term2, **kwargs)`|`bool`|`True` if every string matched by `term1` is also matched by `term2`. |
128
+
|`client.subset(term_subset, term_superset, **kwargs)`|`bool`|`True` if every string matched by `term_subset` is also matched by `term_superset`. |
129
129
130
130
*Note: For `AsyncRegexSolverClient`, these methods are coroutines and must be awaited.*
131
131
@@ -136,9 +136,9 @@ Timeout is best effort. The exact time is not guaranteed.
136
136
|`client.complement(term, **kwargs)`|`Term`| Computes the complement of the given term. |
137
137
|`client.concat(term1, term2, ..., **kwargs)`|`Term`| Concatenates multiple terms in order. |
138
138
|`client.determinize(term, **kwargs)`|`Term`| Computes a deterministic FAIR for the given term, suitable for consistent pagination with `generate_strings()`. |
139
-
|`client.difference(term1, term2, **kwargs)`|`Term`| Computes the difference `term1 - term2`. |
139
+
|`client.difference(base_term, excluded_term, **kwargs)`|`Term`| Computes the difference `base_term - excluded_term`. |
140
140
|`client.intersection(term1, term2, ..., **kwargs)`|`Term`| Computes the intersection of the given terms. |
141
-
|`client.repeat(term, min, max, **kwargs)`|`Term`| Computes the repetition of the term between `min` and `max` times. |
141
+
|`client.repeat(term, min_val, max_val, **kwargs)`|`Term`| Computes the repetition of the term between `min_val` and `max_val` times. |
142
142
|`client.union(term1, term2, ..., **kwargs)`|`Term`| Computes the union of the given terms. |
143
143
144
144
*Note: For `AsyncRegexSolverClient`, these methods are coroutines and must be awaited.*
@@ -147,7 +147,7 @@ Timeout is best effort. The exact time is not guaranteed.
147
147
148
148
| Method | Return | Description |
149
149
| -------- | ------- | ------- |
150
-
|`client.generate_strings(term, limit, offset, **kwargs)`|`List[str]`| Generates up to `limit` unique strings matched by `term`, skipping the first `offset` strings. |
150
+
|`client.generate_strings(term, limit, offset, **kwargs)`|`List[str]`| Generates up to `limit` unique strings matched by `term`, skipping the first `offset` strings. Keyword arguments control `path_order`, `character_order`, `seed`, `min_length`, `max_length` and `charset`. |
151
151
152
152
*Note: For `AsyncRegexSolverClient`, this method is a coroutine and must be awaited.*
0 commit comments