Adjusts module imports and __all__ for byteclasses for easier access …

…to types.

README.md

@@ -60,8 +60,7 @@ The `ByteArray` and `String` collections can be instantiated directly using the
 ## Simple Byteclass Structure Example
 
 ```python
-from byteclasses.types.collections import structure
-from byteclasses.types.primitives.integer import UInt8, UInt32
+from byteclasses.types import structure, UInt8, UInt32
 
 @structure
 class MyStruct:

byteclasses/handlers/executables/elf/elf_hdr.py

@@ -6,10 +6,7 @@
 
 from enum import IntEnum
 
-from ....types.collections import String, member, structure
-from ....types.primitives.byte_enum import ByteEnum
-from ....types.primitives.generics import BitField
-from ....types.primitives.integers import Ptr32, Ptr64, UInt16, UInt32
+from ....types import BitField, ByteEnum, Ptr32, Ptr64, String, UInt16, UInt32, member, structure
 
 __all__ = [
     "ElfHdr32",

byteclasses/handlers/executables/elf/phdr.py

@@ -6,10 +6,7 @@
 
 from enum import IntEnum
 
-from ....types.collections import member, structure
-from ....types.primitives.byte_enum import ByteEnum
-from ....types.primitives.generics import BitField32, BitPos
-from ....types.primitives.integers import Ptr32, Ptr64, UInt32, UInt64
+from ....types import BitField32, BitPos, ByteEnum, Ptr32, Ptr64, UInt32, UInt64, member, structure
 
 __all__ = [
     "PHdr32",

byteclasses/handlers/executables/elf/shdr.py

@@ -6,10 +6,7 @@
 
 from enum import IntEnum
 
-from ....types.collections import member, structure
-from ....types.primitives.byte_enum import ByteEnum
-from ....types.primitives.generics import BitField32, BitPos
-from ....types.primitives.integers import Ptr32, Ptr64, UInt32, UInt64
+from ....types import BitField32, BitPos, ByteEnum, Ptr32, Ptr64, UInt32, UInt64, member, structure
 
 __all__ = [
     "SHdr32",

byteclasses/handlers/executables/mach/mach_hdr.py

@@ -6,10 +6,7 @@
 
 from enum import IntEnum
 
-from ....types.collections import structure
-from ....types.primitives.bitfield import BitField32, mask2bitpos
-from ....types.primitives.generics import DWord
-from ....types.primitives.integers import Int32, UInt32
+from ....types import BitField32, DWord, Int32, UInt32, mask2bitpos, structure
 
 __all__ = [
     "MachFlags32",

byteclasses/handlers/executables/mach/section.py

@@ -3,9 +3,7 @@
 [llvm::MachO Namespace Reference](https://llvm.org/doxygen/namespacellvm_1_1MachO.html)
 """
 
-from ....types.collections import String, member, structure
-from ....types.primitives.generics import BitField32
-from ....types.primitives.integers import Ptr32, Ptr64, UInt32, UInt64
+from ....types import BitField32, Ptr32, Ptr64, String, UInt32, UInt64, member, structure
 
 __all__ = [
     "Section32",

byteclasses/handlers/executables/mach/seg_cmd.py

@@ -1,8 +1,6 @@
 """Mach-O Segment Command Module."""
 
-from ....types.collections import String, member, structure
-from ....types.primitives.generics import BitField32
-from ....types.primitives.integers import Int32, Ptr32, Ptr64, UInt32, UInt64
+from ....types import BitField32, Int32, Ptr32, Ptr64, String, UInt32, UInt64, member, structure
 
 __all__ = [
     "SegCmd32",

byteclasses/handlers/executables/mach/uuid_cmd.py

@@ -4,8 +4,7 @@
 [llvm::MachO Namespace Reference](https://llvm.org/doxygen/namespacellvm_1_1MachO.html)
 """
 
-from ....types.collections import ByteArray, member, structure
-from ....types.primitives.integers import Ptr32, UInt32
+from ....types import ByteArray, Ptr32, UInt32, member, structure
 
 __all__ = ["UUIDCmd"]
 

byteclasses/handlers/network/ipv4_hdr.py

@@ -1,7 +1,7 @@
 """IPv4 Header class implemented with byteclasses."""
 
 from byteclasses.types.collections import ByteArray, member, structure, union
-from byteclasses.types.primitives.generics import BitField, BitPos
+from byteclasses.types.primitives.bitfield import BitField, BitPos
 from byteclasses.types.primitives.integers import UInt8, UInt16, UInt32
 
 

byteclasses/handlers/network/ipv6_hdr.py

@@ -1,7 +1,7 @@
 """IPv6 Header class implemented with byteclasses."""
 
 from byteclasses.types.collections import ByteArray, member, structure, union
-from byteclasses.types.primitives.generics import BitField, BitPos
+from byteclasses.types.primitives.bitfield import BitField, BitPos
 from byteclasses.types.primitives.integers import UInt8, UInt16, UInt32, UInt64
 
 

byteclasses/handlers/network/tcp_hdr.py

@@ -1,16 +1,14 @@
 """TCP Header implemented with byteclasses."""
 
-from byteclasses.types.collections import structure
-from byteclasses.types.primitives.generics import BitField, BitPos
-from byteclasses.types.primitives.integers import UInt16, UInt32
+from ...types import BitField, BitPos, UInt16, UInt32, structure
 
 
 class OffFlag(BitField):
     """Offset and Flag BitField."""
 
     byte_length = 2
     data_offset = BitPos(0, bit_width=4)
-    flags = BitPos(4, bit_width=12)
+    tcp_flags = BitPos(4, bit_width=12)
 
 
 @structure(byte_order=b"!", packed=True)

byteclasses/types/__init__.py

@@ -1,5 +1,85 @@
-"""Byteclasses Types Module."""
+"""Byteclass Types Package."""
 
-from .primitives import floats, integers
+# pylint: disable=R0801
+from .collections import ByteArray, ByteclassCollection, String, make_fixed_collection, member, structure, union
+from .primitives.bitfield import BitField, BitField16, BitField32, BitField64, BitPos, bitpos2mask, mask2bitpos
+from .primitives.byte_enum import ByteEnum
+from .primitives.byteclass_primitive_protocol import ByteclassPrimitive
+from .primitives.characters import Char, SChar, UChar
+from .primitives.floats import Double, Float, Float16, Float32, Float64, Half
+from .primitives.generics import Bit, Byte, DWord, QWord, Word
+from .primitives.integers import (
+    Int,
+    Int8,
+    Int16,
+    Int32,
+    Int64,
+    Long,
+    LongLong,
+    Ptr16,
+    Ptr32,
+    Ptr64,
+    Short,
+    UInt,
+    UInt8,
+    UInt16,
+    UInt32,
+    UInt64,
+    ULong,
+    ULongLong,
+    UnderflowError,
+    UShort,
+)
 
-__all__ = ["floats", "integers"]
+__all__ = [
+    "Bit",
+    "BitField",
+    "BitField16",
+    "BitField32",
+    "BitField64",
+    "BitPos",
+    "bitpos2mask",
+    "Byte",
+    "ByteArray",
+    "ByteclassCollection",
+    "ByteclassPrimitive",
+    "ByteEnum",
+    "Char",
+    "Double",
+    "DWord",
+    "Float16",
+    "Float32",
+    "Float",
+    "Float64",
+    "Half",
+    "Int",
+    "Int8",
+    "Int16",
+    "Int32",
+    "Int64",
+    "Long",
+    "LongLong",
+    "make_fixed_collection",
+    "mask2bitpos",
+    "member",
+    "Ptr16",
+    "Ptr32",
+    "Ptr64",
+    "QWord",
+    "SChar",
+    "Short",
+    "String",
+    "structure",
+    "UChar",
+    "UInt",
+    "UInt8",
+    "UInt16",
+    "UInt32",
+    "UInt64",
+    "ULong",
+    "ULongLong",
+    "UnderflowError",
+    "union",
+    "UShort",
+    "Word",
+]

byteclasses/types/primitives/__init__.py

@@ -1,5 +1,75 @@
-"""Fixed length types for binary data."""
+"""Primitive Byteclasses Package."""
 
-from . import floats, integers
+# pylint: disable=R0801
+from .bitfield import BitField, BitField16, BitField32, BitField64, BitPos
+from .byte_enum import ByteEnum
+from .byteclass_primitive_protocol import ByteclassPrimitive
+from .characters import Char, SChar, UChar
+from .floats import Double, Float, Float16, Float32, Float64, Half
+from .generics import Bit, Byte, DWord, QWord, Word
+from .integers import (
+    Int,
+    Int8,
+    Int16,
+    Int32,
+    Int64,
+    Long,
+    LongLong,
+    Ptr16,
+    Ptr32,
+    Ptr64,
+    Short,
+    UInt,
+    UInt8,
+    UInt16,
+    UInt32,
+    UInt64,
+    ULong,
+    ULongLong,
+    UnderflowError,
+    UShort,
+)
 
-__all__ = ["floats", "generics", "integers"]
+__all__ = [
+    "Bit",
+    "BitField",
+    "BitField16",
+    "BitField32",
+    "BitField64",
+    "BitPos",
+    "Byte",
+    "ByteclassPrimitive",
+    "ByteEnum",
+    "Char",
+    "Double",
+    "DWord",
+    "Float16",
+    "Float32",
+    "Float",
+    "Float64",
+    "Half",
+    "Int",
+    "Int8",
+    "Int16",
+    "Int32",
+    "Int64",
+    "Long",
+    "LongLong",
+    "Ptr16",
+    "Ptr32",
+    "Ptr64",
+    "QWord",
+    "SChar",
+    "Short",
+    "UChar",
+    "UInt",
+    "UInt8",
+    "UInt16",
+    "UInt32",
+    "UInt64",
+    "ULong",
+    "ULongLong",
+    "UnderflowError",
+    "UShort",
+    "Word",
+]

byteclasses/types/primitives/bitfield.py

@@ -1,4 +1,4 @@
-"""BitField Fixed Length Class."""
+"""Primitive Byteclass BitField Type Module."""
 
 from collections.abc import ByteString, Iterable, Sequence
 from struct import calcsize

byteclasses/types/primitives/byte_enum.py

@@ -1,4 +1,4 @@
-"""A fixed size enum class."""
+"""Primitive Byteclass ByteEnum Type Module."""
 
 from collections.abc import ByteString
 from enum import Enum, IntEnum

byteclasses/types/primitives/characters.py

@@ -1,4 +1,4 @@
-"""Fixed Size Character Primitives."""
+"""Primitive Byteclass Character Types Module."""
 
 from struct import calcsize
 

byteclasses/types/primitives/floats.py

@@ -1,4 +1,4 @@
-"""Fixed length floating point types."""
+"""Primitive Byteclass Float Types Module."""
 
 from collections.abc import ByteString
 from struct import calcsize

byteclasses/types/primitives/generics.py

@@ -1,23 +1,17 @@
-"""Fixed Size Integer Types."""
+"""Primitive Byteclass Generic Types Module."""
 
 from enum import IntEnum
 from struct import calcsize
 
 from ..._enums import TypeChar
 from ...types.primitives._primitive import _Primitive
-from .bitfield import BitField, BitField16, BitField32, BitField64, BitPos
 
 __all__ = [
     "Bit",
     "Byte",
     "DWord",
     "QWord",
     "Word",
-    "BitField",
-    "BitField16",
-    "BitField32",
-    "BitField64",
-    "BitPos",
 ]