Hướng dẫn defining structure in python - xác định cấu trúc trong python
Mã nguồn: lib/struct.py Lib/struct.py Mô -đun này thực hiện chuyển đổi giữa các giá trị python và các cấu trúc C được biểu thị dưới dạng các đối tượng Python Ghi chú Theo mặc định, kết quả của việc đóng gói một cấu trúc C đã cho bao gồm các byte pad để duy trì sự liên kết thích hợp cho các loại C liên quan; Tương tự, căn chỉnh được tính đến khi giải nén. Hành vi này được chọn sao cho các byte của một cấu trúc được đóng gói tương ứng chính xác với bố cục trong bộ nhớ của cấu trúc c tương ứng. Để xử lý các định dạng dữ liệu độc lập với nền tảng hoặc bỏ qua các byte pad ngầm, hãy sử dụng kích thước và căn chỉnh Một số hàm Chức năng và ngoại lệMô -đun xác định ngoại lệ và chức năng sau: Ngoại lệ ________ 12 ________ 13¶Ngoại lệ được nâng lên trong các dịp khác nhau; Đối số là một chuỗi mô tả những gì sai. ________ 12 ________ 15 (Định dạng, V1, V2, ...)(format, v1, v2, ...)¶Trả về một đối tượng byte chứa các giá trị v1, v2, được đóng gói theo định dạng chuỗi định dạng. Các đối số phải khớp với các giá trị theo yêu cầu của định dạng chính xác. ________ 12 ________ 17 (Định dạng, bộ đệm, Offset, V1, V2, ...)(format, buffer, offset, v1, v2, ...)¶Đóng gói các giá trị v1, v2, theo định dạng chuỗi định dạng và ghi các byte được đóng gói vào bộ đệm bộ đệm có thể ghi bắt đầu ở độ lệch vị trí. Lưu ý rằng bù là một đối số bắt buộc. ________ 12 ________ 19 (Định dạng, bộ đệm) ¶(format, buffer)¶Giải nén từ bộ đệm bộ đệm (có lẽ được đóng gói bởi >>> pack('ci', b'*', 0x12131415) b'*\x00\x00\x00\x12\x13\x14\x15' >>> pack('ic', 0x12131415, b'*') b'\x12\x13\x14\x15*' >>> calcsize('ci') 8 >>> calcsize('ic') 50) theo định dạng chuỗi định dạng. Kết quả là một tuple ngay cả khi nó chứa chính xác một mục. Kích thước bộ đệm trong byte phải khớp với kích thước theo yêu cầu của định dạng, như được phản ánh bởi >>> pack('ci', b'*', 0x12131415) b'*\x00\x00\x00\x12\x13\x14\x15' >>> pack('ic', 0x12131415, b'*') b'\x12\x13\x14\x15*' >>> calcsize('ci') 8 >>> calcsize('ic') 51. ________ 12 ________ 23 (định dạng, /, bộ đệm, offset = 0) ¶(format, /, buffer, offset=0)¶ Giải nén từ bộ đệm bắt đầu ở vị trí bù, theo định dạng chuỗi định dạng. Kết quả là một tuple ngay cả khi nó chứa chính xác một mục. Kích thước bộ đệm trong byte, bắt đầu ở độ lệch vị trí, phải ít nhất là kích thước theo yêu cầu của định dạng, như được phản ánh bởi >>> pack('ci', b'*', 0x12131415) b'*\x00\x00\x00\x12\x13\x14\x15' >>> pack('ic', 0x12131415, b'*') b'\x12\x13\x14\x15*' >>> calcsize('ci') 8 >>> calcsize('ic') 51. ________ 12 ________ 26 (Định dạng, bộ đệm) ¶(format, buffer)¶ Lặp đi lặp lại từ bộ đệm bộ đệm theo định dạng chuỗi định dạng. Hàm này trả về một trình lặp sẽ đọc các khối có kích thước như nhau từ bộ đệm cho đến khi tất cả các nội dung của nó đã được tiêu thụ. Kích thước bộ đệm trong byte phải là bội số có kích thước theo định dạng, như được phản ánh bởi >>> pack('ci', b'*', 0x12131415) b'*\x00\x00\x00\x12\x13\x14\x15' >>> pack('ic', 0x12131415, b'*') b'\x12\x13\x14\x15*' >>> calcsize('ci') 8 >>> calcsize('ic') 51. Mỗi lần lặp lại mang lại một tuple như được chỉ định bởi chuỗi định dạng. Mới trong phiên bản 3.4. ________ 12 ________ 29 (Định dạng) ¶(format)¶Trả về kích thước của cấu trúc (và do đó của đối tượng byte được tạo bởi >>> pack('ci', b'*', 0x12131415) b'*\x00\x00\x00\x12\x13\x14\x15' >>> pack('ic', 0x12131415, b'*') b'\x12\x13\x14\x15*' >>> calcsize('ci') 8 >>> calcsize('ic') 50) tương ứng với định dạng chuỗi định dạng. Định dạng chuỗiChuỗi định dạng là cơ chế được sử dụng để chỉ định bố cục dự kiến khi đóng gói và giải nén dữ liệu. Chúng được xây dựng từ các ký tự định dạng, chỉ định loại dữ liệu được đóng gói/giải nén. Ngoài ra, có các ký tự đặc biệt để kiểm soát thứ tự byte, kích thước và căn chỉnh.Format Characters, which specify the type of data being packed/unpacked. In addition, there are special characters for controlling the Byte Order, Size, and Alignment. Thứ tự byte, kích thước và căn chỉnhTheo mặc định, các loại C được biểu diễn theo định dạng gốc của máy và thứ tự byte và được căn chỉnh đúng cách bằng cách bỏ qua byte byte nếu cần thiết (theo các quy tắc được sử dụng bởi trình biên dịch C). Ngoài ra, ký tự đầu tiên của chuỗi định dạng có thể được sử dụng để chỉ ra thứ tự byte, kích thước và sự liên kết của dữ liệu được đóng gói, theo bảng sau:
Mạng (= Big-Endian) Nếu nhân vật đầu tiên không phải là một trong số này, >>> pack('llh0l', 1, 2, 3) b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'6 được giả định. Kích thước và căn chỉnh gốc được xác định bằng cách sử dụng biểu thức trình biên dịch C ____ ____38. Điều này luôn được kết hợp với thứ tự byte bản địa. Kích thước tiêu chuẩn chỉ phụ thuộc vào ký tự định dạng; Xem bảng trong phần Định dạng ký tự.Format Characters section. Lưu ý sự khác biệt giữa >>> pack('llh0l', 1, 2, 3) b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'6 và bytes 0: Cả hai đều sử dụng thứ tự byte gốc, nhưng kích thước và sự liên kết của cái sau được tiêu chuẩn hóa.Mẫu Không có cách nào để chỉ ra thứ tự byte không bản địa (hoán đổi byte); Sử dụng lựa chọn thích hợp của Notes:
Định dạng ký tự lorCác ký tự định dạng có nghĩa sau; Việc chuyển đổi giữa các giá trị C và Python nên rõ ràng với các loại của chúng. Cột kích thước tiêu chuẩn, đề cập đến kích thước của giá trị đóng gói tính bằng byte khi sử dụng kích thước tiêu chuẩn; Đó là, khi chuỗi định dạng bắt đầu bằng một trong
(1), (2)Added support for the Char không dấuAdded support for the Notes:
Đã thay đổi trong phiên bản 3.3: Đã thêm hỗ trợ cho các định dạng Đã thay đổi trong phiên bản 3.6: Đã thêm hỗ trợ cho định dạng Mã chuyển đổi Khi đóng gói một giá trị >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)00, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)01, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)02, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)03, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)04, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)05, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)06, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)07, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)08, >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)09), nếu ____. Đã thay đổi trong phiên bản 3.1: Trước đây, một số định dạng số nguyên đã kết thúc các giá trị ngoài phạm vi và tăng >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)12 instead of >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)11. Ký tự định dạng >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)14 mã hóa một chuỗi pascal pascal, có nghĩa là một chuỗi có độ dài thay đổi ngắn được lưu trữ trong một số byte cố định, được đưa ra bởi số đếm. Byte đầu tiên được lưu trữ là chiều dài của chuỗi, hoặc 255, tùy theo mức nào nhỏ hơn. Các byte của chuỗi theo sau. Nếu chuỗi được truyền vào >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)15 quá dài (dài hơn số đếm trừ 1), chỉ có các byte >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)16 hàng đầu của chuỗi được lưu trữ. Nếu chuỗi ngắn hơn >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)16, nó được đệm bằng các byte null để sử dụng chính xác các byte trong tất cả. Lưu ý rằng đối với >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)18, ký tự định dạng >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)14 tiêu thụ >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)20 byte, nhưng chuỗi được trả về không bao giờ có thể chứa nhiều hơn 255 byte. Đối với ký tự định dạng >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)22 hoặc >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)23. Khi đóng gói, giá trị sự thật của đối tượng đối số được sử dụng. 0 hoặc 1 trong biểu diễn BOOL gốc hoặc tiêu chuẩn sẽ được đóng gói và bất kỳ giá trị khác không nào sẽ là >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)22 khi giải nén. Ví dụ;Ghi chú Tất cả các ví dụ giả định một thứ tự byte gốc, kích thước và sự liên kết với một máy lớn. Một ví dụ cơ bản về đóng gói/giải nén ba số nguyên: >>> from struct import * >>> pack('hhl', 1, 2, 3) b'\x00\x01\x00\x02\x00\x00\x00\x03' >>> unpack('hhl', b'\x00\x01\x00\x02\x00\x00\x00\x03') (1, 2, 3) >>> calcsize('hhl') 8 Các trường được giải nén có thể được đặt tên bằng cách gán chúng cho các biến hoặc bằng cách gói kết quả trong một bộ tuple có tên: >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8) Đặt hàng các ký tự định dạng có thể có tác động đến kích thước vì phần đệm cần thiết để đáp ứng các yêu cầu liên kết là khác nhau: >>> pack('ci', b'*', 0x12131415) b'*\x00\x00\x00\x12\x13\x14\x15' >>> pack('ic', 0x12131415, b'*') b'\x12\x13\x14\x15*' >>> calcsize('ci') 8 >>> calcsize('ic') 5 Định dạng sau >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)25 chỉ định hai byte pad ở cuối, giả sử các độ dài được căn chỉnh trên các ranh giới 4 byte: >>> pack('llh0l', 1, 2, 3) b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00' Điều này chỉ hoạt động khi kích thước và căn chỉnh gốc có hiệu lực; Kích thước và căn chỉnh tiêu chuẩn không thực thi bất kỳ sự liên kết nào. Xem thêm Mô -đun>>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)26 Lưu trữ nhị phân đóng gói của dữ liệu đồng nhất. Mô -đun>>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)27 Đóng gói và giải nén dữ liệu XDR. Các lớp học¶Mô -đun Trả về một đối tượng cấu trúc mới ghi và đọc dữ liệu nhị phân theo định dạng chuỗi định dạng. Tạo một đối tượng struct một lần và gọi các phương thức của nó hiệu quả hơn so với việc gọi các hàm Ghi chú Tất cả các ví dụ giả định một thứ tự byte gốc, kích thước và sự liên kết với một máy lớn. Một ví dụ cơ bản về đóng gói/giải nén ba số nguyên: Các trường được giải nén có thể được đặt tên bằng cách gán chúng cho các biến hoặc bằng cách gói kết quả trong một bộ tuple có tên:(v1, v2, ...)¶Đặt hàng các ký tự định dạng có thể có tác động đến kích thước vì phần đệm cần thiết để đáp ứng các yêu cầu liên kết là khác nhau: Định dạng sau>>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)25 chỉ định hai byte pad ở cuối, giả sử các độ dài được căn chỉnh trên các ranh giới 4 byte:(buffer, offset, v1, v2, ...)¶ Điều này chỉ hoạt động khi kích thước và căn chỉnh gốc có hiệu lực; Kích thước và căn chỉnh tiêu chuẩn không thực thi bất kỳ sự liên kết nào. Xem thêm(buffer)¶Mô -đun >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)26Lưu trữ nhị phân đóng gói của dữ liệu đồng nhất.(buffer, offset=0)¶ Mô -đun >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)27Đóng gói và giải nén dữ liệu XDR.(buffer)¶ Các lớp học¶ Mô -đun Trả về một đối tượng cấu trúc mới ghi và đọc dữ liệu nhị phân theo định dạng chuỗi định dạng. Tạo một đối tượng struct một lần và gọi các phương thức của nó hiệu quả hơn so với việc gọi các hàm Các phiên bản được biên dịch của các chuỗi định dạng gần đây nhất được chuyển đến >>> record = b'raymond \x32\x12\x08\x01\x08' >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record) >>> from collections import namedtuple >>> Student = namedtuple('Student', 'name serialnum school gradelevel') >>> Student._make(unpack('<10sHHb', record)) Student(name=b'raymond ', serialnum=4658, school=264, gradelevel=8)50 instead of bytes .Các đối tượng cấu trúc được biên dịch hỗ trợ các phương thức và thuộc tính sau:________ 15 (v1, v2, ...) |