PyOGP Coding Guidelines - Revision history

Chaser Zaks at 15:41, 27 June 2017

2017-06-27T15:41:36Z

← Older revision		Revision as of 08:41, 27 June 2017
Line 115:		Line 115:
	bad:		bad:

	<python>		<syntaxhighlight lang="python">
	from os.path import join, dirname, realpath		from os.path import join, dirname, realpath
	from pyogp.lib.base import agent, region		from pyogp.lib.base import agent, region
	from pyogp.lib.base.datatypes import *		from pyogp.lib.base.datatypes import *
	</~~python~~>		</syntaxhighlight>

	good:		good:

	<python>		<syntaxhighlight lang="python">
	import os.path		import os.path
	import socket		import socket
Line 130:		Line 130:
	from pyogp.lib.base.region import Region		from pyogp.lib.base.region import Region
	from pyogp.lib.base.datatypes import UUID, Vector3		from pyogp.lib.base.datatypes import UUID, Vector3
	</~~python~~>		</syntaxhighlight>

	=== pylint ===		=== pylint ===

2017-06-27T15:40:56Z

← Older revision		Revision as of 08:40, 27 June 2017
Line 8:		Line 8:
	Begin all Python source code files with this header:		Begin all Python source code files with this header:

	<python>		<syntaxhighlight lang="python">
	"""		"""
	@file filename		@file filename
Line 23:		Line 23:
	$/LicenseInfo$		$/LicenseInfo$
	"""		"""
	</~~python~~>		</syntaxhighlight>

	== Code Layout ==		== Code Layout ==

Kireji Haiku: changed tags from

to

2013-07-02T09:06:24Z

changed tags from <pre> to <whatever-programming-language-is-used>

← Older revision		Revision as of 02:06, 2 July 2013
Line 8:		Line 8:
	Begin all Python source code files with this header:		Begin all Python source code files with this header:

	<~~pre~~>		<python>
	"""		"""
	@file filename		@file filename
Line 23:		Line 23:
	$/LicenseInfo$		$/LicenseInfo$
	"""		"""
	</~~pre~~>		</python>

	== Code Layout ==		== Code Layout ==
Line 115:		Line 115:
	bad:		bad:

	<~~pre~~>		<python>
	from os.path import join, dirname, realpath		from os.path import join, dirname, realpath
	from pyogp.lib.base import agent, region		from pyogp.lib.base import agent, region
	from pyogp.lib.base.datatypes import *		from pyogp.lib.base.datatypes import *
	</~~pre~~>		</python>

	good:		good:

	<~~pre~~>		<python>
	import os.path		import os.path
	import socket		import socket
Line 130:		Line 130:
	from pyogp.lib.base.region import Region		from pyogp.lib.base.region import Region
	from pyogp.lib.base.datatypes import UUID, Vector3		from pyogp.lib.base.datatypes import UUID, Vector3
	</~~pre~~>		</python>

	=== pylint ===		=== pylint ===

2009-07-22T18:47:09Z

← Older revision		Revision as of 11:47, 22 July 2009
Line 160:		Line 160:
	# Use one line docstrings when possible.		# Use one line docstrings when possible.
	# When using a multiline docstring, the first line should be the description, followed by a blank line, followed by details in subsequent lines.		# When using a multiline docstring, the first line should be the description, followed by a blank line, followed by details in subsequent lines.
			# Docstrings should observe the line length limit (see above)
	== Unit Tests ==		== Unit Tests ==

2009-07-22T18:42:59Z

← Older revision		Revision as of 11:42, 22 July 2009
Line 32:		Line 32:

	One line requirements:		One line requirements:
	# ~~max~~ line length should be 150 (?)		# line length should be 80 characters if possible, do not exceed 150 (?)
	# a single blank line separates class methods/functions		# a single blank line separates class methods/functions
	# a blank line == ^$ (no unnecessary spaces)		# a blank line == ^$ (no unnecessary spaces)
Line 112:		Line 112:
	* Order your imports alphabetically (this gets a little vague with "from x in y" imports TODO: invent a rule that makes sense)		* Order your imports alphabetically (this gets a little vague with "from x in y" imports TODO: invent a rule that makes sense)
	* Try not to pollute the module's namespace by importing individual functions and classes from other modules.		* Try not to pollute the module's namespace by importing individual functions and classes from other modules.
			* Do not use 'import *'
	bad:		bad:

Line 118:		Line 118:
	from os.path import join, dirname, realpath		from os.path import join, dirname, realpath
	from pyogp.lib.base import agent, region		from pyogp.lib.base import agent, region
			from pyogp.lib.base.datatypes import *
	</pre>		</pre>

Line 128:		Line 129:
	from pyogp.lib.base.agent import Agent		from pyogp.lib.base.agent import Agent
	from pyogp.lib.base.region import Region		from pyogp.lib.base.region import Region
			from pyogp.lib.base.datatypes import UUID, Vector3
	</pre>		</pre>

2009-07-22T18:33:53Z

← Older revision		Revision as of 11:33, 22 July 2009
Line 157:		Line 157:
	# The text should describe the functionality of the function or method, and should only describe the parameters and return values when it is not clear.		# The text should describe the functionality of the function or method, and should only describe the parameters and return values when it is not clear.
	# Use one line docstrings when possible.		# Use one line docstrings when possible.
	# When using a multiline docstring, the first line should be the ~~descriptive~~, followed by a blank line, followed by details in subsequent lines.		# When using a multiline docstring, the first line should be the description, followed by a blank line, followed by details in subsequent lines.

	== Unit Tests ==		== Unit Tests ==

2009-07-22T18:25:14Z

← Older revision		Revision as of 11:25, 22 July 2009
Line 1:		Line 1:
	'''Note:''' New page, and pyogp is not conforming to the guidelines as of writing.		'''Note:''' New page, and pyogp is not conforming to the guidelines as of writing.
	[[User:Enus Linden\|Enus Linden]] 18:23, 22 July 2009 (UTC)		[[User:Enus Linden\|Enus Linden]] 18:23, 22 July 2009 (UTC)

			{{PyOGP/navigation}}

	== Source Files ==		== Source Files ==

2009-07-22T18:23:50Z

← Older revision		Revision as of 11:23, 22 July 2009
Line 1:		Line 1:
			'''Note:''' New page, and pyogp is not conforming to the guidelines as of writing.
			[[User:Enus Linden\|Enus Linden]] 18:23, 22 July 2009 (UTC)

	== Source Files ==		== Source Files ==

2009-07-22T18:23:04Z

@@ Line 1: / Line 1: @@
 == Source Files ==
@@ Line 61: / Line 52: @@
 Block comments start with a # and are followed by a space.
 Inline comments should be sparsely used.
 === Whitespace ===
@@ Line 69: / Line 62: @@
 # one space is expected after a comma, semicolon, colon, around binary operators ( = ), arithmetic operators
 # no spaces expected when dealing with keyword arguments or parameter values (def function(arg1, arg2=True))
 === Indentation ===
@@ Line 134: / Line 126: @@
 === pylint ===
 == docstrings ==
@@ Line 149: / Line 156: @@
 == Unit Tests ==
-Required!
+Unit test coverage should come to be expected for each checkin.

2009-07-22T18:03:54Z

Naming Conventions

← Older revision		Revision as of 11:03, 22 July 2009
Line 54:		Line 54:
	# method names and variables: lowercase, underscores acceptable if required		# method names and variables: lowercase, underscores acceptable if required
	## one leading underscore of non-public methods and variables		## one leading underscore of non-public methods and variables


	=== Comments ===		=== Comments ===