codespell

Author: andreax79

Makefile

@@ -12,6 +12,10 @@ help:
 	@echo - make typecheck -- Typecheck
 	@echo - make venv ------- Create virtual environment
 
+.PHONY: isort
+codespell:
+	@codespell -w cstruct tests examples setup.py
+
 .PHONY: isort
 isort:
 	@isort --profile black cstruct tests examples setup.py
@@ -46,6 +50,6 @@ typecheck:
 	mypy --strict --no-warn-unused-ignores cstruct
 
 venv:
-	python3 -m virtualenv .
+	python3 -m venv . || python3 -m virtualenv .
 	. bin/activate; pip install -Ur requirements.txt
 	. bin/activate; pip install -Ur requirements-dev.txt

cstruct/abstract.py

@@ -80,13 +80,13 @@ class AbstractCStruct(metaclass=CStructMeta):
     __size__: int = 0
     " Size in bytes "
     __fields__: List[str] = []
-    " Struct/union fileds "
+    " Struct/union fields "
     __fields_types__: Dict[str, FieldType]
     " Dictionary mapping field names to types "
     __byte_order__: Optional[str] = None
     " Byte order "
     __alignment__: int = 0
-    " Alignament "
+    " Alignment "
     __is_union__: bool = False
     " True if the class is an union, False if it is a struct "
 
@@ -125,7 +125,7 @@ def parse(
             __is_union__:   True for union, False for struct
 
         Returns:
-            cls: a new class mapping the defintion
+            cls: a new class mapping the definition
         """
         cls_kargs: Dict[str, Any] = dict(kargs)
         if __byte_order__ is not None:

cstruct/c_parser.py

@@ -436,7 +436,7 @@ def parse_struct(
             for nested_field_name, nested_field_type in field_type.ref.__fields_types__.items():
                 if nested_field_name in fields_types:
                     raise ParserError(f"Duplicate member `{nested_field_name}`")
-                # set the corret offset
+                # set the correct offset
                 nested_field_type = nested_field_type.copy()
                 nested_field_type.base_offset = offset + nested_field_type.base_offset
                 nested_field_type.offset = offset + nested_field_type.offset

cstruct/cstruct.py

@@ -48,7 +48,7 @@ def unpack_from(self, buffer: Optional[bytes], offset: int = 0, flexible_array_l
         Args:
             buffer: bytes to be unpacked
             offset: optional buffer offset
-            flexible_array_length: optional flexible array lenght (number of elements)
+            flexible_array_length: optional flexible array length (number of elements)
         """
         self.set_flexible_array_length(flexible_array_length)
         if buffer is None:

cstruct/field.py

@@ -192,7 +192,7 @@ def native_format(self) -> str:
             try:
                 return get_native_type(self.c_type).native_format
             except KeyError:
-                raise ParserError(f"Unknow type `{self.c_type}`")
+                raise ParserError(f"Unknown type `{self.c_type}`")
         elif self.is_enum:
             return self.ref.__native_format__
         else:

cstruct/mem_cstruct.py

@@ -66,7 +66,7 @@ def unpack_from(self, buffer: Optional[bytes], offset: int = 0, flexible_array_l
         Args:
             buffer: bytes to be unpacked
             offset: optional buffer offset
-            flexible_array_length: optional flexible array lenght (number of elements)
+            flexible_array_length: optional flexible array length (number of elements)
         """
         self.set_flexible_array_length(flexible_array_length)
         self.__base__ = offset  # Base offset

requirements-dev.txt

@@ -1,5 +1,6 @@
 black
 build
+codespell
 coverage[toml]
 flake8
 isort