1# 2# QR Code generator demo (Python) 3# 4# Run this command-line program with no arguments. The program computes a bunch of demonstration 5# QR Codes and prints them to the console. Also, the SVG code for one QR Code is printed as a sample. 6# 7# Copyright (c) Project Nayuki. (MIT License) 8# https://www.nayuki.io/page/qr-code-generator-library 9# 10# Permission is hereby granted, free of charge, to any person obtaining a copy of 11# this software and associated documentation files (the "Software"), to deal in 12# the Software without restriction, including without limitation the rights to 13# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 14# the Software, and to permit persons to whom the Software is furnished to do so, 15# subject to the following conditions: 16# - The above copyright notice and this permission notice shall be included in 17# all copies or substantial portions of the Software. 18# - The Software is provided "as is", without warranty of any kind, express or 19# implied, including but not limited to the warranties of merchantability, 20# fitness for a particular purpose and noninfringement. In no event shall the 21# authors or copyright holders be liable for any claim, damages or other 22# liability, whether in an action of contract, tort or otherwise, arising from, 23# out of or in connection with the Software or the use or other dealings in the 24# Software. 25# 26 27from typing import List 28from qrcodegen import QrCode, QrSegment 29 30 31def main() -> None: 32 """The main application program.""" 33 do_basic_demo() 34 do_variety_demo() 35 do_segment_demo() 36 do_mask_demo() 37 38 39 40# ---- Demo suite ---- 41 42def do_basic_demo() -> None: 43 """Creates a single QR Code, then prints it to the console.""" 44 text = "Hello, world!" # User-supplied Unicode text 45 errcorlvl = QrCode.Ecc.LOW # Error correction level 46 47 # Make and print the QR Code symbol 48 qr = QrCode.encode_text(text, errcorlvl) 49 print_qr(qr) 50 print(to_svg_str(qr, 4)) 51 52 53def do_variety_demo() -> None: 54 """Creates a variety of QR Codes that exercise different features of the library, and prints each one to the console.""" 55 56 # Numeric mode encoding (3.33 bits per digit) 57 qr = QrCode.encode_text("314159265358979323846264338327950288419716939937510", QrCode.Ecc.MEDIUM) 58 print_qr(qr) 59 60 # Alphanumeric mode encoding (5.5 bits per character) 61 qr = QrCode.encode_text("DOLLAR-AMOUNT:$39.87 PERCENTAGE:100.00% OPERATIONS:+-*/", QrCode.Ecc.HIGH) 62 print_qr(qr) 63 64 # Unicode text as UTF-8 65 qr = QrCode.encode_text("\u3053\u3093\u306B\u3061\u0077\u0061\u3001\u4E16\u754C\uFF01\u0020\u03B1\u03B2\u03B3\u03B4", QrCode.Ecc.QUARTILE) 66 print_qr(qr) 67 68 # Moderately large QR Code using longer text (from Lewis Carroll's Alice in Wonderland) 69 qr = QrCode.encode_text( 70 "Alice was beginning to get very tired of sitting by her sister on the bank, " 71 "and of having nothing to do: once or twice she had peeped into the book her sister was reading, " 72 "but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice " 73 "'without pictures or conversations?' So she was considering in her own mind (as well as she could, " 74 "for the hot day made her feel very sleepy and stupid), whether the pleasure of making a " 75 "daisy-chain would be worth the trouble of getting up and picking the daisies, when suddenly " 76 "a White Rabbit with pink eyes ran close by her.", QrCode.Ecc.HIGH) 77 print_qr(qr) 78 79 80def do_segment_demo() -> None: 81 """Creates QR Codes with manually specified segments for better compactness.""" 82 83 # Illustration "silver" 84 silver0 = "THE SQUARE ROOT OF 2 IS 1." 85 silver1 = "41421356237309504880168872420969807856967187537694807317667973799" 86 qr = QrCode.encode_text(silver0 + silver1, QrCode.Ecc.LOW) 87 print_qr(qr) 88 89 segs = [ 90 QrSegment.make_alphanumeric(silver0), 91 QrSegment.make_numeric(silver1)] 92 qr = QrCode.encode_segments(segs, QrCode.Ecc.LOW) 93 print_qr(qr) 94 95 # Illustration "golden" 96 golden0 = "Golden ratio \u03C6 = 1." 97 golden1 = "6180339887498948482045868343656381177203091798057628621354486227052604628189024497072072041893911374" 98 golden2 = "......" 99 qr = QrCode.encode_text(golden0 + golden1 + golden2, QrCode.Ecc.LOW) 100 print_qr(qr) 101 102 segs = [ 103 QrSegment.make_bytes(golden0.encode("UTF-8")), 104 QrSegment.make_numeric(golden1), 105 QrSegment.make_alphanumeric(golden2)] 106 qr = QrCode.encode_segments(segs, QrCode.Ecc.LOW) 107 print_qr(qr) 108 109 # Illustration "Madoka": kanji, kana, Cyrillic, full-width Latin, Greek characters 110 madoka = "\u300C\u9B54\u6CD5\u5C11\u5973\u307E\u3069\u304B\u2606\u30DE\u30AE\u30AB\u300D\u3063\u3066\u3001\u3000\u0418\u0410\u0418\u3000\uFF44\uFF45\uFF53\uFF55\u3000\u03BA\u03B1\uFF1F" 111 qr = QrCode.encode_text(madoka, QrCode.Ecc.LOW) 112 print_qr(qr) 113 114 kanjicharbits = [ # Kanji mode encoding (13 bits per character) 115 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 1, 116 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 117 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 118 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 119 0, 1, 0, 1, 0, 1, 1, 0, 1, 0, 1, 1, 1, 120 0, 0, 0, 0, 1, 0, 1, 0, 1, 1, 1, 0, 0, 121 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 1, 1, 1, 122 0, 0, 0, 0, 1, 0, 0, 1, 0, 1, 0, 0, 1, 123 0, 0, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1, 124 0, 0, 0, 0, 1, 1, 0, 1, 1, 1, 1, 0, 1, 125 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 1, 126 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 0, 1, 0, 127 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 128 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0, 0, 1, 129 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 1, 0, 0, 130 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 131 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 132 0, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 133 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 134 0, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 135 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 136 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 137 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1, 138 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 1, 1, 139 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1, 0, 1, 140 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 141 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 142 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 143 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 144 ] 145 segs = [QrSegment(QrSegment.Mode.KANJI, len(kanjicharbits) // 13, kanjicharbits)] 146 qr = QrCode.encode_segments(segs, QrCode.Ecc.LOW) 147 print_qr(qr) 148 149 150def do_mask_demo() -> None: 151 """Creates QR Codes with the same size and contents but different mask patterns.""" 152 153 # Project Nayuki URL 154 segs = QrSegment.make_segments("https://www.nayuki.io/") 155 print_qr(QrCode.encode_segments(segs, QrCode.Ecc.HIGH, mask=-1)) # Automatic mask 156 print_qr(QrCode.encode_segments(segs, QrCode.Ecc.HIGH, mask=3)) # Force mask 3 157 158 # Chinese text as UTF-8 159 segs = QrSegment.make_segments( 160 "\u7DAD\u57FA\u767E\u79D1\uFF08\u0057\u0069\u006B\u0069\u0070\u0065\u0064\u0069\u0061\uFF0C" 161 "\u8046\u807D\u0069\u002F\u02CC\u0077\u026A\u006B\u1D7B\u02C8\u0070\u0069\u02D0\u0064\u0069" 162 "\u002E\u0259\u002F\uFF09\u662F\u4E00\u500B\u81EA\u7531\u5167\u5BB9\u3001\u516C\u958B\u7DE8" 163 "\u8F2F\u4E14\u591A\u8A9E\u8A00\u7684\u7DB2\u8DEF\u767E\u79D1\u5168\u66F8\u5354\u4F5C\u8A08" 164 "\u756B") 165 print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=0)) # Force mask 0 166 print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=1)) # Force mask 1 167 print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=5)) # Force mask 5 168 print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=7)) # Force mask 7 169 170 171 172# ---- Utilities ---- 173 174def to_svg_str(qr: QrCode, border: int) -> str: 175 """Returns a string of SVG code for an image depicting the given QR Code, with the given number 176 of border modules. The string always uses Unix newlines (\n), regardless of the platform.""" 177 if border < 0: 178 raise ValueError("Border must be non-negative") 179 parts: List[str] = [] 180 for y in range(qr.get_size()): 181 for x in range(qr.get_size()): 182 if qr.get_module(x, y): 183 parts.append(f"M{x+border},{y+border}h1v1h-1z") 184 return f"""<?xml version="1.0" encoding="UTF-8"?> 185<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> 186<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 {qr.get_size()+border*2} {qr.get_size()+border*2}" stroke="none"> 187 <rect width="100%" height="100%" fill="#FFFFFF"/> 188 <path d="{" ".join(parts)}" fill="#000000"/> 189</svg> 190""" 191 192 193def print_qr(qrcode: QrCode) -> None: 194 """Prints the given QrCode object to the console.""" 195 border = 4 196 for y in range(-border, qrcode.get_size() + border): 197 for x in range(-border, qrcode.get_size() + border): 198 print("\u2588 "[1 if qrcode.get_module(x,y) else 0] * 2, end="") 199 print() 200 print() 201 202 203# Run the main program 204if __name__ == "__main__": 205 main() 206