FAQ last session about sdia-python HOT 10 CLOSED

Would it be possible to make a checklist of the steps to follow when starting a new python project (creating a new environment, new Github repository,... ) and how to organise it?
(Sorry the message is quite late)

from sdia-python.

Could we talk about git branches?

from sdia-python.

My question is about mistakes in git histories. Here is an example of a bad commit I made for our lab. It's meaningless and I would have liked to delete it. The only way i see is to rewrite the history with a rebase, which is very unsafe on the main branch. Is there a way to do it more safely, or to add a comment / tag to the commit ? How can we avoid mistakes like that in the first place?

from sdia-python.

In a few lessons, we have seen examples of Python lambda functions. Is it possible to see how to write it and some examples of use?

Some examples :

normalize = lambda vec: (vec-np.mean(vec))/np.std(vec)  
g = lambda x, y: .5*(C*x**2 + y**2)
G = lambda x, y: np.array([C*x, y])

from sdia-python.

@SnowHawkeye #1 (comment)

My question is about mistakes in git histories. [...] The only way i see is to rewrite the history [...]

Everyone makes mistakes, and it's part of one's history.
Regarding your git history, rewriting/cleaning your local, unbranched and unpushed history is totally fine, and sometimes even desired (rewording commit messages, squashing commits, adding missing files to your last commit, ...).
On the contrary, when commits are shared between branches or (worse) shared with collaborators, rewriting can make histories diverge, difficult to reconcile, and overall it may impact everyone's work, badly.

How can we avoid mistakes like that in the first place?

• discipline and experience are key I guess
• work in a separate branch to avoid potential "contamination" of the main branch
• use git status, git diff commands before even thinking of git add/commit
• use additional tools like, black, pytest, pydocstyle etc., to make sure everything is formatted, tested, etc.
  • you can have a look at https://pre-commit.com/ hooks, cf. the .pre-commit-config.yaml file

When it comes to notebooks

• avoid using notebooks and/or do not version control them (exclude them in the .gitignore file)
• for example scikit-learn doesn't use notebooks, even for showcase (in fact notebooks are generated from .py files, but you won't find .ipynb files in the repo).

I can give a few more words and/or give a quick demo about this during the last session.

from sdia-python.

@aurelienO #1 (comment)

In a few lessons, we have seen examples of Python lambda functions.

Could you post some examples here ? See creating-and-highlighting-code-blocks to display them in your comments.

Is it possible to see how to write it and some examples of use?

I can give a quick demo of lambda functions during the last session.
For more in-depth explanations, you can have look at this Real Python's tutorial

from sdia-python.

Can we come back on how to create a test (which method do you use) before even writting the function/class method you want to test ?

from sdia-python.

Could we talk about the differences between modules, packages, and librairies ?

from sdia-python.

Could we talk about licenses ? Which one do we have to chose and how are they all different ?

from sdia-python.

Hi everyone,

Most of the topics listed here were discussed during the last session.
I'm closing the issue, but feel free to reopen it or raise a new issue if you need further explanation.

As a follow up of @JustineBrgn question #1 (comment), I've created a new issue #2.
We've already drafted the roadmap together on the black board, feel free to interact on #2, while I'm preparing the corresponding note to appear in the notes/ folder.

from sdia-python.