"""Utility classes and functions for configuring and setting up the content and the look of a QR code."""
import datetime
import decimal
from collections import namedtuple
from dataclasses import asdict
from datetime import date
from enum import Enum
from typing import Optional, Any, Union, Sequence, List, Tuple
import pytz
from django.utils.html import escape
from pydantic import validate_arguments
from pydantic.dataclasses import dataclass as pydantic_dataclass
from qr_code.qrcode.constants import DEFAULT_MODULE_SIZE, SIZE_DICT, DEFAULT_ERROR_CORRECTION, DEFAULT_IMAGE_FORMAT
from segno import helpers
[docs]class QRCodeOptions:
"""
Represents the options used to create and draw a QR code.
"""
[docs] @validate_arguments
def __init__(
self,
size: Union[int, str, None] = DEFAULT_MODULE_SIZE,
border: int = 4,
version: Union[int, str, None] = None,
image_format: str = "svg",
error_correction: str = DEFAULT_ERROR_CORRECTION,
encoding: Optional[str] = "utf-8",
boost_error: bool = True,
micro: bool = False,
eci: bool = False,
dark_color: Union[tuple, str, bool, None] = "#000",
light_color: Union[tuple, str, bool, None] = "#fff",
finder_dark_color: Union[tuple, str, bool, None] = False,
finder_light_color: Union[tuple, str, bool, None] = False,
data_dark_color: Union[tuple, str, bool, None] = False,
data_light_color: Union[tuple, str, bool, None] = False,
version_dark_color: Union[tuple, str, bool, None] = False,
version_light_color: Union[tuple, str, bool, None] = False,
format_dark_color: Union[tuple, str, bool, None] = False,
format_light_color: Union[tuple, str, bool, None] = False,
alignment_dark_color: Union[tuple, str, bool, None] = False,
alignment_light_color: Union[tuple, str, bool, None] = False,
timing_dark_color: Union[tuple, str, bool, None] = False,
timing_light_color: Union[tuple, str, bool, None] = False,
separator_color: Union[tuple, str, bool, None] = False,
dark_module_color: Union[tuple, str, bool, None] = False,
quiet_zone_color: Union[tuple, str, bool, None] = False,
) -> None:
"""
:param size: The size of the QR code as an integer or a string. Default is *'m'*.
:type: str or int
:param int border: The size of the border (blank space around the code).
:param version: The version of the QR code gives the size of the matrix.
Default is *None* which mean automatic in order to avoid data overflow.
:param version: QR Code version. If the value is ``None`` (default), the
minimal version which fits for the input data will be used.
Valid values: "M1", "M2", "M3", "M4" (for Micro QR codes) or an
integer between 1 and 40 (for QR codes).
The `version` parameter is case insensitive.
:type version: int, str or None
:param str image_format: The graphics format used to render the QR code.
It can be either *'svg'* or *'png'*. Default is *'svg'*.
:param str error_correction: How much error correction that might be required
to read the code. It can be either *'L'*, *'M'*, *'Q'*, or *'H'*. Default is *'M'*.
:param bool boost_error: Tells whether the QR code encoding engine tries to increase the error correction level
if it does not affect the version. Error correction level is not increased when it impacts the version of
the code.
:param bool micro: Indicates if a Micro QR Code should be created. Default: False
:param encoding: Indicates the encoding in mode "byte". By default
`encoding` is ``UTF-8``. When set to ``None``, the implementation tries to use the standard conform
ISO/IEC 8859-1 encoding and if it does not fit, it will use UTF-8. Note that no ECI mode indicator is
inserted by default (see :paramref:`eci`).
The `encoding` parameter is case-insensitive.
:type encoding: str or None
:param bool eci: Indicates if binary data which does not use the default
encoding (ISO/IEC 8859-1) should enforce the ECI mode. Since a lot
of QR code readers do not support the ECI mode, this feature is
disabled by default and the data is encoded in the provided
`encoding` using the usual "byte" mode. Set `eci` to ``True`` if
an ECI header should be inserted into the QR Code. Note that
the implementation may not know the ECI designator for the provided
`encoding` and may raise an exception if the ECI designator cannot
be found.
The ECI mode is not supported by Micro QR Codes.
:param dark_color: Color of the dark modules (default: black). The
color can be provided as ``(R, G, B)`` tuple, as hexadecimal
format (``#RGB``, ``#RRGGBB`` ``RRGGBBAA``), or web color
name (i.e. ``red``). If alpha transparency is supported (i.e. PNG and SVG), hexadecimal values like #RRGGBBAA are accepted.
:param light_color: Color of the light modules (default: white).
See `color` for valid values. If light is set to ``None`` the
light modules will be transparent.
:param finder_dark_color: Color of the dark finder modules (default: same as ``dark_color``)
:param finder_light_color: Color of the light finder modules (default: same as ``light_color``)
:param data_dark_color: Color of the dark data modules (default: same as ``dark_color``)
:param data_light_color: Color of the light data modules (default: same as ``light_color``)
:param version_dark_color: Color of the dark version modules (default: same as ``dark_color``)
:param version_light_color: Color of the light version modules (default: same as ``light_color``)
:param format_dark_color: Color of the dark format modules (default: same as ``dark_color``)
:param format_light_color: Color of the light format modules (default: same as ``light_color``)
:param alignment_dark_color: Color of the dark alignment modules (default: same as ``dark_color``)
:param alignment_light_color: Color of the light alignment modules (default: same as ``light_color``)
:param timing_dark_color: Color of the dark timing pattern modules (default: same as ``dark_color``)
:param timing_light_color: Color of the light timing pattern modules (default: same as ``light_color``)
:param separator_color: Color of the separator (default: same as ``light_color``)
:param dark_module_color: Color of the dark module (default: same as ``dark_color``)
:param quiet_zone_color: Color of the quiet zone modules (default: same as ``light_color``)
The *size* parameter gives the size of each module of the QR code matrix. It can be either a positive integer or one of the following letters:
* t or T: tiny (value: 6)
* s or S: small (value: 12)
* m or M: medium (value: 18)
* l or L: large (value: 30)
* h or H: huge (value: 48)
For PNG image format the size unit is in pixels, while the unit is 0.1 mm for SVG format.
The *border* parameter controls how many modules thick the border should be (blank space around the code).
The default is 4, which is the minimum according to the specs.
The *version* parameter is an integer from 1 to 40 that controls the size of the QR code matrix. Set to None to
determine this automatically. The smallest, version 1, is a 21 x 21 matrix. The biggest, version 40, is
177 x 177 matrix.
The size grows by 4 modules/side.
For Micro QR codes, valid values are "M1", "M2", "M3", "M4".
There are 4 error correction levels used for QR codes, with each one adding different amounts of "backup" data
depending on how much damage the QR code is expected to suffer in its intended environment, and hence how much
error correction may be required. The correction level can be configured with the *error_correction* parameter as follow:
* l or L: error correction level L – up to 7% damage
* m or M: error correction level M – up to 15% damage
* q or Q: error correction level Q – up to 25% damage
* h or H: error correction level H – up to 30% damage
You may enforce the creation of a Micro QR Code with `micro=True`. The `micro` option defaults to `False`.
The `encoding` option controls the text encoding used in mode "byte" (used for any general text content). By default `encoding` is ``UTF-8``. When set to ``None``, the implementation (based on Segno) tries to use the standard conform ISO/IEC 8859-1 encoding and if it does not fit, it will use UTF-8. Note that no ECI mode indicator is inserted by default (see `eci` option). The `encoding` parameter is case-insensitive.
The `boost_error` indicates whether the QR code encoding engine (Segno) tries to increase the error correction level if it does not affect the version. Error correction level is not increased when it impacts the version of the code.
The `eci` option indicates if binary data which does not use the default encoding (ISO/IEC 8859-1) should enforce the ECI mode. Since a lot of QR code readers do not support the ECI mode, this feature is disabled by default and the data is encoded in the provided encoding using the usual “byte” mode. Set eci to `True` if an ECI header should be inserted into the QR Code. Note that the implementation may not know the ECI designator for the provided encoding and may raise an exception if the ECI designator cannot be found. The ECI mode is not supported by Micro QR Codes.
:raises: TypeError in case an unknown argument is given.
"""
self._size = size
self._border = int(border)
if _can_be_cast_to_int(version):
version = int(version) # type: ignore
if not 1 <= version <= 40:
version = None
elif version in ("m1", "m2", "m3", "m4", "M1", "M2", "M3", "M4"):
version = version.lower() # type: ignore
# Set / change the micro setting otherwise Segno complains about
# conflicting parameters
micro = True
else:
version = None
self._version = version
# if not isinstance(micro, bool):
# micro = micro == 'True'
self._micro = micro
# if not isinstance(eci, bool):
# eci = eci == 'True'
self._eci = eci
try:
error = error_correction.lower()
self._error_correction = error if error in ("l", "m", "q", "h") else DEFAULT_ERROR_CORRECTION
except AttributeError:
self._error_correction = DEFAULT_ERROR_CORRECTION
self._boost_error = boost_error
# Handle encoding
self._encoding = None if encoding == "" else encoding
try:
image_format = image_format.lower()
self._image_format = image_format if image_format in ("svg", "png") else DEFAULT_IMAGE_FORMAT
except AttributeError:
self._image_format = DEFAULT_IMAGE_FORMAT
self._colors = dict(
dark_color=dark_color,
light_color=light_color,
finder_dark_color=finder_dark_color,
finder_light_color=finder_light_color,
data_dark_color=data_dark_color,
data_light_color=data_light_color,
version_dark_color=version_dark_color,
version_light_color=version_light_color,
format_dark_color=format_dark_color,
format_light_color=format_light_color,
alignment_dark_color=alignment_dark_color,
alignment_light_color=alignment_light_color,
timing_dark_color=timing_dark_color,
timing_light_color=timing_light_color,
separator_color=separator_color,
dark_module_color=dark_module_color,
quiet_zone_color=quiet_zone_color,
)
[docs] def kw_make(self):
"""Internal method which returns a dict of parameters to create a QR code.
:rtype: dict
"""
return dict(
version=self._version,
error=self._error_correction,
micro=self._micro,
eci=self._eci,
boost_error=self._boost_error,
encoding=self._encoding,
)
[docs] def kw_save(self):
"""Internal method which returns a dict of parameters to save a QR code.
:rtype: dict
"""
image_format = self._image_format
kw = dict(border=self.border, kind=image_format, scale=self._size_as_int())
# Change the color mapping into the keywords Segno expects
# (remove the "_color" suffix from the module names)
kw.update({k[:-6]: v for k, v in self.color_mapping().items()})
if image_format == "svg":
kw["unit"] = "mm"
scale = decimal.Decimal(kw["scale"]) / 10
kw["scale"] = scale
return kw
[docs] def color_mapping(self):
"""Internal method which returns the color mapping.
Only non-default values are returned.
:rtype: dict
"""
colors = {k: v for k, v in self._colors.items() if v is not False}
# Remove common default "dark" and "light" values
if colors.get("dark_color") in ("#000", "#000000", "black"):
del colors["dark_color"]
if colors.get("light_color") in ("#fff", "#FFF", "#ffffff", "#FFFFFF", "white"):
del colors["light_color"]
return colors
def _size_as_int(self):
"""Returns the size as integer value.
:rtype: int
"""
size = self._size
if _can_be_cast_to_int(size):
actual_size = int(size)
if actual_size < 1:
actual_size = SIZE_DICT[DEFAULT_MODULE_SIZE]
elif isinstance(size, str):
actual_size = SIZE_DICT.get(size.lower(), DEFAULT_MODULE_SIZE)
else:
actual_size = SIZE_DICT[DEFAULT_MODULE_SIZE]
return actual_size
@property
def size(self):
return self._size
@property
def border(self):
return self._border
@property
def version(self):
return self._version
@property
def image_format(self):
return self._image_format
@property
def error_correction(self):
return self._error_correction
@property
def boost_error(self):
return self._boost_error
@property
def micro(self):
return self._micro
@property
def encoding(self):
return self._encoding
@property
def eci(self):
return self._eci
def _can_be_cast_to_int(value: Any) -> bool:
return isinstance(value, int) or (isinstance(value, str) and value.isdigit())
[docs]class EventClass(Enum):
PUBLIC = 1
PRIVATE = 2
CONFIDENTIAL = 3
[docs]class EventStatus(Enum):
TENTATIVE = 1
CONFIRMED = 2
CANCELLED = 3
[docs]class EventTransparency(Enum):
OPAQUE = 1
TRANSPARENT = 2
[docs]@pydantic_dataclass
class VEvent:
"""
Data for representing VEVENT for iCalendar (.ics) event.
Only a subset of https://icalendar.org/iCalendar-RFC-5545/3-6-1-event-component.html is supported.
Fields meaning:
* uid: Event identifier
* summary: This property defines a short summary or subject for the calendar event.
* start: Start of event
* end: End of event
* dtstamp: The property indicates the date/time that the instance of the iCalendar object was created. Defaults to current time in UTC.
* description: This property provides a more complete description of the calendar component, than that provided by the "SUMMARY" property.
* organizer: E-mail of organizer
* status: Status of event
* location: Location of event
* geo: This property specifies information related to the global position of event. The property value specifies latitude and longitude, in that order. Whole degrees of latitude shall be represented by a two-digit decimal number ranging from -90 through 90. The longitude represents the location east or west of the prime meridian as a positive or negative real number, respectively (a decimal number ranging from -180 through 180).
* event_class: Either PUBLIC, PRIVATE or CONFIDENTIAL (see `utils.EventClass`).
* categories: This property defines the categories for calendar event.
* transparency: Tell whether the event can have its Time Transparency set to "TRANSPARENT" in order to prevent blocking of the event in searches for busy time.
* url: This property defines a Uniform Resource Locator (URL) associated with the iCalendar object.
"""
uid: str
summary: str
start: datetime.datetime
end: datetime.datetime
dtstamp: Optional[datetime.datetime] = None
description: Optional[str] = None
organizer: Optional[str] = None
status: Optional[EventStatus] = None
location: Optional[str] = None
geo: Optional[Tuple[float, float]] = None
event_class: Optional[EventClass] = None
categories: Optional[List[str]] = None
transparency: Optional[EventTransparency] = None
url: Optional[str] = None
[docs] def make_qr_code_data(self) -> str:
"""\
Creates a string encoding the event information.
Only a subset of https://icalendar.org/iCalendar-RFC-5545/3-6-1-event-component.html is supported.
"""
# Inspired form icalendar: https://github.com/collective/icalendar/
def fold_icalendar_line(text, limit=75, fold_sep="\r\n "):
"""Make a string folded as defined in RFC5545
Lines of text SHOULD NOT be longer than 75 octets, excluding the line
break. Long content lines SHOULD be split into a multiple line
representations using a line "folding" technique. That is, a long
line can be split between any two characters by inserting a CRLF
immediately followed by a single linear white-space character (i.e.,
SPACE or HTAB).
"""
new_text = ""
for line in text.split("\n"):
# Use a fast and simple variant for the common case that line is all ASCII.
try:
line.encode("ascii")
except (UnicodeEncodeError, UnicodeDecodeError):
ret_chars = []
byte_count = 0
for char in line:
char_byte_len = len(char.encode("utf-8"))
byte_count += char_byte_len
if byte_count >= limit:
ret_chars.append(fold_sep)
byte_count = char_byte_len
ret_chars.append(char)
new_text += "".join(ret_chars)
else:
new_text += fold_sep.join(line[i : i + limit - 1] for i in range(0, len(line), limit - 1))
return new_text
# Source form icalendar: https://github.com/collective/icalendar/
def escape_char(text):
"""Format value according to iCalendar TEXT escaping rules."""
# NOTE: ORDER MATTERS!
return (
text.replace(r"\N", "\n")
.replace("\\", "\\\\")
.replace(";", r"\;")
.replace(",", r"\,")
.replace("\r\n", r"\n")
.replace("\n", r"\n")
)
def is_naive_datetime(t) -> bool:
return t.tzinfo is None or t.tzinfo.utcoffset(t) is None
def get_datetime_str(t) -> str:
if is_naive_datetime(t):
return t.strftime("%Y%m%dT%H%M%S")
else:
t_utc = t.astimezone(pytz.utc)
return t_utc.strftime("%Y%m%dT%H%M%SZ")
event_str = f"""BEGIN:VCALENDAR
PRODID:Django QR Code
VERSION:2.0
BEGIN:VEVENT
DTSTAMP:{(self.dtstamp or datetime.datetime.utcnow()).astimezone(pytz.utc).strftime("%Y%m%dT%H%M%SZ")}
UID:{self.uid}
DTSTART:{get_datetime_str(self.start)}
DTEND:{get_datetime_str(self.end)}
SUMMARY:{escape_char(self.summary)}"""
if self.event_class:
event_str += f"\nCLASS:{self.event_class.name}"
if self.categories:
event_str += "\n" + fold_icalendar_line(f"CATEGORIES:{','.join(map(escape_char, self.categories))}")
if self.transparency:
event_str += f"\nTRANSP:{self.transparency.name}"
if self.description:
event_str += "\n" + fold_icalendar_line(f"DESCRIPTION:{escape_char(self.description)}")
if self.organizer:
event_str += f"\nORGANIZER:MAILTO:{self.organizer}"
if self.status:
event_str += f"\nSTATUS:{self.status.name}"
if self.location:
event_str += "\n" + fold_icalendar_line(f"LOCATION:{escape_char(self.location)}")
if self.geo:
event_str += f"\nGEO:{self.geo[0]};{self.geo[1]}"
if self.url:
event_str += f"\nURL:{self.url}"
event_str += "\nEND:VEVENT\nEND:VCALENDAR"
# print(event_str)
return event_str
[docs]@pydantic_dataclass
class EpcData:
"""
Data for representing an European Payments Council Quick Response Code (EPC QR Code) version 002.
You must always use the error correction level "M" and utilizes max. version 13 to fulfill the constraints of the
EPC QR Code standard.
.. note::
Either the ``text`` or ``reference`` must be provided but not both
.. note::
Neither the IBAN, BIC, nor remittance reference number or any other
information is validated (aside from checks regarding the allowed string
lengths).
Fields meaning:
* name: Name of the recipient.
* iban: International Bank Account Number (IBAN)
* amount: The amount to transfer. The currency is always Euro, no other currencies are supported.
* text: Remittance Information (unstructured)
* reference: Remittance Information (structured)
* bic: Bank Identifier Code (BIC). Optional, only required for non-EEA countries.
* purpose: SEPA purpose code.
"""
name: str
iban: str
amount: Union[int, float, decimal.Decimal]
text: Optional[str] = None
reference: Optional[str] = None
bic: Optional[str] = None
purpose: Optional[str] = None
[docs] def make_qr_code_data(self) -> str:
"""
Validates the input and creates the data for an European Payments Council Quick Response Code
(EPC QR Code) version 002.
This is a wrapper for :py:func:`segno.helpers._make_epc_qr_data` with no choice for encoding.
:rtype: str
"""
return helpers._make_epc_qr_data(**asdict(self), encoding=1) # type: ignore
[docs]@pydantic_dataclass
class MeCard:
"""Represents the detail of a contact for MeCARD encoding.
Fields meaning:
* name: Name. If it contains a comma, the first part is treated as lastname and the second part is treated as forename.
* reading: Designates a text string to be set as the kana name in the phonebook
* email: E-mail address. Multiple values are allowed.
* phone: Phone number. Multiple values are allowed.
* videophone: Phone number for video calls. Multiple values are allowed.
* memo: A notice for the contact.
* nickname: Nickname.
* birthday: Birthday. If a string is provided, it should encode the date as YYYYMMDD value.
* url: Homepage. Multiple values are allowed.
* pobox: P.O. box (address information).
* roomno: Room number (address information).
* houseno: House number (address information).
* city: City (address information).
* prefecture: Prefecture (address information).
* zipcode: Zip code (address information).
* country: Country (address information).
* org: organization or company name (ORG field, non-standard,but often recognized by readers).
"""
name: str
reading: Optional[str] = None
email: Union[str, Sequence[str], None] = None
phone: Union[str, Sequence[str], None] = None
videophone: Union[str, Sequence[str], None] = None
memo: Optional[str] = None
nickname: Optional[str] = None
birthday: Union[str, datetime.date, None] = None
url: Union[str, Sequence[str], None] = None
pobox: Optional[str] = None
roomno: Optional[str] = None
houseno: Optional[str] = None
city: Optional[str] = None
prefecture: Optional[str] = None
zipcode: Union[int, str, None] = None
country: Optional[str] = None
org: Optional[str] = None
[docs] def make_qr_code_data(self) -> str:
"""\
Creates a string encoding the contact information as MeCARD.
:rtype: str
"""
kw = asdict(self)
if self.zipcode is not None and self.zipcode != "":
kw["zipcode"] = str(self.zipcode)
org = kw.pop("org")
contact_text = helpers.make_mecard_data(**kw)
# Not standard, but recognized by several readers.
if org:
contact_text += f"ORG:{_escape_mecard_special_chars(org)};"
return contact_text
[docs]@pydantic_dataclass
class VCard:
"""Represents the detail of a contact for vCard encoding.
Creates a QR code which encodes a `vCard <https://en.wikipedia.org/wiki/VCard>`_
version 3.0.
Only a subset of available `vCard 3.0 properties <https://tools.ietf.org/html/rfc2426>`
is supported.
Fields meaning:
name: The name. If it contains a semicolon, , the first part
is treated as lastname and the second part is treated as forename.
displayname: Common name.
email: E-mail address. Multiple values are allowed.
phone: Phone number. Multiple values are allowed.
fax: Fax number. Multiple values are allowed.
videophone: Phone number for video calls. Multiple values are allowed.
memo: A notice for the contact.
nickname: Nickname.
birthday: Birthday. If a string is provided, it should encode the
date as ``YYYY-MM-DD`` value.
url: Homepage. Multiple values are allowed.
pobox: P.O. box (address information).
street: Street address.
city: City (address information).
region: Region (address information).
zipcode: Zip code (address information).
country: Country (address information).
org: Company / organization name.
lat: Latitude.
lng: Longitude.
source: URL where to obtain the vCard.
rev: Revision of the vCard / last modification date.
title: Job Title. Multiple values are allowed.
photo_uri: Photo URI. Multiple values are allowed.
cellphone: Cell phone number. Multiple values are allowed.
homephone: Home phone number. Multiple values are allowed.
workphone: Work phone number. Multiple values are allowed.
"""
name: str
displayname: Optional[str] = None
email: Union[str, Sequence[str], None] = None
phone: Union[str, Sequence[str], None] = None
fax: Union[str, Sequence[str], None] = None
videophone: Union[str, Sequence[str], None] = None
memo: Optional[str] = None
nickname: Optional[str] = None
birthday: Union[str, datetime.date, None] = None
url: Union[str, Sequence[str], None] = None
pobox: Optional[str] = None
street: Optional[str] = None
city: Optional[str] = None
region: Optional[str] = None
zipcode: Union[int, str, None] = None
country: Optional[str] = None
org: Optional[str] = None
lat: Optional[float] = None
lng: Optional[float] = None
source: Optional[str] = None
rev: Union[str, datetime.date, None] = None
title: Union[str, Sequence[str], None] = None
photo_uri: Union[str, Sequence[str], None] = None
cellphone: Union[str, Sequence[str], None] = None
homephone: Union[str, Sequence[str], None] = None
workphone: Union[str, Sequence[str], None] = None
def __post_init__(self):
if self.displayname is None:
self.displayname = self.name.replace(" ; ", " ").replace("; ", " ").replace(";", " ")
[docs] def make_qr_code_data(self) -> str:
"""\
Creates a string encoding the contact information as vCard 3.0.
Only a subset of available `vCard 3.0 properties <https://tools.ietf.org/html/rfc2426>`
is supported.
:rtype: str
"""
kw = asdict(self)
kw["zipcode"] = str(self.zipcode)
return helpers.make_vcard_data(**kw)
[docs]@pydantic_dataclass
class WifiConfig:
"""\
Represents a WIFI configuration.
Fields meaning:
* ssid: the name of the SSID
* authentication: the authentication type for the SSID; can be AUTHENTICATION.wep or AUTHENTICATION.wpa, or AUTHENTICATION.nopass for no password. Or, omit for no password.
* password: the password, ignored if "authentication" is 'nopass' (in which case it may be omitted).
* hidden: tells whether the SSID is hidden or not; can be True or False.
"""
AUTHENTICATION = namedtuple("AUTHENTICATION", "nopass WEP WPA")._make(range(3)) # type: ignore
AUTHENTICATION_CHOICES = ((AUTHENTICATION.nopass, "nopass"), (AUTHENTICATION.WEP, "WEP"), (AUTHENTICATION.WPA, "WPA"))
ssid: str = ""
authentication: int = AUTHENTICATION.nopass
password: str = ""
hidden: bool = False
[docs] def make_qr_code_data(self) -> str:
"""
Make a text for configuring a Wi-Fi connexion. The syntax is inspired by the MeCARD format used for contacts.
:return: the WIFI configuration text that can be translated to a QR code.
:rtype: str
"""
wifi_config = "WIFI:"
if self.ssid:
wifi_config += "S:%s;" % _escape_mecard_special_chars(self.ssid)
if self.authentication:
wifi_config += "T:%s;" % WifiConfig.AUTHENTICATION_CHOICES[self.authentication][1]
if self.password:
wifi_config += "P:%s;" % _escape_mecard_special_chars(self.password)
if self.hidden:
wifi_config += "H:%s;" % str(self.hidden).lower()
wifi_config += ";"
return wifi_config
[docs]@pydantic_dataclass
class Coordinates:
"""\
Represents a set of coordinates with an optional altitude.
Fields meaning:
* latitude: The latitude.
* longitude: The longitude.
* altitude: The optional altitude.
"""
latitude: float
longitude: float
altitude: Optional[Union[int, float]] = None
[docs] def __str__(self) -> str:
if self.altitude:
return f"latitude: {self.latitude}, longitude: {self.longitude}, altitude: {self.altitude}"
return f"latitude: {self.latitude}, longitude: {self.longitude}"
def float_to_str(self, f):
return f"{f:.8f}".rstrip("0")
def make_geolocation_text(self) -> str:
geo = f"geo:{self.float_to_str(self.latitude)},{self.float_to_str(self.longitude)}"
if self.altitude:
return f"{geo},{self.float_to_str(self.altitude)}"
return geo
def make_google_maps_text(self) -> str:
geo = f"https://maps.google.com/local?q={self.float_to_str(self.latitude)},{self.float_to_str(self.longitude)}"
if self.altitude:
return f"{geo},{self.float_to_str(self.altitude)}"
return geo
def make_tel_text(phone_number: Any) -> str:
return "tel:%s" % phone_number
def make_sms_text(phone_number: Any) -> str:
return "sms:%s" % phone_number
def make_youtube_text(video_id: str) -> str:
return f"https://www.youtube.com/watch/?v={escape(video_id)}"
def make_google_play_text(package_id: str) -> str:
return f"https://play.google.com/store/apps/details?id={escape(package_id)}"
[docs]@pydantic_dataclass
class Email:
"""Represents the data of an e-mail.
Fields meaning:
* to: The email address (recipient). Multiple values are allowed.
* cc: The carbon copy recipient. Multiple values are allowed.
* bcc: The blind carbon copy recipient. Multiple values are allowed.
* subject: The subject.
* body: The message body.
"""
to: Union[str, Sequence[str]]
cc: Union[str, Sequence[str], None] = None
bcc: Union[str, Sequence[str], None] = None
subject: Optional[str] = None
body: Optional[str] = None
[docs] def make_qr_code_data(self) -> str:
"""\
Creates either a simple "mailto:" URL or complete e-mail message with
(blind) carbon copies and a subject and a body.
:rtype: str
"""
return helpers.make_make_email_data(**asdict(self))
@validate_arguments
def _escape_mecard_special_chars(string_to_escape: Optional[str]) -> Optional[str]:
if not string_to_escape:
return string_to_escape
special_chars = ["\\", '"', ";", ",", ":"]
for sc in special_chars:
string_to_escape = string_to_escape.replace(sc, "\\%s" % sc)
return string_to_escape