Funktioner och funktioner
Funktioner och funktioner
Aspose.BarCode FOSS for Python provides a high-level API for generating seven barcode symbologies with per-symbology encode options and rendering controls. This page is the primary reference for all feature areas.
Stödda symbologier
Biblioteket stöder sju symboler genom dedikerade hjälparfunktioner och generiska funktioner. generate() Inträde punkt:
| Symbology | Typ av | Helper | Alternativ klass |
|---|---|---|---|
| Kod 128 | 1D | code128() | Code128Options |
| Kod 39 | 1D | code39() | Code39Options |
| EAN-13 | 1D | ean13() | Ean13Options |
| EAN-8 | 1D | ean8() | Ean8Options |
| QR koder | 2D | qr() | QrOptions |
| UPC-A | 1D | upca() | UpcaOptions |
| UPC-E | 1D | upce() | UpceOptions |
import aspose_barcode_foss as barcode
# Per-symbology helpers
bc_128 = barcode.code128("ABC123")
bc_qr = barcode.qr("https://example.com")
# Generic API
bc_gen = barcode.generate("ean13", "590123412345")128 koden för kodning
Code128Options kontroller som kod 128 tecken ställer kodaren använder. encode_mode Fastigheten accepterar A Code128EncodeMode Enum värde:
AUTO- Väljer den mest kompakta kodningen automatisktCODE_A,CODE_B,CODE_C- begränsas till en enda tecken uppsättningCODE_AB,CODE_AC,CODE_BC- tillåta växling mellan två tecken uppsättningar
from aspose_barcode_foss import Code128Options, Code128EncodeMode
bc = barcode.code128(
"1234567890",
encode=Code128Options(encode_mode=Code128EncodeMode.CODE_C),
)39 kodning
Code39Options Kontrollera om kodaren använder bas 43-figuren eller full ASCII förlängning:
full_ascii- Sätt tillTrueför att kodera det fullständiga 128-karaktär ASCII-området med hjälp av växelkopparadd_check_digit- Anslut en modul-43 checkdigent
from aspose_barcode_foss import Code39Options
bc = barcode.code39(
"Hello",
encode=Code39Options(full_ascii=True, add_check_digit=True),
)QR kod konfiguration
QrOptions ger den mest konfigurerade bland alla symboler:
| Property | Typ av | Values |
|---|---|---|
error_correction_level | QrErrorCorrectionLevel | L (7 % av dem), M 15 % av, Q 25 % av, H (30 %) av |
encoding_mode | QrEncodeMode | AUTO, NUMERIC, ALPHANUMERIC, BYTE, KANJI |
version | int | 1–40 (controls symbol size) |
mask | int | 0–7 (manual mask pattern selection) |
from aspose_barcode_foss import QrOptions, QrErrorCorrectionLevel, QrEncodeMode
bc = barcode.qr(
"https://example.com/product/12345",
encode=QrOptions(
error_correction_level=QrErrorCorrectionLevel.Q,
encoding_mode=QrEncodeMode.BYTE,
),
)EAN och UPC Check Digits
Ean13Options, Ean8Options, UpcaOptions,och UpceOptions Var och en har ett allow_check_digit_input För standard beräknar biblioteket checknumret automatiskt. allow_check_digit_input=True Om dina data redan innehåller det.
from aspose_barcode_foss import Ean13Options
# Automatic check digit (12 digits in, library appends the 13th)
bc = barcode.ean13("590123412345")
# Pre-computed check digit (13 digits, library validates)
bc2 = barcode.ean13(
"5901234123457",
encode=Ean13Options(allow_check_digit_input=True),
)Rendering kontroller
RenderOptions gäller alla symboler och kontrollerar den visuella utgången. to_svg() eller to_png():
| Property | Typ av | Beskrivning |
|---|---|---|
scale | float | Uniformskala multiplikator |
dpi | int | Resolution för PNG-utsläpp |
module_width | float | Bretthet av en barkodmodul |
module_height | float | Höjd av en barkodmodul |
quiet_zone | float | Whitespace padding runt barkoden |
foreground_color | str | Hexfärg för barer (t.ex., "#000000") |
background_color | str | Hex färg för bakgrunden |
transparent_background | bool | Öppen bakgrund för PNG |
show_text | bool | Visa mänskligt lästa text under barkoden |
font_family | str | Bokstäver för mänskligt lästa text |
font_size | float | Fontstorlek för mänskligt lästa text |
from aspose_barcode_foss import RenderOptions
bc = barcode.upca("01234567890")
png = bc.to_png(options=RenderOptions(
scale=3.0,
dpi=300,
foreground_color="#1a1a1a",
background_color="#ffffff",
show_text=True,
))Utgångsformat
| Format | Method | Return typ |
|---|---|---|
| SVG | to_svg() | str |
| PNG | to_png() | bytes |
Båda metoderna accepterar ett valfritt RenderOptions Parameter är.
Felhantering
Alla kodningsalternativ validering sker vid tidpunkten. biblioteket lyfter typade undantag innan kodning börjar:
| Exception | När uppväxt |
|---|---|
InvalidInputError | Data innehåller tecken som inte stöds av symbolen |
EncodingError | Kodning fel (t.ex. data överstiger kapacitet) |
SymbologyNotFoundError | Obekant symboliskt namn passerar till generate() |
UnsupportedCapabilityError | Begärda funktioner inte tillgängliga för denna symbolik |
Alla undantagsklasser ärvda från BarcodeError.
from aspose_barcode_foss import InvalidInputError
try:
bc = barcode.ean13("ABC")
except InvalidInputError as e:
print(f"Invalid input: {e}")Inträde Validering
Varje symbol har en dedikerad InputParser Parser kontrollerar karaktärsets, längdens och formatkrav specifika för varje symbol. Code128InputParser, Code39InputParser, Ean13InputParser, Ean8InputParser, QrInputParser, UpcaInputParser,och UpceInputParser De används internalt av sina respektive hjälpfunktioner.
Barkod Objekt
Den Barcode objektet som returneras av alla hjälparfunktioner ger:
to_svg(options)- Renderar till SVG strängto_png(options)- Renderar till PNG byterrender(renderer, options)- att använda en specifikRenderergenomförandetsymbol- denEncodedSymbolInnehåller modulsmatrix och metadataprofile- denSymbologyProfilemed förluster och kapacitet
API Referens sammanfattning
| Class | Beskrivning |
|---|---|
Barcode | Public barcode objekt med to_svg() och to_png() |
Code128Options | För att få en kod för kod 128 (encode_mode) |
Code39Options | För att få en kod för koden (full_ascii, add_check_digit) |
QrOptions | För att använda QR-kod (error_correction_level, encoding_mode, version, mask) |
Ean13Options | För att använda EAN-13 (allow_check_digit_input) |
Ean8Options | För att använda EAN-8 (allow_check_digit_input) |
UpcaOptions | För att använda en UPC-A (allow_check_digit_input) |
UpceOptions | För att använda UPC-E (allow_check_digit_input, number_system) |
RenderOptions | Visuell utgångskontroll (skala, DPI, färger, text) |
EncodeOptions | Bastyp för symbolspecifika kodningsalternativ |
BarcodeError | Basexception för barkodbiblioteket |