refactor: replace darglint with pydoclint

.flake8

@@ -11,9 +11,14 @@ ignore = D205,D212,D415,E203,W503
 # https://black.readthedocs.io/en/stable/the_black_code_style.html#line-length
 max-line-length = 88
 
+# This is for pydocstyle - to allow docstrings in __init__ functions
+# This rule was used for easier migration from darglint
+# TODO: remove this rule
+allow-init-docstring=True
+
 per-file-ignores =
   # For tests, disable type annotation and docstring linting.
-  tests/*: ANN D DAR
+  tests/*: ANN D DOC
 
 # Select other tools to enable.
 
@@ -25,7 +30,7 @@ per-file-ignores =
 
 # D enables docstrings warnings from pydocstyle.
 
-# DAR enables docstring style linting via darglint.
+# DOC enables docstring style linting via pydoclint.
 
 # F are errors reported by pyflakes, a tool which parses source files
 # and finds invalid Python code.
@@ -35,4 +40,4 @@ per-file-ignores =
 
 # W and E are warnings and errors reported by pycodestyle, which checks
 # your Python code against some of the style conventions in PEP 8.
-select = ABS,ANN,DAR,BLK,D,E,F,I,W
+select = ABS,ANN,DOC,BLK,D,E,F,I,W

.github/workflows/unit_test.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Lint
         run: |
-          poetry run flake8 xrpl tests snippets --darglint-ignore-regex="^_(.*)"
+          poetry run poe lint
 
       - name: Type-check
         run: |

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
         types: [python]
       - id: flake8
         name: flake8
-        entry: poetry run flake8 --darglint-ignore-regex="^_(.*)"
+        entry: poetry run flake8
         language: system
         types: [python]
       - id: mypy

CONTRIBUTING.md

@@ -66,7 +66,7 @@ To run linting and other checks, `xrpl-py` uses [`pre-commit`](https://pre-commi
 To run the linter:
 
 ```bash
-poetry run flake8 xrpl tests --darglint-ignore-regex="^_(.*)"
+poetry run poe lint
 ```
 
 ### Running Tests

pyproject.toml

@@ -23,7 +23,7 @@ include = ["LICENSE"]
 packages = [{ include = "xrpl" }]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.8.1"
 base58 = "^2.1.0"
 ECPy = "^1.2.5"
 typing-extensions = "^4.2.0"
@@ -34,16 +34,16 @@ types-Deprecated = "^1.2.9"
 pycryptodome = "^3.16.0"
 
 [tool.poetry.dev-dependencies]
-flake8 = "^4.0.1"
+flake8 = "^7.0.0"
 black = "23.3.0"
 flake8-black = "^0.3.6"
 flake8-docstrings = "^1.7.0"
 mypy = "^1"
 isort = "^5.11.5"
 flake8-isort = "^6.0.0"
-flake8-annotations = "2.7.0"
+flake8-annotations = "3.1.1"
 flake8-absolute-import = "^1.0"
-darglint = "^1.5.8"
+pydoclint = "^0.5.7"
 sphinx-rtd-theme = "^3.0.0"
 aiounittest = "^1.4.0"
 coverage = "^7.2.7"
@@ -73,6 +73,7 @@ precision = 2
 [tool.poe.tasks]
 test_unit = "coverage run -m unittest discover tests/unit"
 test_integration = "coverage run -m unittest discover tests/integration"
+lint = "poetry run flake8 xrpl tests snippets"
 
 [tool.poe.tasks.test]
 cmd = "python3 -m unittest ${FILE_PATHS}"

tests/unit/core/binarycodec/types/test_serialized_type.py

@@ -48,7 +48,7 @@ class TestSerializedType(TestCase):
     def fixture_test(self, fixture: ValueTest):
         """Run the appropriate test for given fixture case."""
         serialized_type: SerializedType = TYPE_MAP[fixture.type]
-        if type(fixture.test_json) == dict:
+        if isinstance(fixture.test_json, dict):
             json_value = fixture.test_json
         else:
             json_value = str(fixture.test_json)

xrpl/core/addresscodec/codec.py

@@ -40,8 +40,8 @@ def _encode(bytestring: bytes, prefix: List[int], expected_length: int) -> str:
     length.
     """
     if expected_length and len(bytestring) != expected_length:
-        error_message = """unexpected_payload_length: len(bytestring) does not match expected_length.
-        Ensure that the bytes are a bytestring."""
+        error_message = """unexpected_payload_length: len(bytestring) does not match
+        expected_length. Ensure that the bytes are a bytestring."""
         raise XRPLAddressCodecException(error_message)
     encoded_prefix = bytes(prefix)
     payload = encoded_prefix + bytestring

xrpl/core/binarycodec/types/serialized_type.py

@@ -25,13 +25,13 @@ def from_parser(  # noqa: D102
         cls: Type[Self],
         parser: BinaryParser,
         # length_hint is Any so that subclasses can choose whether or not to require it.
-        length_hint: Any,
+        length_hint: Any,  # noqa: ANN401
     ) -> Self:
         pass
 
     @classmethod
     @abstractmethod
-    def from_value(cls: Type[Self], value: Any) -> Self:  # noqa: D102
+    def from_value(cls: Type[Self], value: Any) -> Self:  # noqa: D102 ANN401
         pass
 
     def to_byte_sink(self: Self, bytesink: bytearray) -> None:
@@ -54,7 +54,7 @@ def __bytes__(self: Self) -> bytes:
         """
         return self.buffer
 
-    def to_json(self: Self) -> Any:
+    def to_json(self: Self) -> Any:  # noqa: ANN401
         """
         Returns the JSON representation of a SerializedType.
 

xrpl/core/binarycodec/types/st_object.py

@@ -58,9 +58,9 @@ def _handle_xaddress(field: str, xaddress: str) -> Dict[str, Union[str, int]]:
     return {field: classic_address}
 
 
-def _str_to_enum(field: str, value: Any) -> Any:
-    # all of these fields have enum values that are used for serialization
-    # converts the string name to the corresponding enum code
+# all of these fields have enum values that are used for serialization
+# converts the string name to the corresponding enum code
+def _str_to_enum(field: str, value: Any) -> Any:  # noqa: ANN401
     if field == "TransactionType":
         return get_transaction_type_code(value)
     if field == "TransactionResult":
@@ -70,8 +70,8 @@ def _str_to_enum(field: str, value: Any) -> Any:
     return value
 
 
-def _enum_to_str(field: str, value: Any) -> Any:
-    # reverse of the above function
+# reverse of the above function
+def _enum_to_str(field: str, value: Any) -> Any:  # noqa: ANN401
     if field == "TransactionType":
         return get_transaction_type_name(value)
     if field == "TransactionResult":