examples/common/QRCode/repo/python/qrcodegen-demo.py

   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
  27 from qrcodegen import QrCode, QrSegment
  28
  29
  30 def main() -> None:
  31         """The main application program."""
  32         do_basic_demo()
  33         do_variety_demo()
  34         do_segment_demo()
  35         do_mask_demo()
  36
  37
  38
  39 # ---- Demo suite ----
  40
  41 def do_basic_demo() -> None:
  42         """Creates a single QR Code, then prints it to the console."""
  43         text = "Hello, world!"      # User-supplied Unicode text
  44         errcorlvl = QrCode.Ecc.LOW  # Error correction level
  45
  46         # Make and print the QR Code symbol
  47         qr = QrCode.encode_text(text, errcorlvl)
  48         print_qr(qr)
  49         print(qr.to_svg_str(4))
  50
  51
  52 def do_variety_demo() -> None:
  53         """Creates a variety of QR Codes that exercise different features of the library, and prints each one to the console."""
  54
  55         # Numeric mode encoding (3.33 bits per digit)
  56         qr = QrCode.encode_text("314159265358979323846264338327950288419716939937510", QrCode.Ecc.MEDIUM)
  57         print_qr(qr)
  58
  59         # Alphanumeric mode encoding (5.5 bits per character)
  60         qr = QrCode.encode_text("DOLLAR-AMOUNT:$39.87 PERCENTAGE:100.00% OPERATIONS:+-*/", QrCode.Ecc.HIGH)
  61         print_qr(qr)
  62
  63         # Unicode text as UTF-8
  64         qr = QrCode.encode_text("\u3053\u3093\u306B\u3061\u0077\u0061\u3001\u4E16\u754C\uFF01\u0020\u03B1\u03B2\u03B3\u03B4", QrCode.Ecc.QUARTILE)
  65         print_qr(qr)
  66
  67         # Moderately large QR Code using longer text (from Lewis Carroll's Alice in Wonderland)
  68         qr = QrCode.encode_text(
  69                 "Alice was beginning to get very tired of sitting by her sister on the bank, "
  70                 "and of having nothing to do: once or twice she had peeped into the book her sister was reading, "
  71                 "but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice "
  72                 "'without pictures or conversations?' So she was considering in her own mind (as well as she could, "
  73                 "for the hot day made her feel very sleepy and stupid), whether the pleasure of making a "
  74                 "daisy-chain would be worth the trouble of getting up and picking the daisies, when suddenly "
  75                 "a White Rabbit with pink eyes ran close by her.", QrCode.Ecc.HIGH)
  76         print_qr(qr)
  77
  78
  79 def do_segment_demo() -> None:
  80         """Creates QR Codes with manually specified segments for better compactness."""
  81
  82         # Illustration "silver"
  83         silver0 = "THE SQUARE ROOT OF 2 IS 1."
  84         silver1 = "41421356237309504880168872420969807856967187537694807317667973799"
  85         qr = QrCode.encode_text(silver0 + silver1, QrCode.Ecc.LOW)
  86         print_qr(qr)
  87
  88         segs = [
  89                 QrSegment.make_alphanumeric(silver0),
  90                 QrSegment.make_numeric(silver1)]
  91         qr = QrCode.encode_segments(segs, QrCode.Ecc.LOW)
  92         print_qr(qr)
  93
  94         # Illustration "golden"
  95         golden0 = "Golden ratio \u03C6 = 1."
  96         golden1 = "6180339887498948482045868343656381177203091798057628621354486227052604628189024497072072041893911374"
  97         golden2 = "......"
  98         qr = QrCode.encode_text(golden0 + golden1 + golden2, QrCode.Ecc.LOW)
  99         print_qr(qr)
 100
 101         segs = [
 102                 QrSegment.make_bytes(golden0.encode("UTF-8")),
 103                 QrSegment.make_numeric(golden1),
 104                 QrSegment.make_alphanumeric(golden2)]
 105         qr = QrCode.encode_segments(segs, QrCode.Ecc.LOW)
 106         print_qr(qr)
 107
 108         # Illustration "Madoka": kanji, kana, Cyrillic, full-width Latin, Greek characters
 109         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"
 110         qr = QrCode.encode_text(madoka, QrCode.Ecc.LOW)
 111         print_qr(qr)
 112
 113         kanjicharbits = [  # Kanji mode encoding (13 bits per character)
 114                 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 1,
 115                 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0,
 116                 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0,
 117                 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1,
 118                 0, 1, 0, 1, 0, 1, 1, 0, 1, 0, 1, 1, 1,
 119                 0, 0, 0, 0, 1, 0, 1, 0, 1, 1, 1, 0, 0,
 120                 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 1, 1, 1,
 121                 0, 0, 0, 0, 1, 0, 0, 1, 0, 1, 0, 0, 1,
 122                 0, 0, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1,
 123                 0, 0, 0, 0, 1, 1, 0, 1, 1, 1, 1, 0, 1,
 124                 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 1,
 125                 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 0, 1, 0,
 126                 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0,
 127                 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0, 0, 1,
 128                 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 1, 0, 0,
 129                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1,
 130                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
 131                 0, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1,
 132                 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0,
 133                 0, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1,
 134                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
 135                 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0,
 136                 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1,
 137                 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 1, 1,
 138                 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 1, 0, 1,
 139                 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
 140                 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0,
 141                 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 142                 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0,
 143         ]
 144         segs = [QrSegment(QrSegment.Mode.KANJI, len(kanjicharbits) // 13, kanjicharbits)]
 145         qr = QrCode.encode_segments(segs, QrCode.Ecc.LOW)
 146         print_qr(qr)
 147
 148
 149 def do_mask_demo() -> None:
 150         """Creates QR Codes with the same size and contents but different mask patterns."""
 151
 152         # Project Nayuki URL
 153         segs = QrSegment.make_segments("https://www.nayuki.io/")
 154         print_qr(QrCode.encode_segments(segs, QrCode.Ecc.HIGH, mask=-1))  # Automatic mask
 155         print_qr(QrCode.encode_segments(segs, QrCode.Ecc.HIGH, mask=3))  # Force mask 3
 156
 157         # Chinese text as UTF-8
 158         segs = QrSegment.make_segments(
 159                 "\u7DAD\u57FA\u767E\u79D1\uFF08\u0057\u0069\u006B\u0069\u0070\u0065\u0064\u0069\u0061\uFF0C"
 160                 "\u8046\u807D\u0069\u002F\u02CC\u0077\u026A\u006B\u1D7B\u02C8\u0070\u0069\u02D0\u0064\u0069"
 161                 "\u002E\u0259\u002F\uFF09\u662F\u4E00\u500B\u81EA\u7531\u5167\u5BB9\u3001\u516C\u958B\u7DE8"
 162                 "\u8F2F\u4E14\u591A\u8A9E\u8A00\u7684\u7DB2\u8DEF\u767E\u79D1\u5168\u66F8\u5354\u4F5C\u8A08"
 163                 "\u756B")
 164         print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=0))  # Force mask 0
 165         print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=1))  # Force mask 1
 166         print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=5))  # Force mask 5
 167         print_qr(QrCode.encode_segments(segs, QrCode.Ecc.MEDIUM, mask=7))  # Force mask 7
 168
 169
 170
 171 # ---- Utilities ----
 172
 173 def print_qr(qrcode: QrCode) -> None:
 174         """Prints the given QrCode object to the console."""
 175         border = 4
 176         for y in range(-border, qrcode.get_size() + border):
 177                 for x in range(-border, qrcode.get_size() + border):
 178                         print("\u2588 "[1 if qrcode.get_module(x,y) else 0] * 2, end="")
 179                 print()
 180         print()
 181
 182
 183 # Run the main program
 184 if __name__ == "__main__":
 185         main()