Function generate

barcode/__init__.py:115–150

Shortcut to generate a barcode in one line. :param name: Name of the type of barcode to use. :param code: Data to encode into the barcode. :param writer: A writer to use (e.g.: ImageWriter or SVGWriter). :param output: Destination file-like or path-like where to save the generated

(
    name: str,
    code: str,
    writer: BaseWriter | None = None,
    output: str | os.PathLike | BinaryIO | None = None,
    writer_options: dict | None = None,
    text: str | None = None,
)

def generate(
    name: str,
    code: str,
    writer: BaseWriter | None = None,
    output: str | os.PathLike | BinaryIO | None = None,
    writer_options: dict | None = None,
    text: str | None = None,
) -> str | None:
    """Shortcut to generate a barcode in one line.

    :param name: Name of the type of barcode to use.
    :param code: Data to encode into the barcode.
    :param writer: A writer to use (e.g.: ImageWriter or SVGWriter).
    :param output: Destination file-like or path-like where to save the generated
     barcode.
    :param writer_options: Options to pass on to the writer instance.
    :param text: Text to render under the barcode.
    """
    from barcode.base import Barcode

    if output is None:
        raise TypeError("'output' cannot be None")

    writer = writer or Barcode.default_writer()
    writer.set_options(writer_options or {})

    barcode = get(name, code, writer)

    if isinstance(output, str):
        return barcode.save(output, writer_options, text)
    if isinstance(output, os.PathLike):
        with open(output, "wb") as fp:
            barcode.write(fp, writer_options, text)
        return None
    barcode.write(output, writer_options, text)
    return None


get_barcode = get