From 7a5b32b446195c6c019dfda1b2ec75f137be2f0c Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 11:35:38 -0400 Subject: [PATCH 1/6] Update 'PYGUIDE.md' --- PYGUIDE.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 75 insertions(+), 1 deletion(-) diff --git a/PYGUIDE.md b/PYGUIDE.md index 0f1e27b3..4fb900c2 100644 --- a/PYGUIDE.md +++ b/PYGUIDE.md @@ -18,5 +18,79 @@ For code analysis, we enforce the usage of [pylint](https://www.pylint.org/) wit * Name your folders and files in lowercase. * Your class names must start in capital letters and follow the python CapWords pattern. * Methods and properties that return lists must end in "s". +* Methods and variables should be lowercase and use _ (underscore) as word separator. * Constants names must be all capitals. -* Avoid the usage of "get_" and "set_" methods whenever possible, by using @property and @variable.setter decorators instead. \ No newline at end of file +* Avoid the usage of "get_" and "set_" methods whenever possible, by using @property and @variable.setter decorators instead. +* "Private" methods, variables and properties start with _ (underscore) + +## Imports + +All the imports should be defined at the top of the file after the license and contact information comment + +```python +""" +MyClass module +SPDX - License - Identifier: LGPL - 3.0 - or -later +Copyright © 2020 Project Author name name@concordia.ca +""" + +import sys +``` + +Ensure that your imports are used and remove any unused. + + +## Object attributes and methods + +Use properties whenever possible and encapsulate the access to all the calculated object attributes into a properties as shown in the following example. + +```python + + @property + def object_attribute(self): + if self._object_attribute is None: + self._object_attribute = ... + ... + return self._object_attribute + +``` + +or if the property can be modified like in the following example + +```python + + @property + def object_changeable_attribute(self): + return self._object_changeable_attribute + + @object_changeable_attribute.setter + def object_changeable_attribute(self, value): + self._object_changeable_attribute = value + +``` + +If your method or attribute returns a complex object use type hints as in this example + +```python + + @property + def complex_object(self) -> ComplexObject: + return self._object_changeable_attribute + + def new_complex_object(self, first_param, second_param) -> ComplexObject: + return ComplexObject(first_param, second_param, self.property) + +``` + +always access your variable throught the method and avoid to access directly. + +```python + + @property + def object_attribute(self): + return self._object_attribute + + def operation(self, first_param, second_param): + return self.object_attribute * 2 + +``` \ No newline at end of file From 43a0e8649272de37e19b2a30f228155410fbd504 Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 11:38:06 -0400 Subject: [PATCH 2/6] Custom code style rules --- pylintrc | 595 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 595 insertions(+) create mode 100644 pylintrc diff --git a/pylintrc b/pylintrc new file mode 100644 index 00000000..7a754652 --- /dev/null +++ b/pylintrc @@ -0,0 +1,595 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10 + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +init-hook='sys.path = list(); sys.path.append(".")' + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=pyproj, reverse_geocoder + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=120 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma, + dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception From 508fefa3d0ff72d1bf67207573b3383f28b39a7f Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 11:49:50 -0400 Subject: [PATCH 3/6] Update 'PYGUIDE.md' --- PYGUIDE.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/PYGUIDE.md b/PYGUIDE.md index 4fb900c2..2c7f963b 100644 --- a/PYGUIDE.md +++ b/PYGUIDE.md @@ -93,4 +93,55 @@ always access your variable throught the method and avoid to access directly. def operation(self, first_param, second_param): return self.object_attribute * 2 -``` \ No newline at end of file +``` + +Attributes with known units should be explicit in method's names + +```python + + @property + def distance_m(self): + return self._distance +``` + +### Coments + +#### code documentation + +all public classes, properties and methods must have code comments + +```python + + class MyClass + """ + MyClass class perform models class operations + """ + + def __init__(self): + + + @property + def object_attribute(self): + """ + My class object attribute + :return: int + """ + return self._object_attribute + + def operation(self, first_param, second_param): + """ + multiplies object_attribute by two + :return: int + """ + return self.object_attribute * 2 + +``` + +#### To do's + +Pending to implement operations should be indicated with ToDo comments to highlight the missing operation + +```python + # ToDo: right now extracted at city level, in the future should be extracted also at building level if exist +``` + From 1647c7df3a030418ea9a9925c9bed01f346767b6 Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 12:01:47 -0400 Subject: [PATCH 4/6] Update 'PYGUIDE.md' --- PYGUIDE.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/PYGUIDE.md b/PYGUIDE.md index 2c7f963b..b6e908c8 100644 --- a/PYGUIDE.md +++ b/PYGUIDE.md @@ -95,15 +95,6 @@ always access your variable throught the method and avoid to access directly. ``` -Attributes with known units should be explicit in method's names - -```python - - @property - def distance_m(self): - return self._distance -``` - ### Coments #### code documentation @@ -137,6 +128,19 @@ all public classes, properties and methods must have code comments ``` +Attributes with known units should be explicit in method's comment + +```python + + @property + def distance(self): + """ + My class distance in meters + :return: float + """ + return self._distance +``` + #### To do's Pending to implement operations should be indicated with ToDo comments to highlight the missing operation From 84ea64d672b927d6cdaac8fe5f7266139093c514 Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 12:09:21 -0400 Subject: [PATCH 5/6] Update 'PYGUIDE.md' --- PYGUIDE.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/PYGUIDE.md b/PYGUIDE.md index b6e908c8..57242754 100644 --- a/PYGUIDE.md +++ b/PYGUIDE.md @@ -5,7 +5,7 @@ Coding style is just how the code looks, it's incredibly personal, and everyone Your preferred architectures, variable and function naming style all of then impacts in your code style and how the others read and understand it, so it could become a significant burden if everyone is coding on his own. -At CERC we are following the [PEP8](https://www.python.org/dev/peps/pep-0008/) with two spaces indentation instead of four. +At CERC, we are following the [PEP8](https://www.python.org/dev/peps/pep-0008/) with two spaces indentation instead of four. ## Tools. @@ -18,14 +18,14 @@ For code analysis, we enforce the usage of [pylint](https://www.pylint.org/) wit * Name your folders and files in lowercase. * Your class names must start in capital letters and follow the python CapWords pattern. * Methods and properties that return lists must end in "s". -* Methods and variables should be lowercase and use _ (underscore) as word separator. -* Constants names must be all capitals. +* Methods and variables should be lowercase and use _ (underscore) as a word separator. +* Constant names must be all capitals. * Avoid the usage of "get_" and "set_" methods whenever possible, by using @property and @variable.setter decorators instead. * "Private" methods, variables and properties start with _ (underscore) ## Imports - -All the imports should be defined at the top of the file after the license and contact information comment +Place your imports at the top of the file, after the license and contact information +comment ```python """ @@ -42,7 +42,7 @@ Ensure that your imports are used and remove any unused. ## Object attributes and methods -Use properties whenever possible and encapsulate the access to all the calculated object attributes into a properties as shown in the following example. +Use properties whenever possible and encapsulate the access to all the calculated object attributes into properties, as shown in the following example. ```python @@ -55,7 +55,7 @@ Use properties whenever possible and encapsulate the access to all the calculate ``` -or if the property can be modified like in the following example +or like in the following example for read and write properties ```python @@ -82,7 +82,7 @@ If your method or attribute returns a complex object use type hints as in this e ``` -always access your variable throught the method and avoid to access directly. +Always access your variable through the method and avoid to access directly. ```python @@ -99,7 +99,7 @@ always access your variable throught the method and avoid to access directly. #### code documentation -all public classes, properties and methods must have code comments +all public classes, properties, and methods must have code comments ```python @@ -128,7 +128,7 @@ all public classes, properties and methods must have code comments ``` -Attributes with known units should be explicit in method's comment +Attributes with known units should be explicit in method's comment. ```python @@ -143,9 +143,9 @@ Attributes with known units should be explicit in method's comment #### To do's -Pending to implement operations should be indicated with ToDo comments to highlight the missing operation +Pending to implement operations should be indicated with ToDo comments to highlight the missing functionality. ```python - # ToDo: right now extracted at city level, in the future should be extracted also at building level if exist + # ToDo: right now extracted at the city level, in the future should be extracted also at building level if exist ``` From 95e3ec7060e6375fce4c32a4b79c9edf599e213e Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 12:11:57 -0400 Subject: [PATCH 6/6] Update 'PYGUIDE.md' --- PYGUIDE.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/PYGUIDE.md b/PYGUIDE.md index 57242754..48f2a54a 100644 --- a/PYGUIDE.md +++ b/PYGUIDE.md @@ -1,5 +1,5 @@ # Cerc Python Style Guide -## What's coding style and why it matters +## What's coding style and why it matters. Coding style is just how the code looks, it's incredibly personal, and everyone has their style. @@ -11,9 +11,9 @@ At CERC, we are following the [PEP8](https://www.python.org/dev/peps/pep-0008/) We use [PyCharm](https://www.jetbrains.com/pycharm/) as an integrated development environment and follow the tool's overall advice but the space indentation, which we set to two spaces instead of default four spaces. -For code analysis, we enforce the usage of [pylint](https://www.pylint.org/) with our own [custom style definition](pylintrc) +For code analysis, we enforce the usage of [pylint](https://www.pylint.org/) with our own [custom style definition](pylintrc). -## Naming convention +## Naming convention. * Name your folders and files in lowercase. * Your class names must start in capital letters and follow the python CapWords pattern. @@ -23,9 +23,9 @@ For code analysis, we enforce the usage of [pylint](https://www.pylint.org/) wit * Avoid the usage of "get_" and "set_" methods whenever possible, by using @property and @variable.setter decorators instead. * "Private" methods, variables and properties start with _ (underscore) -## Imports +## Imports. Place your imports at the top of the file, after the license and contact information -comment +comment. ```python """ @@ -40,7 +40,7 @@ import sys Ensure that your imports are used and remove any unused. -## Object attributes and methods +## Object attributes and methods. Use properties whenever possible and encapsulate the access to all the calculated object attributes into properties, as shown in the following example. @@ -55,7 +55,7 @@ Use properties whenever possible and encapsulate the access to all the calculate ``` -or like in the following example for read and write properties +And like in the following example for read and write properties. ```python @@ -69,7 +69,7 @@ or like in the following example for read and write properties ``` -If your method or attribute returns a complex object use type hints as in this example +If your method or attribute returns a complex object use type hints as in this example. ```python @@ -95,11 +95,11 @@ Always access your variable through the method and avoid to access directly. ``` -### Coments +### Coments. -#### code documentation +#### Code documentation. -all public classes, properties, and methods must have code comments +All public classes, properties, and methods must have code comments. ```python @@ -141,7 +141,7 @@ Attributes with known units should be explicit in method's comment. return self._distance ``` -#### To do's +#### To do's. Pending to implement operations should be indicated with ToDo comments to highlight the missing functionality.