Add example for regex

Signed-off-by: Keshav Priyadarshi <git@keshav.space>

Author: keshav-space

src/fetchcode/package.py

@@ -419,47 +419,54 @@ def get_package_info(cls, package_url):
 class UtilLinuxDirectoryListedSource(DirectoryListedSource):
     source_url = "https://mirrors.edge.kernel.org/pub/linux/utils/util-linux/"
     is_nested = True
+    # Source archive ex: util-linux-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(util-linux-)(?P<version>[\w.-]*)(.tar.gz)$")
     ignored_files_and_dir = []
 
 
 class BusyBoxDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.busybox.net/downloads/"
+    # Source archive ex: busybox-1.2.3.tar.bz2
     source_archive_regex = re.compile(r"^(busybox-)(?P<version>[\w.-]*)(.tar.bz2)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class UclibcDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.uclibc.org/downloads/"
+    # Source archive ex: uClibc-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(uClibc-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class UclibcNGDirectoryListedSource(DirectoryListedSource):
     source_url = "https://downloads.uclibc-ng.org/releases/"
+    # Source archive ex: uClibc-ng-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(uClibc-ng-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = True
     ignored_files_and_dir = []
 
 
 class Bzip2DirectoryListedSource(DirectoryListedSource):
     source_url = "https://sourceware.org/pub/bzip2/"
+    # Source archive ex: bzip2-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(bzip2-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class OpenSSHDirectoryListedSource(DirectoryListedSource):
     source_url = "https://cdn.openbsd.org/pub/OpenBSD/OpenSSH/"
+    # Source archive ex: openssh-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(openssh-)(?P<version>[\w.-]*)(.tgz|.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class DnsmasqDirectoryListedSource(DirectoryListedSource):
     source_url = "https://thekelleys.org.uk/dnsmasq/"
+    # Source archive ex: dnsmasq-1.2.3.tar.gz
     source_archive_regex = re.compile(
         r"^(dnsmasq-)(?P<version>[\w.-]*)(.tar.xz|.tar.gz)$"
     )
@@ -469,13 +476,15 @@ class DnsmasqDirectoryListedSource(DirectoryListedSource):
 
 class EbtablesDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.netfilter.org/pub/ebtables/"
+    # Source archive ex: ebtables-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(ebtables-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class HostapdDirectoryListedSource(DirectoryListedSource):
     source_url = "https://w1.fi/releases/"
+    # Source archive ex: hostapd-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(hostapd-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
@@ -484,6 +493,7 @@ class HostapdDirectoryListedSource(DirectoryListedSource):
 class Iproute2DirectoryListedSource(DirectoryListedSource):
     source_url = "https://mirrors.edge.kernel.org/pub/linux/utils/net/iproute2/"
     source_archive_regex = re.compile(
+        # Source archive ex: iproute2-1.2.3.tar.gz
         r"^(iproute2-)(?P<version>[\w.-]*)(.tar.xz|.tar.gz)$"
     )
     is_nested = False
@@ -492,27 +502,31 @@ class Iproute2DirectoryListedSource(DirectoryListedSource):
 
 class IptablesDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.netfilter.org/pub/iptables/"
+    # Source archive ex: iptables-1.2.3.tar.bz2
     source_archive_regex = re.compile(r"^(iptables-)(?P<version>[\w.-]*)(.tar.bz2)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class LibnlDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.infradead.org/~tgr/libnl/files/"
+    # Source archive ex: libnl-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(libnl-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class LighttpdDirectoryListedSource(DirectoryListedSource):
     source_url = "https://download.lighttpd.net/lighttpd/releases-1.4.x/"
+    # Source archive ex: lighttpd-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(lighttpd-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class NftablesDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.netfilter.org/pub/nftables/"
+    # Source archive ex: nftables-1.2.3.tar.bz2
     source_archive_regex = re.compile(
         r"^(nftables-)(?P<version>[\w.-]*)(.tar.xz|.tar.bz2)$"
     )
@@ -522,6 +536,7 @@ class NftablesDirectoryListedSource(DirectoryListedSource):
 
 class WpaSupplicantDirectoryListedSource(DirectoryListedSource):
     source_url = "https://w1.fi/releases/"
+    # Source archive ex: wpa_supplicant-1.2.3.tar.gz
     source_archive_regex = re.compile(
         r"^(wpa_supplicant-)(?P<version>[\w.-]*)(.tar.gz)$"
     )
@@ -531,20 +546,23 @@ class WpaSupplicantDirectoryListedSource(DirectoryListedSource):
 
 class SyslinuxDirectoryListedSource(DirectoryListedSource):
     source_url = "https://mirrors.edge.kernel.org/pub/linux/utils/boot/syslinux/"
+    # Source archive ex: syslinux-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(syslinux-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class SyslinuxDirectoryListedSource(DirectoryListedSource):
     source_url = "https://mirrors.edge.kernel.org/pub/linux/utils/boot/syslinux/"
+    # Source archive ex: syslinux-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(syslinux-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class ToyboxDirectoryListedSource(DirectoryListedSource):
     source_url = "http://www.landley.net/toybox/downloads/"
+    # Source archive ex: toybox-1.2.3.tar.gz
     source_archive_regex = re.compile(
         r"^(toybox-)(?P<version>[\w.-]*)(.tar.gz|.tar.bz2)$"
     )
@@ -554,6 +572,7 @@ class ToyboxDirectoryListedSource(DirectoryListedSource):
 
 class DropbearDirectoryListedSource(DirectoryListedSource):
     source_url = "https://matt.ucc.asn.au/dropbear/releases/"
+    # Source archive ex: dropbear-1.2.3.tar.bz2
     source_archive_regex = re.compile(
         r"^(dropbear-)(?P<version>[\w.-]*)(.tar.bz2|_i386.deb)$"
     )
@@ -572,26 +591,30 @@ class DropbearDirectoryListedSource(DirectoryListedSource):
 
 class SambaDirectoryListedSource(DirectoryListedSource):
     source_url = "https://download.samba.org/pub/samba/stable/"
+    # Source archive ex: samba-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(samba-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class MtdUtilsDirectoryListedSource(DirectoryListedSource):
     source_url = "https://infraroot.at/pub/mtd/"
+    # Source archive ex: mtd-utils-1.2.3.tar.bz2
     source_archive_regex = re.compile(r"^(mtd-utils-)(?P<version>[\w.-]*)(.tar.bz2)$")
     is_nested = False
     ignored_files_and_dir = []
 
 
 class BareboxDirectoryListedSource(DirectoryListedSource):
     source_url = "https://www.barebox.org/download/"
+    # Source archive ex: barebox-1.2.3.tar.bz2
     source_archive_regex = re.compile(r"^(barebox-)(?P<version>[\w.-]*)(.tar.bz2)$")
     is_nested = False
     ignored_files_and_dir = []
 
 class LinuxDirectoryListedSource(DirectoryListedSource):
     source_url = "https://cdn.kernel.org/pub/linux/kernel/"
+    # Source archive ex: linux-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(linux-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = True
     ignored_files_and_dir = [
@@ -610,6 +633,7 @@ class LinuxDirectoryListedSource(DirectoryListedSource):
 
 class E2fsprogsDirectoryListedSource(DirectoryListedSource):
     source_url = "https://mirrors.edge.kernel.org/pub/linux/kernel/people/tytso/e2fsprogs/"
+    # Source archive ex: e2fsprogs-1.2.3.tar.gz
     source_archive_regex = re.compile(r"^(e2fsprogs-)(?P<version>[\w.-]*)(.tar.gz)$")
     is_nested = True
     ignored_files_and_dir = ["testing/"]