Merge pull request #34 from moevm/33_pre-commit-hook

pre-commit hook with black

Author: AndrewGavril

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+        name: Format code with Black
+        language: python
+        types: [python]
+        args: [--line-length=120]
+        stages: [pre-commit, commit]
+        additional_dependencies: []
+        require_serial: false
+        verbose: true

README.md

@@ -8,3 +8,19 @@
 -- [Scripts and Yocto Layers to build VM image with all dependencies](https://github.com/moevm/vm_build_risc_v)
 
 -- [Sources to build and run gRPC server and worker nodes](https://github.com/moevm/grpc_server)
+
+## Contribution
+
+### Recommendations for working with the repository
+
+#### Setting up a pre-commit hook for formatting code using Black
+
+- The black configuration settings are located in .pre-commit-config.yaml
+
+- After cloning the project, download all the necessary dependencies using `pip install -r requirements.txt` in a virtual environment. Run the `pre-commit install` command in the virtual environment once. Next, the hook will be triggered with each commit.
+
+- If black finds a problem in the code, he will fix it, and you will need to repeat `git add .` and `git commit -m "name_commit"`
+
+- You can check for a hook with `cat command.git/hooks/pre-commit` if it returns the code then the hook is installed.
+
+- Additional information is described in the file [using_black.md](wiki/using_black.md)

requirements.txt

@@ -1,11 +1,24 @@
+black==25.1.0
+cfgv==3.4.0
+click==8.1.8
 coverage==7.7.0
+distlib==0.3.9
+filelock==3.18.0
 grpcio==1.70.0
 grpcio-tools==1.70.0
+identify==2.6.9
 iniconfig==2.0.0
+mypy-extensions==1.0.0
+nodeenv==1.9.1
 packaging==24.2
+pathspec==0.12.1
+platformdirs==4.3.7
 pluggy==1.5.0
+pre_commit==4.2.0
 protobuf==5.29.3
 pytest==8.3.5
 pytest-cov==6.0.0
 python-dotenv==1.0.1
-setuptools==75.8.2
+PyYAML==6.0.2
+setuptools==75.8.2
+virtualenv==20.29.3

src/client/client.py

@@ -5,24 +5,22 @@
 from src.protobuf import file_service_pb2
 from src.protobuf import file_service_pb2_grpc
 
-load_dotenv(os.path.join(os.path.dirname(__file__), '..', '..', 'env', '.grpc.env'))
+load_dotenv(os.path.join(os.path.dirname(__file__), "..", "..", "env", ".grpc.env"))
 
 
 class FileClient:
     def __init__(self):
-        self.host: str = os.environ['GRPC_CLIENT_HOST']
-        self.port: str = os.environ['GRPC_PORT']
-        max_message_length: int = int(os.environ['GRPC_MAX_MESSAGE_LENGTH'])
+        self.host: str = os.environ["GRPC_CLIENT_HOST"]
+        self.port: str = os.environ["GRPC_PORT"]
+        max_message_length: int = int(os.environ["GRPC_MAX_MESSAGE_LENGTH"])
 
         options = [
-            ('grpc.max_receive_message_length', max_message_length),
-            ('grpc.max_send_message_length', max_message_length),
+            ("grpc.max_receive_message_length", max_message_length),
+            ("grpc.max_send_message_length", max_message_length),
         ]
 
-        self.channel: grpc.Channel = grpc.insecure_channel(
-            f'{self.host}:{self.port}',
-            options=options
-        )
+        self.channel: grpc.Channel = grpc.insecure_channel(f"{self.host}:{self.port}", options=options)
+
         self.stub: file_service_pb2_grpc.FileServiceStub = file_service_pb2_grpc.FileServiceStub(self.channel)
 
     def upload_and_validate(self, file_path: str, file_type: str) -> file_service_pb2.FileResponse:
@@ -39,13 +37,11 @@ def upload_and_validate(self, file_path: str, file_type: str) -> file_service_pb
 
         `file_service_pb2.FileResponse` - Server response with validation result
         """
-        with open(file_path, 'rb') as f:
+        with open(file_path, "rb") as f:
             content: bytes = f.read()
 
         request: file_service_pb2.FileRequest = file_service_pb2.FileRequest(
-            filename=file_path,
-            content=content,
-            file_type=file_type
+            filename=file_path, content=content, file_type=file_type
         )
 
         return self.stub.UploadFile(request)
@@ -63,5 +59,5 @@ def test_file_upload():
     print(f"Binary file: Size={response.size}, Valid={response.is_valid}, Msg={response.message}")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     test_file_upload()

wiki/using_black.md

@@ -0,0 +1,17 @@
+## Useful:
+If a block cannot be formatted (for example, due to compatibility reasons), add a comment:
+```
+# fmt: off
+non_formatted_code = {
+    "key": "value",
+    "data": [1, 2, 3,]
+}
+# fmt: on
+```
+- \# fmt: off — before the code that should not be formatted.
+
+- \# fmt: on — after this code, to enable auto-formatting again.
+
+## Links:
+- The Black documentation: https://black.readthedocs.io
+- Config examples: https://github.com/pre-commit/pre-commit-hooks