Bug#481562: Updated patch: Add Python coding style guide
package python-apt
found 481562 0.7.7
thanks
The file 'apt/README.apt' has a section with the beginnings of
recommendations for Python style, following PEP 8. This would be
better applied to the project as a whole, for all its Python code.
The attached patch bundle is made against the Bazaar branch
<URL:http://bzr.debian.org/bzr/apt/python-apt/debian-sid/>, revno 197.
The patches move the Python style advice to 'README.python', and
expand on that advice by highlighting key points from PEP 8.
--
\ “We have to go forth and crush every world view that doesn't |
`\ believe in tolerance and free speech.” —David Brin |
_o__) |
Ben Finney <ben@benfinney.id.au>
# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: ben+debian@benfinney.id.au-20080807231039-\
# ep50mhnqkg3gqaoi
# target_branch: bzr+ssh://bzr.debian.org/bzr/apt/python-apt/debian-\
# sid/
# testament_sha1: abc969f3bc992db95fd9fd96c38e21a76a08ed08
# timestamp: 2008-08-08 09:53:49 +1000
# base_revision_id: egon@debian-vm-20080722083317-vgu5ahryr1m6aqtg
#
# Begin patch
=== added file 'README.python'
--- README.python 1970-01-01 00:00:00 +0000
+++ README.python 2008-08-07 23:10:39 +0000
@@ -0,0 +1,55 @@
+Style Guides for Python code
+============================
+
+Follow PEP 8 <URL:http://www.python.org/dev/peps/pep-0008>.
+
+Use an automated style checker such as `pep8.py`_.
+
+.. pep8.py:: http://svn.browsershots.org/trunk/devtools/pep8/
+
+Particular points of note from PEP 8:
+
+Indenting, whitespace, line length, and blank lines
+---------------------------------------------------
+
+* Use spaces only for indenting; indent levels are 4 spaces each.
+
+* Statements on separate lines; one module per 'import' statement.
+
+* Single space after ':' and ','; single space before and after binary
+ operators; no space around '=' in function keyword arguments only.
+
+* Maximum line length 79 characters; no trailing white space on any
+ line; continue lines with backslash or grouping parentheses.
+
+* Two blank lines separating top-level functions and classes;
+ one blank line separating class methods.
+
+Names
+-----
+
+* 'TitleCase' for class names; 'lowercase' or 'lower_case' for
+ attribute, function, method, and module names.
+
+* Names with a single leading underscore (e.g. '_foo_bar' or
+ '_FooBar') indicate "internal use only", i.e. not to be relied upon
+ for external interfaces.
+
+Docstrings
+----------
+
+* Follow PEP 257 <URL:http://www.python.org/dev/peps/pep-0257>.
+
+Encoding
+--------
+
+* Follow PEP 263 <URL:http://www.python.org/dev/peps/pep-0263>.
+
+* Use UTF-8 encoding for source files.
+
+..
+ Local Variables:
+ mode: rst
+ coding: utf-8
+ End:
+ vim: filetype=rst fileencoding=utf-8 :
=== modified file 'apt/README.apt'
--- apt/README.apt 2007-11-29 11:17:28 +0000
+++ apt/README.apt 2008-08-07 23:08:38 +0000
@@ -8,14 +8,3 @@
considered stable. If in doubt, please contact deity@lists.debian.org.
WARNING !!! The API is not 100% stable yet !!!
-
-
-Style Guides:
--------------
-
-Follow PEP08.
-
-Internal variables/methods are prefixed with a "_" (e.g. _foo).
-
-
-
# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWUfReQsACKp/gGVQAEBR////
f///8P////BgDr9SnXtnXp6aAAAANuEu6ABWWtUqQaKFAB1wkpTFPTCmaFPNAZMiZGk8mo0zRGR6
TymMo9TCGIJSIQ1MZD1NTTBpGmDTSPUGmQZANBpoAANU9JhBT2ijyamCPUxBkyYRiNDRhBhGmBNA
lNCKMlGj01HhT9UeoNHqfqmhoaA9TTQ9TIAAAHMJoyNDQyGEaGQ00aADEZMgGEAwCSIQACNAIaAk
8QFP0CmyU/IU/FPVP0aUyYnpOjAEsozTZCjtDdBtm1oHIxfdCC2o37+cNDI/flUn5VFGxMJqqcak
B3f86Z5Hh64mVBH8209kTgdej419z63i7YCzQMCgDB+357v7l0yn5zdversTKZ2TAy+bUSIhBID2
8/VMnDokDsTsDvFf5tDs3rX0x6pSXq8aShSMW63gDBeZy0XWzgmhB7PExB+1ImAxMFw1kHOHdIJw
alsw7vkUWNKacHIM063wX/tBS0OXeT8bw1lAXHaED/az0PEPmBsnppC8FUoscd3foJcjexvFBOmC
DpkQasd4BZlHnkzEhDWwgKDapHlTW0pYCSNAor+iFs6LegJBTdlptiXPdK+98JeSmwK61dvpvyYk
QyuixjGDztGX8Rgo9tXhRjM23i5tMEoSli1CQkCijhQ7CB0LcQohUJ+BwPqIBYYAdSo7ZNRkvGAy
eU6mA/v14dHJ01ctni1B1h2QDVsgy2yg2LO1M7eKq/x8HxmlPPhk1XHvSFRRRRaHQEyDiwCZheMO
ogG05eJNyPtvadJGJL1CpPPlEcflYq30IWO/UxsG8MPUCEQ5wTAB1/pfyBvoAYLUAupC6z+2aS7g
LwoCFW4GBfAvBKC+gkMezLXkuSNDU9a5CuUKpGPsfijCdsRbjW3JxQhZ7w75jWhCiqKlQEgPBdIR
5+8O1B/v/AUYtZa6d3Hdx3favL8wwYGD+U4F+rRjENliaNKrjZhICDRKCLnC4MsZDBvsAFe+KyDn
aaqqj4HLcIcYDy8HKklVWB0LAYgqz8UKeLmlJPKdCF0n9YAoIBMgFUHcknYQs1UKEV/NQDo87aJw
wh9LLDBKAufHVQAsTURNQMs3hSmH50GTBFkDRBl1g0DkNgGIGBzeUt/e1tu6D8hKcOmfpIPPVZzT
8XqqbjxAmJAVROqy8qigaQFRcTWawyMTADCQY5Tl82m4JDqkf0Y04hPF0F4WGZMVl5DMvNRWxiFc
5YHkQtOvXpt0LaJJYzpK4JaCIdkcwpkYaVFAJ54akLSVmReTROAFdNQ7yKmi2N5rLCM144g0O5aV
FtBhMUl0QPx+7ypxp22ASQIwYCEZw2FBdPggmComqYjVwWUjgFQ9JDXoIJKNNeeFIEHkaSwI/nDc
sjQZDlNplcbkLQbjGqAdoHOkmopVfBp3ot0ToWXMH+YEUEmpAbEqHgbDWWDAUFq0G2aagW2s8ila
bysqsMinUQKCs2jKykZB/rjqCmstutuK3Cy5JcP43oWGelF7ZgUXlkwyix7QKDOdBmYnMqZgH2bW
JyTG2PehMtglHMpvtew4VAum06KyyzM3fTKKicgaTknzGQoOayoyKTYXnfBCvCpb5b2E0p5IU1IT
bSwsAnKjAnLbiuyDuSMaygnLBiw1ctZu3WkxfaYVq0R9PCHvC8kQMkk5Cg9qF/bzOGzK8dLCrXHA
Nm4mJrza6EKRNr22YmotOJo0lN5cYtFAYMUE+JIvJDlJgXlBq8vtQupd7NezOimdJaaoRFDAiJIV
kkMZlpkY1QnCcZJZjqxjVOWUTFRAYzJi20ntKMx7LJicFpAhd6L5V0lBqKzEleSNZoKS5zQUlWJ5
Z/PlZMLnDSWwvQYlpBoVHPz6kLAkYQQpoCaOgzKjDWKN1RmX5UEypeRUbBnMWtNZ+kTehZ1eqjI/
APyCAQOrZp8/x5g32Mw1DDMuVoAmNKcBv/lm6DegJbUGYgn0F1zq7rBcQ9gEwMGtMhepgP+gYD5a
ZswZJykB3XtB0Pt3jJmTMMxAIDpW0FKJX9Ye9BuDIIBIHArDs2ZxCQck4ToEsQ/wHZ4Bwei/kce+
bGPGCB+ADCGneycQb1DVuGYOghDJmLlrUgaQJH9sK4VpGwzu23nFBBHomBUCGUh9SXmTP3R6B+gY
FFDETA7QCEOgC0HcJ0NQO+eHtgDTzi3idp8K4Rgd4L+g2CvvCyB9r8IaNjgK0BccHsGCfZB6dOWG
ZTOYQ6pWbkWAgj52pAmugP5rQEgMChHQC09c+WqWLT2UbvbLJEikCZSFtBgLTr1QNqlLlvk3C8oO
cDKhiBaU+ijr2o6fDEDACCoGnM3loLt1jjY4A3Fv1O3DrYrQeWQDUjnBYDO1SVjCtdotuA8mxPga
LrG9NOpLPeC2Gb3Za2S3dx6D2xGBM4mEacdJ8G1eNpZKGY1c3v6qvoCrC1kgcPl64lLMmSadej6H
zH+BOJEfqeHnPAYTQSiSpBUWvd9jF3Ga2G1F+xmszvPOwkjHJkyS6Tr+2Ow3gViCYG08FkyDgH4j
jhRFAlMDox6U/wA+34B/5LR9YBppCkZITcn6P78Hy+TWeoGX2QQyH0jqegMkIT+BjkHDidZznOe8
OQ7DpoJoR7TtKOSwcnJHy/norMpzw+Ibi3ahaS6jEmf+gXJ+5DncDKEAeAMoQB4AyhBP/KELzF9G
Ia0CVAaikOH6hNFC0IWCFvNpEz7SBvVpEdC3wIEJzyEthQfH4cQiHq5erKolhcYDqZiGs04kVhDq
CFYGxaYQB3go1AO431fYE0UejKFEyqqkfPDZMrWOFTjDNjRShC5NyA4VzcnGj7pK4KDcW8x08DAz
JCOsnDBAMSIgUQKDgVS0CR2UcrFeoYa4OX47FpqGYOTqD4oQrlm0jsCjgR/ogq4sUMYuB87SKNaF
l3c55Tw6+pouXymZEHdQLoPCMzzNzScrSxM74JDUvid0DuYpEkkr7+HpTelENqI3DbIJmJroTxZ2
MyecoGGNq4FJ7qDlqNOtg9wODaUEtQCBErFaAZW5uyztkcQ8IJvm1vARCEqpbHCv3xxYvu0cZB4l
LLTbC6y/POscyTlCmc4OoQoL0rSEKwfYwqRykFAggXMvABg7QZWM3to6YB8ZM8yCj+cKAFs6tDp4
SrtSh4m4DTbICBM1cLMXoQP+MhBppQJYUB5cwznNxRDYdz+HV6zv7GIDo2QUSYe0bstx58hjzFnk
GERwj7nQURxA8wbJEET7IvRqA4IQs/4f8iIEWEsjuA9kFMJcjew1BrSU4GNxdd4M/MPqkIVctooq
gFQLAETfsLEk55wiecNFi6G8jOhw73cSGA2sRnPMdCF6/IBJRYQUI0hKeldfLiHOhMpNT3IUQwW9
AlvyA1jZEHYowfnQhRhgEEoHI4A+gztWQw8Qg3ctAHz9e01NmIGVYGu61qWtZ2k7s0fE2v9gwQhP
6Outeg2hmCIKIQg4MQgZMBYQgeJViq3wizpJ9FfdLZ8PrX5OM4EwGQcuuXpyhUc6HrmwB0MggjuV
bdvgycLIA+wA4+nlku1eOatetToYqkbHIIiisnY6oIyZhqhuSFkzgRvrCwDmDyFEfSKIGHBT+nyB
PBl4g9wWwkgbxAXIPFQ4XOzOH6h3hSGUGcOIH0PZNUFiPpQVBMgpJNYDkWRBgIIQmQoBg6XQaQG9
8EKSEJgRkqkizohQH+eIyNKTD96gwUXbVVahIQINDAzToQnA5QZIccKVNMpIEqw5QIToIlLqDAoJ
khTB/AQQFHd39PYxcVcGz5X0fOBjNs4MiBsgZ7g/RZAeiaf2BdCoMWRNUT5odxOwDAyTAc8EAQcQ
JnrmxKy1VcAUJMocEMGWaHuBkKNYWDgdaEwbC+VZ3+/tFDmUzAfBAwMKkNgemypLL8qAc7w7g7UB
Sg88V5pvvAHvQHq/Pu9Enq2vAoC0BguXRchVgZ8BB+/lA4pL5Q6wOIG7kAsD8OsDYUYDjMiQw7OJ
zAGDd1vNBg6fiCAkz4wKkpQGfMHpCPKF1Ksw28P6gQRQDAoBXUEye2looUE9PbJwCbZfmBTSlX74
IniA7AVk0YoF3BKliO7t88SntGHZkoOPcpfCC5BkSAYP+3oAj9TY1iyDv31USRFBuDWgnCqAVQOI
KIMgUkWAH6tJFbFQ4DTjgQqEHndfcGIct1HmfXUDI3a4QK/BC1BuFtFWA4eLLZBU3CLkHtnQqC9t
eycCC5ywKosYT5iV4FJ4wvkmn2LxCC7NBUBeTKxUxVfreGgQTzgsAk0YaNjhz2uBayA5qwkFcQYL
pgKSoDDjMFTIBWh4IXqjpCwPrvD9g67b90/y9xUL3mmk5kHqgSgtu+zxhCFz5ogRbx6/4xDcpBxu
2QrkTAvSH5wQgcLvWEJg3LuQsEL9vt6+r72ITo+lRSUoYsaIjwEvVmCikaVQlaeQb3IdFUELLFhg
WHQD1tFCFFAeeMg00yCNSSkkeJCiH8KSSeeA13X0PicDuQv+LuSKcKEgj6LyFg==
Reply to: