etigui

Python naming conventions

This document gives coding conventions example for the Python code. This style guide evolves over time as additional conventions are identified and past conventions are rendered obsolete by changes in the language itself.

1. General

Avoid using names that are too general or too wordy. Strike a good balance between the two.
- Bad: data_structure, my_list, info_map, dictionary_for_the_purpose_of_storing_data_representing_word_definitions
- Good: user_profile, menu_options, word_definitions
Never use the characters as single character variable names:
“l“ : lowercase letter el

	# Ref: https://stackoverflow.com/questions/3013449/list-comprehension-vs-lambda-filter/3013686
	# Ref json: https://catalog.data.gov/dataset/most-popular-baby-names-by-sex-and-mothers-ethnic-group-new-york-city-8c742
	from types import SimpleNamespace
	import json
	import time

	data_object = {}
	with open('name.json', 'r') as f:
	json_data = f.read()
	data_object = json.loads(json_data, object_hook=lambda d: SimpleNamespace(**d))

	# Standard
	import sys

	def main(args):
	# My code here
	pass

	if __name__ == "__main__":
	main(sys.argv)

	import pyproj

	def main():

	longFrom, latFrom = (6.090743, 46.225631)
	longTo, latTo = (6.127212, 46.250516)
	proj = pyproj.Geod(f'+proj=somerc +lat_0={latFrom} +lon_0={longFrom} +ellps=bessel +units=m +no_defs')
	startAz, endAz, dist = proj.inv(longFrom, latFrom, longTo, latTo)
	print(f'StartAz: {startAz}\nEndAz: {endAz}\nDist: {dist} [m]\n')

	import string

	def main():
	for s in string.ascii_uppercase:
	print(f'http://maps.google.com/mapfiles/kml/paddle/{s}.png')

	if __name__ == "__main__":
	main()

	# In Python 3.4+ you can use
	# contextlib.suppress() to selectively
	# ignore specific exceptions:

	import contextlib

	with contextlib.suppress(FileNotFoundError):
	os.remove('somefile.tmp')

	# This is equivalent to:

	# Python's `for` and `while` loops
	# support an `else` clause that executes
	# only if the loops terminates without
	# hitting a `break` statement.

	def contains(haystack, needle):
	"""
	Throw a ValueError if `needle` not
	in `haystack`.
	"""

	# Pythonic ways of checking if all
	# items in a list are equal:

	>>> lst = ['a', 'a', 'a']

	>>> len(set(lst)) == 1
	True

	>>> all(x == lst[0] for x in lst)
	True

	# In Python 3 you can use a bare "*" asterisk
	# in function parameter lists to force the
	# caller to use keyword arguments for certain
	# parameters:

	>>> def f(a, b, *, c='x', d='y', e='z'):
	... return 'Hello'

	# To pass the value for c, d, and e you
	# will need to explicitly pass it as

	# Python 3.5+ allows passing multiple sets
	# of keyword arguments ("kwargs") to a
	# function within a single call, using
	# the "**" syntax:

	>>> def process_data(a, b, c, d):
	>>> print(a, b, c, d)

	>>> x = {'a': 1, 'b': 2}
	>>> y = {'c': 3, 'd': 4}