changes in PYGUIDE.md and WINDOWS_INSTALL.md
This commit is contained in:
parent
4da0a42530
commit
1bb471cbe8
51
PYGUIDE.md
51
PYGUIDE.md
@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
Coding style is just how the code looks, it's incredibly personal, and everyone has their style.
|
Coding style is just how the code looks, it's incredibly personal, and everyone has their style.
|
||||||
|
|
||||||
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.
|
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 or her 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.
|
||||||
|
|
||||||
@ -11,17 +11,17 @@ 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.
|
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). This file will be downloaded with the project the first time you clone it.
|
||||||
|
|
||||||
## Naming convention.
|
## Naming convention.
|
||||||
|
|
||||||
* Name your folders and files in lowercase.
|
* Name your folders and files in lowercase and use _ (underscore) to separate words.
|
||||||
* Your class names must start in capital letters and follow the python CapWords pattern.
|
* 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 properties that return lists must end in "s". Therefore, those that return single values, must be singular.
|
||||||
* Methods and variables should be lowercase and use _ (underscore) as a word separator.
|
* Methods and variables should be lowercase and use _ (underscore) as a word separator.
|
||||||
* Constant names must be all capitals.
|
* Constant names must be all capitals.
|
||||||
* Avoid the usage of "get_" and "set_" methods whenever possible, by using @property and @variable.setter decorators instead.
|
* Avoid the usage of "get_" and "set_" methods whenever it is possible, use @property and @variable.setter decorators instead.
|
||||||
* "Private" methods, variables and properties start with _ (underscore)
|
* "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
|
Place your imports at the top of the file, after the license and contact information
|
||||||
@ -43,7 +43,7 @@ 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.
|
Use properties whenever it is possible. Encapsulate the access to all the calculated object attributes to avoid recalculating each time the property is called.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|
||||||
@ -56,7 +56,7 @@ Use properties whenever possible and encapsulate the access to all the calculate
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
And like in the following example for read and write properties.
|
And like in the following example for read and write properties:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|
||||||
@ -70,7 +70,7 @@ And 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
|
```python
|
||||||
|
|
||||||
@ -79,7 +79,8 @@ If your method or attribute returns a complex object use type hints as in this e
|
|||||||
return self._object_changeable_attribute
|
return self._object_changeable_attribute
|
||||||
|
|
||||||
def new_complex_object(self, first_param, second_param) -> ComplexObject:
|
def new_complex_object(self, first_param, second_param) -> ComplexObject:
|
||||||
return ComplexObject(first_param, second_param, self.property)
|
other_needed_property = self.other_needed_property
|
||||||
|
return ComplexObject(first_param, second_param, other_needed_property)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -96,11 +97,11 @@ Always access your variable through the method and avoid to access directly.
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Coments.
|
### Comments.
|
||||||
|
|
||||||
#### Code documentation.
|
#### Code documentation.
|
||||||
|
|
||||||
All public classes, properties, and methods must have code comments.
|
All public classes, properties, and methods must have code comments. Code comments start with capital letters and end without period:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|
||||||
@ -115,20 +116,42 @@ All public classes, properties, and methods must have code comments.
|
|||||||
@property
|
@property
|
||||||
def object_attribute(self):
|
def object_attribute(self):
|
||||||
"""
|
"""
|
||||||
My class object attributes
|
Get my class object attribute
|
||||||
:return: int
|
:return: int
|
||||||
"""
|
"""
|
||||||
return self._object_attribute
|
return self._object_attribute
|
||||||
|
|
||||||
def operation(self, first_param, second_param):
|
def operation(self, first_param, second_param):
|
||||||
"""
|
"""
|
||||||
multiplies object_attribute by two
|
Multiplies object_attribute by two
|
||||||
:return: int
|
:return: int
|
||||||
"""
|
"""
|
||||||
return self.object_attribute * 2
|
return self.object_attribute * 2
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Comments at getters and setters always start with Get and Set, and identity the type of variable at return (at getter) or the value (at setter):
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
@property
|
||||||
|
def object_attribute(self):
|
||||||
|
"""
|
||||||
|
Get object attribute
|
||||||
|
:return: int
|
||||||
|
"""
|
||||||
|
return self._object_attribute
|
||||||
|
|
||||||
|
@object_attribute.setter
|
||||||
|
def object_attribute(self, value):
|
||||||
|
"""
|
||||||
|
Set object attribute
|
||||||
|
:param value: int
|
||||||
|
"""
|
||||||
|
self._object_attribute = value
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
Attributes with known units should be explicit in method's comment.
|
Attributes with known units should be explicit in method's comment.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
@ -7,17 +7,20 @@ Download the latest version of python and Microsoft c++ redistributable
|
|||||||
|
|
||||||
# Get the code.
|
# Get the code.
|
||||||
|
|
||||||
1. First thing you will need is an editor for your source code, that's a personal choice, but we would like to recommend PyCharm community edition, an excellent open-source python editor.
|
1. First thing you will need is an editor for your source code, that's a personal choice, but we would like to recommend PyCharm community edition, an excellent open-source python editor. [PyCharm Community edition](https://www.jetbrains.com/pycharm/download/download-thanks.html?platform=windows&code=PCC)
|
||||||
|
|
||||||
[PyCharm Community edition](https://www.jetbrains.com/pycharm/download/download-thanks.html?platform=windows&code=PCC)
|
|
||||||
|
|
||||||
2. Run the installer, and follow the installation instructions for PyCharm, you may change a few options, but the default ones should be fine.
|
2. Run the installer, and follow the installation instructions for PyCharm, you may change a few options, but the default ones should be fine.
|
||||||
|
|
||||||
3. Open PyCharm and click on **"Get from Version Control"**.
|
3. Open PyCharm and click on **"Get from Version Control"**.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
4. Select Git as the version control and set the URL to [libs repository](https://binarycat.org/git/Guille/libs.git) as shown in the picture.
|
You can find it also at VCS -> Get from Version Control...
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
4. Select Git as the version control and set the URL to [libs repository](https://rs-loy-gitlab.concordia.ca/Guille/libs.git) as shown in the picture.
|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
@ -25,17 +28,16 @@ Download the latest version of python and Microsoft c++ redistributable
|
|||||||
|
|
||||||
You may need to install Git, by clicking at ***Download and install***.
|
You may need to install Git, by clicking at ***Download and install***.
|
||||||
|
|
||||||
5. Click Clone to download CERC libs source code.
|
5. Click Clone to download CERC libs source code. You will end with a project like this:
|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
you will end with a project like this.
|
|
||||||
|
|
||||||
|
|
||||||
# Configure PyCharm.
|
# Configure PyCharm.
|
||||||
|
|
||||||
We use two spaces as a tab instead of standard [pep8](https://www.python.org/dev/peps/pep-0008/) four spaces indentation.
|
We use two spaces as a tab instead of standard [pep8](https://www.python.org/dev/peps/pep-0008/) four spaces indentation.
|
||||||
This option could be configured in PyCharm at the settings screen, as shown in the picture.
|
This option can be configured in PyCharm at the settings screen, as shown in the picture.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@ -46,19 +48,25 @@ This option could be configured in PyCharm at the settings screen, as shown in t
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
2. Go to project settings and add the libs project to your own, as shown in the picture.
|
2. Go to project settings and add the libs project to your own, by clicking on Add Content Root:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
3. Add your first file to your project and click in install requirements to automatically download all the dependencies.
|

|
||||||
|
|
||||||
4. When all the dependencies are satisfied, we are good to go to start importing our first model.
|
3. Add your first file to your project and click in install requirements to automatically download all the dependencies (in blue at top-right corner).
|
||||||
|
|
||||||
by adding the following code to our main.py
|

|
||||||
|
|
||||||
```
|
4. When all the dependencies are satisfied, you are all set to start importing your first city model.
|
||||||
from geometry.geometry_factory import GeometryFactory
|
|
||||||
|
Add the following code to your main.py
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
from imports.geometry_factory import GeometryFactory
|
||||||
|
|
||||||
city = GeometryFactory('citygml', 'myfile.gml').city
|
city = GeometryFactory('citygml', 'myfile.gml').city
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The rest depends on you. Have fun!
|
@ -5,6 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||||||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class Catalog:
|
class Catalog:
|
||||||
"""
|
"""
|
||||||
Catalogs base class not implemented instance of the Catalog base class, catalog_factories will inherit from this class.
|
Catalogs base class not implemented instance of the Catalog base class, catalog_factories will inherit from this class.
|
||||||
|
Loading…
Reference in New Issue
Block a user