101 lines
2.9 KiB
Python
101 lines
2.9 KiB
Python
"""barcode.base
|
|
|
|
"""
|
|
from typing import ClassVar
|
|
from typing import List
|
|
from typing import Optional
|
|
|
|
from barcode.writer import BaseWriter
|
|
from barcode.writer import SVGWriter
|
|
|
|
|
|
class Barcode:
|
|
name = ""
|
|
|
|
digits = 0
|
|
|
|
default_writer = SVGWriter
|
|
|
|
default_writer_options: ClassVar[dict] = {
|
|
"module_width": 0.2,
|
|
"module_height": 15.0,
|
|
"quiet_zone": 6.5,
|
|
"font_size": 10,
|
|
"text_distance": 5.0,
|
|
"background": "white",
|
|
"foreground": "black",
|
|
"write_text": True,
|
|
"text": "",
|
|
}
|
|
|
|
writer: BaseWriter
|
|
|
|
def to_ascii(self) -> str:
|
|
code = self.build()
|
|
for i, line in enumerate(code):
|
|
code[i] = line.replace("1", "X").replace("0", " ")
|
|
return "\n".join(code)
|
|
|
|
def __repr__(self) -> str:
|
|
return f"<{self.__class__.__name__}({self.get_fullcode()!r})>"
|
|
|
|
def build(self) -> List[str]:
|
|
raise NotImplementedError
|
|
|
|
def get_fullcode(self):
|
|
"""Returns the full code, encoded in the barcode.
|
|
|
|
:returns: Full human readable code.
|
|
:rtype: String
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
def save(
|
|
self, filename: str, options: Optional[dict] = None, text: Optional[str] = None
|
|
) -> str:
|
|
"""Renders the barcode and saves it in `filename`.
|
|
|
|
:param filename: Filename to save the barcode in (without filename extension).
|
|
:param options: The same as in `self.render`.
|
|
:param text: Text to render under the barcode.
|
|
|
|
:returns: The full filename with extension.
|
|
"""
|
|
output = self.render(options, text) if text else self.render(options)
|
|
|
|
return self.writer.save(filename, output)
|
|
|
|
def write(self, fp, options=None, text=None):
|
|
"""Renders the barcode and writes it to the file like object
|
|
`fp`.
|
|
|
|
:parameters:
|
|
fp : File like object
|
|
Object to write the raw data in.
|
|
options : Dict
|
|
The same as in `self.render`.
|
|
text : str
|
|
Text to render under the barcode.
|
|
"""
|
|
output = self.render(options, text)
|
|
self.writer.write(output, fp)
|
|
|
|
def render(self, writer_options: Optional[dict] = None, text: Optional[str] = None):
|
|
"""Renders the barcode using `self.writer`.
|
|
|
|
:param writer_options: Options for `self.writer`, see writer docs for details.
|
|
:param text: Text to render under the barcode.
|
|
|
|
:returns: Output of the writers render method.
|
|
"""
|
|
options = self.default_writer_options.copy()
|
|
options.update(writer_options or {})
|
|
if options["write_text"] or text is not None:
|
|
if text is not None:
|
|
options["text"] = text
|
|
else:
|
|
options["text"] = self.get_fullcode()
|
|
self.writer.set_options(options)
|
|
code = self.build()
|
|
return self.writer.render(code)
|