search

fiatrete / OpenDAN-Personal-AI-OS

OpenDAN is an open source Personal AI OS , which consolidates various AI modules in one place for your personal use.
https://opendan.ai
MIT License
1.7k stars 142 forks source link

Some suggestions about python code style #37

Open lurenpluto opened 1 year ago

lurenpluto commented 1 year ago

After looked at the mvp branch of some of the latest commit code, feel inside the python code writing style maybe some conflict, in accordance with the management, our python code style should follow the PEP-8 specification, as follows

https://peps.python.org/pep-0008/

where

Class names should normally use the CapWords convention.

So the code below corresponds to

https://github.com/fiatrete/OpenDAN-Personal-AI-OS/blob/23963adc6e9888747f729e78bf5ea071f74464f8/src/component/agent_manager/agent_manager.py#L12-L12

The correct class name for agent_manager should be AgentManager. @waterflier

waterflier commented 1 year ago

Inherited from my C/Rust habits, I've gotten used to all-lowercase. Thank you for your suggestion; I've read the relevant guidelines, and I'll adjust my code later to meet PEP-8 requirements.

P.S I've been using the pylint tool, but it doesn't seem to have flagged this issue.

waterflier commented 1 year ago

Refactoring is complete. 5454009