用 Python 的魔术方法做出更好的正则表达式 API

2023年5月18日 226次阅读 来源: yexiaobai

注：原文地址为 Playing with Python Magic Methods to make a nicer Regex API

我的一个同事提到,他错过了 Ruby 的正则表达式的语法糖。我没有使用过 Ruby 的正则表达式，但是以我对 Python 的足够了解知道 API 是缺少足够的语法糖。

首先，从正则表达式检索捕捉组需要两个步骤。第一步，你需要调用 match() 或是 search()，并将结果分配给一个变量。然后，你需要检查结果是否为 None（表明没有发现匹配）。最后，如果匹配存在，你可以安全的提取捕获组。下面是一个示例：

>>> import re
>>> match_obj = re.match('([0-9]+)', '123foo')
>>> match_obj  # What is `match_obj`?
<_sre.SRE_Match object at 0x7fd1bb000828>
>>> match_obj.groups()
('123',)

>>> match_obj = re.match('([0-9]+)', 'abc')
>>> match_obj
None

还可以更好，在我看来，类似下面：

>>> re.get_matches('([0-9]+)', '123foo')
('123',)

>>> re.get_matches('([0-9]+)', 'abc')
None

我经常遇到的另外一件事情就是 re.sub 的混合参数，它可以执行正则的查找和替换。要求的参数，按照顺序，是 pattern，replacement， search_string。无论出于何种原因，对我来说，更直观的是在替换之前使用 search_string。

不幸的是，改编这些参数会导致“看起来正确”的结果。下面是一个例子，这里的目标是使用单词 bar 替换单词 foo。

>>> re.sub('foo', 'replace foo with bar', 'bar')
'bar'

>>> re.sub('foo', 'bar', 'replace foo with bar')
'replace bar with bar'

其中关于 re.sub 的用法可以参考这篇文章，很详细 http://www.crifan.com/python_re_sub_detailed_introduction/

在第一个例子中，我们可能会假设输入的字符串只是“foo”。

语法糖

为了好玩，我把一个小小的增加了一些语法糖的 Python 正则表达式库的帮助类放在一起。我不建议任何人都使用它，但好玩的是，也许它可以为你提供一些提高其他库的语法的想法。

再我向你展示这个实现之前，这里有我设计的一个 API 的示例。

寻找匹配的单步操作：

>>> def has_lower(s):
...     return bool(R/'[a-z]+'/s)

>>> has_lower('This contains lower-case')
True
>>> has_lower('NO LOWER-CASE HERE!')
False

检索捕获组也是非常容易的：

>>> list(R/'([0-9]+)'/'extract 12 the 456 numbers')
['12', '456']

最后你可以使用字符串插值来实现替换：

>>> R/'(foo|bar)'/'replace foo and bar' % 'Huey!'
'replace Huey! and Huey!'

你怎么认为？是不是很有趣？

实现

这个实现是非常简单的，依赖于 Python 的魔术方法提供的 API。是否有一个整洁的技巧，本质上，它是使用一个元类来实现类方法的操作符重载。

import re

class _R(type):
    def __div__(self, regex):
        return R(regex)

class R(object):
    __metaclass__ = _R

    def __init__(self, regex):
        self._regex = re.compile(regex)

    def __div__(self, s):
        return RegexOperation(self._regex, s)

class RegexOperation(object):
    def __init__(self, regex, search):
        self._regex = regex
        self._search = search

    def search(self):
        match =  self._regex.search(self._search)
        if match is not None:
            return match.groups()

    def __len__(self):
        return self._regex.search(self._search) is not None

    def __mod__(self, replacement):
        return self._regex.sub(replacement, self._search)

    def __iter__(self):
        return iter(self._regex.findall(self._search))

通过一步步的操作，希望它可以阐明幕后的知识。

调用 R / <something> 将调用 _R 类的 __div__ 方法。它是一个创建 R 实例的工厂方法。

>>> R/'foo'
<rx.R at 0x7f77c00831d0>

然后，在最新创建的 R 对象上调用 __div__ 方法，我们会得到一个 RegexOperation 实例，因此 R.__div__ 是另外一个工厂方法。

>>> r_obj = R/'foo'
>>> r_obj / 'bar'
<rx.RegexOperation at 0x7f77c00837d0>

最后的对象，RegexOperation 实现了一些魔法方法，允许我们检索匹配，执行替换，以及测试匹配是否存在。

    原文作者：yexiaobai
    原文地址: https://segmentfault.com/a/1190000000617744
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞