คุณสมบัติและฟังก์ชั่น
คุณสมบัติและฟังก์ชั่น
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.
สัญลักษณ์ที่สนับสนุน
ห้องสมุดรองรับสัญลักษณ์ 7 ช่องทางผ่านการใช้งานผู้ช่วยที่มอบหมายและแบบทั่วไป generate() จุดเข้า:
| Symbology | Type | Helper | ประเภทของตัวเลือก |
|---|---|---|---|
| รหัส 128 | 1D | code128() | Code128Options |
| รหัส 39 | 1D | code39() | Code39Options |
| EAN-13 | 1D | ean13() | Ean13Options |
| EAN-8 | 1D | ean8() | Ean8Options |
| รหัส QR | 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 รูปแบบการรหัส
Code128Options การควบคุมที่รหัส 128 ตัวอักษรตั้งตัว Encoder ใช้. encode_mode อสังหาริมทรัพย์ยอมรับการ Code128EncodeMode enum value: ค่าที่ใช้ในการทําการ:
AUTOเลือกการโค๊ดที่สั้นที่สุดโดยอัตโนมัติCODE_A,CODE_B,CODE_CจํากัดตัวอักษรเดียวCODE_AB,CODE_AC,CODE_BCให้การเปลี่ยนระหว่างสองชุดตัวอักษร
from aspose_barcode_foss import Code128Options, Code128EncodeMode
bc = barcode.code128(
"1234567890",
encode=Code128Options(encode_mode=Code128EncodeMode.CODE_C),
)รหัส 39 การรหัวกระบุ
Code39Options การควบคุมว่าตัวโค้ดจะใช้เซตหลัก 43 ตัวอักษรหรือการขยาย Full ASCII หรือไม่:
full_asciiตั้งเป็นTrueเพื่อรหัสระดับ ASCII 128 ตัวเต็ม โดยใช้คู่ shiftadd_check_digitติดหมายเลขตรวจสอบ Modulo-43
from aspose_barcode_foss import Code39Options
bc = barcode.code39(
"Hello",
encode=Code39Options(full_ascii=True, add_check_digit=True),
)การตั้งค่า QR Code
QrOptions ให้การตั้งค่ามากที่สุดในหมู่ทั้งหมดของสัญลักษณ์:
| Property | Type | Values |
|---|---|---|
error_correction_level | QrErrorCorrectionLevel | L (7%), M (15%), Q (25%), H (30%) |
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 และ UPC เลขตรวจสอบ
Ean13Options, Ean8Options, UpcaOptions,และ UpceOptions แต่ละคนมีตัวเลข allow_check_digit_input property โดยตั้งค่าล่วงหน้า ห้องสมุดคํานวณตัวเลขเช็คโดยอัตโนมัติ. Set allow_check_digit_input=True ถ้าข้อมูลของคุณมีมันอยู่อยู่แล้ว.
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),
)การทําการควบคุม
RenderOptions ใช้กับสัญลักษณ์ทั้งหมด และควบคุมผลิตทางสายตา to_svg() หรือ to_png():
| Property | Type | Description |
|---|---|---|
scale | float | เครื่องคูณขนาดแบบเดียวกัน |
dpi | int | ความละเอียดสําหรับการออก PNG |
module_width | float | ความกว้างของโมดูล barcode หนึ่ง |
module_height | float | ความสูงของโมดูล barcode หนึ่ง |
quiet_zone | float | การปรับพื้นที่ขาวรอบบาร์โค้ด |
foreground_color | str | สี Hex สําหรับบาร์ (เช่น., "#000000") |
background_color | str | สี Hex สําหรับพื้นหลัง |
transparent_background | bool | แฟนที่โปร่งใสสําหรับ PNG |
show_text | bool | แสดงข้อความที่อ่านได้ภายใต้บาร์โค้ด |
font_family | str | แฟนต์สําหรับข้อความที่สามารถอ่านได้โดยมนุษย์ |
font_size | float | ขนาดตัวอักษรสําหรับข้อความที่สามารถอ่านได้โดยมนุษย์ |
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,
))รูปแบบการออกผลิต
| Format | Method | ประเภทการคืน |
|---|---|---|
| SVG | to_svg() | str |
| PNG | to_png() | bytes |
ทั้งสองวิธีรับการเลือก RenderOptions ปารามีเตอร์.
การจัดการข้อผิดพลาด
การตรวจสอบการใช้งานตัวเลือกโค้ดทั้งหมดจะเกิดขึ้นในเวลาพาร์ส. ห้องสมุดจะยกเว้นเฉพาะที่ถูกตีไว้ก่อนที่จะเริ่มต้นการโค๊ด:
| Exception | เมื่อ ถูก สร้าง ขึ้น |
|---|---|
InvalidInputError | ข้อมูลมีตัวอักษรที่ไม่สนับสนุนโดยสัญลักษณ์ |
EncodingError | การรหัสล้มเหลว (เช่น ข้อมูลเกินความจุ) |
SymbologyNotFoundError | ชื่อสัญลักษณ์ที่ไม่รับรู้เปลี่ยนไปเป็น generate() |
UnsupportedCapabilityError | คุณสมบัติที่ต้องการไม่พร้อมสําหรับสัญลักษณ์นี้ |
ทุกคลาสความพิเศษได้รับมรดกจาก BarcodeError.
from aspose_barcode_foss import InvalidInputError
try:
bc = barcode.ean13("ABC")
except InvalidInputError as e:
print(f"Invalid input: {e}")การตรวจสอบการเข้า
ทุกปัญลักษณ์มีตัวเลขที่มอบไว้ให้กับเรา InputParser ที่ตรวจสอบข้อมูลก่อนการรหัส การพาร์เซอร์เช็คความต้องการของตัวอักษร ความยาวและรูปแบบที่เฉพาะสําหรับสัญลักษณ์แต่ละตัว. Code128InputParser, Code39InputParser, Ean13InputParser, Ean8InputParser, QrInputParser, UpcaInputParser,และ UpceInputParser ใช้ภายในโดยหน้าที่ช่วยของแต่ละตัว.
barcode object วัตถุบาร์โค้ด
การ Barcode object ที่กลับโดยฟังก์ชันผู้ช่วยทั้งหมด ให้:
to_svg(options)การทําตัวเป็น SVG สตริงto_png(options)การทําตัวเป็น PNG byterender(renderer, options)การทําการแสดงโดยใช้แบบเฉพาะเจาะจงRendererการดําเนินงานsymbolสาขาEncodedSymbolซึ่งมีเมทริกซ์โมดูลและ เมตาเดต้าprofileสาขาSymbologyProfileด้วยการกําหนดและความสามารถ
คําอธิบายการพบบ่อย API
| Class | Description |
|---|---|
Barcode | อัตถุบาร์โค้ดสาธารณะที่มี to_svg() และ to_png() |
Code128Options | ตัวเลือกการรหัสสําหรับโค้ด 128 (encode_mode) |
Code39Options | ตัวเลือกการรหัสสําหรับโค้ด 39 (full_ascii, add_check_digit) |
QrOptions | ตัวเลือกการรหัส QR Code (error_correction_level, encoding_mode, version, mask) |
Ean13Options | ตัวเลือกการรหัสสําหรับ EAN-13 (allow_check_digit_input) |
Ean8Options | ตัวเลือกการรหัสสําหรับ EAN-8 (allow_check_digit_input) |
UpcaOptions | ตัวเลือกการรหัสสําหรับ UPC-A (allow_check_digit_input) |
UpceOptions | ตัวเลือกการรหัส UPC-E (allow_check_digit_input, number_system) |
RenderOptions | การควบคุมการออกแบบทางวิวชู (ขนาด, DPI, สี, กลอน) |
EncodeOptions | ประเภทฐานสําหรับตัวเลือกการรหัสเฉพาะทางสัญลักษณ์ |
BarcodeError | พื้นฐานความพิเศษสําหรับห้องสมุดบาร์โค้ด |