Inspired from[clean-code-javascript](https://github.com/ryanmcdermott/clean-code-javascript)

Targets Python3.7+

**Good**:

current_date= datetime.date.today().strftime("%y-%m-%d")

current_date:str= datetime.date.today().strftime("%y-%m-%d")

**[⬆ back to top](#table-of-contents)**

**Bad:**

Here we use three different names for the same underlying entity:

get_user_info()

get_client_data()

get_customer_record()

**Good**:

If the entity is the same, you should be consistent in referring to it in your functions:

get_user()

get_user_info()

get_user_data()

get_user_record()

**Even better**

Python is (also) an object oriented programming language. If it makes sense, package the functions together with the concrete implementation

of the entity in your code, as instance attributes, property methods, or methods:

classUser:

info :str

defdata(self) ->dict:

defget_record(self) -> Union[Record,None]:

**[⬆ back to top](#table-of-contents)**

time.sleep(86400);

**Good**:

**[⬆ back to top](#table-of-contents)**

**Bad:**

**Bad:**

class Car

{

public $carMake;

public $carModel;

public $carColor;

//...

}

classCar:

car_make:str

car_model:str

car_color:str

**Good**:

class Car

{

public $make;

public $model;

public $color;

//...

}

classCar:

make:str

model:str

color:str

**[⬆ back to top](#table-of-contents)**

**Not bad:**

This opinion is more understandable than the previous version, but it better controls the value of the variable.

function createMicrobrewery($name = null)

{

   $breweryName = $name ?: 'Hipster Brew Co.';

// ...

}

... when you can specify a default argument instead? This also makes ist clear that

you are expecting a string as the argument.

**Good**:

If you support only PHP 7+, then you can use[type hinting](http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration) and be sure that the`$breweryName` will not be`NULL`.

function createMicrobrewery(string $breweryName = 'Hipster Brew Co.')

{

   // ...

}

defcreate_micro_brewery(name:str="Hipster Brew Co."):

slug= hashlib.sha1(name.encode()).hexdigest()

**[⬆ back to top](#table-of-contents)**

of the time a higher-level object will suffice as an argument.

**Bad:**

function createMenu($title, $body, $buttonText, $cancellable) {

// ...

}

defcreate_menu(title,body,button_text,cancellable):

**Good**:

class MenuConfig

{

public $title;

public $body;

public $buttonText;

public $cancellable = false;

}

classMenu:

def__init__(self,config:dict):

title= config["title"]

body= config["body"]

$config = new MenuConfig();

$config->title = 'Foo';

$config->body = 'Bar';

$config->buttonText = 'Baz';

$config->cancellable = true;

menu= Menu(

{

"title":"My Menu",

"body":"Something about my menu",

"button_text":"OK",

"cancellable":False

}

)

**Also good**

classMenuConfig:

title:str

body:str

button_text:str

cancellable:bool=False

defcreate_menu(config: MenuConfig):

title= config.title

body= config.body

function createMenu(MenuConfig $config) {

// ...

}

config= MenuConfig

config.title="My delicious menu"

config.body="A description of the various items on the menu"

config.button_text="Order now!"

config.cancellable=True

create_menu(config)

**Fancy**

from typingimport NamedTuple

classMenuConfig(NamedTuple):

title:str

body:str

button_text:str

cancellable:bool=False

defcreate_menu(config: MenuConfig):

title, body, button_text, cancellable= config

create_menu(

MenuConfig(

title="My delicious menu",

body="A description of the various items on the menu",

)

)

**[⬆ back to top](#table-of-contents)**