isort

Author: andreax79

Makefile

@@ -2,6 +2,7 @@ SHELL=/bin/bash -e
 
 help:
 	@echo - make black ------ Format code
+	@echo - make isort ------ Sort imports
 	@echo - make clean ------ Clean virtual environment
 	@echo - make coverage --- Run tests coverage
 	@echo - make docs ------- Make docs
@@ -11,8 +12,13 @@ help:
 	@echo - make typecheck -- Typecheck
 	@echo - make venv ------- Create virtual environment
 
-black:
-	black -S cstruct tests examples setup.py
+.PHONY: isort
+isort:
+	@isort --profile black cstruct tests examples setup.py
+
+.PHONY: black
+black: isort
+	@black -S cstruct tests examples setup.py
 
 clean:
 	-rm -rf build dist

README.md

@@ -8,6 +8,7 @@ C-style structs for Python
 [![PyPI](https://img.shields.io/pypi/pyversions/cstruct.svg)](https://pypi.org/project/cstruct)
 [![Downloads](https://pepy.tech/badge/cstruct/month)](https://pepy.tech/project/cstruct)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 [![Known Vulnerabilities](https://snyk.io/test/github/andreax79/python-cstruct/badge.svg)](https://snyk.io/test/github/andreax79/python-cstruct)
 [![Documentation](https://readthedocs.org/projects/python-cstruct/badge/?version=latest)](https://python-cstruct.readthedocs.io/en/latest/)
 

cstruct/__init__.py

@@ -28,21 +28,22 @@
 __date__ = "15 August 2013"
 
 from typing import Any, Dict, Optional, Type, Union
+
+from .abstract import AbstractCEnum, AbstractCStruct, CStructMeta
 from .base import (
-    LITTLE_ENDIAN,
     BIG_ENDIAN,
+    CHAR_ZERO,
+    DEFINES,
+    ENUMS,
+    LITTLE_ENDIAN,
     NATIVE_ORDER,
     STRUCTS,
-    ENUMS,
-    DEFINES,
     TYPEDEFS,
-    CHAR_ZERO,
 )
-from .abstract import CStructMeta, AbstractCStruct, AbstractCEnum
-from .cstruct import CStruct
 from .c_parser import parse_struct_def
-from .mem_cstruct import MemCStruct
 from .cenum import CEnum
+from .cstruct import CStruct
+from .mem_cstruct import MemCStruct
 from .native_types import get_native_type
 
 __all__ = [

cstruct/abstract.py

@@ -24,18 +24,19 @@
 # IN THE SOFTWARE.
 #
 
+import hashlib
+import struct
 from abc import ABCMeta
 from collections import OrderedDict
-from typing import Any, BinaryIO, List, Dict, Optional, Type, Tuple, Union
-import hashlib
+from enum import EnumMeta, IntEnum, _EnumDict
 from io import StringIO
-from enum import IntEnum, EnumMeta, _EnumDict
-import struct
-from .base import STRUCTS, ENUMS, DEFAULT_ENUM_SIZE, ENUM_SIZE_TO_C_TYPE
-from .c_parser import parse_struct, parse_struct_def, parse_enum_def, parse_enum, Tokens
-from .field import calculate_padding, FieldType
-from .native_types import get_native_type
+from typing import Any, BinaryIO, Dict, List, Optional, Tuple, Type, Union
+
+from .base import DEFAULT_ENUM_SIZE, ENUM_SIZE_TO_C_TYPE, ENUMS, STRUCTS
+from .c_parser import Tokens, parse_enum, parse_enum_def, parse_struct, parse_struct_def
 from .exceptions import CStructException, ParserError
+from .field import FieldType, calculate_padding
+from .native_types import get_native_type
 
 __all__ = ["CStructMeta", "AbstractCStruct", "CEnumMeta", "AbstractCEnum"]
 

cstruct/base.py

@@ -22,10 +22,10 @@
 # IN THE SOFTWARE.
 #
 
-from typing import Any, Dict, Type, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Dict, Type
 
 if TYPE_CHECKING:
-    from .abstract import AbstractCStruct, AbstractCEnum
+    from .abstract import AbstractCEnum, AbstractCStruct
 
 __all__ = [
     "LITTLE_ENDIAN",

cstruct/c_expr.py

@@ -24,7 +24,8 @@
 
 import ast
 import operator
-from typing import Any, Callable, Dict, Union, Type, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Callable, Dict, Type, Union
+
 from .base import DEFINES, STRUCTS
 from .exceptions import EvalError
 

cstruct/c_parser.py

@@ -24,15 +24,16 @@
 
 import re
 from collections import OrderedDict
-from typing import Union, Optional, Any, Dict, List, Type, TYPE_CHECKING
-from .base import DEFINES, ENUMS, TYPEDEFS, STRUCTS
-from .field import calculate_padding, Kind, FieldType
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
+
+from .base import DEFINES, ENUMS, STRUCTS, TYPEDEFS
 from .c_expr import c_eval
 from .exceptions import CStructException, ParserError
+from .field import FieldType, Kind, calculate_padding
 from .native_types import get_native_type
 
 if TYPE_CHECKING:
-    from .abstract import AbstractCStruct, AbstractCEnum
+    from .abstract import AbstractCEnum, AbstractCStruct
 
 __all__ = ["parse_struct", "parse_struct_def", "parse_enum_def", "Tokens"]
 

cstruct/cstruct.py

@@ -23,8 +23,9 @@
 #
 
 from typing import List, Optional
-from .base import CHAR_ZERO
+
 from .abstract import AbstractCStruct
+from .base import CHAR_ZERO
 
 
 class CStruct(AbstractCStruct):

cstruct/field.py

@@ -25,10 +25,11 @@
 import copy
 import struct
 from enum import Enum
-from typing import Optional, Any, List, Type, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, List, Optional, Type
+
 from .base import NATIVE_ORDER
-from .native_types import get_native_type
 from .exceptions import ParserError
+from .native_types import get_native_type
 
 if TYPE_CHECKING:
     from .abstract import AbstractCStruct

cstruct/mem_cstruct.py

@@ -22,9 +22,10 @@
 # IN THE SOFTWARE.
 #
 
-from typing import Any, List, Optional
 import ctypes
 import struct
+from typing import Any, List, Optional
+
 from .abstract import AbstractCStruct
 
 

cstruct/native_types.py

@@ -24,7 +24,7 @@
 
 import struct
 from abc import ABCMeta
-from typing import Any, Dict, Type, Tuple
+from typing import Any, Dict, Tuple, Type
 
 __all__ = [
     "get_native_type",

examples/dir.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python
-import cstruct
 import ctypes
 import sys
 
+import cstruct
+
 libc = ctypes.cdll.LoadLibrary("libc.so.6")
 # opendir
 libc.opendir.argtypes = [ctypes.c_char_p]

examples/fdisk.py

@@ -1,9 +1,10 @@
 #!/usr/bin/env python
 
-from pathlib import Path
 import argparse
-import cstruct
 import sys
+from pathlib import Path
+
+import cstruct
 
 UNITS = ['B', 'K', 'M', 'G', 'T']
 SECTOR_SIZE = 512

examples/flexible_array.py

@@ -1,9 +1,10 @@
 #!/usr/bin/env python
 
 import random
-from cstruct import MemCStruct
 from pathlib import Path
 
+from cstruct import MemCStruct
+
 
 class FlexArray(MemCStruct):
     __def__ = """

examples/who.py

@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 
-from cstruct import parse, getdef, MemCStruct, NATIVE_ORDER
-from pathlib import Path
 import argparse
 import sys
 import time
+from pathlib import Path
+
+from cstruct import NATIVE_ORDER, MemCStruct, getdef, parse
 
 DEFAULT_FILENAME = "/var/run/utmp"
 

pyproject.toml

@@ -10,3 +10,6 @@ source = ["cstruct"]
 
 [tool.coverage.report]
 exclude_lines = [ "# pragma: no cover", "if TYPE_CHECKING:" ]
+
+[tool.isort]
+profile = "black"

requirements-dev.txt

@@ -1,14 +1,15 @@
+black
+build
 coverage[toml]
-pytest-cov
 flake8
-mypy
-tox
-black
-twine<3.4
-pytest
+isort
+markdown_include
 mkdocs
-mkdocstrings[python]
 mkdocs-material
-markdown_include
-build
+mkdocstrings[python]
+mypy
+pytest
+pytest-cov
 setuptools>=65.5.1 # not directly required, pinned by Snyk to avoid a vulnerability
+tox
+twine<3.4

tests/test_alignment.py

@@ -26,7 +26,8 @@
 # *****************************************************************************
 
 import sys
-from cstruct import sizeof, typedef, define, CStruct, NATIVE_ORDER
+
+from cstruct import NATIVE_ORDER, CStruct, define, sizeof, typedef
 
 IS_64BITS = sys.maxsize > 2**32
 

tests/test_c_expr.py

@@ -25,7 +25,7 @@
 #
 # *****************************************************************************
 
-from cstruct import parse, getdef, define
+from cstruct import define, getdef, parse
 from cstruct.c_expr import c_eval
 
 

tests/test_cenum.py

@@ -1,7 +1,9 @@
+from enum import Enum
+
 import pytest
+
 import cstruct
 from cstruct import CEnum
-from enum import Enum
 
 
 class Dummy(CEnum):

tests/test_cstruct.py

@@ -25,12 +25,14 @@
 #
 # *****************************************************************************
 
-import pytest
-import cstruct
-from cstruct import sizeof, typedef
 import io
 import os
 from pathlib import Path
+
+import pytest
+
+import cstruct
+from cstruct import sizeof, typedef
 from cstruct.exceptions import ParserError
 
 MBR_DATA = (Path(__file__).parent.parent / "mbr").read_bytes()

tests/test_define.py

@@ -26,9 +26,11 @@
 # *****************************************************************************
 
 import sys
+
 import pytest
+
 import cstruct
-from cstruct import define, undef, sizeof, typedef
+from cstruct import define, sizeof, typedef, undef
 from cstruct.exceptions import ParserError
 
 IS_64BITS = sys.maxsize > 2**32

tests/test_get_type.py

@@ -26,6 +26,7 @@
 # *****************************************************************************
 
 import pytest
+
 import cstruct
 
 

tests/test_memcstruct.py

@@ -25,11 +25,13 @@
 #
 # *****************************************************************************
 
+import os
+from pathlib import Path
+
 import pytest
+
 import cstruct
 from cstruct import sizeof, typedef
-import os
-from pathlib import Path
 from cstruct.exceptions import ParserError
 
 MBR_DATA = (Path(__file__).parent.parent / "mbr").read_bytes()

tests/test_nested.py

@@ -26,11 +26,11 @@
 # *****************************************************************************
 
 import pytest
+
 import cstruct
 from cstruct import sizeof
 from cstruct.exceptions import ParserError
 
-
 INVALID_ANONYMOUS = """
     struct NestedStruct {
         struct {

tests/test_pickle.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 import pickle
+
 import cstruct
 
 

tests/test_typdef.py

@@ -25,7 +25,7 @@
 #
 # *****************************************************************************
 
-from cstruct import MemCStruct, NATIVE_ORDER
+from cstruct import NATIVE_ORDER, MemCStruct
 from cstruct.base import TYPEDEFS
 
 

tests/test_union.py

@@ -25,9 +25,10 @@
 #
 # *****************************************************************************
 
+import struct
+
 import cstruct
 from cstruct import sizeof
-import struct
 
 
 class Position(cstruct.MemCStruct):