js-regex2 1.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1,134 @@
1
+ Metadata-Version: 2.4
2
+ Name: js-regex2
3
+ Version: 1.0.2
4
+ Summary: A thin compatibility layer to use Javascript regular expressions in Python
5
+ Home-page: https://github.com/ciphertechsolutions/js-regex
6
+ Author: Cipher Tech Solutions
7
+ Author-email: opensource@ciphertechsolutions.com
8
+ License: MPL 2.0
9
+ Keywords: python javascript regex compatibility
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
13
+ Classifier: Programming Language :: JavaScript
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Topic :: Software Development :: Testing
22
+ Classifier: Topic :: Text Processing
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.10
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Provides-Extra: test
28
+ Requires-Dist: pytest; extra == "test"
29
+ Requires-Dist: pytest-cov; extra == "test"
30
+ Dynamic: author
31
+ Dynamic: author-email
32
+ Dynamic: classifier
33
+ Dynamic: description
34
+ Dynamic: description-content-type
35
+ Dynamic: home-page
36
+ Dynamic: keywords
37
+ Dynamic: license
38
+ Dynamic: license-file
39
+ Dynamic: provides-extra
40
+ Dynamic: requires-python
41
+ Dynamic: summary
42
+
43
+ # js-regex
44
+
45
+ *A compatibility layer to use Javascript regular expressions in Python.*
46
+
47
+ Did you know that regular expressions may vary between programming languages?
48
+ For example, let's consider the pattern `"^abc$"`, which matches the string
49
+ `"abc"`. But what about the string `"abc\n"`? It's also matched in Python,
50
+ but not in Javascript!
51
+
52
+ This and other slight differences can be really important for cross-language
53
+ standards like `jsonschema`, and that's why `js-regex` exists.
54
+
55
+ ## How it works
56
+
57
+ ```python
58
+ import re
59
+ import js_regex
60
+
61
+ re.compile("^abc$").search("abc\n") # matches, unlike JS
62
+ js_regex.compile("^abc$").search("abc\n") # does not match
63
+ ```
64
+
65
+ Internally, `js_regex.compile()` replaces JS regex syntax which has a different
66
+ meaning in Python with whatever *Python* regex syntax has the intended meaning.
67
+
68
+ **This only works for the `.search()` method** - there is no equivalent to
69
+ `.match()` or `.fullmatch()` for Javascript regular expressions.
70
+
71
+ We also check for constructs which are valid in Python but not JS - such as
72
+ named capture groups - and raise an explicit error. Constructs which are valid
73
+ in JS but not Python may also raise an error, because we're still using Python's
74
+ `re.compile()` function under the hood!
75
+
76
+ The following table is adapted from [this larger version](https://web.archive.org/web/20130830063653/http://www.regular-expressions.info:80/refflavors.html),
77
+ ommiting other languages and any rows where JS and Python have the same behaviour.
78
+
79
+ | Feature | Javascript | Python | Handling
80
+ | --- | --- | --- | ---
81
+ | `\a` (bell) | no | yes | Converted to JS behaviour
82
+ | `\ca`-`\cz` and `\cA`-`\cZ` (control characters) | yes | no | Converted to JS behaviour
83
+ | `\d` for digits, `\w` for word chars, `\s` for whitespace | ascii | unicode | Converted to JS behaviour (including `\D`, `\W`, `\S` for negated classes)
84
+ | `$` (end of line/string) | at end | allows trailing `\n` | Converted to JS behaviour
85
+ | `\A` (start of string) | no | yes | Explicit error, use `^` instead
86
+ | `\Z` (end of string) | no | yes | Explicit error, use `$` instead
87
+ | `(?<=text)` (positive lookbehind) | new in ES2018 | yes | Allowed
88
+ | `(?<!text)` (negative lookbehind) | new in ES2018 | yes | Allowed
89
+ | `(?(1)then\|else)` | no | yes | Explicit error
90
+ | `(?(group)then\|else)` | no | yes | Explicit error
91
+ | `(?#comment)` | no | yes | Explicit error
92
+ | `(?P<name>regex)` (Python named capture group) | no | yes | Not detected (yet)
93
+ | `(?P=name)` (Python named backreference) | no | yes | Not detected (yet)
94
+ | `(?<name>regex)` (JS named capture group) | new in ES2018 | no | Error from Python, not translated (yet)
95
+ | `$<name>` (JS named backreference) | new in ES2018 | no | Error from Python, not translated (yet)
96
+ | `(?i)` (case insensitive) | `/i` only | yes | Explicit error, compile with `flags=re.IGNORECASE` instead
97
+ | `(?m)` (`^` and `$` match at line breaks) | `/m` only | yes | Explicit error, compile with `flags=re.MULTILINE` instead
98
+ | `(?s)` (dot matches newlines) | no | yes | Explicit error, compile with `flags=re.DOTALL` instead
99
+ | `(?x)` (free-spacing mode) | no | yes | Explicit error, there is no corresponding mode in Javascript
100
+ | Backreferences non-existent groups are an error | no | yes | Follows Python behaviour
101
+ | Backreferences to failed groups also fail | no | yes | Follows Python behaviour
102
+ | Nested references `\1` through `\9` | yes | no | Follows Python behaviour
103
+
104
+ Note that in many cases Python-only regex features would be treated as part of
105
+ an ordinary pattern by JS regex engines. Currently we raise an explicit error
106
+ on such inputs, but may translate them to have the JS behaviour in a future version.
107
+
108
+
109
+ ## Changelog
110
+
111
+ #### 1.0.1 - 2019-10-17
112
+ - Allow use of native strings on Python 2. This is not actually valid according
113
+ to the spec, but it's only going to be around for a few months so whatever.
114
+
115
+ #### 1.0.0 - 2019-10-04
116
+ - Now considered feature-complete and stable, as all constructs recommended
117
+ for `jsonschema` patterns are supported and all Python-side incompatibilities
118
+ are detected.
119
+ - Compiled patterns are now cached on Python 3, exactly as for `re.compile`
120
+
121
+ #### 0.4.0 - 2019-10-03
122
+ - Now compatible with Python 2.7 and 3.5, until
123
+ [their respective EOL dates](https://devguide.python.org/#status-of-python-branches).
124
+
125
+ #### 0.3.0 - 2019-09-30
126
+ - Fixed handling of non-trailing `$`, e.g. in `"^abc$|^def$"` both are converted
127
+ - Added explicit errors for `re.LOCALE` and `re.VERBOSE` flags, which have no JS equivalent
128
+ - Added explicit checks and errors for use of Python-only regex features
129
+
130
+ #### 0.2.0 - 2019-09-28
131
+ Convert JS-only syntax to Python equivalent wherever possible.
132
+
133
+ #### 0.1.0 - 2019-09-28
134
+ Initial release, with project setup and a very basic implementation.
@@ -0,0 +1,92 @@
1
+ # js-regex
2
+
3
+ *A compatibility layer to use Javascript regular expressions in Python.*
4
+
5
+ Did you know that regular expressions may vary between programming languages?
6
+ For example, let's consider the pattern `"^abc$"`, which matches the string
7
+ `"abc"`. But what about the string `"abc\n"`? It's also matched in Python,
8
+ but not in Javascript!
9
+
10
+ This and other slight differences can be really important for cross-language
11
+ standards like `jsonschema`, and that's why `js-regex` exists.
12
+
13
+ ## How it works
14
+
15
+ ```python
16
+ import re
17
+ import js_regex
18
+
19
+ re.compile("^abc$").search("abc\n") # matches, unlike JS
20
+ js_regex.compile("^abc$").search("abc\n") # does not match
21
+ ```
22
+
23
+ Internally, `js_regex.compile()` replaces JS regex syntax which has a different
24
+ meaning in Python with whatever *Python* regex syntax has the intended meaning.
25
+
26
+ **This only works for the `.search()` method** - there is no equivalent to
27
+ `.match()` or `.fullmatch()` for Javascript regular expressions.
28
+
29
+ We also check for constructs which are valid in Python but not JS - such as
30
+ named capture groups - and raise an explicit error. Constructs which are valid
31
+ in JS but not Python may also raise an error, because we're still using Python's
32
+ `re.compile()` function under the hood!
33
+
34
+ The following table is adapted from [this larger version](https://web.archive.org/web/20130830063653/http://www.regular-expressions.info:80/refflavors.html),
35
+ ommiting other languages and any rows where JS and Python have the same behaviour.
36
+
37
+ | Feature | Javascript | Python | Handling
38
+ | --- | --- | --- | ---
39
+ | `\a` (bell) | no | yes | Converted to JS behaviour
40
+ | `\ca`-`\cz` and `\cA`-`\cZ` (control characters) | yes | no | Converted to JS behaviour
41
+ | `\d` for digits, `\w` for word chars, `\s` for whitespace | ascii | unicode | Converted to JS behaviour (including `\D`, `\W`, `\S` for negated classes)
42
+ | `$` (end of line/string) | at end | allows trailing `\n` | Converted to JS behaviour
43
+ | `\A` (start of string) | no | yes | Explicit error, use `^` instead
44
+ | `\Z` (end of string) | no | yes | Explicit error, use `$` instead
45
+ | `(?<=text)` (positive lookbehind) | new in ES2018 | yes | Allowed
46
+ | `(?<!text)` (negative lookbehind) | new in ES2018 | yes | Allowed
47
+ | `(?(1)then\|else)` | no | yes | Explicit error
48
+ | `(?(group)then\|else)` | no | yes | Explicit error
49
+ | `(?#comment)` | no | yes | Explicit error
50
+ | `(?P<name>regex)` (Python named capture group) | no | yes | Not detected (yet)
51
+ | `(?P=name)` (Python named backreference) | no | yes | Not detected (yet)
52
+ | `(?<name>regex)` (JS named capture group) | new in ES2018 | no | Error from Python, not translated (yet)
53
+ | `$<name>` (JS named backreference) | new in ES2018 | no | Error from Python, not translated (yet)
54
+ | `(?i)` (case insensitive) | `/i` only | yes | Explicit error, compile with `flags=re.IGNORECASE` instead
55
+ | `(?m)` (`^` and `$` match at line breaks) | `/m` only | yes | Explicit error, compile with `flags=re.MULTILINE` instead
56
+ | `(?s)` (dot matches newlines) | no | yes | Explicit error, compile with `flags=re.DOTALL` instead
57
+ | `(?x)` (free-spacing mode) | no | yes | Explicit error, there is no corresponding mode in Javascript
58
+ | Backreferences non-existent groups are an error | no | yes | Follows Python behaviour
59
+ | Backreferences to failed groups also fail | no | yes | Follows Python behaviour
60
+ | Nested references `\1` through `\9` | yes | no | Follows Python behaviour
61
+
62
+ Note that in many cases Python-only regex features would be treated as part of
63
+ an ordinary pattern by JS regex engines. Currently we raise an explicit error
64
+ on such inputs, but may translate them to have the JS behaviour in a future version.
65
+
66
+
67
+ ## Changelog
68
+
69
+ #### 1.0.1 - 2019-10-17
70
+ - Allow use of native strings on Python 2. This is not actually valid according
71
+ to the spec, but it's only going to be around for a few months so whatever.
72
+
73
+ #### 1.0.0 - 2019-10-04
74
+ - Now considered feature-complete and stable, as all constructs recommended
75
+ for `jsonschema` patterns are supported and all Python-side incompatibilities
76
+ are detected.
77
+ - Compiled patterns are now cached on Python 3, exactly as for `re.compile`
78
+
79
+ #### 0.4.0 - 2019-10-03
80
+ - Now compatible with Python 2.7 and 3.5, until
81
+ [their respective EOL dates](https://devguide.python.org/#status-of-python-branches).
82
+
83
+ #### 0.3.0 - 2019-09-30
84
+ - Fixed handling of non-trailing `$`, e.g. in `"^abc$|^def$"` both are converted
85
+ - Added explicit errors for `re.LOCALE` and `re.VERBOSE` flags, which have no JS equivalent
86
+ - Added explicit checks and errors for use of Python-only regex features
87
+
88
+ #### 0.2.0 - 2019-09-28
89
+ Convert JS-only syntax to Python equivalent wherever possible.
90
+
91
+ #### 0.1.0 - 2019-09-28
92
+ Initial release, with project setup and a very basic implementation.
@@ -0,0 +1,8 @@
1
+ [metadata]
2
+ description-file = README.md
3
+ license_file = LICENSE
4
+
5
+ [egg_info]
6
+ tag_build =
7
+ tag_date = 0
8
+
@@ -0,0 +1,62 @@
1
+ """It's a setup.py"""
2
+
3
+ import os
4
+
5
+ import setuptools
6
+
7
+
8
+ def local_file(name):
9
+ # type: (str) -> str
10
+ """Interpret filename as relative to this file."""
11
+ return os.path.relpath(os.path.join(os.path.dirname(__file__), name))
12
+
13
+
14
+ SOURCE = local_file("src")
15
+ README = local_file("README.md")
16
+
17
+ with open(local_file("src/js_regex/__init__.py")) as o:
18
+ for line in o:
19
+ if line.startswith("__version__"):
20
+ _, __version__, _ = line.split('"')
21
+
22
+
23
+ setuptools.setup(
24
+ name="js-regex2",
25
+ version=__version__,
26
+ author="Cipher Tech Solutions",
27
+ author_email="opensource@ciphertechsolutions.com",
28
+ packages=setuptools.find_packages(SOURCE),
29
+ package_dir={"": SOURCE},
30
+ package_data={"": ["py.typed"]},
31
+ url="https://github.com/ciphertechsolutions/js-regex",
32
+ license="MPL 2.0",
33
+ description="A thin compatibility layer to use Javascript regular expressions in Python",
34
+ zip_safe=False,
35
+ install_requires=[],
36
+ extras_require={
37
+ "test": [
38
+ "pytest",
39
+ "pytest-cov",
40
+ ]
41
+ },
42
+ python_requires=">=3.10",
43
+ classifiers=[
44
+ "Development Status :: 4 - Beta",
45
+ "Intended Audience :: Developers",
46
+ "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
47
+ "Programming Language :: JavaScript",
48
+ "Programming Language :: Python",
49
+ "Programming Language :: Python :: 3",
50
+ "Programming Language :: Python :: 3.10",
51
+ "Programming Language :: Python :: 3.11",
52
+ "Programming Language :: Python :: 3.12",
53
+ "Programming Language :: Python :: 3.13",
54
+ "Programming Language :: Python :: 3.14",
55
+ "Topic :: Software Development :: Testing",
56
+ "Topic :: Text Processing",
57
+ "Typing :: Typed",
58
+ ],
59
+ long_description=open(README).read(),
60
+ long_description_content_type="text/markdown",
61
+ keywords="python javascript regex compatibility",
62
+ )
@@ -0,0 +1,6 @@
1
+ """A thin compatibility layer to use Javascript regular expressions in Python."""
2
+
3
+ __version__ = "1.0.2"
4
+ __all__ = ["NotJavascriptRegex", "compile"]
5
+
6
+ from ._impl import NotJavascriptRegex, compile
@@ -0,0 +1,173 @@
1
+ """The implementation of the js-regex library."""
2
+ from __future__ import unicode_literals
3
+
4
+ import re
5
+ import sys
6
+ try: # pragma: no cover
7
+ import re._parser as sre_parse
8
+ import re._constants as sre_constants
9
+ except ImportError: # pragma: no cover
10
+ import sre_parse
11
+ import sre_constants
12
+ from sys import version_info as python_version
13
+
14
+ try:
15
+ from functools import lru_cache
16
+ from typing import Any, Pattern # pragma: no cover # for Python 2
17
+ except ImportError: # pragma: no cover
18
+
19
+ def lru_cache(maxsize): # type: ignore
20
+ return lambda f: f
21
+
22
+
23
+ class NotJavascriptRegex(ValueError):
24
+ """The pattern uses Python regex features that do not exist in Javascript."""
25
+
26
+
27
+ if python_version.major < 3: # pragma: no cover # Awful Python 2 compat hack.
28
+ exec("chr = unichr") # nosec
29
+
30
+
31
+ @lru_cache(maxsize=512) # Matches the internal cache size for re.compile
32
+ def compile(pattern, flags=0):
33
+ # type: (str, int) -> Pattern[str]
34
+ """Compile the given string, treated as a Javascript regex.
35
+
36
+ This aims to match all strings that would be matched in JS, and as few
37
+ additional strings as possible. Where possible it will also warn if the
38
+ pattern would not be valid in JS.
39
+
40
+ This is not a full implementation of EMCA-standard regex, but somewhat
41
+ better than simply ignoring the differences between dialects.
42
+ """
43
+ if not isinstance(pattern, (str, type(""))):
44
+ raise TypeError("pattern={!r} must be a unicode string".format(pattern))
45
+ if not isinstance(flags, int):
46
+ raise TypeError("flags={!r} must be an integer".format(flags))
47
+ # Check that the supplied flags are legal in both Python and JS. See
48
+ # https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Parameters
49
+ # and the list of flags at https://docs.python.org/3/library/re.html#re.compile
50
+ if flags & re.LOCALE:
51
+ raise NotJavascriptRegex("The re.LOCALE flag has no equivalent in Javascript")
52
+ if sys.version_info < (3, 13): # pragma: no cover
53
+ if flags & re.TEMPLATE:
54
+ raise NotJavascriptRegex("The re.TEMPLATE flag has no equivalent in Javascript")
55
+ if flags & re.VERBOSE:
56
+ raise NotJavascriptRegex("The re.VERBOSE flag has no equivalent in Javascript")
57
+
58
+ # Replace JS-only BELL escape with BELL character, and replace character class
59
+ # shortcuts (Unicode in Python) with the corresponding ASCII set like in JS.
60
+ for esc, replacement in [
61
+ (r"\a", "\a"),
62
+ (r"\d", "[0-9]"),
63
+ (r"\D", "[^0-9]"),
64
+ (r"\w", "[A-Za-z]"),
65
+ (r"\W", "[^A-Za-z]"),
66
+ (r"\s", "[ \t\n\r\x0b\x0c]"),
67
+ (r"\S", "[^ \t\n\r\x0b\x0c]"),
68
+ ]:
69
+ # r"(?<!\\)" is 'not preceeded by a backslash', i.e. the escape is unescaped.
70
+ pattern = re.sub(r"(?<!\\)" + re.escape(esc), repl=replacement, string=pattern)
71
+ # Replace JS-only control-character escapes \cA - \cZ and \ca - \cz
72
+ # with their corresponding control characters.
73
+ pattern = re.sub(
74
+ r"(?<!\\)(\\c[A-Za-z])",
75
+ repl=lambda m: chr(ord(m.group(0)[-1].upper()) - 64),
76
+ string=pattern,
77
+ )
78
+ # Compile at this stage, to check for Python-only constructs *before* we add any.
79
+ try:
80
+ parsed = sre_parse.parse(pattern, flags=flags)
81
+ except re.error as e:
82
+ raise re.error("{} in pattern={!r}".format(e, pattern))
83
+ check_features(parsed, flags=flags, pattern=pattern)
84
+ # Check for comments - with `in` because don't appear in the parse tree.
85
+ if re.search(r"\(\?\#[^)]*\)", pattern):
86
+ raise NotJavascriptRegex(
87
+ "'(?#comment)' groups are ignored by Python, but have no meaning in "
88
+ "Javascript regular expressions (pattern={!r})".format(pattern)
89
+ )
90
+ # Replace any unescaped $ - which is allowed in both but behaves
91
+ # differently - with the Python-only \Z which behaves like JS' $.
92
+ pattern = re.sub(r"(?<!\\)[$]", repl=r"\\Z", string=pattern)
93
+ # Finally, we compile our fixed pattern to a Python regex pattern and return it.
94
+ return re.compile(pattern, flags=flags)
95
+
96
+
97
+ def check_features(parsed, flags, pattern):
98
+ # type: (Any, int, str) -> None
99
+ """Recursively walk through a SRE regex parse tree to check that every
100
+ node is for a feature that also exists in Javascript regular expressions.
101
+
102
+ `parsed` is either a list of SRE regex elements representations or a
103
+ particular element representation. Each element is a tuple of element code
104
+ (as string) and parameters. E.g. regex 'ab[0-9]+' compiles to following
105
+ elements:
106
+
107
+ [
108
+ (LITERAL, 97),
109
+ (LITERAL, 98),
110
+ (MAX_REPEAT, (1, 4294967295, [
111
+ (IN, [
112
+ (RANGE, (48, 57))
113
+ ])
114
+ ]))
115
+ ]
116
+
117
+ This function is inspired by https://github.com/HypothesisWorks/hypothesis
118
+ /blob/master/hypothesis-python/src/hypothesis/searchstrategy/regex.py
119
+ """
120
+ if not isinstance(parsed, tuple):
121
+ for elem in parsed:
122
+ assert isinstance(elem, tuple)
123
+ check_features(elem, flags=flags, pattern=pattern)
124
+ else:
125
+ code, value = parsed
126
+ if code == sre_constants.ASSERT or code == sre_constants.ASSERT_NOT:
127
+ # Regexes '(?=...)', '(?<=...)', '(?!...)' or '(?<!...)'
128
+ # (positive/negative lookahead/lookbehind)
129
+ check_features(value[1], flags=flags, pattern=pattern)
130
+ elif code == sre_constants.MIN_REPEAT or code == sre_constants.MAX_REPEAT:
131
+ # Regexes 'a?', 'a*', 'a+', and their non-greedy variants (repeaters)
132
+ check_features(value[2], flags=flags, pattern=pattern)
133
+ elif code == sre_constants.BRANCH:
134
+ # Regex 'a|b|c' (branch)
135
+ for branch in value[1]:
136
+ check_features(branch, flags=flags, pattern=pattern)
137
+ elif code == sre_constants.SUBPATTERN:
138
+ # Various groups: '(...)', '(:...)' or '(?P<name>...)'
139
+ # The parser converts group names to numbers, so the `_` doesn't help here
140
+ check_features(value[-1], flags=flags, pattern=pattern)
141
+ if python_version >= (3, 6) and (value[1] | value[2]): # pragma: no cover
142
+ raise NotJavascriptRegex(
143
+ "Javascript regular expressions do not support "
144
+ "subpattern flags (pattern={pattern!r})"
145
+ )
146
+ elif code == sre_constants.AT:
147
+ # Regexes like '^...', '...$', '\bfoo', '\Bfoo', '\A', '\Z'
148
+ if value == sre_constants.AT_BEGINNING_STRING:
149
+ raise NotJavascriptRegex(
150
+ r"\A is not valid in Javascript regular expressions - "
151
+ "use ^ instead (pattern={!r})".format(pattern)
152
+ )
153
+ if value == sre_constants.AT_END_STRING:
154
+ raise NotJavascriptRegex(
155
+ r"\Z is not valid in Javascript regular expressions - "
156
+ "use $ instead (pattern={!r})".format(pattern)
157
+ )
158
+ elif code == sre_constants.GROUPREF_EXISTS:
159
+ # Regex '(?(id/name)yes-pattern|no-pattern)' (if group exists choice)
160
+ raise NotJavascriptRegex(
161
+ "Javascript regular expressions do not support if-group-exists choice, "
162
+ "like `'(?(id/name)yes-pattern|no-pattern)'` (pattern={!r})".format(
163
+ pattern
164
+ )
165
+ )
166
+ else:
167
+ assert code in [
168
+ sre_constants.IN, # Regex '[abc0-9]' (set of characters)
169
+ sre_constants.ANY, # Regex '.' (any char)
170
+ sre_constants.LITERAL, # Regex 'a' (single char)
171
+ sre_constants.NOT_LITERAL, # Regex '[^a]' (negation of a single char)
172
+ sre_constants.GROUPREF, # Regex '\\1' or '(?P=name)' (group reference)
173
+ ]
File without changes
@@ -0,0 +1,134 @@
1
+ Metadata-Version: 2.4
2
+ Name: js-regex2
3
+ Version: 1.0.2
4
+ Summary: A thin compatibility layer to use Javascript regular expressions in Python
5
+ Home-page: https://github.com/ciphertechsolutions/js-regex
6
+ Author: Cipher Tech Solutions
7
+ Author-email: opensource@ciphertechsolutions.com
8
+ License: MPL 2.0
9
+ Keywords: python javascript regex compatibility
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
13
+ Classifier: Programming Language :: JavaScript
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Topic :: Software Development :: Testing
22
+ Classifier: Topic :: Text Processing
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.10
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Provides-Extra: test
28
+ Requires-Dist: pytest; extra == "test"
29
+ Requires-Dist: pytest-cov; extra == "test"
30
+ Dynamic: author
31
+ Dynamic: author-email
32
+ Dynamic: classifier
33
+ Dynamic: description
34
+ Dynamic: description-content-type
35
+ Dynamic: home-page
36
+ Dynamic: keywords
37
+ Dynamic: license
38
+ Dynamic: license-file
39
+ Dynamic: provides-extra
40
+ Dynamic: requires-python
41
+ Dynamic: summary
42
+
43
+ # js-regex
44
+
45
+ *A compatibility layer to use Javascript regular expressions in Python.*
46
+
47
+ Did you know that regular expressions may vary between programming languages?
48
+ For example, let's consider the pattern `"^abc$"`, which matches the string
49
+ `"abc"`. But what about the string `"abc\n"`? It's also matched in Python,
50
+ but not in Javascript!
51
+
52
+ This and other slight differences can be really important for cross-language
53
+ standards like `jsonschema`, and that's why `js-regex` exists.
54
+
55
+ ## How it works
56
+
57
+ ```python
58
+ import re
59
+ import js_regex
60
+
61
+ re.compile("^abc$").search("abc\n") # matches, unlike JS
62
+ js_regex.compile("^abc$").search("abc\n") # does not match
63
+ ```
64
+
65
+ Internally, `js_regex.compile()` replaces JS regex syntax which has a different
66
+ meaning in Python with whatever *Python* regex syntax has the intended meaning.
67
+
68
+ **This only works for the `.search()` method** - there is no equivalent to
69
+ `.match()` or `.fullmatch()` for Javascript regular expressions.
70
+
71
+ We also check for constructs which are valid in Python but not JS - such as
72
+ named capture groups - and raise an explicit error. Constructs which are valid
73
+ in JS but not Python may also raise an error, because we're still using Python's
74
+ `re.compile()` function under the hood!
75
+
76
+ The following table is adapted from [this larger version](https://web.archive.org/web/20130830063653/http://www.regular-expressions.info:80/refflavors.html),
77
+ ommiting other languages and any rows where JS and Python have the same behaviour.
78
+
79
+ | Feature | Javascript | Python | Handling
80
+ | --- | --- | --- | ---
81
+ | `\a` (bell) | no | yes | Converted to JS behaviour
82
+ | `\ca`-`\cz` and `\cA`-`\cZ` (control characters) | yes | no | Converted to JS behaviour
83
+ | `\d` for digits, `\w` for word chars, `\s` for whitespace | ascii | unicode | Converted to JS behaviour (including `\D`, `\W`, `\S` for negated classes)
84
+ | `$` (end of line/string) | at end | allows trailing `\n` | Converted to JS behaviour
85
+ | `\A` (start of string) | no | yes | Explicit error, use `^` instead
86
+ | `\Z` (end of string) | no | yes | Explicit error, use `$` instead
87
+ | `(?<=text)` (positive lookbehind) | new in ES2018 | yes | Allowed
88
+ | `(?<!text)` (negative lookbehind) | new in ES2018 | yes | Allowed
89
+ | `(?(1)then\|else)` | no | yes | Explicit error
90
+ | `(?(group)then\|else)` | no | yes | Explicit error
91
+ | `(?#comment)` | no | yes | Explicit error
92
+ | `(?P<name>regex)` (Python named capture group) | no | yes | Not detected (yet)
93
+ | `(?P=name)` (Python named backreference) | no | yes | Not detected (yet)
94
+ | `(?<name>regex)` (JS named capture group) | new in ES2018 | no | Error from Python, not translated (yet)
95
+ | `$<name>` (JS named backreference) | new in ES2018 | no | Error from Python, not translated (yet)
96
+ | `(?i)` (case insensitive) | `/i` only | yes | Explicit error, compile with `flags=re.IGNORECASE` instead
97
+ | `(?m)` (`^` and `$` match at line breaks) | `/m` only | yes | Explicit error, compile with `flags=re.MULTILINE` instead
98
+ | `(?s)` (dot matches newlines) | no | yes | Explicit error, compile with `flags=re.DOTALL` instead
99
+ | `(?x)` (free-spacing mode) | no | yes | Explicit error, there is no corresponding mode in Javascript
100
+ | Backreferences non-existent groups are an error | no | yes | Follows Python behaviour
101
+ | Backreferences to failed groups also fail | no | yes | Follows Python behaviour
102
+ | Nested references `\1` through `\9` | yes | no | Follows Python behaviour
103
+
104
+ Note that in many cases Python-only regex features would be treated as part of
105
+ an ordinary pattern by JS regex engines. Currently we raise an explicit error
106
+ on such inputs, but may translate them to have the JS behaviour in a future version.
107
+
108
+
109
+ ## Changelog
110
+
111
+ #### 1.0.1 - 2019-10-17
112
+ - Allow use of native strings on Python 2. This is not actually valid according
113
+ to the spec, but it's only going to be around for a few months so whatever.
114
+
115
+ #### 1.0.0 - 2019-10-04
116
+ - Now considered feature-complete and stable, as all constructs recommended
117
+ for `jsonschema` patterns are supported and all Python-side incompatibilities
118
+ are detected.
119
+ - Compiled patterns are now cached on Python 3, exactly as for `re.compile`
120
+
121
+ #### 0.4.0 - 2019-10-03
122
+ - Now compatible with Python 2.7 and 3.5, until
123
+ [their respective EOL dates](https://devguide.python.org/#status-of-python-branches).
124
+
125
+ #### 0.3.0 - 2019-09-30
126
+ - Fixed handling of non-trailing `$`, e.g. in `"^abc$|^def$"` both are converted
127
+ - Added explicit errors for `re.LOCALE` and `re.VERBOSE` flags, which have no JS equivalent
128
+ - Added explicit checks and errors for use of Python-only regex features
129
+
130
+ #### 0.2.0 - 2019-09-28
131
+ Convert JS-only syntax to Python equivalent wherever possible.
132
+
133
+ #### 0.1.0 - 2019-09-28
134
+ Initial release, with project setup and a very basic implementation.
@@ -0,0 +1,13 @@
1
+ LICENSE
2
+ README.md
3
+ setup.cfg
4
+ setup.py
5
+ src/js_regex/__init__.py
6
+ src/js_regex/_impl.py
7
+ src/js_regex/py.typed
8
+ src/js_regex2.egg-info/PKG-INFO
9
+ src/js_regex2.egg-info/SOURCES.txt
10
+ src/js_regex2.egg-info/dependency_links.txt
11
+ src/js_regex2.egg-info/not-zip-safe
12
+ src/js_regex2.egg-info/requires.txt
13
+ src/js_regex2.egg-info/top_level.txt
@@ -0,0 +1,4 @@
1
+
2
+ [test]
3
+ pytest
4
+ pytest-cov
@@ -0,0 +1 @@
1
+ js_regex