- Almost A Circle
- Classes: I
- Classes: II
- Data Structures: I
- Data Structures: II
- Everything Is Object
- Exceptions
- Hello World
- If, Else, Loops and Functions
- Import Modules
- Inheritance
- Input and Output
- Network: I
- Network: II
- Object Relational Mapping
- Test Driven Development
- JavaScript: Warm Up
- JavaScript: Objects, Scopes, Closures
- JavaScript: Web Scrapping
- JavaScript: Web jQuery
For this project, we expect you to look at this concept:
Welcome to the Python world!
The first projects are more "C-oriented" - no tricks, no funky syntax - simple!
If you've already played with Python, don't worry, fun things will come.
You'll soon find that with Python (and the majority of higher level languages), there are ten different ways to do the same thing. Some tasks will expect only one implementation, while other tasks will have multiple possible implementations.
Like C, Python also has a linter / style guide like Betty, called PEP8, also now known as PyCode.
Enjoy!
- Guillaume
Read or watch:
- The Python tutorial (only the first three chapters below)
- Whetting Your Appetite
- Using the Python Interpreter
- An Informal Introduction to Python (Read up until “3.1.2. Strings” included)
- How To Use String Formatters in Python 3
- Learn to Program
- Pycodestyle – Style Guide for Python Code
At the end of this project, you are expected to be able to explain to anyone, without the help of Google:
- Why Python programming is awesome
- Who created Python
- Who is Guido van Rossum
- Where does the name ‘Python’ come from
- What is the Zen of Python
- How to use the Python interpreter
- How to print text and variables using
print
- How to use strings
- What are indexing and slicing in Python
- What is the official Python coding style and how to check your code with
pycodestyle
- Allowed editors:
vi
,vim
,emacs
- All your files will be interpreted/compiled on Ubuntu 20.04 LTS using python3 (version 3.8.5)
- All your files should end with a new line
- The first line of all your files should be exactly
#!/usr/bin/python3
- A
README.md
file at the root of the repo, containing a description of the repository - A
README.md
file, at the root of the folder of this project, is mandatory - Your code should use the pycodestyle (version
2.8.*
) - All your files must be executable
- The length of your files will be tested using
wc
- Allowed editors:
vi
,vim
,emacs
- All your files should end with a new line
- All your test files should be inside a folder
tests
- All your test files should be text files (extension:
.txt
) - All your tests should be executed by using this command:
python3 -m doctest ./tests/*
- All your modules should have a documentation (
python3 -c 'print(__import__("my_module").__doc__)'
) - All your classes should have a documentation (
python3 -c 'print(__import__("my_module").MyClass.__doc__)'
) - All your functions (inside and outside a class) should have a documentation (
python3 -c 'print(__import__("my_module").my_function.__doc__)'
andpython3 -c 'print(__import__("my_module").MyClass.my_function.__doc__)'
) - A documentation is not a simple word, it’s a real sentence explaining what’s the purpose of the module, class or method (the length of it will be verified)
- We strongly encourage you to work together on test cases, so that you don’t miss any edge case
- Do not use the words
import
orfrom
inside your comments, the checker will think you try to import some modules
- Only one line
- No Shebang
- All your files should end with a new line
- Allowed editors:
vi
,vim
,emacs
- All your scripts will be tested on Ubuntu 20.04 LTS
- All your scripts should be exactly two lines long (
wc -l file
should print 2) - All your files should end with a new line
- The first line of all your files should be exactly
#!/bin/bash
- All your files must be executable
- Allowed editors:
vi
,vim
,emacs
- All your files will be compiled on Ubuntu 20.04 LTS using gcc, using the options -Wall -Werror -Wextra -pedantic -std=gnu89
- All your files should end with a new line
- Your code should use the
Betty
style. It will be checked using betty-style.pl and betty-doc.pl - You are not allowed to use global variables
- No more than 5 functions per file
- In the following examples, the
main.c
files are shown as examples. You can use them to test your functions, but you don’t have to push them to your repo (if you do we won’t take them into account). We will use our own main.c files at compilation. Ourmain.c
files might be different from the one shown in the examples - The prototypes of all your functions should be included in your header file called
lists.h
- Don’t forget to push your header file
- All your header files should be include guarded
Zen
The Zen of Python, by Tim Peters
Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!
Pycodestyle
Pycodestyle
is now the new standard of Python style code