From 8b0fcc57d36534349c5bf339ac6c84164408018b Mon Sep 17 00:00:00 2001
From: shinedday <shinedday@gmail.com>
Date: Tue, 18 May 2021 08:45:57 +0200
Subject: [PATCH] Add bunch of docstring and type
---
pyAmakCore/classes/schedulable.py | 2 +-
pyAmakCore/classes/scheduler.py | 2 +-
pyAmakCore/classes/tools/loggable.py | 13 ++++++++++---
pyAmakCore/enumeration/agent_phase.py | 3 +++
pyAmakCore/enumeration/executionPolicy.py | 3 +++
5 files changed, 18 insertions(+), 5 deletions(-)
diff --git a/pyAmakCore/classes/schedulable.py b/pyAmakCore/classes/schedulable.py
index 45d906c..7cd78bd 100644
--- a/pyAmakCore/classes/schedulable.py
+++ b/pyAmakCore/classes/schedulable.py
@@ -9,7 +9,7 @@ sys.path.insert(0, str(pathlib.Path(__file__).parent))
from pyAmakCore.exception.override import ToOverrideWarning
-class Schedulable():
+class Schedulable:
"""
Class Schedulable
"""
diff --git a/pyAmakCore/classes/scheduler.py b/pyAmakCore/classes/scheduler.py
index 9c20e64..a7c2b59 100644
--- a/pyAmakCore/classes/scheduler.py
+++ b/pyAmakCore/classes/scheduler.py
@@ -11,7 +11,7 @@ sys.path.insert(0, str(pathlib.Path(__file__).parent))
from pyAmakCore.classes.schedulable import Schedulable
-class Scheduler():
+class Scheduler:
"""
Scheduler class, to make sure that environment and amas are always sync together
"""
diff --git a/pyAmakCore/classes/tools/loggable.py b/pyAmakCore/classes/tools/loggable.py
index 19eeb4d..a74ba82 100644
--- a/pyAmakCore/classes/tools/loggable.py
+++ b/pyAmakCore/classes/tools/loggable.py
@@ -2,6 +2,7 @@
class allowing to save the state of the system at a given moment
"""
from os import path
+from typing import List
from pandas import DataFrame
@@ -14,7 +15,7 @@ class Loggable:
self.__do_log = False
self.__file_path = None
- def to_csv(self, cycle, var_list):
+ def to_csv(self, cycle: int, var_list: List['Agent']) -> None:
"""
get cycle and agent list and print them
"""
@@ -34,8 +35,14 @@ class Loggable:
else:
dataframe.to_csv(path_or_buf=self.__file_path, index=False)
- def set_do_log(self, boolean):
+ def set_do_log(self, boolean: bool) -> None:
+ """
+ tell the amas if it should log or not
+ """
self.__do_log = boolean
- def set_file_path(self, path_to_file):
+ def set_file_path(self, path_to_file: str) -> None:
+ """
+ specify path to csv
+ """
self.__file_path = path_to_file
diff --git a/pyAmakCore/enumeration/agent_phase.py b/pyAmakCore/enumeration/agent_phase.py
index 56464f8..259a21e 100644
--- a/pyAmakCore/enumeration/agent_phase.py
+++ b/pyAmakCore/enumeration/agent_phase.py
@@ -1,3 +1,6 @@
+"""
+Agent phases
+"""
from enum import Enum, auto
diff --git a/pyAmakCore/enumeration/executionPolicy.py b/pyAmakCore/enumeration/executionPolicy.py
index 78fc09c..7adbd01 100644
--- a/pyAmakCore/enumeration/executionPolicy.py
+++ b/pyAmakCore/enumeration/executionPolicy.py
@@ -1,3 +1,6 @@
+"""
+Agent execution policy
+"""
from enum import Enum, auto
--
GitLab