Library Improvements #2
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added several new features to the library including a new `BytesView` class; updated the documentation, added unit tests for all of the data types; and fixed a few issues: * Added support for creating `Bytes` values from `bytes` values. * Added a new `BytesView` class for iterating over `bytes` and `bytearray` objects with the ability to access the data as arbitrarily sized groups of bytes as well as being able to cast bytes to specific data types. * Added `Float`, `Float16`, `Float32` and `Float64` types, as well as `Double` (an alias for `Float64`). * Added `Size`, `SingedSize` and `UnsignedSize` integer subtypes which have a maximum size dependent upon the system they are running on. * Added `Unicode`, `UTF8`, `UTF16`, `UTF32`, `ASCII` types to compliment the `String` type; these string variants hold strings with different default character encodings. * Added `Type` superclass as a parent of all of the type subclasses which makes type comparison and class hierarchy membership easier to discern and allows shared behaviour to be centrally defined and maintained. * The `Short` type was previously unsigned and is now signed as per the C standard following the Python convention; the `Short` type was previously based on embedded metadata standards, which treat `short` as unsigned and defined a separate `signed short`. * The `Long` type was previously unsigned and is now signed as per the C standard following the Python convention; the `Long` type was previously based on embedded metadata standards, which treat `long` as unsigned and defined a separate `signed long`. * The `LongLong` type was previously unsigned and is now signed as per the C standard following the Python convention; the `LongLong` type was previously based on embedded metadata standards, which treat `long long` as unsigned and defined a separate `signed long long`. * A new `UnsignedShort` type has been added to compliment the signed `Short` type and pairs with the `SignedShort` type which is functionally equivalent to `Short`. * A new `UnsignedLong` type has been added to compliment signed `Long` type and pairs with the `SignedLong` type which is functionally equivalent to `Long`. * A new `UnsignedLongLong` type has been added to compliment signed `LongLong` type and pairs with the `SignedLongLong` type which is functionally equivalent to `LongLong`.
Fixed Python 3.13’s breaking change related to dropped support for combining the `@classmethod` and `@property` decorators to create class properties; this was supported between at least Python versions 3.9 and 3.12. Backwards compatible support that works on Python versions 3.9+ has been introduced via the new `@classproperty` decorator from the `classicist` library.
Add input validation for the `.encode()` methods, and additional unit testing for the `UnsignedLong` type. Added a new `utilities` sub-module containing the `hexbytes` helper method that can be used to format raw `bytes` or `bytearray` values into hexadecimal encoded strings for review, and the `print_hexbytes` helper method that can be used to print such strings. Changed type casting of the decoded return value for the `Bytes` class when reversed back to a `bytes` type, fixing a previous issue where the reversed return type was a `list` type. The `BytesView` class `split` length can now be equal to the length of the provided `data` value, previously the `split` length had to be less than the length of the `data` value. The type hints for the `BytesView` class' `__iter__` and `__next__` methods have been corrected from `bytesview` to `BytesView`, and `bytes` to `bytearray` respectively.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added input validation for the
.encode()methods, and additional unit testing for theUnsignedLongtype.Added a new
utilitiessub-module containing thehexbyteshelper method that can be used to format rawbytesorbytearrayvalues into hexadecimal encoded strings for review, and theprint_hexbyteshelper method that can be used to print such strings.Changed type casting of the decoded return value for the
Bytesclass when reversed back to abytestype, fixing a previous issue where the reversed return type was alisttype.The
BytesViewclasssplitlength can now be equal to the length of the provideddatavalue, previously thesplitlength had to be less than the length of thedatavalue.The type hints for the
BytesViewclass'__iter__and__next__methods have been corrected frombytesviewtoBytesView, andbytestobytearrayrespectively.