Merge pull request #6 from Golem-Base/rvdp/improve_linting

Improve CI and linting

Author: r-vdp

example/golem_base_sdk_example/__init__.py

@@ -1,14 +1,11 @@
-#! /usr/bin/env python
-
-"""GolemBase Python SDK"""
+"""GolemBase Python SDK."""
 
 import argparse
 import asyncio
 import logging
 import logging.config
 
-from xdg import BaseDirectory
-
+import anyio
 from golem_base_sdk import (
     Annotation,
     GolemBaseClient,
@@ -17,6 +14,7 @@
     GolemBaseExtend,
     GolemBaseUpdate,
 )
+from xdg import BaseDirectory
 
 __version__ = "0.0.1"
 
@@ -62,15 +60,12 @@
 
 
 async def run_example(instance: str) -> None:
-    """
-    connect
-    """
-
-    with open(
+    """Run the example."""
+    async with await anyio.open_file(
         BaseDirectory.xdg_config_home + "/golembase/private.key",
         "rb",
     ) as private_key_file:
-        key_bytes = private_key_file.readline()
+        key_bytes = await private_key_file.read(32)
 
     client = await GolemBaseClient.create(
         rpc_url=INSTANCE_URLS[instance]["rpc"],
@@ -106,15 +101,14 @@ async def run_example(instance: str) -> None:
     )
 
     if await client.is_connected():
-        block = await client.http_client().eth.get_block("latest")
-
         logger.info("""\n
         *****************************
         * Checking basic methods... *
         *****************************
         """)
 
-        logger.info("Retrieved block %s", block.number)
+        block = await client.http_client().eth.get_block("latest")
+        logger.info("Retrieved block %s", block["number"])
 
         logger.info("entity count: %s", await client.get_entity_count())
 
@@ -143,17 +137,28 @@ async def run_example(instance: str) -> None:
         """)
 
         logger.info(
-            "entities to expire at block: %s",
+            "entities to expire at block %s: %s",
+            metadata.expires_at_block,
             await client.get_entities_to_expire_at_block(metadata.expires_at_block),
         )
 
-        extend_receipt = await client.extend_entities([GolemBaseExtend(entity_key, 60)])
+        [extend_receipt] = await client.extend_entities(
+            [GolemBaseExtend(entity_key, 60)]
+        )
         logger.info("receipt: %s", extend_receipt)
 
         logger.info(
-            "entities to expire at block: %s",
+            "entities to expire at block %s: %s",
+            metadata.expires_at_block,
             await client.get_entities_to_expire_at_block(metadata.expires_at_block),
         )
+        logger.info(
+            "entities to expire at block %s: %s",
+            extend_receipt.new_expiration_block,
+            await client.get_entities_to_expire_at_block(
+                extend_receipt.new_expiration_block
+            ),
+        )
         logger.info("entity metadata: %s", await client.get_entity_metadata(entity_key))
 
         logger.info("""\n
@@ -162,6 +167,9 @@ async def run_example(instance: str) -> None:
         ************************
         """)
 
+        logger.info(
+            "block number: %s", await client.http_client().eth.get_block_number()
+        )
         update_receipt = await client.update_entities(
             [GolemBaseUpdate(entity_key, b"hello", 60, [Annotation("app", "demo")], [])]
         )
@@ -186,6 +194,10 @@ async def run_example(instance: str) -> None:
         """)
 
         logger.info("entity metadata: %s", await client.get_entity_metadata(entity_key))
+        logger.info(
+            "block number: %s", await client.http_client().eth.get_block_number()
+        )
+
         receipt = await client.delete_entities([GolemBaseDelete(entity_key)])
         logger.info("receipt: %s", receipt)
 
@@ -205,9 +217,7 @@ async def run_example(instance: str) -> None:
 
 
 def main() -> None:
-    """
-    main
-    """
+    """Run the example."""
     parser = argparse.ArgumentParser(description="GolemBase Python SDK Example")
     parser.add_argument(
         "--instance",

example/nix/devshell.nix

@@ -3,9 +3,9 @@
 perSystem.devshell.mkShell {
   packages = [
     (pkgs.python3.withPackages (ps: [
-      ps.web3
-      ps.rlp
+      ps.anyio
       ps.pyxdg
+      perSystem.golem-base-sdk.golem-base-sdk
     ]))
   ];
 }

example/nix/packages/golem-base-sdk-example.nix

@@ -53,6 +53,7 @@ pkgs.python3Packages.buildPythonPackage rec {
   ];
 
   propagatedBuildInputs = [
+    pkgs.python3Packages.anyio
     pkgs.python3Packages.pyxdg
     perSystem.golem-base-sdk.golem-base-sdk
   ];
@@ -64,7 +65,7 @@ pkgs.python3Packages.buildPythonPackage rec {
   ];
 
   checkPhase = ''
-    mypy --check-untyped-defs ${src}/golem_base_sdk_example
+    mypy --config ${../../../mypy.ini} ${src}/golem_base_sdk_example
     ruff check --no-cache ${src}/golem_base_sdk_example
     PYLINTHOME="$TMPDIR" pylint ${src}/golem_base_sdk_example
   '';

example/pyproject.toml

@@ -17,5 +17,35 @@ dependencies = [
   "pyxdg",
 ]
 
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    "ASYNC",
+    "PL",
+    "D"
+]
+ignore = [
+  "D203",
+  "D212"
+]
+
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
 [project.scripts]
 main = "golem_base_sdk_example:main"