文目标
30分钟内让你明白正则表达式是什么,并对它有一些基本的了解,让你可以在自己的程序或网页里使用它
正则表达式到底是什么东西?
字符是计算机软件处理文字时最基本的单位,可能是字母,数字,标点符号,空格,换行符,汉字等等。字符串是0个或更多个字符的序列。文本也就是文字,字符串。说某个字符串匹配某个正则表达式,通常是指这个字符串里有一部分(或几部分分别)能满足表达式给出的条件。
在编写处理字符串的程序或网页时,经常会有查找符合某些复杂规则的字符串的需要。正则表达式就是用于描述这些规则的工具。换句话说,正则表达式就是记录文本规则的代码。
很可能你使用过Windows/Dos下用于文件查找的通配符(wildcard),也就是*和?。如果你想查找某个目录下的所有的Word文档的话,你会搜索*.doc。在这里,*会被解释成任意的字符串。和通配符类似,正则表达式也是用来进行文本匹配的工具,只不过比起通配符,它能更精确地描述你的需求——当然,代价就是更复杂——比如你可以编写一个正则表达式,用来查找所有以0开头,后面跟着2-3个数字,然后是一个连字号“-”,最后是7或8位数字的字符串(像010-12345678或0376-7654321)。
入门
学习正则表达式的最好方法是从例子开始,理解例子之后再自己对例子进行修改,实验。下面给出了不少简单的例子,并对它们作了详细的说明。
假设你在一篇英文小说里查找hi,你可以使用正则表达式hi。
这几乎是最简单的正则表达式了,它可以精确匹配这样的字符串:由两个字符组成,前一个字符是h,后一个是i。通常,处理正则表达式的工具会提供一个忽略大小写的选项,如果选中了这个选项,它可以匹配hi,HI,Hi,hI这四种情况中的任意一种。
不幸的是,很多单词里包含hi这两个连续的字符,比如him,history,high等等。用hi来查找的话,这里边的hi也会被找出来。如果要精确地查找hi这个单词的话,我们应该使用\bhi\b。
\b是正则表达式规定的一个特殊代码(好吧,某些人叫它元字符,metacharacter),代表着单词的开头或结尾,也就是单词的分界处。虽然通常英文的单词是由空格,标点符号或者换行来分隔的,但是\b并不匹配这些单词分隔字符中的任何一个,它只匹配一个位置。
如果需要更精确的说法,\b匹配这样的位置:它的前一个字符和后一个字符不全是(一个是,一个不是或不存在)\w。
假如你要找的是hi后面不远处跟着一个Lucy,你应该用\bhi\b.*\bLucy\b。
这里,.是另一个元字符,匹配除了换行符以外的任意字符。*同样是元字符,不过它代表的不是字符,也不是位置,而是数量——它指定*前边的内容可以连续重复使用任意次以使整个表达式得到匹配。因此,.*连在一起就意味着任意数量的不包含换行的字符。现在\bhi\b.*\bLucy\b的意思就很明显了:先是一个单词hi,然后是任意个任意字符(但不能是换行),最后是Lucy这个单词。
换行符就是'\n',ASCII编码为10(十六进制0x0A)的字符。
如果同时使用其它元字符,我们就能构造出功能更强大的正则表达式。比如下面这个例子:
0\d\d-\d\d\d\d\d\d\d\d匹配这样的字符串:以0开头,然后是两个数字,然后是一个连字号“-”,最后是8个数字(也就是中国的电话号码。当然,这个例子只能匹配区号为3位的情形)。
这里的\d是个新的元字符,匹配一位数字(0,或1,或2,或……)。-不是元字符,只匹配它本身——连字符(或者减号,或者中横线,或者随你怎么称呼它)。
为了避免那么多烦人的重复,我们也可以这样写这个表达式:0\d{2}-\d{8}。这里\d后面的{2}({8})的意思是前面\d必须连续重复匹配2次(8次)。
测试正则表达式
如果你不觉得正则表达式很难读写的话,要么你是一个天才,要么,你不是地球人。正则表达式的语法很令人头疼,即使对经常使用它的人来说也是如此。由于难于读写,容易出错,所以找一种工具对正则表达式进行测试是很有必要的。
不同的环境下正则表达式的一些细节是不相同的,本教程介绍的是微软 .Net Framework 4.5 下正则表达式的行为,所以,我向你推荐我编写的.Net下的工具 Regester。请参考该页面的说明来安装和运行该软件。
元字符
现在你已经知道几个很有用的元字符了,如\b,.,*,还有\d.正则表达式里还有更多的元字符,
下面来看看更多的例子:
\ba\w*\b匹配以字母a开头的单词——先是某个单词开始处(\b),然后是字母a,然后是任意数量的字母或数字(\w*),最后是单词结束处(\b)。
\d+匹配1个或更多连续的数字。这里的+是和*类似的元字符,不同的是*匹配重复任意次(可能是0次),而+则匹配重复1次或更多次。
\b\w{6}\b 匹配刚好6个字符的单词。
常用的元字符
.匹配除换行符以外的任意字符
\w匹配字母或数字或下划线或汉字
\s匹配任意的空白符
\d匹配数字
\b匹配单词的开始或结束
^匹配字符串的开始$匹配字符串的结束
元字符^(和数字6在同一个键位上的符号)和$都匹配一个位置,这和\b有点类似。^匹配你要用来查找的字符串的开头,$匹配结尾。这两个代码在验证输入的内容时非常有用,比如一个网站如果要求你填写的QQ号必须为5位到12位数字时,可以使用:^\d{5,12}$。
这里的{5,12}和前面介绍过的{2}是类似的,只不过{2}匹配只能不多不少重复2次,{5,12}则是重复的次数不能少于5次,不能多于12次,否则都不匹配。
因为使用了^和$,所以输入的整个字符串都要用来和\d{5,12}来匹配,也就是说整个输入必须是5到12个数字,因此如果输入的QQ号能匹配这个正则表达式的话,那就符合要求了。
和忽略大小写的选项类似,有些正则表达式处理工具还有一个处理多行的选项。如果选中了这个选项,^和$的意义就变成了匹配行的开始处和结束处。
字符转义
如果你想查找元字符本身的话,比如你查找.,或者*,就出现了问题:你没办法指定它们,因为它们会被解释成别的意思。这时你就得使用\来取消这些字符的特殊意义。因此,你应该使用\.和\*。当然,要查找\本身,你也得用\.
例如:deerchao\.net匹配deerchao.net,C:\Windows匹配C:\Windows。
重复
你已经看过了前面的*, +, {2}, {5,12}这几个匹配重复的方式了。下面是正则表达式中所有的限定符(指定数量的代码,例如*, {5,12}等):
常用的限定符
*重复零次或更多次
+重复一次或更多次
?重复零次或一次
{n}重复n次
{n,}重复n次或更多次
{n,m}重复n到m次
下面是一些使用重复的例子:
Windows\d+匹配Windows后面跟1个或更多数字
^\w+匹配一行的第一个单词(或整个字符串的第一个单词,具体匹配哪个意思得看选项设置)
字符类
要想查找数字,字母或数字,空白是很简单的,因为已经有了对应这些字符集合的元字符,但是如果你想匹配没有预定义元字符的字符集合(比如元音字母a,e,i,o,u),应该怎么办?
很简单,你只需要在方括号里列出它们就行了,像[aeiou]就匹配任何一个英文元音字母,[.?!]匹配标点符号(.或?或!)。
我们也可以轻松地指定一个字符范围,像[0-9]代表的含意与\d就是完全一致的:一位数字;同理[a-z0-9A-Z_]也完全等同于\w(如果只考虑英文的话)。
下面是一个更复杂的表达式:\(?0\d{2}[) -]?\d{8}。
这个表达式可以匹配几种格式的电话号码,像(010)88886666,或022-22334455,或02912345678等。
我们对它进行一些分析吧:
分枝条件
不幸的是,刚才那个表达式也能匹配010)12345678或(022-87654321这样的“不正确”的格式。要解决这个问题,我们需要用到分枝条件。正则表达式里的分枝条件指的是有几种规则,如果满足其中任意一种规则都应该当成匹配,具体方法是用|把不同的规则分隔开。听不明白?没关系,看例子:
0\d{2}-\d{8}|0\d{3}-\d{7}这个表达式能匹配两种以连字号分隔的电话号码:一种是三位区号,8位本地号(如010-12345678),一种是4位区号,7位本地号(0376-2233445)。
\(0\d{2}\)[- ]?\d{8}|0\d{2}[- ]?\d{8}这个表达式匹配3位区号的电话号码,其中区号可以用小括号括起来,也可以不用,区号与本地号间可以用连字号或空格间隔,也可以没有间隔。你可以试试用分枝条件把这个表达式扩展成也支持4位区号的。
\d{5}-\d{4}|\d{5}这个表达式用于匹配美国的邮政编码。美国邮编的规则是5位数字,或者用连字号间隔的9位数字。之所以要给出这个例子是因为它能说明一个问题:使用分枝条件时,要注意各个条件的顺序。如果你把它改成\d{5}|\d{5}-\d{4}的话,那么就只会匹配5位的邮编(以及9位邮编的前5位)。原因是匹配分枝条件时,将会从左到右地测试每个条件,如果满足了某个分枝的话,就不会去再管其它的条件了。
分组
我们已经提到了怎么重复单个字符(直接在字符后面加上限定符就行了);但如果想要重复多个字符又该怎么办?你可以用小括号来指定子表达式(也叫做分组),然后你就可以指定这个子表达式的重复次数了,你也可以对子表达式进行其它一些操作(后面会有介绍)。
(\d{1,3}\.){3}\d{1,3}是一个简单的IP地址匹配表达式。要理解这个表达式,请按下列顺序分析它:\d{1,3}匹配1到3位的数字,(\d{1,3}\.){3}匹配三位数字加上一个英文句号(这个整体也就是这个分组)重复3次,最后再加上一个一到三位的数字(\d{1,3})。
不幸的是,它也将匹配256.300.888.999这种不可能存在的IP地址。如果能使用算术比较的话,或许能简单地解决这个问题,但是正则表达式中并不提供关于数学的任何功能,所以只能使用冗长的分组,选择,字符类来描述一个正确的IP地址:((2[0-4]\d|25[0-5]|[01]?\d\d?)\.){3}(2[0-4]\d|25[0-5]|[01]?\d\d?)。
理解这个表达式的关键是理解2[0-4]\d|25[0-5]|[01]?\d\d?,这里我就不细说了,你自己应该能分析得出来它的意义。
反义
有时需要查找不属于某个能简单定义的字符类的字符。比如想查找除了数字以外,其它任意字符都行的情况,这时需要用到反义:
常用的反义代码
\W匹配任意不是字母,数字,下划线,汉字的字符
\S匹配任意不是空白符的字符
\D匹配任意非数字的字符
\B匹配不是单词开头或结束的位置
[^x]匹配除了x以外的任意字符
[^aeiou]匹配除了aeiou这几个字母以外的任意字符
例子:
\S+匹配不包含空白符的字符串。
<a[^>]+>匹配用尖括号括起来的以a开头的字符串。
后向引用
使用小括号指定一个子表达式后,匹配这个子表达式的文本(也就是此分组捕获的内容)可以在表达式或其它程序中作进一步的处理。默认情况下,每个分组会自动拥有一个组号,规则是:从左向右,以分组的左括号为标志,第一个出现的分组的组号为1,第二个为2,以此类推。
后向引用用于重复搜索前面某个分组匹配的文本。例如,代表分组1匹配的文本。难以理解?请看示例:
\b(\w+)\b\s+\b可以用来匹配重复的单词,像go go, 或者kitty kitty。这个表达式首先是一个单词,也就是单词开始处和结束处之间的多于一个的字母或数字(\b(\w+)\b),这个单词会被捕获到编号为1的分组中,然后是1个或几个空白符(\s+),最后是分组1中捕获的内容(也就是前面匹配的那个单词)()。
你也可以自己指定子表达式的组名。要指定一个子表达式的组名,请使用这样的语法:(?<Word>\w+)(或者把尖括号换成'也行:(?'Word'\w+)),这样就把\w+的组名指定为Word了。要反向引用这个分组捕获的内容,你可以使用\k<Word>,所以上一个例子也可以写成这样:\b(?<Word>\w+)\b\s+\k<Word>\b。
使用小括号的时候,还有很多特定用途的语法。下面列出了最常用的一些:
常用分组语法
我们已经讨论了前两种语法。第三个(?:exp)不会改变正则表达式的处理方式,只是这样的组匹配的内容不会像前两种那样被捕获到某个组里面,也不会拥有组号。“我为什么会想要这样做?”——好问题,你觉得为什么呢?
零宽断言
接下来的四个用于查找在某些内容(但并不包括这些内容)之前或之后的东西,也就是说它们像\b,^,$那样用于指定一个位置,这个位置应该满足一定的条件(即断言),因此它们也被称为零宽断言。最好还是拿例子来说明吧:
(?=exp)也叫零宽度正预测先行断言,它断言自身出现的位置的后面能匹配表达式exp。比如\b\w+(?=ing\b),匹配以ing结尾的单词的前面部分(除了ing以外的部分),如查找I'm singing while you're dancing.时,它会匹配sing和danc。
(?<=exp)也叫零宽度正回顾后发断言,它断言自身出现的位置的前面能匹配表达式exp。比如(?<=\bre)\w+\b会匹配以re开头的单词的后半部分(除了re以外的部分),例如在查找reading a book时,它匹配ading。
假如你想要给一个很长的数字中每三位间加一个逗号(当然是从右边加起了),你可以这样查找需要在前面和里面添加逗号的部分:((?<=\d)\d{3})+\b,用它对1234567890进行查找时结果是234567890。
下面这个例子同时使用了这两种断言:(?<=\s)\d+(?=\s)匹配以空白符间隔的数字(再次强调,不包括这些空白符)。
负向零宽断言
前面我们提到过怎么查找不是某个字符或不在某个字符类里的字符的方法(反义)。但是如果我们只是想要确保某个字符没有出现,但并不想去匹配它时怎么办?例如,如果我们想查找这样的单词--它里面出现了字母q,但是q后面跟的不是字母u,我们可以尝试这样:
\b\w*q[^u]\w*\b匹配包含后面不是字母u的字母q的单词。但是如果多做测试(或者你思维足够敏锐,直接就观察出来了),你会发现,如果q出现在单词的结尾的话,像Iraq,Benq,这个表达式就会出错。这是因为[^u]总要匹配一个字符,所以如果q是单词的最后一个字符的话,后面的[^u]将会匹配q后面的单词分隔符(可能是空格,或者是句号或其它的什么),后面的\w*\b将会匹配下一个单词,于是\b\w*q[^u]\w*\b就能匹配整个Iraq fighting。负向零宽断言能解决这样的问题,因为它只匹配一个位置,并不消费任何字符。现在,我们可以这样来解决这个问题:\b\w*q(?!u)\w*\b。
零宽度负预测先行断言(?!exp),断言此位置的后面不能匹配表达式exp。例如:\d{3}(?!\d)匹配三位数字,而且这三位数字的后面不能是数字;\b((?!abc)\w)+\b匹配不包含连续字符串abc的单词。
同理,我们可以用(?<!exp),零宽度负回顾后发断言来断言此位置的前面不能匹配表达式exp:(?<![a-z])\d{7}匹配前面不是小写字母的七位数字。
一个更复杂的例子:(?<=<(\w+)>).*(?=<\/>)匹配不包含属性的简单HTML标签内里的内容。(?<=<(\w+)>)指定了这样的前缀:被尖括号括起来的单词(比如可能是<b>),然后是.*(任意的字符串),最后是一个后缀(?=<\/>)。注意后缀里的\/,它用到了前面提过的字符转义;则是一个反向引用,引用的正是捕获的第一组,前面的(\w+)匹配的内容,这样如果前缀实际上是<b>的话,后缀就是</b>了。整个表达式匹配的是<b>和</b>之间的内容(再次提醒,不包括前缀和后缀本身)。
注释
小括号的另一种用途是通过语法(?#comment)来包含注释。例如:2[0-4]\d(?#200-249)|25[0-5](?#250-255)|[01]?\d\d?(?#0-199)。
要包含注释的话,最好是启用“忽略模式里的空白符”选项,这样在编写表达式时能任意的添加空格,Tab,换行,而实际使用时这些都将被忽略。启用这个选项后,在#后面到这一行结束的所有文本都将被当成注释忽略掉。例如,我们可以前面的一个表达式写成这样:
(?<= # 断言要匹配的文本的前缀 <(\w+)> # 查找尖括号括起来的字母或数字(即HTML/XML标签) ) # 前缀结束 .* # 匹配任意文本 (?= # 断言要匹配的文本的后缀 <\/\1> # 查找尖括号括起来的内容:前面是一个"/",后面是先前捕获的标签 ) # 后缀结束
贪婪与懒惰
当正则表达式中包含能接受重复的限定符时,通常的行为是(在使整个表达式能得到匹配的前提下)匹配尽可能多的字符。以这个表达式为例:a.*b,它将会匹配最长的以a开始,以b结束的字符串。如果用它来搜索aabab的话,它会匹配整个字符串aabab。这被称为贪婪匹配。
有时,我们更需要懒惰匹配,也就是匹配尽可能少的字符。前面给出的限定符都可以被转化为懒惰匹配模式,只要在它后面加上一个问号?。这样.*?就意味着匹配任意数量的重复,但是在能使整个匹配成功的前提下使用最少的重复。现在看看懒惰版的例子吧:
a.*?b匹配最短的,以a开始,以b结束的字符串。如果把它应用于aabab的话,它会匹配aab(第一到第三个字符)和ab(第四到第五个字符)。
处理选项
上面介绍了几个选项如忽略大小写,处理多行等,这些选项能用来改变处理正则表达式的方式。下面是.Net中常用的正则表达式选项:
一个经常被问到的问题是:是不是只能同时使用多行模式和单行模式中的一种?答案是:不是。这两个选项之间没有任何关系,除了它们的名字比较相似(以至于让人感到疑惑)以外。事实上,为了避免混淆,在最新的 JavaScript 中,单行模式其实名叫 dotAll,意为点可以匹配所有字符,然而在指定该选项时,用的还是 Singleline 的首字母 s.
、元字符
元字符
对应说明.匹配除换行符之外的任意字符\w
匹配字母数字下划线,等同于:[a-zA-Z0-9_]\s
匹配任意空白符\d匹配数字,等同于[0-9]\b匹配单词边界|或匹配,如 /x|y/ 正则可匹配x或y两个字符^匹配字符串的开始$匹配字符串的结束二、反义字符
反义字符
对应说明[^x]匹配除“x”之外的所有字符,其中“x”可以为任意字符[^xyz]同上,匹配除“x、y、z”之外的任意字符\W匹配除了字母、数字、下划线之外的所有字符,等同于:[^\w]\S匹配除空白符之外的任意字符,等同于:[^\s]\B匹配不是单词边界的字符,等同于:[^\b]\D匹配不是数字的所有字符,等同于:[^\d]
三、转义字符
转义字符
对应说明\xnn匹配十六进制数\f匹配换页符,等同于:\x0c\n匹配换行符,等同于:\x0a\r匹配回车符,等同于:\x0d\t匹配水平制表符,等同于:\x09\v
匹配垂直制表符,等同于:\x0b\unnnn匹配Unicode字符,如:\u00A0
四、重复匹配
匹配字符
对应说明*
重复出现零次或多次+重复出现一次或多次?重复出现零次或一次
{n}重复出现n次
{n,}至少重复出现n次{m,n}重复重现m到n次,其中,m<n
五、分组/捕获
分组字符
对应说明(exp)用小圆括号进行分组,如日期中年月日的分组:/(\d{5})-(\d{1,2})-(\d{1,2})/
每个分组将产生分组号,从第一个括号开始,可以使用\n的形式在正则中使用分组号,
如匹配成对出现的HTML标签,可以写成:/<(\w+)><\/>/(?:exp)匹配exp正则,但不产生分组号exp1(?=exp2)前瞻断言,匹配exp1,但后面必须是exp2
如匹配名字叫xianlie,但不姓zhao的人:/zhao(?=xianlie)/exp1(?!=exp2)后瞻断言,匹配exp1,但后面不能是exp2
如匹配姓zhao,但名字不叫xianlie的人:/zhao(?!xianlie)/六、贪婪与惰性
相关字符
对应说明*?
重复任意次,但尽可能少的重复+?重复一次或多次,但尽可能少的重复??重复零次或一次,但尽可能少的重复
{m,n}?重复m到n次,但尽可能少的重复
{n,}?重复n次以上,但尽可能少的重复{n}?
重复n次,但尽可能少的重复
七、修饰符
修饰符
对应说明i
ignoreCase的缩写,表示忽略字母的大小写mmultiline的缩写,更改^和$的含义,使它们分别在任意一行的行首和行尾匹配
,而不仅仅在整个字符串的开头和结尾匹配。
(在此模式下,$的精确含意是:匹配\n之前的位置以及字符串结束前的位置.)
gglobal的缩写,进行全局匹配,即对字符串进行全文匹配,直到字符串遍历结束
为开发人员,我们依赖于静态分析工具来检查、lint(分析)和转换我们的代码。我们使用这些工具来帮助我们提高生产效率并生成更好的代码。然而,当我们使用markdown编写内容时,可用的工具就很少。
在本文中,我们将介绍如何开发一个Markdown扩展来解决在使用Markdown管理Django站点中的内容时遇到的挑战。
你认为他们有linter吗?
照片来自Pexels,由mali maeder拍摄
像每个网站一样,我们在主页、FAQ部分和“关于”页面等地方都有不同类型的(大部分)静态内容。很长一段时间以来,我们都是在Django模板中直接管理这些内容的。
当我们最终决定是时候将这些内容从模板转移到数据库中时,我们认为最好使用Markdown。从Markdown生成HTML更安全,它提供了一定程度的控制和一致性,并且对于非技术用户来说更容易处理。随着我们转移过程的进展,我们注意到我们遗漏了一些东西:
当URL更改时,链接到内部页面的链接可能会中断。在Django模板和视图中,我们使用了reverseand {% url %},但是这在普通的Markdown中是不可用的。
绝对内部连接不能在不同环境之间进行复制。这可以使用相对链接来解决,不过目前没有开箱即用的增强这一点的方法。
无效链接会损害用户体验,并导致用户质疑整个内容的可靠性。这并不是Markdown独有的东西,只不过HTML模板是由对URL有一定了解的开发人员维护的。另一方面,Markdown文档是为非技术写作人员设计的。
当我研究这个问题时,我搜索了Python linters、Markdown预处理器和扩展来帮助生成更好的Markdown。结果都不是很好。一个引人注目的方法是使用Django模板来生成Markdown文档。
使用Django模板,你可以使用诸如url之类的模板标记来反向查询URL名称,并配合使用条件、变量、日期格式和所有其他Django模板特性。这种方法本质上是使用Django模板作为Markdown文档的预处理程序。
我个人认为这可能不是非技术作家的最佳解决方案。另外,我担心提供对Django模板标记的访问可能是危险的。
对这个问题有了更好的理解之后,我们准备在Python中更深入地研究Markdown。
要在Python中开始使用Markdown,我们先安装markdown包:
接着,创建一个Markdown对象并使用其函数将一些Markdown转换成HTML:
你现在可以在你的模板中使用这个HTML代码片段。
基本的Markdown处理器提供了生成HTML内容的基本要素。对于更“新奇”的选项,Python markdown包包含了一些内置扩展。一个流行的扩展是“extra”扩展,除了其他东西之外,它增加了对隔离代码块的支持:
为了使用我们独特的Django功能扩展Markdown,我们将开发自己的扩展。
如果你查看源代码,你将看到要将markdown转换为HTML, Markdown会使用多种不同的处理器。一种类型的处理器是内联处理器。内联处理器会匹配特定的内联模式,如链接、反引号、粗体文本和带下划线的文本,并将它们转换为HTML。
我们的Markdown扩展的主要目的是验证和转换链接。因此,我们最感兴趣的内联处理器是LinkInlineProcessor。这个处理器以[Haki的网站](https://hakibenito.com)的形式获取markdown ,解析它并返回一个包含链接和文本的元组。
为了扩展该功能,我们扩展了LinkInlineProcessor并创建了一个Markdown.Extension, 我们用它来处理链接:
我们来将这段代码分解一下::
DjangoUrlExtension扩展注册了一个名为DjangoLinkInlineProcessor的内联链接处理器。这个处理器将取代任何其他现有的链接处理器。
内联处理器DjangoLinkInlineProcessor扩展了内置的LinkInlineProcessor,并在它处理的每个链接上调用clean_link函数。
clean_link函数接收一个链接和一个域名,并返回一个转换后的链接。这就是我们要插入我们的实现的地方。
如何获得网站域名
要识别到你自己网站的链接,你必须知道你的网站的域名。如果你正在使用Django的sites框架,那么你可以使用它来获取当前域名。
我没有把它包含在我的实现中,因为我们没有使用sites框架。相反,我们在Django设置中设置了一个变量。
获取当前域名的另一种方法是使用HttpRequest对象。如果内容只在你自己的站点中被编辑,你可以尝试从请求对象中插入站点域名。这可能需要对你的实现进行一些更改。
要使用该扩展,请在初始化一个新的Markdown实例时添加它:
太好了,这个扩展已经被使用了,我们准备进入有趣的部分了!
既然我们得到了在所有链接上调用clean_link的扩展,那我们可以来实现我们的验证和转换逻辑。
要开始工作,我们将从一个简单的验证开始。mailto链接对于使用预定义的收件人地址、主题甚至消息正文打开用户的电子邮件客户端非常有用。
一个常见的mailto链接是这样的:
这个链接将打开你的电子邮件客户端,并设置成撰写一封主题行为“我需要帮助!”的新电子邮件给“support@service.com”。
mailto链接不一定非要包含电子邮件地址。如果你看一看这篇文章底部的“分享”按钮,你会发现像这样的一个mailto链接:
这个mailto链接没有包含收件人,仅包含了主题行和消息正文。
既然我们已经很好地理解了mailto链接是什么样子的,我们就可以向clean_link函数添加第一个验证:
为了验证mailto链接,我们向clean_link中添加了以下代码:
检查链接是否以mailto:开头,以识别相关链接。
使用正则表达式将链接分割到它的组件。
从mailto链接中删除实际的电子邮件地址,并使用Django的EmailValidator验证它。
注意,我们还添加了一种名为InvalidMarkdown的新异常类型。我们定义了自己的自定义异常类型,以将它与markdown本身所引发的其他错误区分开来。
自定义错误类
我曾经写过关于自定义错误类的文章,为什么它们是有用的,以及你什么时候应该使用它们。
在我们继续之前,让我们添加一些测试,看看它的实际效果:
太棒了!按预期的运行了。
既然我们已经了解了mailto链接,我们也可以处理其他类型的链接:
外部链接
我们的Django应用程序外部的链接。
必须包含一个页面跳转协议(scheme):http或https。
理想情况下,我们还希望确保这些链接没有被破坏,但我们现在不会这样做。
内部链接
到我们的Django应用程序中的页面的链接。
链接必须是相对的:这将允许我们在不同环境之间移动内容。
使用Django的URL名称而不是一个URL路径:这将允许我们安全地来回移动视图,而不必担心markdown内容中的失效链接。
链接可能包含查询参数(?)和片段(#)。
SEO
从SEO的角度来看,公共URL不应该改变。当他们这样做的时候,你应该使用重定向正确地处理它,否则你可能会受到搜索引擎的惩罚。
有了这个需求列表,我们就可以开始工作了。
解析URL名称
要链接到内部页面,我们希望编写者提供一个URL名称,而不是URL路径。例如,假设我们有这个视图:
这个页面的URL路径是https://example.com/, URL名称是home。我们想要在我们的markdown链接中使用这个URL名称home,就像这样:
这将渲染到:
我们还想支持查询参数和散列:
这将渲染到以下HTML:
在使用URL名称时,如果我们更改了URL路径,内容中的链接将不会被破坏。要检查作者提供的href是否是一个有效的url_name,我们可以尝试reverse它:
URL名称“home”指向URL路径“/”。当没有匹配项时,将会引发一个异常:
在我们继续之前,当URL名称包含查询参数或散列时,会发生什么:
这是有意义的,因为查询参数和散列不是URL名称的一部分。
要使用reverse并支持查询参数和散列,我们首先需要清除值。然后,检查它是一个有效的URL名称,并返回包含查询参数和散列的URL路径,如果提供了的话:
这个代码段使用一个正则表达式来以?或#的出现对href进行分割,并返回各部分。
请确保它可以工作:
太了不起了!作者们现在可以在Markdown中使用URL名称了。它们还可以包括要添加到该URL的查询参数和片段。
处理外部链接
要正确处理外部链接,我们需要检查两件事:
1.外部链接总是提供一个跳转协议,http:或者https:。
2.阻止到我们自己网站的绝对链接。内部链接应该使用URL名称。
到目前为止,我们已经处理了URL名称和mailto链接。如果我们通过了这两个检查,这意味着href是一个URL。让我们从检查链接是否是链接到我们自己的网站开始:
函数urlparse会返回一个命名元组,该元组包含URL的不同部分。如果netloc属性等于site_domain,那么该链接就确实是一个内部链接。
如果URL实际上是内部的,我们就需要终止。但是,请记住,作者们不一定是技术人员,因此我们希望帮助他们,并提供一个有用的错误消息。我们要求该内部链接使用URL名称而不是URL路径,所以最好让作者们知道他们提供的路径的URL名称。
要获得一个URL路径的URL名称,Django为我们提供了一个名为resolve的函数:
当找到匹配项时,resolve会返回一个ResolverMatch对象,其中包含URL名称和其他信息。当没有找到匹配项时,它就会引发一个错误:
这实际上就是Django在底层所做的工作,用来确定在一个新请求到来时执行哪个视图函数。
为了给作者们提供更好的错误信息,我们可以使用来自ResolverMatch对象的URL名称:
当我们识别出内部链接时,我们要处理两种情况:
我们没有识别出这个URL:这个URL很可能是不正确的。请作者检查该URL是否有错误。
我们识别出了这个URL: 这个URL是正确的,所以就告诉作者应该使用什么URL名称。
我们来实际地看一下它:
漂亮!外部链接被接受,内部链接被拒绝,并带有一个有用的消息。
要求跳转协议
我们要做的最后一件事是确保外部链接包含一个跳转协议,要么是http:,要么是https:。让我们将这最后一部分添加到函数clean_link:
使用解析后的URL,我们可以很容易地检查跳转协议。让我们确保它正在工作:
我们向这个函数提供了一个没有跳转协议的链接,但是它运行失败了,并显示了一条有用的消息。太酷了!
这是clean_link函数的全部代码:
要了解所有这些特性的一个实际用例是什么样子的,请看下面的内容:
这将产生以下HTML:
不错!
我们现在有一个很不错的扩展,它可以验证和转换Markdown文档中的链接!现在,在不同环境之间移动文档和保持内容整洁要容易多了,最重要的是,可以保持正确和最新!
源码
你可以在这个gist中找到全部源代码。(地址:https://gist.github.com/hakib/73fccc340e855bb65f42197e298c0c7d )
本文中所描述的功能对我们很有用,但是你可能需要根据自己的需求对它进行调整。
如果你需要一些想法,那么除了这个扩展之外,我们还创建了一个markdown Preprocessor,它允许作者们在markdown中使用常量。例如,我们定义了一个名为SUPPORT_EMAIL的常量,我们像这样使用它:
该预处理程序将用我们定义的文本替换字符串$SUPPORT_EMAIL,然后才渲染Markdown。
英文原文:https://hakibenita.com/django-markdown
译者:Nothing
*请认真填写需求信息,我们会在24小时内与您取得联系。