Pm2022: Pm2022 moved page BOSS/Languages/Python to Python

2026-08-26T07:03:22Z

Pm2022 moved page BOSS/Languages/Python to Python

← Older revision	Revision as of 07:03, 26 August 2026
(No difference)

Pm2022: cat

2026-08-26T06:59:58Z

cat

← Older revision		Revision as of 06:59, 26 August 2026
Line 114:		Line 114:
	...		...
	</syntaxhighlight>		</syntaxhighlight>

			[[Category:Bath Open Source Society]]
			[[Category:Programming language guidelines]]

Hw2210: Translate from boss.bathcs.com

2026-06-04T08:01:46Z

Translate from boss.bathcs.com

New page

Should follow [https://peps.python.org/pep-0008/ PEP-8]

== Quick overview ==

<ul>
<li>4 spaces as tabs</li>
<li><code>snake_case</code> for variables, functions and modules</li>
<li><code>PascalCase</code> for classes</li>
<li>Global variables should not be used.</li>
<li>Global constants should be in <code>SCREAMING_CASE</code> when used.</li>
<li>Lines should not be longer than 80 characters</li>
<li>Use trailing commas when the closing bracket is on a new line</li>
<li>Space after comments e.g. <code># something</code></li>
<li>Protected methods and attributes to start with <code>_</code>, private to start with <code>__</code></li>
<li>When a variable is not used, give it the name <code>_</code> e.g.
<syntaxhighlight lang="python">for _ in range(10):
print("Hi")

(important_var, _) = some_func()</syntaxhighlight></li></ul>

== Non-biased opinions ==

<ul>
<li>Try to prioritise readability of code</li>
<li>Order imports alphabetically but split internal imports</li>
<li>Comments should only be written when necessary, mainly to describe why something is done the way it is or to example a really unreadable bit of code (however this normally means you should change the code).</li>
<li>Methods should be ordered alphabetically (with private methods ordered separately and at the bottom of the file) e.g.
<syntaxhighlight lang="python">def a_func():
...

def b_func():
...

def z_func():
...

def _a_private_func():
...

def _b_private_func():
...</syntaxhighlight></li>
<li>Please use statically-typed code when possible: always for functions and parameters and then only for variables when its hard to tell e.g.
<syntaxhighlight lang="python">MY_CONST: dict[str, set[list[(str|int)]]] = {
"something": set(["hi"], [2], [3]),
}

def my_func(param1: int, param2: list[str]) -> (dict[str, int]|None):
my_variable = "hi"
...

def void_func():
...</syntaxhighlight>
However note that we should try to avoid using the <code>str|int</code> type and keep to one type when possible.</li>
<li>Generators are cool but don’t over use them and format them to be more readable with good naming schemes. e.g.
<syntaxhighlight lang="py">cube = np.from_iter((
(y + x for x in range(10))
for y in range(10)
), ...)</syntaxhighlight></li></ul>

== Using Pylint ==

On most IDEs (including vscode) you should be able to get a pylint extension to point out mistakes and annoy you into writing okay code. Please use this as it should help you with the above styling requirements.

You can also use flake8 (however these are really strict and I don’t like some of them), so here is an example configuration (in the <code>.flake8</code> file):

<pre class="toml">[flake8]
extend-ignore = E272,E221,E227,E201,E202
exclude = .git,__pycache__
max-complexity = 10</pre>
== Documentation ==

There is annoyingly no exact style in python for these… Here is something I kinda like.

Documentation should be for all public modules, methods, classes and functions (however please also try to do them for private versions, but they don’t have to be as indepth).

The style of documentation is kinda whatever you want it to be, so here is a somewhat okay layout. (Any better styles are most welcome as long as we are consistent)

Example:

example_module.py

<syntaxhighlight lang="python">"""
Description
"""

def my_func(param1: int) -> str:
"""Description of return which fits in less than 80 chars"""
...

def my_complex_func(param1: list[str]):
"""
Description

Parameters
----------
param1 (type): Description

Return
------
brief_name (type): Description
"""

class MyClass:
"""
Description

Attributes
----------
...
"""

def my_method():
"""..."""
...
</syntaxhighlight>

Python - Revision history

Pm2022: Pm2022 moved page BOSS/Languages/Python to Python

Pm2022: cat

Hw2210: Translate from boss.bathcs.com