MV - refacto m00 + m01

Author: maperez42

.gitignore

@@ -9,6 +9,11 @@ __pycache__/
 # C extensions
 *.so
 
+# Latex compilation files
+*.fdb_latexmk 
+*.fls
+*.pdf.version
+
 # Distribution / packaging
 .Python
 develop-eggs/

module00/subject/acknowledgements.tex module00/subject/en.acknowledgements.texmodule00/subject/acknowledgements.tex renamed to module00/subject/en.acknowledgements.tex

@@ -103,7 +103,7 @@
 \author{}
 \summary{The goal of this module is to get you started with Python}
 \maketitle
-\input{en.py_proj.tex}
+\input{en.instruction.tex}
 \newpage
 \tableofcontents
 \startexercices
@@ -160,7 +160,7 @@
 % ===========================(fin ex 10)         %
 \newpage
 % ================================= %
-\input{acknowledgements.tex}
+\input{en.acknowledgements.tex}
 % ================================= %
 
 \end{document}

module00/subject/en.py_proj.tex module00/subject/en.instructions.texmodule00/subject/en.py_proj.tex renamed to module00/subject/en.instructions.tex

@@ -0,0 +1,87 @@
+\chapter{Exercise 00}
+\extitle{The Book}
+\turnindir{ex00}
+\exnumber{00}
+\exfiles{book.py, recipe.py, test.py}
+\exforbidden{None}
+\makeheaderfilesforbidden
+
+% ================================== %
+\section*{Objective}
+% ---------------------------------- %
+The goal of this exercise is to get you familiar with the notions of
+classes and the manipulation of the objects related to these classes.
+
+% ================================== %
+\section*{Instructions}
+% ---------------------------------- %
+You will have to make a class \texttt{Book} and a class \texttt{Recipe}.
+The classes \texttt{Book} and \texttt{Recipe} will be written in 
+\texttt{book.py} and \texttt{recipe.py} respectively.\\
+\newline
+Let's describe the \texttt{Recipe} class. It has some attributes:
+\begin{itemize}
+  \item \texttt{name} (str): name of the recipe,
+  \item \texttt{cooking\_lvl} (int): range from $1$ to $5$,
+  \item \texttt{cooking\_time} (int): in minutes (no negative numbers),
+  \item \texttt{ingredients} (list): list of all ingredients each represented by a string,
+  \item \texttt{description} (str): description of the recipe,
+  \item \texttt{recipe\_type} (str): can be "starter", "lunch" or "dessert".
+\end{itemize}
+You have to \textbf{initialize} the object \texttt{Recipe} and check all of its values. Only the description can be empty.
+In case of input errors, you should print what they are and exit properly.\\
+\newline
+You will have to implement the built-in method \texttt{\_\_str\_\_}.
+It's the method called when the following code is executed:\\
+\newline
+\begin{minted}[bgcolor=darcula-back,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+tourte = Recipe(...)
+to_print = str(tourte)
+print(to_print)
+\end{minted}
+\newline
+\newline
+It is implemented this way:\\
+\newline
+\begin{minted}[bgcolor=darcula-back,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+def __str__(self):
+    """Returns the string to print with the recipe's info"""
+    txt = ""
+    """Your code here"""
+    return txt
+\end{minted}
+\newline
+The \texttt{Book} class also has some attributes:
+\begin{itemize}
+  \item \texttt{name} (str): name of the book,
+  \item \texttt{last\_update} \href{https://docs.python.org/3/library/datetime.html}{(datetime)}: the date of the last update,
+  \item \texttt{creation\_date} \href{https://docs.python.org/3/library/datetime.html}{(datetime)}: the creation date of the book,
+  \item \texttt{recipes\_list} (dict): a dictionnary with 3 keys: "starter", "lunch", "dessert".
+\end{itemize}
+You will have to implement some methods in the \texttt{Book} class:\\
+\newline
+\begin{minted}[bgcolor=darcula-back	,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+def get_recipe_by_name(self, name):
+    """Prints a recipe with the name \texttt{name} and returns the instance"""
+    #... Your code here ...
+
+def get_recipes_by_types(self, recipe_type):
+    """Gets all recipes names for a given recipe_type """
+    #... Your code here ...
+
+def add_recipe(self, recipe):
+    """Adds a recipe to the book and updates last_update"""
+    #... Your code here ...
+\end{minted}
+\newline
+You have to handle the error if the argument passed in \texttt{add\_recipe} is not a \texttt{Recipe}.\\
+\newline
+Finally, you will provide a \texttt{test.py} file to test your classes and prove that they are working properly.
+You can import all the classes into your \texttt{test.py} file by adding these lines at the top of the \texttt{test.py} file:\\
+\newline
+\begin{minted}[bgcolor=darcula-back	,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+from book import Book
+from recipe import Recipe
+
+# ... Your tests ...
+\end{minted}

module00/subject/en.subject.fdb_latexmk

@@ -0,0 +1,76 @@
+\chapter{Exercise 01}
+\extitle{Family tree}
+\turnindir{ex01}
+\exnumber{01}
+\exfiles{game.py}
+\exforbidden{None}
+\makeheaderfilesforbidden
+
+% ================================= %
+\section*{Objective}
+% --------------------------------- %
+The goal of the exercise is to tackle the notion of class inheritance.
+
+% ================================= %
+\section*{Instructions}
+% --------------------------------- %
+Create a \texttt{GotCharacter} class and initialize it with the following attributes:
+\begin{itemize}
+  \item \texttt{first\_name},
+  \item  \texttt{is\_alive} (by default is \texttt{True}).
+\end{itemize}
+Pick up a Game of Thrones House (e.g., Stark, Lannister...), create a child class that inherits from \texttt{GotCharacter} and 
+define the following attributes:
+\begin{itemize}
+  \item \texttt{family\_name} (by default should be the same as the Class)
+  \item \texttt{house\_words} (e.g., the House words for the Stark House is: "Winter is Coming")\\
+\end{itemize}
+\begin{minted}[bgcolor=darcula-back,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+  class Stark(GotCharacter):
+    def __init__(self, first_name=None, is_alive=True):
+        super().__init__(first_name=first_name, is_alive=is_alive)
+        self.family_name = "Stark"
+        self.house_words = "Winter is Coming"
+\end{minted}
+
+\newpage
+Add two methods to your child class:
+\begin{itemize}
+  \item \texttt{print\_house\_words}: prints the House words,
+  \item \texttt{die}: changes the value of \texttt{is\_alive} to \texttt{False}.
+\end{itemize}
+
+\section*{Examples}
+Running commands in the Python console, an example of what you should get:\\
+\newline
+
+\begin{minted}[bgcolor=darcula-back,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+	$> python
+  >>> from game import Stark
+  
+  >>> arya = Stark("Arya")
+  >>> print(arya.__dict__)
+  {'first_name': 'Arya', 'is_alive': True, 'family_name': 'Stark', 'house_words': 'Winter is Coming'}
+  
+  >>> arya.print_house_words()
+  Winter is Coming
+  
+  >>> print(arya.is_alive)
+  True
+  
+  >>> arya.die()
+  >>> print(arya.is_alive)
+  False
+\end{minted}
+\newline
+You can add any attribute or method you need to your class and format the docstring the way you want.
+Feel free to create other children of \texttt{GotCharacter} class.
+\newline
+\begin{minted}[bgcolor=darcula-back,formatcom=\color{lightgrey},fontsize=\scriptsize]{python}
+	$> python
+  >>> from game import Stark
+  
+  >>> arya = Stark("Arya")
+  >>> print(arya.__doc__)
+  A class representing the Stark family. Or when bad things happen to good people.
+\end{minted}