From 767459d17e031e96d09e533a2a53df896b3a57e1 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Wed, 27 Sep 2023 22:10:55 +0800 Subject: feat(docstring): 添加PEP8规范的Docstring MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/psi/__init__.py | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) (limited to 'src/psi/__init__.py') diff --git a/src/psi/__init__.py b/src/psi/__init__.py index 1c274e2..3652c6d 100644 --- a/src/psi/__init__.py +++ b/src/psi/__init__.py @@ -8,19 +8,64 @@ __all__ = ['psi'] from psi.execution import Execution class Psi: + """ + A class representing a Psi object. + + Args: + input: The input value for the Psi object. + + Returns: + None + + Example: + ```python + obj = Psi("example") + ``` + """ + def __init__(self, input): + """ + Initializes a Psi object. + + Args: + input: The input value for the Psi object. + + Returns: + None + """ self.input = input self.execution = Execution(input) self.result = None def execute(self): + """ + Executes the Psi object. + + Returns: + The result of the execution. + """ self.result = self.execution.execute() return self.result def get_result(self): + """ + Retrieves the result of the Psi object. + + Returns: + The result of the execution. + """ return self.result def set_input(self, input): + """ + Sets the input value for the Psi object. + + Args: + input: The new input value. + + Returns: + None + """ self.input = input self.execution = Execution(input) self.result = None -- cgit v1.2.3-70-g09d2